SallyAPI::GUI::CImageBox Class Reference

Image box. More...

#include <ImageBox.h>

Inheritance diagram for SallyAPI::GUI::CImageBox:

List of all members.

Public Member Functions
	CImageBox (SallyAPI::GUI::CGUIBaseObject *parent, int x, int y, int width, int height, int controlId=0)
	Constructor.
virtual	~CImageBox ()
	Destructor.
virtual void	Timer (float timeDelta)
	Timers.
void	SetImageId (int image)
	Sets an image to this image box loaded by LoadPicture. Set to GUI_NO_IMAGE to erase the image.
int	GetImageId ()
	Gets the image identifier.
void	SetPicture (SallyAPI::GUI::CPicture *picture)
	Sets a picture to this image box. Set to NULL to erase the image.
SallyAPI::GUI::CPicture *	GetPicture ()
	Gets the picture.
void	SetDisplayType (ImageBoxDisplayType value)
	Sets a diyplay type.
ImageBoxDisplayType	GetDiyplayType ()
	Gets the diyplay type.
Protected Member Functions
virtual void	RenderControl ()
	Renders a control.
virtual bool	ProcessMouseDoubleClick (int x, int y)
	Process a mouse double click.
virtual bool	ProcessMouseUp (int x, int y)
	Process a mouse up.
virtual bool	ProcessMouseMove (int x, int y)
	Process a mouse move.
Protected Attributes
int	m_iImage
SallyAPI::GUI::CPicture *	m_pPicture
ImageBoxDisplayType	m_eDiyplayType

---

Detailed Description

Image box.

Author:

Christian Knobloch

Date:

19.04.2010

---

Constructor & Destructor Documentation

CImageBox::CImageBox	(	SallyAPI::GUI::CGUIBaseObject *	parent,
		int	x,
		int	y,
		int	width,
		int	height,
		int	controlId = 0
	)

Constructor.

m_pPicture(NULL), m_iImage(GUI_NO_IMAGE), m_eDiyplayType(IMAGEBOX_DISPLAY_TYPE_STRETCH)

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

[in,out]	parent	If non-null, the parent.
	x	The x coordinate.
	y	The y coordinate.
	width	The width.
	height	The height.
	controlId	Identifier for the control.

CImageBox::~CImageBox

(

)

[virtual]

Destructor.

Author:

Christian Knobloch

Date:

19.04.2010

---

Member Function Documentation

ImageBoxDisplayType CImageBox::GetDiyplayType

(

)

Gets the diyplay type.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The diyplay type.

int CImageBox::GetImageId

(

)

Gets the image identifier.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The image identifier.

SallyAPI::GUI::CPicture * CImageBox::GetPicture

(

)

Gets the picture.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

null if it fails, else the picture.

bool CImageBox::ProcessMouseDoubleClick	(	int	x,
		int	y
	)		[protected, virtual]

Process a mouse double click.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

x	The x coordinate.
y	The y coordinate.

Returns:

true if it succeeds, false if it fails.

Reimplemented from SallyAPI::GUI::CControl.

bool CImageBox::ProcessMouseMove	(	int	x,
		int	y
	)		[protected, virtual]

Process a mouse move.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

x	The x coordinate.
y	The y coordinate.

Returns:

true if it succeeds, false if it fails.

Reimplemented from SallyAPI::GUI::CControl.

bool CImageBox::ProcessMouseUp	(	int	x,
		int	y
	)		[protected, virtual]

Process a mouse up.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

x	The x coordinate.
y	The y coordinate.

Returns:

true if it succeeds, false if it fails.

Reimplemented from SallyAPI::GUI::CControl.

void CImageBox::RenderControl

(

)

[protected, virtual]

Renders a control.

Author:

Christian Knobloch

Date:

19.04.2010

Implements SallyAPI::GUI::CGUIBaseObject.

void CImageBox::SetDisplayType

(

ImageBoxDisplayType

value

)

Sets a diyplay type.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

value

The value.

void CImageBox::SetImageId

(

int

image

)

Sets an image to this image box loaded by LoadPicture. Set to GUI_NO_IMAGE to erase the image.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

image

The image.

void CImageBox::SetPicture

(

SallyAPI::GUI::CPicture *

picture

)

Sets a picture to this image box. Set to NULL to erase the image.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

[in,out]

picture

If non-null, the picture.

void CImageBox::Timer

(

float

timeDelta

)

[virtual]

Timers.

Author:

Christian Knobloch

Date:

26.05.2011

Parameters:

timeDelta

The time delta.

Reimplemented from SallyAPI::GUI::CControl.

Reimplemented in SallyAPI::GUI::CBox2DObject.

---

Member Data Documentation

ImageBoxDisplayType SallyAPI::GUI::CImageBox::m_eDiyplayType [protected]

int SallyAPI::GUI::CImageBox::m_iImage [protected]

SallyAPI::GUI::CPicture* SallyAPI::GUI::CImageBox::m_pPicture [protected]

---

The documentation for this class was generated from the following files:

• D:/source/c++/Programme/sally/sally/sallyAPI/ImageBox.h
• D:/source/c++/Programme/sally/sally/sallyAPI/ImageBox.cpp