SallyAPI::GUI::CLabel Class Reference

Label. More...

#include <Label.h>

Inheritance diagram for SallyAPI::GUI::CLabel:

List of all members.

Public Member Functions
	CLabel (SallyAPI::GUI::CGUIBaseObject *parent, int x, int y, int width, int controlId=0)
	Constructor.
virtual	~CLabel ()
	Destructor.
virtual void	Timer (float timeDelta)
	Timers.
void	SetBold (bool bold)
	Sets a bold.
void	SetFont (const std::string &fontName)
	Sets a font.
void	SetDrawBackground (bool drawBackground)
	Sets a draw background.
void	SetBig (bool big)
	Sets a big.
void	SetFitBackgroundToText (bool value)
	If true, the background is resized to be only visible behind the text. Default is false.
Protected Member Functions
virtual void	RenderControl ()
	Renders a control.
virtual bool	ProcessMouseUp (int x, int y)
	Process a mouse up.
Protected Attributes
bool	m_bDrawBackground
bool	m_bBold
bool	m_bBig
bool	m_bFitBackgroundToText
std::string	m_strFontName

---

Detailed Description

Label.

Author:

Christian Knobloch

Date:

19.04.2010

---

Constructor & Destructor Documentation

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

Constructor.

m_bBold(false), m_bDrawBackground(false), m_bBig(false)

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.
	controlId	Identifier for the control.

CLabel::~CLabel

(

)

[virtual]

Destructor.

Author:

Christian Knobloch

Date:

19.04.2010

---

Member Function Documentation

bool CLabel::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 CLabel::RenderControl

(

)

[protected, virtual]

Renders a control.

Author:

Christian Knobloch

Date:

19.04.2010

Implements SallyAPI::GUI::CGUIBaseObject.

void CLabel::SetBig

(

bool

big

)

Sets a big.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

big	true to big.

void CLabel::SetBold

(

bool

bold

)

Sets a bold.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

bold	true to bold.

void CLabel::SetDrawBackground

(

bool

drawBackground

)

Sets a draw background.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

drawBackground

true to draw background.

void CLabel::SetFitBackgroundToText

(

bool

value

)

If true, the background is resized to be only visible behind the text. Default is false.

Author:

Christian Knobloch

Date:

19.12.2011

Parameters:

value

true to value.

void CLabel::SetFont

(

const std::string &

fontName

)

Sets a font.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

fontName

Name of the font.

void CLabel::Timer

(

float

timeDelta

)

[virtual]

Timers.

Author:

Christian Knobloch

Date:

26.05.2011

Parameters:

timeDelta

The time delta.

Reimplemented from SallyAPI::GUI::CControl.

---

Member Data Documentation

bool SallyAPI::GUI::CLabel::m_bBig [protected]

bool SallyAPI::GUI::CLabel::m_bBold [protected]

bool SallyAPI::GUI::CLabel::m_bDrawBackground [protected]

bool SallyAPI::GUI::CLabel::m_bFitBackgroundToText [protected]

std::string SallyAPI::GUI::CLabel::m_strFontName [protected]

---

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

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