Guiliani  Version 2.4 revision 5970 (build 3)
CGUIBaseCheckBox Class Reference

Base class for checkboxes. More...

#include <GUIBaseCheckBox.h>

Inheritance diagram for CGUIBaseCheckBox:

Public Types

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 }
 

Public Member Functions

 CGUIBaseCheckBox ()
 
 CGUIBaseCheckBox (CGUICompositeObject *const pParent, 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 (CGUICompositeObject *const pParent, const CGUIRect &kRect, 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
 
CGUIBaseCheckBoxoperator= (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 (CGUICompositeObject *const pParent, 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)
 
 CGUIBaseButton (CGUICompositeObject *const pParent, const CGUIRect &kRect, const TextResource_t &eTextID, CGUICommandPtr pCommandObject, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIBaseButton (CGUICompositeObject *const pParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_String &kText, CGUICommandPtr pCommandObject, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIBaseButton (CGUICompositeObject *const pParent, const CGUIRect &kRect, const eC_String &kText, CGUICommandPtr pCommandObject, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIBaseButton ()
 
 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))
 
CGUICommandPtr GetCommand () const
 
CGUITextGetLabel () const
 
CGUIBaseButtonoperator= (const CGUIBaseButton &kSource)
 
void SetCommand (CGUICommandPtr pCommand)
 
virtual void SetHeight (const eC_Value &vNewHeight)
 
void SetLabel (const eC_String &kString)
 
void SetLabel (const TextResource_t &eTextID)
 
void SetText (CGUIText *pkText)
 
virtual void SetWidth (const eC_Value &vNewWidth)
 
- Public Member Functions inherited from CGUIObject
 CGUIObject (CGUICompositeObject *const pParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIObject (CGUICompositeObject *const pParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIObject ()
 
 CGUIObject (const CGUIObject &kSource)
 
virtual ~CGUIObject ()
 
void AddValueObserver (CGUIObserver *pObserver)
 
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 DoDrawSnapshot ()
 
virtual void EnableSnapshotDrawing ()
 
virtual CGUIObjectFindObject (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
 
CGUIBehaviourDecoratorGetBehaviour ()
 
const CGUIBehaviourDecoratorGetBehaviour () const
 
GUIBitmapPlaneID_t GetBitmapID () const
 
CGUIBitmapPlaneGetBitmapPlane () 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
 
CDataPoolConnectorGetDataPoolConnector ()
 
eC_Value GetDistanceBottom () const
 
eC_Value GetDistanceRight () const
 
eC_Value GetHalfHeight () const
 
eC_Value GetHalfWidth () const
 
eC_Value GetHeight () const
 
ObjectHandle_t GetID () const
 
CGUILayouterGetLayouter ()
 
const CGUILayouterGetLayouter () const
 
ObjectHandle_t GetNeighborBottomID () const
 
ObjectHandle_t GetNeighborLeftID () const
 
ObjectHandle_t GetNeighborRightID () const
 
ObjectHandle_t GetNeighborTopID () const
 
CGUIObjectGetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false)
 
const CGUIObjectGetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false) const
 
CGUIRect GetOriginRect () const
 
CGUICompositeObjectGetParent ()
 
const CGUICompositeObjectGetParent () 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)
 
CGUIObjectoperator= (const CGUIObject &kSource)
 
virtual void RefreshLayout (CGUILayouter::eMovedEdges_t eMovedEdges) const
 
void RemoveValueObserver (CGUIObserver *pObserver)
 
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 *pBehaviour)
 
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)
 
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 pParent)
 
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)
 
- 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
 
void SetXMLTag (const eC_String &kXMLTag)
 
- 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 Member Functions

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

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_pCommandObject
 Holds the attached command.
 
CGUITextm_pkLabel
 Holds the label.
 

Additional Inherited Members

- Static Public Attributes inherited from CGUIObject
static const eC_Char XMLTAG_ALPHA [] = "Alpha"
 XML tag to be used writing alpha-value into a stream.
 
static const eC_Char XMLTAG_CLICKTHROUGH [] = "ClickThrough"
 XML tag to be used writing clickthrough-state into a stream.
 
static const eC_Char XMLTAG_CONTROLCLASSID [] = "ControlClassID"
 XML tag to be used when writing a control class ID into a stream.
 
static const eC_Char XMLTAG_DISABLED [] = "Disabled"
 XML tag to be used writing disabled-state into a stream.
 
static const eC_Char XMLTAG_FOCUSSABLE [] = "Focussable"
 XML tag to be used writing focussable-state into a stream.
 
static const eC_Char XMLTAG_GRAYEDOUT [] = "GrayedOut"
 XML tag to be used writing grayedout-state into a stream.
 
static const eC_Char XMLTAG_HEIGHT [] = "Height"
 XML tag to be used writing height into a stream.
 
static const eC_Char XMLTAG_INVISIBLE [] = "Invisible"
 XML tag to be used writing invisible-state into a stream.
 
static const eC_Char XMLTAG_OBJECTID [] = "ObjectID"
 XML tag to be used writing object id into a stream.
 
static const eC_Char XMLTAG_OVERRIDDENNEIGHBORS [] = "OverriddenNeighbors"
 XML tag to be used writing overridden neighbors into a stream.
 
static const eC_Char XMLTAG_WIDTH [] = "Width"
 XML tag to be used writing width into a stream.
 
static const eC_Char XMLTAG_XPOS [] = "XPos"
 XML tag to be used writing x-position into a stream.
 
static const eC_Char XMLTAG_YPOS [] = "YPos"
 XML tag to be used writing y-position into a stream.
 
- Static Public Attributes inherited from CGUIBehaviour
static const eC_Char XMLTAG_BEHAVIOURCLASSID [] = "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 [] = "ClassVersion"
 

Detailed Description

Base class for checkboxes.

This is the base class for checkboxes and radiobuttons. In addition to the text label, which it inherits from its base class CGUIBaseButton, it adds an additional "selected"-state.

This implementation draws itself using plain lines and rectangles. It serves as a base-class from which you can derive customized checkbox classes. For an implementation that uses bitmaps to visualize itself, please refer to CGUICheckBox.

Example:

// Create base check box.
CGUIBaseCheckBox *pkBaseCheckBox = new CGUIBaseCheckBox(this,
eC_FromInt(100), eC_FromInt(10), eC_FromInt(20),
eC_FromInt(20), false, OBJ_BASECHECKBOX);

An elegant way to react when the user selects / deselects the checkbox is by registering an observer. The following example shows how this can be done:

Example:

// Implement your own observer
class CMyCheckBoxObserver : public CGUIObserver
{
public:
// Called when checkbox status has changed
void OnNotification(const CGUIValue& kObservedValue, const CGUIObject* const pkUpdatedObject, const eC_UInt uiX, const eC_UInt uiY)
{
if (kObservedValue.ToBool())
{
// Checkbox is selected
}
else
{
// Checkbox is not selected
}
}
};
// Somewhere after the creation of the checkbox, register your observer within the checkbox
CGUIObserver* pObserver = new CMyCheckBoxObserver()
pkBaseCheckBox->AddSelectionObserver(pObserver);
// Note: Do not forget to delete your observer later!

Member Enumeration Documentation

◆ CheckBoxLayout_t

Enumeration for checkbox layout styles.

Enumerator
MANUAL_LAYOUT 

No automatic layout. Values set by user will remain untouched.

ICON_LEFT_AUTOSCALE 

Icon left and scaled automatically - Text resides right.

ICON_RIGHT_AUTOSCALE 

Icon right and scaled automatically - Text resides left.

ICON_LEFT_CENTERED 

Icon left and not scaled - Text resides right.

ICON_RIGHT_CENTERED 

Icon right and not scaled- Text resides left.

ICON_FILL_OBJECT 

The Icon will fill the entire area of the object.

Constructor & Destructor Documentation

◆ CGUIBaseCheckBox() [1/4]

CGUIBaseCheckBox::CGUIBaseCheckBox ( )

CGUIBaseCheckBox standard constructor.

See also
CGUIObject().

◆ CGUIBaseCheckBox() [2/4]

CGUIBaseCheckBox::CGUIBaseCheckBox ( CGUICompositeObject *const  pParent,
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 constructor.

Parameters
pParentPointer to parent object.
vXX position relative to its parent object.
vYY position relative to its parent object.
vWidthWidth of the checkbox.
vHeightHeight of the checkbox.
bSelectedStatus of the image checkbox to indicate whether the checkbox is checked or not. Checked, if true, not checked, otherwise
eIDObject Identifier of this checkbox

◆ CGUIBaseCheckBox() [3/4]

CGUIBaseCheckBox::CGUIBaseCheckBox ( CGUICompositeObject *const  pParent,
const CGUIRect kRect,
const eC_Bool &  bSelected = false,
const ObjectHandle_t eID = NO_HANDLE 
)

CGUIBaseCheckBox constructor.

Parameters
pParentPointer to parent object.
kRectStructure containing x- and y-coordinates as well as width and height.
bSelectedStatus of the checkbox to indicate whether the checkbox is checked or not. Checked, if true, not checked, otherwise
eIDObject Identifier of this checkbox

◆ CGUIBaseCheckBox() [4/4]

CGUIBaseCheckBox::CGUIBaseCheckBox ( const CGUIBaseCheckBox kSource)

Copy-constructor of the CGUIBaseCheckBox class.

Parameters
kSourceSource object to be copied.

Member Function Documentation

◆ CalculateIconRect()

CGUIRect CGUIBaseCheckBox::CalculateIconRect ( )
virtual

Calculates the size and position of the Icon area with regard to the chosen checkbox layout. The resulting rectangle will be stored in m_kIconRelRect

Returns
The rectangle in relative coordinates which should be covered by the Icon

◆ CalculateLabelRect()

CGUIRect CGUIBaseCheckBox::CalculateLabelRect ( const CGUIRect kIconRect)
virtual

Calculates the size and position of the label area with regard to the chosen checkbox layout and the associated icon's position and dimension.

Parameters
kIconRectRectangle in relative coordinates which is covered by the icon
Returns
The rectangle in absolute which should be covered by the text label

◆ DoClick()

eC_Bool CGUIBaseCheckBox::DoClick ( const eC_Value &  vAbsX,
const eC_Value &  vAbsY 
)
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
vAbsXX-position in screen coordinates where the click occurred
vAbsYY-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 CGUIBaseButton.

Reimplemented in CGUIBaseRadioButton.

◆ DoDraw()

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

Reimplemented in CGUIRadioButton, CGUICheckBox, and CGUIBaseRadioButton.

◆ Init()

void CGUIBaseCheckBox::Init ( const eC_Bool &  bSelected)
protected

Helper function for constructors.

Parameters
bSelectedInitial value of m_bIsSelected

◆ IsSelected()

virtual eC_Bool CGUIBaseCheckBox::IsSelected ( ) const
inlinevirtual

Checks if the object is currently selected

Returns
True if selected, False otherwise

◆ operator=()

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

Operator= method of the CGUIBaseCheckBox class.

Parameters
kSourceSource object to be copied.
Returns
Copied object.

◆ ReadFromStream()

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

Reimplemented in CGUICheckBox, CGUIBaseRadioButton, and CGUIRadioButton.

◆ RemoveSelectionObserver()

void CGUIBaseCheckBox::RemoveSelectionObserver ( CGUIObserver pObserver)

Unsubscribe an observer that subscribed as selection observer.

Parameters
pObserverThe Observer that wants to unsubscribe.

◆ SetCheckBoxLayout()

void CGUIBaseCheckBox::SetCheckBoxLayout ( const CheckBoxLayout_t  eLayout)

Sets the layout for this checkbox. Please refer to CheckBoxLayout_t for a description of the supported layouts.

Parameters
eLayoutThe desired layout.

◆ SetIconRect()

void CGUIBaseCheckBox::SetIconRect ( const CGUIRect kRect)

Sets the rect for the icon

Parameters
kRectrect for icon

◆ SetSelected()

virtual void CGUIBaseCheckBox::SetSelected ( eC_Bool  bSelect)
inlinevirtual

Set the object's status to selected (true) or NOT selected (false). Mote: Whem called on a RadioButton, this will NOT ensure unique selection of just ONE button in the RadioButtonGroup.

Parameters
bSelectBoolean value indicating the new state.

◆ SetValue()

virtual eC_Bool CGUIBaseCheckBox::SetValue ( const CGUIValue rkValue)
inlinevirtual

Sets the selected state of this CheckBox

See also
SetSelected()
Parameters
rkValueThe CGUIValue containing the new value(s)
Returns
Always True.

Reimplemented from CGUIBaseButton.

◆ WriteToStream()

void CGUIBaseCheckBox::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
bWriteClassIDThis 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 CGUIBaseButton.

Reimplemented in CGUICheckBox, CGUIBaseRadioButton, and CGUIRadioButton.


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