SallyAPI::GUI::CControl Class Reference

The base GUI control. Every GUI control will inherit from this class. More...

#include <Control.h>

Inheritance diagram for SallyAPI::GUI::CControl:

List of all members.

Public Member Functions
	CControl (SallyAPI::GUI::CGUIBaseObject *parent, int x, int y, int width, int height, int controlId=0)
	Constructor.
virtual	~CControl ()
	Destructor.
virtual void	Move (int x, int y)
	Moves.
virtual void	Resize (int width, int height)
	Resizes.
virtual void	MoveAnimated (int x, int y, int speed, bool moveToEnd=true)
	Move animated.
virtual void	ResizeAnimated (int width, int height, int speed, bool moveToEnd=true)
	Resize animated.
virtual void	MoveAnimated (int x, int y, int speedX, int speedY, bool moveToEnd=true)
	Move animated.
virtual void	ResizeAnimated (int width, int height, int speedWidth, int speedHeight, bool moveToEnd=true)
	Resize animated.
virtual void	BlendAnimated (int alphaBlending, int speed, bool moveToEnd=true)
	Blend animated.
virtual void	RotateAnimatedY (float speed, bool bRun)
	Rotate animated y coordinate.
virtual void	RotateAnimatedX (float speed, bool bRun)
	Rotate animated x coordinate.
virtual void	RotateAnimatedZ (float speed, bool bRun)
	Rotate animated z coordinate.
virtual void	SetRotationX (ControlRotation value)
	Sets a rotation x coordinate coordinate.
virtual void	SetRotationY (ControlRotation value)
	Sets a rotation y coordinate coordinate.
virtual void	SetRotationZ (ControlRotation value)
	Sets a rotation z coordinate coordinate.
virtual ControlRotation	GetRotationX ()
	Gets the rotation x coordinate coordinate.
virtual ControlRotation	GetRotationY ()
	Gets the rotation y coordinate coordinate.
virtual ControlRotation	GetRotationZ ()
	Gets the rotation z coordinate coordinate.
virtual void	Visible (bool visible)
	Visibles.
virtual void	Enable (bool enable)
	Enables.
virtual void	SetLocalised (bool localised)
	Sets a localised.
virtual void	InvalidateControl ()
virtual void	SetText (const std::string &text)
	Sets a text.
virtual bool	IsVisible ()
	Query if this object is visible.
virtual bool	IsEnabled ()
	Query if this object is enabled.
virtual bool	IsLocalised ()
	Query if this object is localised.
virtual bool	IsMouseDown ()
	Query if this object is mouse down.
virtual bool	IsPressed ()
	Query if this object is pressed.
virtual void	SetStopAngelX (float angel)
	Sets a stop angel x coordinate coordinate.
virtual void	SetStopAngelY (float angel)
	Sets a stop angel y coordinate coordinate.
virtual void	SetStopAngelZ (float angel)
	Sets a stop angel z coordinate coordinate.
virtual int	GetMouseDownX ()
	Gets the mouse down x coordinate coordinate.
virtual int	GetMouseDownY ()
	Gets the mouse down y coordinate coordinate.
virtual void	SetColor (D3DCOLOR rgbFontColour)
	Sets the font color.
virtual void	SetAlign (int align)
	Sets an align.
virtual int	GetControlId ()
	Gets the control identifier.
virtual void	Timer (float timeDelta)
	Timers.
virtual void	Render ()
	Renders this object.
virtual void	Update ()
	Updates this object.
virtual void	CleanUp ()
	This method is called when the control is destroyed.
virtual void	SendMessageToParent (SallyAPI::GUI::CGUIBaseObject *reporter, int reporterId, int messageId, SallyAPI::GUI::SendMessage::CParameterBase *messageParameter=NULL)
	This method implements the message bus to the parent control. Messages send to the parent control will go through this method. You can hook in here, if you want to intercept a message.
virtual void	SendMessageToChilds (SallyAPI::GUI::CGUIBaseObject *reporter, int reporterId, int messageId, SallyAPI::GUI::SendMessage::CParameterBase *messageParameter=NULL)
	This method implements the message bus to the child controls. Messages send to all child controls will go through this method. You can hook in here, if you want to intercept a message.
virtual void	ProcessKeyboard (char KeyboardState[256], char KeyboardStatePressed[256])
	Process a keyboard.
virtual bool	CheckProcessMouseDoubleClick (int x, int y)
	Check process mouse double click.
virtual bool	CheckProcessMouseDown (int x, int y)
	Check process mouse down.
virtual bool	CheckProcessMouseUp (int x, int y)
	Check process mouse up.
virtual bool	CheckProcessMouseMove (int x, int y)
	Check process mouse move.
int	GetDestinationPositionX ()
	Gets the destination position x coordinate coordinate.
int	GetDestinationPositionY ()
	Gets the destination position y coordinate coordinate.
int	GetDestinationHeight ()
	Gets the destination height.
int	GetDestinationWidth ()
	Gets the destination width.
bool	IsAnimationActivePositionX ()
	Query if this object is animation active position x coordinate.
bool	IsAnimationActivePositionY ()
	Query if this object is animation active position y coordinate.
bool	IsAnimationActiveHeight ()
	Query if this object is animation active height.
bool	IsAnimationActiveWidth ()
	Query if this object is animation active width.
bool	IsControlHit (int x, int y)
	Query if at that coordinats the control would be hit.
Protected Member Functions
virtual SallyAPI::Core::CFont *	GetCurrentFont (const std::string &fontName)
	Gets a current font.
virtual RECT	GetTextRect (int leftImage, int rightImage, int borderLeft, int borderRight, int topImage, int bottomImage, int borderTop, int borderBottom)
	Gets a text rectangle.
virtual void	DrawButtonBackground (int leftImageTop, int middleImageTop, int rightImageTop, int leftImage, int middleImage, int rightImage, int leftImageBottom, int middleImageBottom, int rightImageBottom)
	Draw button background.
virtual void	DrawButtonBackground (int leftImage, int middleImage, int rightImage)
	Draw button background.
virtual void	DrawButtonBackground (int leftImage, int middleImage, int rightImage, int xCorrection, int yCorrection, int widthCorrection, int heightCorrection)
	Draw button background.
virtual void	DrawText (RECT r, const std::string &fontName, const std::string &text)
	Draw text.
virtual void	DrawText (int leftImage, int rightImage, int borderLeft, int borderRight, const std::string &fontName, const std::string &text="")
	Draw text.
virtual void	DrawText (int leftImage, int rightImage, int borderLeft, int borderRight, int topImage, int bottomImage, int borderTop, int borderBottom, const std::string &fontName, const std::string &text="")
	Draw text.
virtual void	DrawTextToRenderTarget (int width, int height, const std::string &fontName, int offSetX, int offSetY, const std::string &text="")
	Draw text to render target.
virtual void	ResizeInternal (int width, int height)
	Resize internal.
virtual void	MoveInternal (int x, int y)
	Move internal.
virtual void	UpdateControl ()
	Updates a control.
virtual void	ResetMouse ()
	Resets the mouse down variables.
virtual bool	ProcessMouseDoubleClick (int x, int y)
	Process a mouse double click.
virtual bool	ProcessMouseDown (int x, int y)
	Process a mouse down.
virtual bool	ProcessMouseUp (int x, int y)
	Process a mouse up.
virtual bool	ProcessMouseMove (int x, int y)
	Process a mouse move.
Protected Attributes
bool	m_bVisible
bool	m_bEnabled
bool	m_bPressed
int	m_iControlId
D3DCOLOR	m_rgbFontColour
int	m_iAlign
bool	m_bLocalised
bool	m_bMouseDown
int	m_iMouseDownX
int	m_iMouseDownY
float	m_fDeltaMoveX
float	m_fDeltaMoveY
int	m_iDestinationX
int	m_iDestinationY
int	m_iStartX
int	m_iStartY
int	m_iAnimationSpeedMoveX
int	m_iAnimationSpeedMoveY
bool	m_bAnimationMoveY
bool	m_bAnimationMoveX
float	m_fDeltaResizeWidth
float	m_fDeltaResizeHeight
int	m_iDestinationWidth
int	m_iDestinationHeight
int	m_iStartWidth
int	m_iStartHeight
int	m_iAnimationSpeedResizeWidth
int	m_iAnimationSpeedResizeHeight
bool	m_bAnimationResizeWidth
bool	m_bAnimationResizeHeight
float	m_fDeltaBlend
int	m_iDestinationBlend
int	m_iStartBlend
int	m_iAnimationSpeedBlend
bool	m_bAnimationBlend
float	m_fDeltaRotateY
float	m_fStartRotateY
float	m_fSpeedRotateY
bool	m_bAnimationRotateY
bool	m_bAnimationRotateYRun
float	m_fDeltaRotateX
float	m_fStartRotateX
float	m_fSpeedRotateX
bool	m_bAnimationRotateX
bool	m_bAnimationRotateXRun
float	m_fDeltaRotateZ
float	m_fStartRotateZ
float	m_fSpeedRotateZ
bool	m_bAnimationRotateZ
bool	m_bAnimationRotateZRun
ControlRotation	m_eRotationX
ControlRotation	m_eRotationY
ControlRotation	m_eRotationZ
float	m_fStopAtAngelX
float	m_fStopAtAngelY
float	m_fStopAtAngelZ
float	m_fTimeMouseUp
float	m_fTimeMouseDown

---

Detailed Description

The base GUI control. Every GUI control will inherit from this class.

Author:

Christian Knobloch

Date:

19.04.2010

---

Constructor & Destructor Documentation

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

Constructor.

m_bEnabled(true), m_iControlId(controlId), m_rgbFontColour(0), m_iAlign(-1), m_bLocalised(true), m_bMouseDown(false), m_iMouseDownY(-1), m_iMouseDownX(-1), m_bPressed(false), m_fDeltaMoveX(0), m_bAnimationMoveX(false), m_fDeltaMoveY(0), m_bAnimationMoveY(false), m_fDeltaResizeWidth(0), m_bAnimationResizeWidth(false), m_fDeltaResizeHeight(0), m_bAnimationResizeHeight(false), m_fDeltaBlend(0), m_bAnimationBlend(false), m_fDeltaRotateY(0), m_bAnimationRotateY(false), m_fDeltaRotateX(0), m_bAnimationRotateX(false), m_fDeltaRotateZ(0), m_bAnimationRotateZ(false), m_fSpeedRotateY(0), m_fSpeedRotateX(0), m_fSpeedRotateZ(0), m_fStopAtAngelX(360), m_fStopAtAngelY(360), m_fStopAtAngelZ(360), m_iDestinationX(-1), m_iDestinationY(-1), m_iDestinationHeight(-1), m_iDestinationWidth(-1), m_eRotationX(CONTROLROTATION_LEFT), m_eRotationY(CONTROLROTATION_LEFT), m_eRotationZ(CONTROLROTATION_LEFT), m_fTimeMouseClick(-1)

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.

CControl::~CControl

(

)

[virtual]

Destructor.

Author:

Christian Knobloch

Date:

19.04.2010

---

Member Function Documentation

void CControl::BlendAnimated	(	int	alphaBlending,
		int	speed,
		bool	moveToEnd = true
	)		[virtual]

Blend animated.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

alphaBlending	The alpha blending.
speed	The speed.
moveToEnd	true to move to end.

bool CControl::CheckProcessMouseDoubleClick	(	int	x,
		int	y
	)		[virtual]

Check process 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.

bool CControl::CheckProcessMouseDown	(	int	x,
		int	y
	)		[virtual]

Check process mouse down.

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 in SallyAPI::GUI::CListView, SallyAPI::GUI::CListViewExt, SallyAPI::GUI::CScrollbar, SallyAPI::GUI::CListViewButton, and SallyAPI::GUI::CSlider.

bool CControl::CheckProcessMouseMove	(	int	x,
		int	y
	)		[virtual]

Check process 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.

bool CControl::CheckProcessMouseUp	(	int	x,
		int	y
	)		[virtual]

Check process 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 in SallyAPI::GUI::CListView, SallyAPI::GUI::CListViewExt, and SallyAPI::GUI::CListViewButton.

void CControl::CleanUp

(

)

[virtual]

This method is called when the control is destroyed.

Author:

Christian Knobloch

Date:

19.04.2010

void CControl::DrawButtonBackground	(	int	leftImageTop,
		int	middleImageTop,
		int	rightImageTop,
		int	leftImage,
		int	middleImage,
		int	rightImage,
		int	leftImageBottom,
		int	middleImageBottom,
		int	rightImageBottom
	)		[protected, virtual]

Draw button background.

Author:

Christian Knobloch

Date:

19.09.2010

Parameters:

leftImageTop	The left image top.
middleImageTop	The middle image top.
rightImageTop	The right image top.
leftImage	The left image.
middleImage	The middle image.
rightImage	The right image.
leftImageBottom	The left image bottom.
middleImageBottom	The middle image bottom.
rightImageBottom	The right image bottom.

void CControl::DrawButtonBackground	(	int	leftImage,
		int	middleImage,
		int	rightImage
	)		[protected, virtual]

Draw button background.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

leftImage	The left image.
middleImage	The middle image.
rightImage	The right image.

void CControl::DrawButtonBackground	(	int	leftImage,
		int	middleImage,
		int	rightImage,
		int	xCorrection,
		int	yCorrection,
		int	widthCorrection,
		int	heightCorrection
	)		[protected, virtual]

Draw button background.

Author:

Christian Knobloch

Date:

19.12.2011

Parameters:

leftImage	The left image.
middleImage	The middle image.
rightImage	The right image.
xCorrection	The x coordinate correction.
yCorrection	The y coordinate correction.
widthCorrection	The width correction.
heightCorrection	The height correction.

void CControl::DrawText	(	RECT	r,
		const std::string &	fontName,
		const std::string &	text
	)		[protected, virtual]

Draw text.

Author:

Christian Knobloch

Date:

04.05.2010

Parameters:

r	The.
fontName	Name of the font.
text	The text.

void CControl::DrawText	(	int	leftImage,
		int	rightImage,
		int	borderLeft,
		int	borderRight,
		const std::string &	fontName,
		const std::string &	text = ""
	)		[protected, virtual]

Draw text.

Author:

Christian Knobloch

Date:

04.05.2010

Parameters:

leftImage	The left image.
rightImage	The right image.
borderLeft	The border left.
borderRight	The border right.
fontName	Name of the font.
text	The text.

void CControl::DrawText	(	int	leftImage,
		int	rightImage,
		int	borderLeft,
		int	borderRight,
		int	topImage,
		int	bottomImage,
		int	borderTop,
		int	borderBottom,
		const std::string &	fontName,
		const std::string &	text = ""
	)		[protected, virtual]

Draw text.

Author:

Christian Knobloch

Date:

13.09.2010

Parameters:

leftImage	The left image.
rightImage	The right image.
borderLeft	The border left.
borderRight	The border right.
topImage	The top image.
bottomImage	The bottom image.
borderTop	The border top.
borderBottom	The border bottom.
fontName	Name of the font.
text	The text.

void CControl::DrawTextToRenderTarget	(	int	width,
		int	height,
		const std::string &	fontName,
		int	offSetX,
		int	offSetY,
		const std::string &	text = ""
	)		[protected, virtual]

Draw text to render target.

Author:

Christian Knobloch

Date:

04.05.2010

Parameters:

width	The width.
height	The height.
fontName	Name of the font.
offSetX	The off set x coordinate.
offSetY	The off set y coordinate.
text	The text.

void CControl::Enable

(

bool

enable

)

[virtual]

Enables.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

enable

true to enable, false to disable.

Reimplemented in SallyAPI::GUI::CListView, SallyAPI::GUI::CListViewExt, and SallyAPI::GUI::CNumberSelector.

int CControl::GetControlId

(

)

[virtual]

Gets the control identifier.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The control identifier.

SallyAPI::Core::CFont * CControl::GetCurrentFont

(

const std::string &

fontName

)

[protected, virtual]

Gets a current font.

Author:

Christian Knobloch

Date:

13.09.2010

Parameters:

fontName

Name of the font.

Returns:

null if it fails, else the current font.

int CControl::GetDestinationHeight

(

)

Gets the destination height.

Author:

Christian Knobloch

Date:

15.11.2010

Returns:

The destination height.

int CControl::GetDestinationPositionX

(

)

Gets the destination position x coordinate coordinate.

Author:

Christian Knobloch

Date:

15.11.2010

Returns:

The destination position x coordinate coordinate.

int CControl::GetDestinationPositionY

(

)

Gets the destination position y coordinate coordinate.

Author:

Christian Knobloch

Date:

15.11.2010

Returns:

The destination position y coordinate coordinate.

int CControl::GetDestinationWidth

(

)

Gets the destination width.

Author:

Christian Knobloch

Date:

15.11.2010

Returns:

The destination width.

int CControl::GetMouseDownX

(

)

[virtual]

Gets the mouse down x coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The mouse down x coordinate coordinate.

int CControl::GetMouseDownY

(

)

[virtual]

Gets the mouse down y coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The mouse down y coordinate coordinate.

ControlRotation CControl::GetRotationX

(

)

[virtual]

Gets the rotation x coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The rotation x coordinate coordinate.

ControlRotation CControl::GetRotationY

(

)

[virtual]

Gets the rotation y coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The rotation y coordinate coordinate.

ControlRotation CControl::GetRotationZ

(

)

[virtual]

Gets the rotation z coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The rotation z coordinate coordinate.

RECT CControl::GetTextRect	(	int	leftImage,
		int	rightImage,
		int	borderLeft,
		int	borderRight,
		int	topImage,
		int	bottomImage,
		int	borderTop,
		int	borderBottom
	)		[protected, virtual]

Gets a text rectangle.

Author:

Christian Knobloch

Date:

21.09.2010

Parameters:

leftImage	The left image.
rightImage	The right image.
borderLeft	The border left.
borderRight	The border right.
topImage	The top image.
bottomImage	The bottom image.
borderTop	The border top.
borderBottom	The border bottom.

Returns:

The text rectangle.

void CControl::InvalidateControl

(

)

[virtual]

bool CControl::IsAnimationActiveHeight

(

)

Query if this object is animation active height.

Author:

Christian Knobloch

Date:

15.11.2010

Returns:

true if animation active height, false if not.

bool CControl::IsAnimationActivePositionX

(

)

Query if this object is animation active position x coordinate.

Author:

Christian Knobloch

Date:

15.11.2010

Returns:

true if animation active position x coordinate coordinate, false if not.

bool CControl::IsAnimationActivePositionY

(

)

Query if this object is animation active position y coordinate.

Author:

Christian Knobloch

Date:

15.11.2010

Returns:

true if animation active position y coordinate coordinate, false if not.

bool CControl::IsAnimationActiveWidth

(

)

Query if this object is animation active width.

Author:

Christian Knobloch

Date:

15.11.2010

Returns:

true if animation active width, false if not.

bool CControl::IsControlHit	(	int	x,
		int	y
	)

Query if at that coordinats the control would be hit.

Author:

Christian Knobloch

Date:

07.06.2011

Parameters:

x	The x coordinate.
y	The y coordinate.

Returns:

true if control hit, false if not.

bool CControl::IsEnabled

(

)

[virtual]

Query if this object is enabled.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

true if enabled, false if not.

bool CControl::IsLocalised

(

)

[virtual]

Query if this object is localised.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

true if localised, false if not.

Reimplemented in SallyAPI::GUI::CDropDown.

bool CControl::IsMouseDown

(

)

[virtual]

Query if this object is mouse down.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

true if mouse down, false if not.

bool CControl::IsPressed

(

)

[virtual]

Query if this object is pressed.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

true if pressed, false if not.

bool CControl::IsVisible

(

)

[virtual]

Query if this object is visible.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

true if visible, false if not.

void CControl::Move	(	int	x,
		int	y
	)		[virtual]

Moves.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

x	The x coordinate.
y	The y coordinate.

void CControl::MoveAnimated	(	int	x,
		int	y,
		int	speed,
		bool	moveToEnd = true
	)		[virtual]

Move animated.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

x	The x coordinate.
y	The y coordinate.
speed	The speed.
moveToEnd	true to move to end.

void CControl::MoveAnimated	(	int	x,
		int	y,
		int	speedX,
		int	speedY,
		bool	moveToEnd = true
	)		[virtual]

Move animated.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

x	The x coordinate.
y	The y coordinate.
speedX	The speed x coordinate.
speedY	The speed y coordinate.
moveToEnd	true to move to end.

void CControl::MoveInternal	(	int	x,
		int	y
	)		[protected, virtual]

Move internal.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

x	The x coordinate.
y	The y coordinate.

void CControl::ProcessKeyboard	(	char	KeyboardState[256],
		char	KeyboardStatePressed[256]
	)		[virtual]

Process a keyboard.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

KeyboardState	State of the keyboard.
KeyboardStatePressed	The keyboard state pressed.

bool CControl::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 in SallyAPI::GUI::CForm, SallyAPI::GUI::CImageBox, and SallyAPI::GUI::CScreensaverControlButton.

bool CControl::ProcessMouseDown	(	int	x,
		int	y
	)		[protected, virtual]

Process a mouse down.

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 in SallyAPI::GUI::CForm, and SallyAPI::GUI::CPopUpWindow.

bool CControl::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 in SallyAPI::GUI::CButton, SallyAPI::GUI::CForm, SallyAPI::GUI::CImageBox, SallyAPI::GUI::CSlider, and SallyAPI::GUI::CProcessbar.

bool CControl::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 in SallyAPI::GUI::CButton, SallyAPI::GUI::CForm, SallyAPI::GUI::CEdit, SallyAPI::GUI::CImageBox, SallyAPI::GUI::CLabel, SallyAPI::GUI::CSlider, SallyAPI::GUI::CProcessbar, SallyAPI::GUI::CScreensaverControlButton, SallyAPI::GUI::CCheckbox, and SallyAPI::GUI::CRadioButton.

void CControl::Render

(

)

[virtual]

Renders this object.

Author:

Christian Knobloch

Date:

19.04.2010

Reimplemented from SallyAPI::GUI::CGUIBaseObject.

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

void CControl::ResetMouse

(

)

[protected, virtual]

Resets the mouse down variables.

Author:

Christian Knobloch

Date:

26.05.2011

void CControl::Resize	(	int	width,
		int	height
	)		[virtual]

Resizes.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

width	The width.
height	The height.

Reimplemented in SallyAPI::GUI::CListViewExt, SallyAPI::GUI::CLabelBox, SallyAPI::GUI::CEditBox, and SallyAPI::GUI::CScrollForm.

void CControl::ResizeAnimated	(	int	width,
		int	height,
		int	speed,
		bool	moveToEnd = true
	)		[virtual]

Resize animated.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

width	The width.
height	The height.
speed	The speed.
moveToEnd	true to move to end.

void CControl::ResizeAnimated	(	int	width,
		int	height,
		int	speedWidth,
		int	speedHeight,
		bool	moveToEnd = true
	)		[virtual]

Resize animated.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

width	The width.
height	The height.
speedWidth	Width of the speed.
speedHeight	Height of the speed.
moveToEnd	true to move to end.

void CControl::ResizeInternal	(	int	width,
		int	height
	)		[protected, virtual]

Resize internal.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

width	The width.
height	The height.

void CControl::RotateAnimatedX	(	float	speed,
		bool	bRun
	)		[virtual]

Rotate animated x coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

speed	The speed.
bRun	true to run.

void CControl::RotateAnimatedY	(	float	speed,
		bool	bRun
	)		[virtual]

Rotate animated y coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

speed	The speed.
bRun	true to run.

void CControl::RotateAnimatedZ	(	float	speed,
		bool	bRun
	)		[virtual]

Rotate animated z coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

speed	The speed.
bRun	true to run.

void CControl::SendMessageToChilds	(	SallyAPI::GUI::CGUIBaseObject *	reporter,
		int	reporterId,
		int	messageId,
		SallyAPI::GUI::SendMessage::CParameterBase *	messageParameter = NULL
	)		[virtual]

This method implements the message bus to the child controls. Messages send to all child controls will go through this method. You can hook in here, if you want to intercept a message.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

[in,out]	reporter	If non-null, the reporter.
	reporterId	Identifier for the reporter.
	messageId	Identifier for the message.
[in,out]	messageParameter	If non-null, the message parameter.

Implements SallyAPI::GUI::CGUIBaseObject.

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

void CControl::SendMessageToParent	(	SallyAPI::GUI::CGUIBaseObject *	reporter,
		int	reporterId,
		int	messageId,
		SallyAPI::GUI::SendMessage::CParameterBase *	messageParameter = NULL
	)		[virtual]

This method implements the message bus to the parent control. Messages send to the parent control will go through this method. You can hook in here, if you want to intercept a message.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

[in,out]	reporter	If non-null, the reporter.
	reporterId	Identifier for the reporter.
	messageId	Identifier for the message.
[in,out]	messageParameter	If non-null, the message parameter.

Implements SallyAPI::GUI::CGUIBaseObject.

Reimplemented in 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::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 CControl::SetAlign

(

int

align

)

[virtual]

Sets an align.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

align

The align.

void CControl::SetColor

(

D3DCOLOR

rgbFontColour

)

[virtual]

Sets the font color.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

rgbFontColour

The rgb font colour.

void CControl::SetLocalised

(

bool

localised

)

[virtual]

Sets a localised.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

localised

true to localised.

Reimplemented in SallyAPI::GUI::CDropDown.

void CControl::SetRotationX

(

ControlRotation

value

)

[virtual]

Sets a rotation x coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

value

The value.

void CControl::SetRotationY

(

ControlRotation

value

)

[virtual]

Sets a rotation y coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

value

The value.

void CControl::SetRotationZ

(

ControlRotation

value

)

[virtual]

Sets a rotation z coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

value

The value.

void CControl::SetStopAngelX

(

float

angel

)

[virtual]

Sets a stop angel x coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

angel

The angel.

void CControl::SetStopAngelY

(

float

angel

)

[virtual]

Sets a stop angel y coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

angel

The angel.

void CControl::SetStopAngelZ

(

float

angel

)

[virtual]

Sets a stop angel z coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

angel

The angel.

void CControl::SetText

(

const std::string &

text

)

[virtual]

Sets a text.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

text

The text.

Reimplemented from SallyAPI::GUI::CGUIBaseObject.

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

void CControl::Timer

(

float

timeDelta

)

[virtual]

Timers.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

timeDelta

The time delta.

Reimplemented from SallyAPI::GUI::CGUIBaseObject.

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

void CControl::Update

(

)

[virtual]

Updates this object.

Author:

Christian Knobloch

Date:

30.04.2010

Reimplemented from SallyAPI::GUI::CGUIBaseObject.

Reimplemented in SallyAPI::GUI::CForm.

void CControl::UpdateControl

(

)

[protected, virtual]

Updates a control.

Author:

Christian Knobloch

Date:

30.04.2010

Implements SallyAPI::GUI::CGUIBaseObject.

Reimplemented in SallyAPI::GUI::CForm.

void CControl::Visible

(

bool

visible

)

[virtual]

Visibles.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

visible

true to show, false to hide.

---

Member Data Documentation

bool SallyAPI::GUI::CControl::m_bAnimationBlend [protected]

bool SallyAPI::GUI::CControl::m_bAnimationMoveX [protected]

bool SallyAPI::GUI::CControl::m_bAnimationMoveY [protected]

bool SallyAPI::GUI::CControl::m_bAnimationResizeHeight [protected]

bool SallyAPI::GUI::CControl::m_bAnimationResizeWidth [protected]

bool SallyAPI::GUI::CControl::m_bAnimationRotateX [protected]

bool SallyAPI::GUI::CControl::m_bAnimationRotateXRun [protected]

bool SallyAPI::GUI::CControl::m_bAnimationRotateY [protected]

bool SallyAPI::GUI::CControl::m_bAnimationRotateYRun [protected]

bool SallyAPI::GUI::CControl::m_bAnimationRotateZ [protected]

bool SallyAPI::GUI::CControl::m_bAnimationRotateZRun [protected]

bool SallyAPI::GUI::CControl::m_bEnabled [protected]

bool SallyAPI::GUI::CControl::m_bLocalised [protected]

bool SallyAPI::GUI::CControl::m_bMouseDown [protected]

bool SallyAPI::GUI::CControl::m_bPressed [protected]

bool SallyAPI::GUI::CControl::m_bVisible [protected]

ControlRotation SallyAPI::GUI::CControl::m_eRotationX [protected]

ControlRotation SallyAPI::GUI::CControl::m_eRotationY [protected]

ControlRotation SallyAPI::GUI::CControl::m_eRotationZ [protected]

float SallyAPI::GUI::CControl::m_fDeltaBlend [protected]

float SallyAPI::GUI::CControl::m_fDeltaMoveX [protected]

float SallyAPI::GUI::CControl::m_fDeltaMoveY [protected]

float SallyAPI::GUI::CControl::m_fDeltaResizeHeight [protected]

float SallyAPI::GUI::CControl::m_fDeltaResizeWidth [protected]

float SallyAPI::GUI::CControl::m_fDeltaRotateX [protected]

float SallyAPI::GUI::CControl::m_fDeltaRotateY [protected]

float SallyAPI::GUI::CControl::m_fDeltaRotateZ [protected]

float SallyAPI::GUI::CControl::m_fSpeedRotateX [protected]

float SallyAPI::GUI::CControl::m_fSpeedRotateY [protected]

float SallyAPI::GUI::CControl::m_fSpeedRotateZ [protected]

float SallyAPI::GUI::CControl::m_fStartRotateX [protected]

float SallyAPI::GUI::CControl::m_fStartRotateY [protected]

float SallyAPI::GUI::CControl::m_fStartRotateZ [protected]

float SallyAPI::GUI::CControl::m_fStopAtAngelX [protected]

float SallyAPI::GUI::CControl::m_fStopAtAngelY [protected]

float SallyAPI::GUI::CControl::m_fStopAtAngelZ [protected]

float SallyAPI::GUI::CControl::m_fTimeMouseDown [protected]

float SallyAPI::GUI::CControl::m_fTimeMouseUp [protected]

int SallyAPI::GUI::CControl::m_iAlign [protected]

int SallyAPI::GUI::CControl::m_iAnimationSpeedBlend [protected]

int SallyAPI::GUI::CControl::m_iAnimationSpeedMoveX [protected]

int SallyAPI::GUI::CControl::m_iAnimationSpeedMoveY [protected]

int SallyAPI::GUI::CControl::m_iAnimationSpeedResizeHeight [protected]

int SallyAPI::GUI::CControl::m_iAnimationSpeedResizeWidth [protected]

int SallyAPI::GUI::CControl::m_iControlId [protected]

int SallyAPI::GUI::CControl::m_iDestinationBlend [protected]

int SallyAPI::GUI::CControl::m_iDestinationHeight [protected]

int SallyAPI::GUI::CControl::m_iDestinationWidth [protected]

int SallyAPI::GUI::CControl::m_iDestinationX [protected]

int SallyAPI::GUI::CControl::m_iDestinationY [protected]

int SallyAPI::GUI::CControl::m_iMouseDownX [protected]

int SallyAPI::GUI::CControl::m_iMouseDownY [protected]

int SallyAPI::GUI::CControl::m_iStartBlend [protected]

int SallyAPI::GUI::CControl::m_iStartHeight [protected]

int SallyAPI::GUI::CControl::m_iStartWidth [protected]

int SallyAPI::GUI::CControl::m_iStartX [protected]

int SallyAPI::GUI::CControl::m_iStartY [protected]

D3DCOLOR SallyAPI::GUI::CControl::m_rgbFontColour [protected]

---

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

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