SallyAPI::GUI::CGUIBaseObject Class Reference

Cgui base object. More...

#include <GUIBaseObject.h>

Inheritance diagram for SallyAPI::GUI::CGUIBaseObject:

List of all members.

Public Member Functions
	CGUIBaseObject (CGUIBaseObject *parent)
	Constructor.
virtual	~CGUIBaseObject ()
	Destructor.
int	GetWidth ()
	Gets the width.
int	GetHeight ()
	Gets the height.
int	GetPositionX ()
	Gets the position x coordinate coordinate.
int	GetPositionY ()
	Gets the position y coordinate coordinate.
SallyAPI::GUI::CGUIBaseObject *	GetParent ()
	Gets the parent of this item.
virtual void	SetAlphaBlending (int alphaBlending)
	Sets an alpha blending.
virtual int	GetAlphaBlending ()
	Gets the alpha blending.
virtual void	SetRotationAngleY (float angle)
	Sets a rotation angle y coordinate coordinate.
virtual float	GetRotationAngleY ()
	Gets the rotation angle y coordinate coordinate.
virtual void	SetRotationAngleX (float angle)
	Sets a rotation angle x coordinate coordinate.
virtual float	GetRotationAngleX ()
	Gets the rotation angle x coordinate coordinate.
virtual void	SetRotationAngleZ (float angle)
	Sets a rotation angle z coordinate coordinate.
virtual float	GetRotationAngleZ ()
	Gets the rotation angle z coordinate coordinate.
virtual void	SetText (const std::string &text)
	Sets a text.
virtual std::string	GetText ()
	Gets the text.
virtual void	GetAbsolutPosition (int *x, int *y)
	Gets an absolut position.
virtual void	SendMessageToParent (SallyAPI::GUI::CGUIBaseObject *reporter, int iReporterID, int iMessageID, SallyAPI::GUI::SendMessage::CParameterBase *messageParameter=NULL)=0
virtual void	SendMessageToChilds (SallyAPI::GUI::CGUIBaseObject *reporter, int iReporterID, int iMessageID, SallyAPI::GUI::SendMessage::CParameterBase *messageParameter=NULL)=0
virtual void	Timer (float timeDelta)
	Timers.
virtual void	Render ()
	Renders this object.
virtual void	Update ()
	Updates this object.
Protected Member Functions
void	DrawImage (int gui, int x, int y)
	Draw image.
void	DrawImagePart (int gui, int x, int y, int srcX, int srcY, int srcW, int srcH)
	Draw image part.
void	DrawImage (int gui, int x, int y, int width, int height)
	Draw image.
void	EnterRenderLock ()
	Enter render lock.
void	LeaveRenderLock ()
	Leave render lock.
virtual void	RenderControl ()=0
virtual void	UpdateControl ()=0
SallyAPI::GUI::CPicture *	GetPicture (int gui)
	Gets an image.
RECT	GetImageRect (int gui)
	Gets an image rectangle.
Protected Attributes
CRITICAL_SECTION	m_critSectLockRender
std::string	m_strText
float	m_fTimeDelta
SallyAPI::GUI::CGUIBaseObject *	m_pParent
bool	m_bUpdateRequested
int	m_iX
int	m_iY
int	m_iXAbsolut
int	m_iYAbsolut
int	m_iWidth
int	m_iHeight
int	m_iAlphaBlending
float	m_fAngleY
float	m_fAngleX
float	m_fAngleZ

---

Detailed Description

Cgui base object.

Author:

Christian Knobloch

Date:

19.04.2010

---

Constructor & Destructor Documentation

CGUIBaseObject::CGUIBaseObject

(

CGUIBaseObject *

parent

)

Constructor.

Author:

Christian Knobloch

Date:

30.04.2010

Parameters:

[in,out]

parent

If non-null, the parent.

CGUIBaseObject::~CGUIBaseObject

(

)

[virtual]

Destructor.

Author:

Christian Knobloch

Date:

19.04.2010

---

Member Function Documentation

void CGUIBaseObject::DrawImage	(	int	gui,
		int	x,
		int	y
	)		[protected]

Draw image.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

gui	The graphical user interface.
x	The x coordinate.
y	The y coordinate.

void CGUIBaseObject::DrawImage	(	int	gui,
		int	x,
		int	y,
		int	width,
		int	height
	)		[protected]

Draw image.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

gui	The graphical user interface.
x	The x coordinate.
y	The y coordinate.
width	The width.
height	The height.

void CGUIBaseObject::DrawImagePart	(	int	gui,
		int	x,
		int	y,
		int	srcX,
		int	srcY,
		int	srcW,
		int	srcH
	)		[protected]

Draw image part.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

gui	The graphical user interface.
x	The x coordinate.
y	The y coordinate.
srcX	Source x coordinate.
srcY	Source y coordinate.
srcW	Source w.
srcH	Source h.

void CGUIBaseObject::EnterRenderLock

(

)

[protected]

Enter render lock.

Author:

Christian Knobloch

Date:

19.04.2010

void CGUIBaseObject::GetAbsolutPosition	(	int *	x,
		int *	y
	)		[virtual]

Gets an absolut position.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

[in,out]	x	If non-null, the x coordinate.
[in,out]	y	If non-null, the y coordinate.

Reimplemented in SallyAPI::GUI::CWindow.

int CGUIBaseObject::GetAlphaBlending

(

)

[virtual]

Gets the alpha blending.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The alpha blending.

int CGUIBaseObject::GetHeight

(

)

Gets the height.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The height.

RECT CGUIBaseObject::GetImageRect

(

int

gui

)

[protected]

Gets an image rectangle.

Author:

Christian Knobloch

Date:

03.05.2010

Parameters:

gui	The graphical user interface.

Returns:

The image rectangle.

SallyAPI::GUI::CGUIBaseObject * CGUIBaseObject::GetParent

(

)

Gets the parent of this item.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

null if it fails, else the parent.

SallyAPI::GUI::CPicture * CGUIBaseObject::GetPicture

(

int

gui

)

[protected]

Gets an image.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

gui	The graphical user interface.

Returns:

null if it fails, else the image.

int CGUIBaseObject::GetPositionX

(

)

Gets the position x coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The position x coordinate coordinate.

int CGUIBaseObject::GetPositionY

(

)

Gets the position y coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The position y coordinate coordinate.

float CGUIBaseObject::GetRotationAngleX

(

)

[virtual]

Gets the rotation angle x coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The rotation angle x coordinate coordinate.

float CGUIBaseObject::GetRotationAngleY

(

)

[virtual]

Gets the rotation angle y coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The rotation angle y coordinate coordinate.

float CGUIBaseObject::GetRotationAngleZ

(

)

[virtual]

Gets the rotation angle z coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The rotation angle z coordinate coordinate.

std::string CGUIBaseObject::GetText

(

)

[virtual]

Gets the text.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The text.

Reimplemented in SallyAPI::GUI::CScreensaverControlLabel.

int CGUIBaseObject::GetWidth

(

)

Gets the width.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The width.

void CGUIBaseObject::LeaveRenderLock

(

)

[protected]

Leave render lock.

Author:

Christian Knobloch

Date:

19.04.2010

void CGUIBaseObject::Render

(

)

[virtual]

Renders this object.

Author:

Christian Knobloch

Date:

19.04.2010

Reimplemented in SallyAPI::GUI::CControl, SallyAPI::GUI::CForm, SallyAPI::GUI::CPopUpWindow, and SallyAPI::GUI::CWindow.

virtual void SallyAPI::GUI::CGUIBaseObject::RenderControl

(

)

[protected, pure virtual]

Implemented in SallyAPI::GUI::CButton, SallyAPI::GUI::CForm, SallyAPI::GUI::CEdit, SallyAPI::GUI::CImageBox, SallyAPI::GUI::CContextMenu, SallyAPI::GUI::CSideMenuButton, SallyAPI::GUI::CLabel, SallyAPI::GUI::CWindow, SallyAPI::GUI::CSlider, SallyAPI::GUI::CButtonBarButton, SallyAPI::GUI::CProcessbar, SallyAPI::GUI::CScreensaverControlLabel, SallyAPI::GUI::CSideMenu, SallyAPI::GUI::CCheckbox, SallyAPI::GUI::CRadioButton, and SallyAPI::GUI::CScreensaverControlButton.

virtual void SallyAPI::GUI::CGUIBaseObject::SendMessageToChilds	(	SallyAPI::GUI::CGUIBaseObject *	reporter,
		int	iReporterID,
		int	iMessageID,
		SallyAPI::GUI::SendMessage::CParameterBase *	messageParameter = NULL
	)		[pure virtual]

Implemented in SallyAPI::GUI::CControl, SallyAPI::GUI::CFileBrowser, SallyAPI::GUI::CListView, SallyAPI::GUI::CListViewExt, SallyAPI::GUI::CApplicationWindow, SallyAPI::GUI::CForm, SallyAPI::GUI::CScrollbar, SallyAPI::GUI::CRating, SallyAPI::GUI::CWindow, SallyAPI::GUI::CLabelBox, SallyAPI::GUI::CBox2DObject, SallyAPI::GUI::CEditBox, SallyAPI::GUI::CSlider, and SallyAPI::GUI::CProcessbar.

virtual void SallyAPI::GUI::CGUIBaseObject::SendMessageToParent	(	SallyAPI::GUI::CGUIBaseObject *	reporter,
		int	iReporterID,
		int	iMessageID,
		SallyAPI::GUI::SendMessage::CParameterBase *	messageParameter = NULL
	)		[pure virtual]

Implemented in SallyAPI::GUI::CControl, SallyAPI::GUI::CFileBrowser, SallyAPI::GUI::CListView, SallyAPI::GUI::CListViewExt, SallyAPI::GUI::CApplicationWindow, SallyAPI::GUI::CForm, SallyAPI::GUI::C3DCircle, SallyAPI::GUI::CScrollbar, SallyAPI::GUI::CPopUpWindow, SallyAPI::GUI::CTabcontrol, SallyAPI::GUI::CScrollList, SallyAPI::GUI::CGameWindow, SallyAPI::GUI::CNumberSelector, SallyAPI::GUI::CWindow, SallyAPI::GUI::CMessageBox, SallyAPI::GUI::CAppBase, SallyAPI::GUI::COpenDialog, SallyAPI::GUI::CInputBox, SallyAPI::GUI::CWizardPanel, SallyAPI::GUI::CQuestionBox, SallyAPI::GUI::CScreensaverControl, SallyAPI::GUI::CVolumeControl, and SallyAPI::GUI::CConfigPanel.

void CGUIBaseObject::SetAlphaBlending

(

int

alphaBlending

)

[virtual]

Sets an alpha blending.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

alphaBlending

The alpha blending.

Reimplemented in SallyAPI::GUI::CListView, SallyAPI::GUI::CListViewExt, SallyAPI::GUI::CForm, and SallyAPI::GUI::CScrollList.

void CGUIBaseObject::SetRotationAngleX

(

float

angle

)

[virtual]

Sets a rotation angle x coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

angle

The angle.

void CGUIBaseObject::SetRotationAngleY

(

float

angle

)

[virtual]

Sets a rotation angle y coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

angle

The angle.

void CGUIBaseObject::SetRotationAngleZ

(

float

angle

)

[virtual]

Sets a rotation angle z coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

angle

The angle.

void CGUIBaseObject::SetText

(

const std::string &

text

)

[virtual]

Sets a text.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

text

The text.

Reimplemented in SallyAPI::GUI::CControl, SallyAPI::GUI::CEdit, SallyAPI::GUI::CLabelBox, SallyAPI::GUI::CEditBox, and SallyAPI::GUI::CScreensaverControlLabel.

void CGUIBaseObject::Timer

(

float

timeDelta

)

[virtual]

Timers.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

timeDelta

The time delta.

Reimplemented in SallyAPI::GUI::CControl, SallyAPI::GUI::CListView, SallyAPI::GUI::CListViewExt, SallyAPI::GUI::CButton, SallyAPI::GUI::CForm, SallyAPI::GUI::C3DCircle, SallyAPI::GUI::CBox2DObject, SallyAPI::GUI::CNumberSelector, SallyAPI::GUI::CWindow, SallyAPI::GUI::CImageBox, SallyAPI::GUI::CListViewButton, and SallyAPI::GUI::CLabel.

void CGUIBaseObject::Update

(

)

[virtual]

Updates this object.

Author:

Christian Knobloch

Date:

30.04.2010

Reimplemented in SallyAPI::GUI::CControl, SallyAPI::GUI::CForm, and SallyAPI::GUI::CWindow.

virtual void SallyAPI::GUI::CGUIBaseObject::UpdateControl

(

)

[protected, pure virtual]

Implemented in SallyAPI::GUI::CControl, SallyAPI::GUI::CForm, and SallyAPI::GUI::CWindow.

---

Member Data Documentation

bool SallyAPI::GUI::CGUIBaseObject::m_bUpdateRequested [protected]

CRITICAL_SECTION SallyAPI::GUI::CGUIBaseObject::m_critSectLockRender [protected]

float SallyAPI::GUI::CGUIBaseObject::m_fAngleX [protected]

float SallyAPI::GUI::CGUIBaseObject::m_fAngleY [protected]

float SallyAPI::GUI::CGUIBaseObject::m_fAngleZ [protected]

float SallyAPI::GUI::CGUIBaseObject::m_fTimeDelta [protected]

int SallyAPI::GUI::CGUIBaseObject::m_iAlphaBlending [protected]

int SallyAPI::GUI::CGUIBaseObject::m_iHeight [protected]

int SallyAPI::GUI::CGUIBaseObject::m_iWidth [protected]

int SallyAPI::GUI::CGUIBaseObject::m_iX [protected]

int SallyAPI::GUI::CGUIBaseObject::m_iXAbsolut [protected]

int SallyAPI::GUI::CGUIBaseObject::m_iY [protected]

int SallyAPI::GUI::CGUIBaseObject::m_iYAbsolut [protected]

SallyAPI::GUI::CGUIBaseObject* SallyAPI::GUI::CGUIBaseObject::m_pParent [protected]

std::string SallyAPI::GUI::CGUIBaseObject::m_strText [protected]

---

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

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