CtrlText Class Reference

Class for control text. More...

Inheritance diagram for CtrlText:

[legend]

Collaboration diagram for CtrlText:

[legend]

Public Types
enum	Align_t { kLeft, kCenter, kRight }
enum	Scrolling_t { kAutomatic, kManual, kNone }
Public Member Functions
	CtrlText (intf_thread_t *pIntf, VarText &rVariable, const GenericFont &rFont, const UString &rHelp, uint32_t color, VarBool *pVisible, Scrolling_t scrollMode, Align_t alignment)
	Create a text control with the optional given color.
virtual	~CtrlText ()
virtual void	handleEvent (EvtGeneric &rEvent)
	Handle an event.
virtual bool	mouseOver (int x, int y) const
	Check whether coordinates are inside the control.
virtual void	draw (OSGraphics &rImage, int xDest, int yDest)
	Draw the control on the given graphics.
void	setText (const UString &rText, uint32_t color=0xFFFFFFFF)
	Set the text of the control, with an optional color This takes effect immediatly.
virtual string	getType () const
	Get the type of control (custom RTTI).
Friends
class	CmdToManual
class	CmdManualMoving
class	CmdManualStill
class	CmdMove
class	CmdUpdateText
Data Structures
class	CmdManualMoving
class	CmdManualStill
class	CmdMove
class	CmdToManual
	Callback objects.
class	CmdUpdateText
	Callback for the timer.

---

Detailed Description

Class for control text.

---

Member Enumeration Documentation

enum CtrlText::Align_t

Enumerator:

kLeft
kCenter
kRight

enum CtrlText::Scrolling_t

Enumerator:

kAutomatic
kManual
kNone

---

Constructor & Destructor Documentation

CtrlText::CtrlText	(	intf_thread_t *	pIntf,
		VarText &	rVariable,
		const GenericFont &	rFont,
		const UString &	rHelp,
		uint32_t	color,
		VarBool *	pVisible,
		Scrolling_t	scrollMode,
		Align_t	alignment
	)

Create a text control with the optional given color.

References Subject< S, ARG >::addObserver(), FSM::addState(), FSM::addTransition(), OSFactory::createOSTimer(), VarText::get(), OSFactory::instance(), kAutomatic, kManual, and FSM::setState().

CtrlText::~CtrlText

(

)

[virtual]

References Subject< S, ARG >::delObserver().

---

Member Function Documentation

void CtrlText::handleEvent

(

EvtGeneric &

rEvent

)

[virtual]

Handle an event.

Reimplemented from CtrlGeneric.

References EvtGeneric::getAsString(), and FSM::handleTransition().

bool CtrlText::mouseOver	(	int	x,
		int	y
	)			const [virtual]

Check whether coordinates are inside the control.

Reimplemented from CtrlGeneric.

References Box::getHeight(), Position::getHeight(), CtrlGeneric::getPosition(), Box::getWidth(), and Position::getWidth().

void CtrlText::draw	(	OSGraphics &	rImage,
		int	xDest,
		int	yDest
	)			[virtual]

Draw the control on the given graphics.

Reimplemented from CtrlGeneric.

References OSGraphics::drawBitmap(), Position::getHeight(), Box::getHeight(), CtrlGeneric::getPosition(), Position::getWidth(), Box::getWidth(), kCenter, kLeft, and kRight.

void CtrlText::setText	(	const UString &	rText,
		uint32_t	color = 0xFFFFFFFF
	)

Set the text of the control, with an optional color This takes effect immediatly.

References VarText::set().

virtual string CtrlText::getType

(

)

const [inline, virtual]

Get the type of control (custom RTTI).

Reimplemented from CtrlGeneric.

---

Friends And Related Function Documentation

friend class CmdToManual [friend]

friend class CmdManualMoving [friend]

friend class CmdManualStill [friend]

friend class CmdMove [friend]

friend class CmdUpdateText [friend]

---

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

• modules/gui/skins2/controls/ctrl_text.hpp
• modules/gui/skins2/controls/ctrl_text.cpp