Guiliani  Version 2.5 revision 7293 (documentation build 13)
Public Member Functions | List of all members
CGUIRadioButton Class Reference
Controls

Radio button specialization that uses images for graphical representation. More...

#include <GUIRadioButton.h>

Inheritance diagram for CGUIRadioButton:
Inheritance graph
[legend]

Public Member Functions

 CGUIRadioButton ()
 
 CGUIRadioButton (CGUIRadioButtonGroup *const pkParent, const CGUIRect &kRect, const eC_Bool &bSelected=false, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIRadioButton (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)
 
 CGUIRadioButton (const CGUIRadioButton &kSource)
 
 ~CGUIRadioButton (void)
 
eC_Bool DoDraw ()
 
CGUINinePatch & GetNinePatch ()
 
CGUIRadioButton & operator= (const CGUIRadioButton &kSource)
 
virtual void ReadFromStream ()
 
void SetImages (const ImageResource_t &eSelectedFocussed, const ImageResource_t &eSelectedHighlighted, const ImageResource_t &eSelectedPressed, const ImageResource_t &eSelectedNormal, const ImageResource_t &eSelectedGrayedOut, const ImageResource_t &eNotSelectedFocussed, const ImageResource_t &eNotSelectedHighlighted, const ImageResource_t &eNotSelectedPressed, const ImageResource_t &eNotSelectedNormal, const ImageResource_t &eNotSelectedGrayedOut)
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUIBaseRadioButton
 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 ()
 

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

Radio button specialization that uses images for graphical representation.

The "radio button" control has two states (checked or unchecked). It is arranged in a group of radio buttons. If one of the radio buttons is checked by the user, all other buttons in the group of radio buttons will become unchecked instantly. The "radio button" control is typically used in applications where the user has to select a single option out of various alternatives. (Class: CGUIRadioButton).

Example:

// Create a radio button.
CGUIRadioButton *pkRadioButton = new CGUIRadioButton(pkRadioButtonGroup, // parent must be a CGUIRadioButtonGroup
eC_FromInt(0), eC_FromInt(0),
eC_FromInt(60), eC_FromInt(20),
false, OBJ_RADIOBUTTON);
// Set the images of the radio button.
// Before calling this method, please add image IDs to UserImageResource.h.
// After that call GETRESMANAGER.RegisterImageResource() to register images for image IDs.
pkRadioButton->SetImages(
IMG_BT_SEL_FOCUSED,
IMG_BT_SEL_HIGHLIGHTED,
IMG_BT_SEL_PRESSED,
IMG_BT_SEL_STANDARD,
IMG_BT_SEL_GRAYEDOUT,
IMG_BT_NOTSEL_FOCUSED,
IMG_BT_NOTSEL_HIGHLIGHTED,
IMG_BT_NOTSEL_PRESSED,
IMG_BT_NOTSEL_STANDARD,
IMG_BT_NOTSEL_GRAYEDOUT);
CGUIRadioButton
Radio button specialization that uses images for graphical representation.
Definition: GUIRadioButton.h:62
CGUIRadioButton::SetImages
void SetImages(const ImageResource_t &eSelectedFocussed, const ImageResource_t &eSelectedHighlighted, const ImageResource_t &eSelectedPressed, const ImageResource_t &eSelectedNormal, const ImageResource_t &eSelectedGrayedOut, const ImageResource_t &eNotSelectedFocussed, const ImageResource_t &eNotSelectedHighlighted, const ImageResource_t &eNotSelectedPressed, const ImageResource_t &eNotSelectedNormal, const ImageResource_t &eNotSelectedGrayedOut)
See also
CGUIRadioButtonGroup

Constructor & Destructor Documentation

◆ CGUIRadioButton() [1/4]

CGUIRadioButton::CGUIRadioButton ( 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 
)

Constructor To set the standard Guiliani images, please call the SetStandardImages() method. To Set the user specific images, please use the SetImages() method.

Parameters
pkParentPointer to parent object.
vXX position relative to its parent object.
vYY position relative to its parent object.
vWidthWidth of the image radio button.
vHeightHeight of the image radio button.
bSelectedStatus of the image radio button to indicate whether it is selected or not. Selected, if true, not selected, otherwise
eIDObject Identifier of this image radio button

◆ CGUIRadioButton() [2/4]

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

Constructor.

Parameters
pkParentPointer to parent object.
kRectStructure containing x- and y-coordinates as well as width and height.
bSelectedStatus of the image radio button to indicate whether it is selected or not. Selected, if true, not selected, otherwise
eIDObject Identifier of this image radio button

◆ CGUIRadioButton() [3/4]

CGUIRadioButton::CGUIRadioButton ( const CGUIRadioButton &  kSource)

Copy-constructor of the CGUIRadioButton class.

Parameters
kSourceSource object to be copied.

◆ CGUIRadioButton() [4/4]

CGUIRadioButton::CGUIRadioButton ( )

Standard constructor.

See also
CGUIObject().

◆ ~CGUIRadioButton()

CGUIRadioButton::~CGUIRadioButton ( void  )

Destructor

Member Function Documentation

◆ DoDraw()

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

◆ GetNinePatch()

CGUINinePatch & CGUIRadioButton::GetNinePatch ( )
inline

Grants access to the object's nine patch.

Returns
Nine patch used to display the object

◆ operator=()

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

Operator= method of the CGUIRadioButton class.

Parameters
kSourceSource object to be copied.
Returns
Copied object.

◆ ReadFromStream()

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

◆ SetImages()

void CGUIRadioButton::SetImages ( const ImageResource_t &  eSelectedFocussed,
const ImageResource_t &  eSelectedHighlighted,
const ImageResource_t &  eSelectedPressed,
const ImageResource_t &  eSelectedNormal,
const ImageResource_t &  eSelectedGrayedOut,
const ImageResource_t &  eNotSelectedFocussed,
const ImageResource_t &  eNotSelectedHighlighted,
const ImageResource_t &  eNotSelectedPressed,
const ImageResource_t &  eNotSelectedNormal,
const ImageResource_t &  eNotSelectedGrayedOut 
)

Method to change the images used for the radio button representation.

Parameters
eSelectedFocussedID of image of the radio button in state "focused and selected before".
eSelectedHighlightedID of image of the radio button in state "highlighted and selected before".
eSelectedPressedID of image of the radio button in state "pressed and selected before".
eSelectedNormalID of image of the radio button in state "not pressed, not highlighted, not focused but selected before".
eSelectedGrayedOutID of image of the radio button in state "selected before but now grayed out".
eNotSelectedFocussedID of image of the radio button in state "focused but not selected before".
eNotSelectedHighlightedID of image of the radio button in state "highlighted but not selected before".
eNotSelectedPressedID of image of the radio button in state "pressed but not selected before".
eNotSelectedNormalID of image of the radio button in state "not pressed, not highlighted, not focused, not selected before".
eNotSelectedGrayedOutID of image of the radio button in state "not selected before but now grayed out".

◆ WriteToStream()

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

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