CGUIBaseRadioButton Class Reference

Base class for radio buttons. More...

#include <GUIBaseRadioButton.h>

Inheritance diagram for CGUIBaseRadioButton:

Public Member Functions
	CGUIBaseRadioButton ()
	CGUIBaseRadioButton (CGUIRadioButtonGroup *const pkParent, const CGUIRect &kRect, const eC_Bool &bSelected=false, const ObjectHandle_t &eID=NO_HANDLE)
	CGUIBaseRadioButton (CGUIRadioButtonGroup *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_Bool &bSelected=false, const ObjectHandle_t &eID=NO_HANDLE)
	CGUIBaseRadioButton (const CGUIBaseRadioButton &kSource)
eC_Bool	DoClick (const eC_Value &vAbsX, const eC_Value &vAbsY)
eC_Bool	DoDraw ()
CGUIBaseRadioButton &	operator= (const CGUIBaseRadioButton &kSource)
virtual void	ReadFromStream ()
void	Select ()
virtual void	WriteToStream (const eC_Bool bWriteClassID=false)
Public Member Functions inherited from CGUIBaseCheckBox
	CGUIBaseCheckBox ()
	CGUIBaseCheckBox (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const eC_Bool &bSelected=false, const ObjectHandle_t &eID=NO_HANDLE)
	CGUIBaseCheckBox (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_Bool &bSelected=false, const ObjectHandle_t &eID=NO_HANDLE)
	CGUIBaseCheckBox (const CGUIBaseCheckBox &kSource)
virtual	~CGUIBaseCheckBox ()
	Destructor.
void	AddSelectionObserver (CGUIObserver *pObserver)
virtual CGUIRect	CalculateIconRect ()
virtual CGUIRect	CalculateLabelRect (const CGUIRect &kIconRect)
virtual eC_Bool	DoClick (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoDraw ()
virtual eC_Bool	IsSelected () const
CGUIBaseCheckBox &	operator= (const CGUIBaseCheckBox &kSource)
virtual void	ReadFromStream ()
void	RemoveSelectionObserver (CGUIObserver *pObserver)
void	SetCheckBoxLayout (const CheckBoxLayout_t eLayout)
void	SetIconRect (const CGUIRect &kRect)
virtual void	SetSelected (eC_Bool bSelect)
virtual eC_Bool	SetValue (const CGUIValue &rkValue)
virtual void	WriteToStream (const eC_Bool bWriteClassID=false)
Public Member Functions inherited from CGUIBaseButton
	CGUIBaseButton ()
	CGUIBaseButton (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const eC_String &kText, CGUICommandPtr pkCommandObject, const ObjectHandle_t &eID=NO_HANDLE)
	CGUIBaseButton (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const TextResource_t &eTextID, CGUICommandPtr pkCommandObject, const ObjectHandle_t &eID=NO_HANDLE)
	CGUIBaseButton (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_String &kText, CGUICommandPtr pkCommandObject, const ObjectHandle_t &eID=NO_HANDLE)
	CGUIBaseButton (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const TextResource_t &eTextID, CGUICommandPtr pkCommandObject, const ObjectHandle_t &eID=NO_HANDLE)
	CGUIBaseButton (const CGUIBaseButton &kSource)
virtual	~CGUIBaseButton (void)
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	DoDraw ()
CGUICommandPtr	GetCommand () const
CGUIText *	GetLabel () const
CGUIBaseButton &	operator= (const CGUIBaseButton &kSource)
virtual void	ReadFromStream ()
void	SetCommand (CGUICommandPtr pkCommand)
virtual void	SetHeight (const eC_Value &vNewHeight)
void	SetLabel (const eC_String &kString)
void	SetLabel (const TextResource_t &eTextID)
void	SetText (CGUIText *pkText)
virtual eC_Bool	SetValue (const CGUIValue &rkValue)
virtual void	SetWidth (const eC_Value &vNewWidth)
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	DoDrag (const eC_Value &vDeltaX=eC_FromInt(-1), const eC_Value &vDeltaY=eC_FromInt(-1), const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
virtual eC_Bool	DoDragEnd (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
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 &vAbsY=eC_FromInt(-1))
virtual void	GetFocus ()
virtual void	LoseFocus ()
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 ()

Friends
class	CGUIRadioButtonGroup

Additional Inherited Members
Public Types inherited from CGUIBaseCheckBox
enum	CheckBoxLayout_t {   MANUAL_LAYOUT , ICON_LEFT_AUTOSCALE , ICON_RIGHT_AUTOSCALE , ICON_LEFT_CENTERED ,   ICON_RIGHT_CENTERED , ICON_FILL_OBJECT }
	Enumeration for checkbox layout styles. More...
Public Types inherited from CGUIObject
enum	FourWayFocus_t { FOCUS_LEFT , FOCUS_RIGHT , FOCUS_UP , FOCUS_DOWN }
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 []
Protected Member Functions inherited from CGUIBaseCheckBox
void	Init (const eC_Bool &bSelected)
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 inherited from CGUIBaseCheckBox
CheckBoxLayout_t	m_eCheckBoxLayout
	Position of text label relative to checkbox element.
CGUIRect	m_kIconRelRect
	Icon size/position in relative coordinates.
Protected Attributes inherited from CGUIBaseButton
CGUICommandPtr	m_pkCommandObject
	Holds the attached command.
CGUIText *	m_pkLabel
	Holds the label.

Detailed Description

Base class for radio buttons.

Like all the "BaseXXXXX"-Classes, this serves primarily as base-class, from which you can derive your own customized objects. For a radio button implementation which uses images to visualize itself, please refer to CGUIRadioButton.

A radio button, like a check box, can have two states, 'selected' and 'not selected'. Radio buttons in addition must be children of a CGUIRadioButtonGroup. Only one of the radio buttons in a group can be selected at a time.

Example:

// Create base radio button.
CGUIBaseRadioButton *pkBaseRadioButton = new CGUIBaseRadioButton(
                                                 pkRadioButtonGroup, // parent must be a CGUIRadioButtonGroup
                                                 eC_FromInt(0), eC_FromInt(0),
                                                 eC_FromInt(60), eC_FromInt(20),
                                                 false, OBJ_BASERADIOBUTTON);

Constructor & Destructor Documentation

CGUIBaseRadioButton() [1/4]

CGUIBaseRadioButton::CGUIBaseRadioButton	(	CGUIRadioButtonGroup *const	pkParent,
		const eC_Value &	vX,
		const eC_Value &	vY,
		const eC_Value &	vWidth,
		const eC_Value &	vHeight,
		const eC_Bool &	bSelected = false,
		const ObjectHandle_t &	eID = NO_HANDLE
	)

CGUIBaseRadioButton constructor.

Parameters

pkParent	Pointer to parent object which must be a button group.
vX	X position relative to its parent object.
vY	Y position relative to its parent object.
vWidth	Width of the checkbox.
vHeight	Height of the checkbox.
bSelected	Status of the radio button. Selected, if true, not selected, otherwise
eID	Object Identifier of this radio button

CGUIBaseRadioButton() [2/4]

CGUIBaseRadioButton::CGUIBaseRadioButton	(	CGUIRadioButtonGroup *const	pkParent,
		const CGUIRect &	kRect,
		const eC_Bool &	bSelected = false,
		const ObjectHandle_t &	eID = NO_HANDLE
	)

CGUIBaseRadioButton constructor.

Parameters

pkParent	Pointer to parent object which must be a button group.
kRect	Structure containing x- and y-coordinates as well as width and height.
bSelected	Status of the radio button. Selected if true, not selected otherwise.
eID	Object Identifier of this radio button

CGUIBaseRadioButton() [3/4]

CGUIBaseRadioButton::CGUIBaseRadioButton

(

const CGUIBaseRadioButton &

kSource

)

Copy-constructor of the CGUIBaseRadioButton class.

Parameters

kSource

Source object to be copied.

CGUIBaseRadioButton() [4/4]

CGUIBaseRadioButton::CGUIBaseRadioButton

(

)

Standard constructor.

See also

CGUIObject().

Member Function Documentation

DoClick()

eC_Bool CGUIBaseRadioButton::DoClick ( const eC_Value &  vAbsX, const eC_Value &  vAbsY  )

virtual

Must be implemented to avoid calling of DoClick() in CGUIBaseCheckBox base class. This is because the CGUIRadioButtonGroup should handle toggling the selection state of its children.

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 CGUIBaseCheckBox.

DoDraw()

eC_Bool CGUIBaseRadioButton::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 CGUIBaseCheckBox.

Reimplemented in CGUIRadioButton.

operator=()

CGUIBaseRadioButton & CGUIBaseRadioButton::operator=

(

const CGUIBaseRadioButton &

kSource

)

Operator= method of the CGUIBaseRadioButton class.

Parameters

kSource

Source object to be copied.

Returns

Copied object.

ReadFromStream()

virtual void CGUIBaseRadioButton::ReadFromStream ( )

virtual

Reads all object attributes from streaming file. Only for use with GUIFactory. GUIStreamingFileReader has to be set in CGUI::Init().

See also

CGUIFactory

Reimplemented from CGUIBaseCheckBox.

Reimplemented in CGUIRadioButton.

Select()

void CGUIBaseRadioButton::Select

(

)

Set radio button selection status true. If another radio button in the same group is selected, it will become unselected before.

WriteToStream()

virtual void CGUIBaseRadioButton::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 CGUIBaseCheckBox.

Reimplemented in CGUIRadioButton.

Friends And Related Function Documentation

CGUIRadioButtonGroup

friend class CGUIRadioButtonGroup

friend

---

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

• GUIBaseRadioButton.h