button which constructs from other objects (ALPHA) More...

#include <GUIPrimitiveButton.h>

Inheritance diagram for CGUIPrimitiveButton:

[legend]

Public Member Functions
	CGUIPrimitiveButton ()

	CGUIPrimitiveButton (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const eC_String &rkText, CGUICommandPtr pCommandObject, const ObjectHandle_t &eID=NO_HANDLE)

	CGUIPrimitiveButton (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const TextResource_t &eTextID, CGUICommandPtr pCommandObject, const ObjectHandle_t &eID=NO_HANDLE)

	CGUIPrimitiveButton (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_String &rkText, CGUICommandPtr pCommandObject, const ObjectHandle_t &eID=NO_HANDLE)

	CGUIPrimitiveButton (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const TextResource_t &eTextID, CGUICommandPtr pCommandObject, const ObjectHandle_t &eID=NO_HANDLE)

	CGUIPrimitiveButton (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const TextResource_t &eTextID, CGUICommandPtr pCommandObject, const ObjectHandle_t &eBtnStandard, const ObjectHandle_t &eBtnPressed=NO_HANDLE, const ObjectHandle_t &eBtnHighlighted=NO_HANDLE, const ObjectHandle_t &eBtnGrayedOut=NO_HANDLE, const ObjectHandle_t &eBtnFocused=NO_HANDLE, const ObjectHandle_t &eID=NO_HANDLE)

	CGUIPrimitiveButton (const CGUIPrimitiveButton &kSource)

virtual	~CGUIPrimitiveButton ()

virtual eC_Bool	DoButtonDown (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoButtonUp (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoDrag (const eC_Value &vDeltaX, const eC_Value &vDeltaY, const eC_Value &vAbsX, const eC_Value &vAbsY)

virtual eC_Bool	DoDragEnd (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoDraw ()

virtual eC_Bool	DoMouseEnter (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoMouseLeave (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoMouseMove (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbs=eC_FromInt(-1))

CGUICommandPtr	GetCommand () const

virtual void	GetFocus ()

void	GetHandles (ObjectHandle_t &eBtnStandard, ObjectHandle_t &eBtnPressed, ObjectHandle_t &eBtnHighlighted, ObjectHandle_t &eBtnGrayedOut, ObjectHandle_t &eBtnFocused)

CGUIText *	GetLabel () const

virtual void	LoseFocus ()

CGUIPrimitiveButton &	operator= (const CGUIPrimitiveButton &kSource)

virtual void	ReadFromStream ()

void	SetCommand (CGUICommandPtr pCommand)

virtual void	SetGrayedOut (const eC_Bool &bGrayOut)

void	SetHandles (ObjectHandle_t eBtnStandard, ObjectHandle_t eBtnPressed, ObjectHandle_t eBtnHighlighted, ObjectHandle_t eBtnGrayedOut, ObjectHandle_t eBtnFocused)

virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

Public Member Functions inherited from CGUICompositeObject
	CGUICompositeObject ()

	CGUICompositeObject (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)

	CGUICompositeObject (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ObjectHandle_t &eID=NO_HANDLE)

	CGUICompositeObject (const CGUICompositeObject &kSource)

virtual	~CGUICompositeObject ()
	This destructor is automatically virtual, as the base class destructor is virtual.

virtual eC_Bool	AddObject (CGUIObject *pkObject)

eC_Bool	BringToFront (const CGUIObject *pkObject)

eC_Bool	CanBeCyclicFocussed () const

virtual eC_Bool	DoPostDraw ()

void	DrawOnTop (CGUIObject *pkObject)

void	DrawOnTopOf (CGUIObject const pkObject, CGUIObject const pDrawOnTopOf)

virtual CGUIObject *	FindObject (const eC_Value &vAbsX, const eC_Value &vAbsY)

void	Flip (const eC_Bool &rbVertical)

eC_Bool	FocusAny ()

virtual eC_Bool	FocusNext (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false)

virtual eC_Bool	FocusPrevious (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false)

CGUIObject *	GetAndCheckObjectByID (ObjectHandle_t eObjID, const eC_String &kObjectName)

const CGUIObject *	GetAndCheckObjectByID (ObjectHandle_t eObjID, const eC_String &kObjectName) const

CGUIObject *	GetChild (const eC_UInt uIndex)

CGUIObject *	GetChild (const eC_UInt uIndex) const

const ObjectPtrList &	GetChildObjectsList () const

const ObjectPtrList &	GetDrawOrderList () const

eC_Int	GetIndexOfChild (const CGUIObject *pkObject) const

eC_UInt	GetNumberOfChildren () const

CGUIObject *	GetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false)

const CGUIObject *	GetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false) const

eC_Bool	InsertChildAt (const eC_UInt cuiIndex, CGUIObject *pkChild)

void	InvalidateChildren ()
	Invalidates all chidren, but not this parent.

eC_Bool	IsAncestorOf (const CGUIObject *pkObject) const

virtual eC_Bool	IsCompositeObject () const

eC_Bool	LowerOneLevel (const CGUIObject *pkObject)

CGUICompositeObject &	operator= (const CGUICompositeObject &kSource)

eC_Bool	RaiseOneLevel (const CGUIObject *pkObject)

virtual void	ReadFromStream ()

virtual void	RefreshLayout (CGUILayouter::eMovedEdges_t eMovedEdges) const

void	RemoveAllChildren ()

virtual void	RemoveObject (CGUIObject *pkObject)

void	Rotate (const eC_UInt &ruiDegrees, const eC_Bool &rbFirst=false)

eC_Bool	SendToBack (const CGUIObject *pkObject)

virtual void	SetClickThrough (const eC_Bool &bClickThrough)

virtual void	SetClickThrough (const eC_Bool &bClickThrough, const eC_Bool &bChildrenClickThrough)

void	SetCyclicFocus (const eC_Bool &bCyclicFocus)

virtual void	SetDisabled (const eC_Bool &bDisabled)

virtual void	SetDisabled (const eC_Bool &bDisabled, const eC_Bool &bChildrenDisabled)

virtual void	SetFocussable (const eC_Bool &bFocussable)

virtual void	SetFocussable (const eC_Bool &bFocussable, const eC_Bool &bChildrenFocussable)

virtual void	SetGrayedOut (const eC_Bool &bGrayedOut)

virtual void	SetGrayedOut (const eC_Bool &bGrayedOut, const eC_Bool &bChildrenGrayedOut)

virtual void	SetHeight (const eC_Value &vY)

virtual void	SetInvisible (const eC_Bool &bInvisible)

virtual void	SetInvisible (const eC_Bool &bInvisible, const eC_Bool &bChildrenInvisible)

virtual void	SetWidth (const eC_Value &vX)

virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

Public Member Functions inherited from CGUIObject
	CGUIObject ()

	CGUIObject (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)

	CGUIObject (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ObjectHandle_t &eID=NO_HANDLE)

	CGUIObject (const CGUIObject &kSource)

virtual	~CGUIObject ()

void	AddValueObserver (CGUIObserver *pkObserver)

eC_Bool	CalculateInvalidatedRect (CGUIRect &rRect) const

virtual eC_Bool	ClaimFocus ()

virtual void	CreateSnapshot (eC_UInt uiBackColor=0x00)

eC_Bool	DataPoolConnectorExists () const

void	DeleteSnapshot ()

virtual void	DisableSnapshotDrawing (eC_Bool bDeleteSnapshot=true)

virtual eC_Bool	DoDraw ()

virtual eC_Bool	DoDrawSnapshot ()

virtual void	EnableSnapshotDrawing ()

virtual CGUIObject *	FindObject (const eC_Value &vAbsX, const eC_Value &vAbsY)

virtual eC_Bool	FocusAny ()

virtual eC_Bool	FocusNext (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false)

virtual eC_Bool	FocusPrevious (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false)

CGUIRect	GetAbsRect () const

eC_Value	GetAbsXPos () const

eC_Value	GetAbsXPosCenter () const

eC_Value	GetAbsXPosREdge () const

eC_Value	GetAbsYPos () const

eC_Value	GetAbsYPosBEdge () const

eC_Value	GetAbsYPosCenter () const

eC_UByte	GetAlpha () const

CGUIBehaviourDecorator *	GetBehaviour ()

const CGUIBehaviourDecorator *	GetBehaviour () const

GUIBitmapPlaneID_t	GetBitmapID () const

CGUIBitmapPlane &	GetBitmapPlane () const

CGUIRect	GetCurrentAbsRect () const

eC_Value	GetCurrentAbsXPos () const

eC_Value	GetCurrentAbsXPosCenter () const

eC_Value	GetCurrentAbsXPosREdge () const

eC_Value	GetCurrentAbsYPos () const

eC_Value	GetCurrentAbsYPosBEdge () const

eC_Value	GetCurrentAbsYPosCenter () const

CDataPoolConnector &	GetDataPoolConnector ()

eC_Value	GetDistanceBottom () const

eC_Value	GetDistanceRight () const

eC_Value	GetHalfHeight () const

eC_Value	GetHalfWidth () const

eC_Value	GetHeight () const

ObjectHandle_t	GetID () const

CGUILayouter *	GetLayouter ()

const CGUILayouter *	GetLayouter () const

ObjectHandle_t	GetNeighborBottomID () const

ObjectHandle_t	GetNeighborLeftID () const

ObjectHandle_t	GetNeighborRightID () const

ObjectHandle_t	GetNeighborTopID () const

CGUIObject *	GetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false)

const CGUIObject *	GetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false) const

CGUIRect	GetOriginRect () const

CGUICompositeObject *	GetParent ()

const CGUICompositeObject *	GetParent () const

CGUIRect	GetRelRect () const

eC_Value	GetRelXPos () const

eC_Value	GetRelXPosCenter () const

eC_Value	GetRelXPosREdge () const

eC_Value	GetRelYPos () const

eC_Value	GetRelYPosBEdge () const

eC_Value	GetRelYPosCenter () const

eC_Value	GetWidth () const

void	InvalidateArea ()

eC_Bool	IsClickable () const

eC_Bool	IsClickThrough () const

virtual eC_Bool	IsCompositeObject () const

eC_Bool	IsDescendantOf (const CGUIObject *const pAncestor) const

eC_Bool	IsDisabled () const

eC_Bool	IsDragable () const

eC_Bool	IsDragged () const

eC_Bool	IsDrawingSnapshot () const

eC_Bool	IsFocussable () const

eC_Bool	IsFocussed () const

eC_Bool	IsGrayedOut () const

virtual eC_Bool	IsHighlightable () const

eC_Bool	IsHighlighted () const

eC_Bool	IsInvisible () const

eC_Bool	IsPressed () const

eC_Bool	IsStopFocus () const

void	NotifyValueObservers (const CGUIValue &kValue, const eC_UInt uiX=0, const eC_UInt uiY=0)

CGUIObject &	operator= (const CGUIObject &kSource)

virtual void	ReadFromStream ()

virtual void	RefreshLayout (CGUILayouter::eMovedEdges_t eMovedEdges) const

void	RemoveValueObserver (CGUIObserver *pkObserver)

void	RenderToBitmap (eC_UInt uiBitmapID, eC_Value vXOffset=eC_FromInt(0), eC_Value vYOffset=eC_FromInt(0))

eC_Bool	RequestFocus ()

void	SetAlpha (eC_UByte ubAlpha)

void	SetBehaviour (CGUIBehaviourDecorator *pkBehaviour)

void	SetClickThrough (const eC_Bool &bClickThrough)

virtual void	SetDisabled (const eC_Bool &bDisabled)

virtual void	SetFocussable (const eC_Bool &bFocussable)

virtual void	SetGrayedOut (const eC_Bool &bGrayOut)

virtual void	SetHeight (const eC_Value &vY)

void	SetID (const ObjectHandle_t &eID)

virtual void	SetInvisible (const eC_Bool &bInvisible)

void	SetLayouter (CGUILayouter *pLayouter)

void	SetNeighborBottomID (const ObjectHandle_t eNewNeighborBottomID)

void	SetNeighborIDs (const ObjectHandle_t eNewNeighborLeftID, const ObjectHandle_t eNewNeighborRightID, const ObjectHandle_t eNewNeighborTopID, const ObjectHandle_t eNewNeighborBottomID)

void	SetNeighborLeftID (const ObjectHandle_t eNewNeighborLeftID)

void	SetNeighborRightID (const ObjectHandle_t eNewNeighborRightID)

void	SetNeighborTopID (const ObjectHandle_t eNewNeighborTopID)

virtual void	SetParent (CGUICompositeObject *const pkParent)

void	SetRelRect (const CGUIRect &kNewRect)

virtual void	SetRelXPos (const eC_Value &vX)

void	SetRelXPosCenter (const eC_Value &vXCenter)

void	SetRelXPosREdge (const eC_Value &vX)

virtual void	SetRelYPos (const eC_Value &vY)

void	SetRelYPosBEdge (const eC_Value &vY)

void	SetRelYPosCenter (const eC_Value &vYCenter)

void	SetStopFocus (const eC_Bool &bDontFocusToParent)

virtual eC_Bool	SetValue (CDataPoolEntry &rkValue)

virtual eC_Bool	SetValue (const CGUIValue &rkValue)

virtual void	SetWidth (const eC_Value &vX)

virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

Public Member Functions inherited from CGUIBehaviour
virtual eC_Bool	DoUserEvent (CGUIEvent *const pEvent)

virtual void	OnCreate ()

virtual void	OnDelete ()

virtual void	OnHide ()

virtual void	OnShow ()

virtual eC_Bool	DoLongClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoDoubleClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	Decrease ()

virtual eC_Bool	Increase ()

virtual eC_Bool	DoKeyDown (const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)

virtual eC_Bool	DoKeyUp (const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)

virtual eC_Bool	DoChar (const eC_UInt &uiKey, const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)

virtual eC_Bool	DoScrollUp (const eC_Value &vAbsX, const eC_Value &vAbsY)

virtual eC_Bool	DoScrollDown (const eC_Value &vAbsX, const eC_Value &vAbsY)

virtual eC_Bool	DoScrollLeft (const eC_Value &vAbsX, const eC_Value &vAbsY)

virtual eC_Bool	DoScrollRight (const eC_Value &vAbsX, const eC_Value &vAbsY)

Public Member Functions inherited from CGUIStreamableObject
const eC_String &	GetXMLTag () const

virtual void	ReadFromStream ()

void	SetXMLTag (const eC_String &kXMLTag)

virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

Public Member Functions inherited from CGUIAnimatable
virtual	~CGUIAnimatable ()
	Destructor. Removes all existing animation callbacks.

virtual void	DoAnimate (const eC_Value &vTimes=eC_FromInt(1))

virtual eC_Bool	IsAnimating () const

virtual void	StartAnimation ()

virtual void	StopAnimation ()

Protected Types
enum	ButtonState_t { BUTTON_STATE_PRESSED , BUTTON_STATE_HIGHLIGHTED , BUTTON_STATE_STANDARD , BUTTON_STATE_GRAYEDOUT , BUTTON_STATE_FOCUSED }
	Button States. More...

Protected Member Functions
virtual void	SetButtonState ()

Protected Member Functions inherited from CGUICompositeObject
virtual eC_Bool	FourWayNext (FourWayFocus_t eFocusDirection)

ObjectPtrList &	GetChildObjectsList ()

virtual void	HandleDraw (const CGUIRect &ClipRect)

Protected Member Functions inherited from CGUIObject
virtual eC_Bool	CreateBitmapPlane ()

virtual eC_Bool	FourWayNext (FourWayFocus_t eFocusDirection)

Protected Member Functions inherited from CGUIStreamableObject
eC_UInt	ReadStreamingHeader (const eC_UInt &uiClassVersion, const eC_UInt &uiClassMinVersion=0) const

void	WriteStreamingFooter (const eC_Bool &bWriteClassID) const

void	WriteStreamingHeader (const eC_Bool &bWriteClassID, const eC_Char *const pkClassIDTag, const eC_Int &iClassID, const eC_UInt &uiClassVersion) const

Protected Attributes
ObjectHandle_t	m_eBtnFocused
	the focused Object ID

ObjectHandle_t	m_eBtnGrayedOut
	the grayed out Object ID

ObjectHandle_t	m_eBtnHighlighted
	the highlighted Object ID

ObjectHandle_t	m_eBtnPressed
	the pressed Object ID

ObjectHandle_t	m_eBtnStandard
	the standard Object ID

ButtonState_t	m_eButtonState
	Current button state.

CGUICommandPtr	m_pkCommandObject
	Holds the attached command.

CGUIText *	m_pkLabel
	Label of button.

Additional Inherited Members
Public Types inherited from CGUIObject
enum	FourWayFocus_t { FOCUS_LEFT , FOCUS_RIGHT , FOCUS_UP , FOCUS_DOWN }

Static Public Attributes inherited from CGUICompositeObject
static const eC_Char	XMLTAG_CHILDREN []
	XML comment tag to be used before writing children to a stream.

static const eC_Char	XMLTAG_ENDCHILDREN []
	XML comment tag to be used after writing children to a stream.

Static Public Attributes inherited from CGUIObject
static const eC_Char	XMLTAG_ALPHA []
	XML tag to be used writing alpha-value into a stream.

static const eC_Char	XMLTAG_CLICKTHROUGH []
	XML tag to be used writing clickthrough-state into a stream.

static const eC_Char	XMLTAG_CONTROLCLASSID []
	XML tag to be used when writing a control class ID into a stream.

static const eC_Char	XMLTAG_DISABLED []
	XML tag to be used writing disabled-state into a stream.

static const eC_Char	XMLTAG_FOCUSSABLE []
	XML tag to be used writing focussable-state into a stream.

static const eC_Char	XMLTAG_GRAYEDOUT []
	XML tag to be used writing grayedout-state into a stream.

static const eC_Char	XMLTAG_HEIGHT []
	XML tag to be used writing height into a stream.

static const eC_Char	XMLTAG_INVISIBLE []
	XML tag to be used writing invisible-state into a stream.

static const eC_Char	XMLTAG_OBJECTID []
	XML tag to be used writing object id into a stream.

static const eC_Char	XMLTAG_OVERRIDDENNEIGHBORS []
	XML tag to be used writing overridden neighbors into a stream.

static const eC_Char	XMLTAG_WIDTH []
	XML tag to be used writing width into a stream.

static const eC_Char	XMLTAG_XPOS []
	XML tag to be used writing x-position into a stream.

static const eC_Char	XMLTAG_YPOS []
	XML tag to be used writing y-position into a stream.

Static Public Attributes inherited from CGUIBehaviour
static const eC_Char	XMLTAG_BEHAVIOURCLASSID []
	XML tag to be used when writing a behaviour class ID into a stream.

Static Public Attributes inherited from CGUIStreamableObject
static const eC_Char	XMLTAG_CLASSVERSION []

Detailed Description

button which constructs from other objects (ALPHA)

Member Enumeration Documentation

◆ ButtonState_t

enum CGUIPrimitiveButton::ButtonState_t

protected

Button States.

Enumerator
BUTTON_STATE_PRESSED	Pressed state.
BUTTON_STATE_HIGHLIGHTED	Highlighted state.
BUTTON_STATE_STANDARD	Standard state.
BUTTON_STATE_GRAYEDOUT	Grayed out state.
BUTTON_STATE_FOCUSED	Focused state.

Constructor & Destructor Documentation

◆ CGUIPrimitiveButton() [1/7]

CGUIPrimitiveButton::CGUIPrimitiveButton	(	CGUICompositeObject *const	pkParent,
		const eC_Value &	vX,
		const eC_Value &	vY,
		const eC_Value &	vWidth,
		const eC_Value &	vHeight,
		const eC_String &	rkText,
		CGUICommandPtr	pCommandObject,
		const ObjectHandle_t &	eID = `NO_HANDLE`
	)

Constructor.

Parameters

pkParent	Pointer to the designated parent object
vX	X-position relative to its parent object
vY	Y-position relative to its parent object
vWidth	Width of the button
vHeight	Height of the button
rkText	Text string that will be displayed on the Button
pCommandObject	Pointer to command object which will be executed in reaction to a click
eID	Object Identifier of this button

◆ CGUIPrimitiveButton() [2/7]

CGUIPrimitiveButton::CGUIPrimitiveButton	(	CGUICompositeObject *const	pkParent,
		const CGUIRect &	kRect,
		const eC_String &	rkText,
		CGUICommandPtr	pCommandObject,
		const ObjectHandle_t &	eID = `NO_HANDLE`
	)

Constructor.

Parameters

pkParent	Pointer to the designated parent object
kRect	Boundary rectangle of the button relative to the parent.
rkText	Text string that will be displayed on the Button
pCommandObject	Pointer to command object which will be executed in reaction to a click
eID	Object Identifier of this button

◆ CGUIPrimitiveButton() [3/7]

CGUIPrimitiveButton::CGUIPrimitiveButton	(	CGUICompositeObject *const	pkParent,
		const eC_Value &	vX,
		const eC_Value &	vY,
		const eC_Value &	vWidth,
		const eC_Value &	vHeight,
		const TextResource_t &	eTextID,
		CGUICommandPtr	pCommandObject,
		const ObjectHandle_t &	eID = `NO_HANDLE`
	)

Constructor.

Parameters

pkParent	Pointer to the designated parent object
vX	X-position relative to its parent object
vY	Y-position relative to its parent object
vWidth	Width of the button
vHeight	Height of the button
eTextID	ID of text string to be displayed on the Button
pCommandObject	Pointer to command object which will be executed in reaction to a click
eID	Object Identifier of this button (choose NO_HANDLE if none is required)

◆ CGUIPrimitiveButton() [4/7]

CGUIPrimitiveButton::CGUIPrimitiveButton	(	CGUICompositeObject *const	pkParent,
		const CGUIRect &	kRect,
		const TextResource_t &	eTextID,
		CGUICommandPtr	pCommandObject,
		const ObjectHandle_t &	eID = `NO_HANDLE`
	)

Constructor.

Parameters

pkParent	Pointer to the designated parent object
kRect	Boundary rectangle of the button relative to the parent.
eTextID	ID of text string to be displayed on the Button
pCommandObject	Pointer to command object which will be executed in reaction to a click
eID	Object Identifier of this button (choose NO_HANDLE if none is required)

◆ CGUIPrimitiveButton() [5/7]

CGUIPrimitiveButton::CGUIPrimitiveButton	(	CGUICompositeObject *const	pkParent,
		const eC_Value &	vX,
		const eC_Value &	vY,
		const TextResource_t &	eTextID,
		CGUICommandPtr	pCommandObject,
		const ObjectHandle_t &	eBtnStandard,
		const ObjectHandle_t &	eBtnPressed = `NO_HANDLE`,
		const ObjectHandle_t &	eBtnHighlighted = `NO_HANDLE`,
		const ObjectHandle_t &	eBtnGrayedOut = `NO_HANDLE`,
		const ObjectHandle_t &	eBtnFocused = `NO_HANDLE`,
		const ObjectHandle_t &	eID = `NO_HANDLE`
	)

CGUIButton constructor which sets width and height depending on the size of the given standard image. The objects will be added to the CompositeObject.

Parameters

pkParent	Pointer to the designated parent object
vX	X-position relative to its parent object
vY	Y-position relative to its parent object
eTextID	ID of text string to be displayed on the Button
pCommandObject	Pointer to command object which will be executed in reaction to a click
eBtnStandard	ImageID for button in standard state
eBtnPressed	ImageID for button in pressed state
eBtnHighlighted	ImageID for button in highlight state
eBtnGrayedOut	ImageID for button in grayed out state
eBtnFocused	ImageID for button in focused state
eID	Object Identifier of this button.

◆ CGUIPrimitiveButton() [6/7]

CGUIPrimitiveButton::CGUIPrimitiveButton ( const CGUIPrimitiveButton & kSource )

Copy-constructor.

Parameters

kSource Source object to be copied

◆ CGUIPrimitiveButton() [7/7]

CGUIPrimitiveButton::CGUIPrimitiveButton ( )

Standard constructor

See also: CGUIObject().

◆ ~CGUIPrimitiveButton()

virtual CGUIPrimitiveButton::~CGUIPrimitiveButton ( )

virtual

Destructor

Member Function Documentation

◆ DoButtonDown()

virtual eC_Bool CGUIPrimitiveButton::DoButtonDown	(	const eC_Value &	vAbsX = `eC_FromInt(-1)`,
		const eC_Value &	vAbsY = `eC_FromInt(-1)`
	)

virtual

Called when the mouse button or finger is pressed down over an object.

Note: DoButtonDown() should work on the absolute positions of this object, that were set at the time of the passed redraw, as the user expects to click on what he sees and not to click on the object in a newer and probably intermediate state that he currently does not see in this state. Thus, to calculate the relative position (where the object was pressed relative to the origin of this object) from the vAbsY argument you must do it like this: vMyRelYPos = vAbsY - GetAbsYPos().

Parameters

vAbsX	X-position in screen coordinates where the click occurred
vAbsY	Y-position in screen coordinates where the click occurred

Returns: True The event has been handled.
False The event has not been handled. In this base implementation always returns False.

Reimplemented from CGUIBehaviour.

◆ DoButtonUp()

virtual eC_Bool CGUIPrimitiveButton::DoButtonUp	(	const eC_Value &	vAbsX = `eC_FromInt(-1)`,
		const eC_Value &	vAbsY = `eC_FromInt(-1)`
	)

virtual

Called when the mouse button or finger is released. The object under the mouse at the time of releasing will receive this event.

Note: DoButtonUp() should work on the absolute positions of this object, that were set at the time of the passed redraw, as the user expects to click on what he sees and not to click on an object in a newer and probably intermediate state that he currently does not see in this state. Thus, to calculate the relative position (where the button was released relative to the origin of this object) from the vAbsY argument you must do it like this: vMyRelYPos = vAbsY - GetAbsYPos().

Parameters

vAbsX	X-position in screen coordinates where the mouse was released.
vAbsY	Y-position in screen coordinates where the mouse was released.

Returns: True The event has been handled.
False The event has not been handled. In this base implementation always returns False.

Reimplemented from CGUIBehaviour.

◆ DoClick()

virtual eC_Bool CGUIPrimitiveButton::DoClick	(	const eC_Value &	vAbsX = `eC_FromInt(-1)`,
		const eC_Value &	vAbsY = `eC_FromInt(-1)`
	)

virtual

Called when the object receives a click event. A click can e.g., be the result of a mouse click, a finger press/release sequence on touchscreens, or be triggered by a GK_ACTION keyboard event.

Note: DoClick() should work on the absolute positions of this object, that were set at the time of the passed redraw, as the user expects to click on what he sees and not to click on an object in a newer and probably intermediate state that he currently does not see. Thus, to calculate the relative position (where the mouse button was pressed and released at the same position for in a certain time span, relative to the origin of this object) from the vAbsY argument you must do it like this: vMyRelYPos = vAbsY - GetAbsYPos().

Parameters

vAbsX	X-position in screen coordinates where the click occurred
vAbsY	Y-position in screen coordinates where the click occurred

Returns: True The event has been handled.
False The event has not been handled. In this base implementation it always returns False.

Reimplemented from CGUIBehaviour.

◆ DoDrag()

virtual eC_Bool CGUIPrimitiveButton::DoDrag	(	const eC_Value &	vDeltaX,
		const eC_Value &	vDeltaY,
		const eC_Value &	vAbsX,
		const eC_Value &	vAbsY
	)

virtual

Called when the object receives a Drag event. Drags are typically created if the mouse is being used while a mouse-button is being pressed, or if the user moves his finger over a touchscreen.

Parameters

vDeltaX	relative movement in x-direction since the last call of DoDrag/ButtonDown
vDeltaY	relative movement in y-direction since the last call of DoDrag/ButtonDown
vAbsX	current X-position in screen coordinates of the mouse
vAbsY	current Y-position in screen coordinates of the mouse

Returns: True If the event has been handled.
false Else.

Reimplemented from CGUIBehaviour.

◆ DoDragEnd()

virtual eC_Bool CGUIPrimitiveButton::DoDragEnd	(	const eC_Value &	vAbsX = `eC_FromInt(-1)`,
		const eC_Value &	vAbsY = `eC_FromInt(-1)`
	)

virtual

Called on the dragged object (=the object on which the initial ButtonDown-event occurred) when the mouse button is released after a drag event.

Parameters

vAbsX	current X-position in screen coordinates of the mouse
vAbsY	current Y-position in screen coordinates of the mouse

Returns: True If the event has been handled.
false Else.

Reimplemented from CGUIBehaviour.

◆ DoDraw()

virtual eC_Bool CGUIPrimitiveButton::DoDraw ( )

virtual

Visualizes the object. It is forbidden to call SetRelXPos, SetRelYPos, SetWidth or SetHeight in DoDraw, i.e., it is not allowed to change the layout.

Returns: True if anything was drawn, False otherwise

Reimplemented from CGUIObject.

◆ DoMouseEnter()

virtual eC_Bool CGUIPrimitiveButton::DoMouseEnter	(	const eC_Value &	vAbsX = `eC_FromInt(-1)`,
		const eC_Value &	vAbsY = `eC_FromInt(-1)`
	)

virtual

Called when the mouse enters the area which is covered by an object. If several objects cover the same region, the topmost one receives the event. Objects will not receive DoMouseEnter events if they are not highlightable.

See also: CGUIObject::IsHighlightable()

Parameters

vAbsX	X-position in screen coordinates where the mouse entered the object
vAbsY	Y-position in screen coordinates where the mouse entered the object

Returns: True If the event has been handled.
false Else.

Reimplemented from CGUIBehaviour.

◆ DoMouseLeave()

virtual eC_Bool CGUIPrimitiveButton::DoMouseLeave	(	const eC_Value &	vAbsX = `eC_FromInt(-1)`,
		const eC_Value &	vAbsY = `eC_FromInt(-1)`
	)

virtual

Called when the mouse leaves the area which is covered by an object. Objects will not receive DoMouseLeave events if they are not highlightable.

See also: CGUIObject::IsHighlightable()

Parameters

vAbsX	X-position of the mouse in screen coordinates after it left the object
vAbsY	Y-position of the mouse in screen coordinates after it left the object

Returns: True If the event has been handled.
false Else.

Reimplemented from CGUIBehaviour.

◆ DoMouseMove()

virtual eC_Bool CGUIPrimitiveButton::DoMouseMove	(	const eC_Value &	vAbsX = `eC_FromInt(-1)`,
		const eC_Value &	vAbsY = `eC_FromInt(-1)`
	)

virtual

Called when the mouse is moved within the area covered by an object. If several objects cover the same region, the topmost one receives the event. Objects will not receive DoMouseEnter events if they are not highlightable.

See also: CGUIObject::IsHighlightable()

Parameters

vAbsX	X-position of the mouse in screen coordinates
vAbsY	Y-position of the mouse in screen coordinates

Returns: True If the event has been handled.
false Else.

Reimplemented from CGUIBehaviour.

◆ GetCommand()

CGUICommandPtr CGUIPrimitiveButton::GetCommand ( ) const

inline

Returns the command object that is currently attached to this button.

Returns: The command object that is currently attached to this button, or NULL if this button does not have a command.

◆ GetFocus()

virtual void CGUIPrimitiveButton::GetFocus ( )

virtual

Called when the object, or one of its children, received the focus. If this control is a composite object then the following applies: Whether this control or a child control got the focus can be determined by checking if this control is the currently focused object in the event handler.

See also: LoseFocus, CGUIEventHandler::GetFocussedObject()

Reimplemented from CGUIBehaviour.

◆ GetHandles()

void CGUIPrimitiveButton::GetHandles	(	ObjectHandle_t &	eBtnStandard,
		ObjectHandle_t &	eBtnPressed,
		ObjectHandle_t &	eBtnHighlighted,
		ObjectHandle_t &	eBtnGrayedOut,
		ObjectHandle_t &	eBtnFocused
	)

Retrieves currently set object handles for the button states.

Parameters

eBtnStandard	ImageID for button in standard state
eBtnPressed	ImageID for button in pressed state
eBtnHighlighted	ImageID for button in highlight state
eBtnGrayedOut	ImageID for button in grayed out state
eBtnFocused	ImageID for button in focused state

◆ GetLabel()

CGUIText * CGUIPrimitiveButton::GetLabel ( ) const

Returns: A pointer to the text object that represents the caption of the button. To accomplish a "SetLabel" functionality to change the label, you can use these calls: GetLabel()->SetTextString(newString)

◆ LoseFocus()

virtual void CGUIPrimitiveButton::LoseFocus ( )

virtual

Called when an object has lost the focus. In this method the focused object is already set to the object that newly received the focus.

See also: GetFocus

Reimplemented from CGUIBehaviour.

◆ operator=()

CGUIPrimitiveButton & CGUIPrimitiveButton::operator= ( const CGUIPrimitiveButton & kSource )

operator= to copy the whole CGUIPrimitiveButton.

Parameters

kSource Source object to be copied

Returns: Copied object

◆ ReadFromStream()

virtual void CGUIPrimitiveButton::ReadFromStream ( )

virtual

Reads composite object attributes and children from stream.

Reads attributes from the streaming file. Only for use with GUIFactoryManager.

See also: CGUIObject::ReadFromStream()

Exceptions

CGUIStreamingControlException When catching a CGUIStreamingControlException from a child, this method adds the object from the exception, resets the object pointer to 'this', then re-throws.

Reimplemented from CGUICompositeObject.

◆ SetButtonState()

virtual void CGUIPrimitiveButton::SetButtonState ( )

protectedvirtual

Sets visibility state if the Object Id, which represents the given button state to visible. All others will be set to invisible.

◆ SetCommand()

void CGUIPrimitiveButton::SetCommand ( CGUICommandPtr pCommand )

inline

Attaches a command to this button. This command is executed whenever the button is clicked.

Parameters

pCommand The command to attach to this button.

◆ SetGrayedOut()

virtual void CGUIPrimitiveButton::SetGrayedOut ( const eC_Bool & bGrayedOut )

virtual

Set only this composite object grayed-out. This method simply calls the base implementation CGUIObject::SetGrayedOut(). If you also want to set the children's state, use SetGrayedOut(const eC_Bool&, const eC_Bool&) instead.

Parameters

bGrayedOut The new grayed-out state of this composite object.

See also: SetGrayedOut(const eC_Bool&, const eC_Bool&)

Reimplemented from CGUICompositeObject.

◆ SetHandles()

void CGUIPrimitiveButton::SetHandles	(	ObjectHandle_t	eBtnStandard,
		ObjectHandle_t	eBtnPressed,
		ObjectHandle_t	eBtnHighlighted,
		ObjectHandle_t	eBtnGrayedOut,
		ObjectHandle_t	eBtnFocused
	)

Sets object handles for the button states. Five handles for the five supported states of an image button. The handles will be added to the CompositeObject.

Parameters

eBtnStandard	ImageID for button in standard state
eBtnPressed	ImageID for button in pressed state
eBtnHighlighted	ImageID for button in highlight state
eBtnGrayedOut	ImageID for button in grayed out state
eBtnFocused	ImageID for button in focused state

◆ WriteToStream()

virtual void CGUIPrimitiveButton::WriteToStream ( const eC_Bool bWriteClassID = false )

virtual

Writes all object attributes to the streaming file. StreamWriter has to be initialized. Only for use with GUIStreamWriter.

Parameters

bWriteClassID This flag is used to select if writing of ControlID, leading and trailing tags is performed. Only GUIStreamWriter and GUICompositeObject have to set this flag true.

See also: CGUIStreamWriter

Reimplemented from CGUICompositeObject.

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

GUIPrimitiveButton.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ButtonState_t

Constructor & Destructor Documentation

◆ CGUIPrimitiveButton() [1/7]

◆ CGUIPrimitiveButton() [2/7]

◆ CGUIPrimitiveButton() [3/7]

◆ CGUIPrimitiveButton() [4/7]

◆ CGUIPrimitiveButton() [5/7]

◆ CGUIPrimitiveButton() [6/7]

◆ CGUIPrimitiveButton() [7/7]

◆ ~CGUIPrimitiveButton()

Member Function Documentation

◆ DoButtonDown()

◆ DoButtonUp()

◆ DoClick()

◆ DoDrag()

◆ DoDragEnd()

◆ DoDraw()

◆ DoMouseEnter()

◆ DoMouseLeave()

◆ DoMouseMove()

◆ GetCommand()

◆ GetFocus()

◆ GetHandles()

◆ GetLabel()

◆ LoseFocus()

◆ operator=()

◆ ReadFromStream()

◆ SetButtonState()

◆ SetCommand()

◆ SetGrayedOut()

◆ SetHandles()

◆ WriteToStream()