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

Button specialization that shows a state-dependent icon. More...

#include <GUIIconButton.h>

Inheritance diagram for CGUIIconButton:

Public Member Functions

 CGUIIconButton (CGUICompositeObject *const pParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_Value &vXIconPos, const eC_Value &vYIconPos, const eC_String &pkText, CGUICommandPtr pCommandObject, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIIconButton (CGUICompositeObject *const pParent, const CGUIRect &kRect, const eC_Value &vXIconPos, const eC_Value &vYIconPos, const eC_String &rkText, CGUICommandPtr pCommandObject, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIIconButton (CGUICompositeObject *const pParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_Value &vXIconPos, const eC_Value &vYIconPos, const TextResource_t &eTextID, CGUICommandPtr pCommandObject, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIIconButton (CGUICompositeObject *const pParent, const CGUIRect &kRect, const eC_Value &vXIconPos, const eC_Value &vYIconPos, const TextResource_t &eTextID, CGUICommandPtr pCommandObject, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIIconButton (const CGUIIconButton &kSource)
 
 ~CGUIIconButton ()
 Destructor.
 
virtual eC_Bool DoDraw ()
 
eC_UByte GetIconAlpha ()
 
void GetIconImages (ImageResource_t &eIconNormal, ImageResource_t &eIconPressed, ImageResource_t &eIconHighlighted, ImageResource_t &eIconGrayedOut, ImageResource_t &eIconFocussed) const
 
void GetIconPos (eC_Value &vIconPosX, eC_Value &vIconPosY) const
 
CGUIIconButtonoperator= (const CGUIIconButton &kSource)
 
void SetIconAlpha (const eC_UByte ubIconAlpha)
 
void SetIconImages (const ImageResource_t eIconNormal, const ImageResource_t eIconPressed, const ImageResource_t eIconHighlighted, const ImageResource_t eIconGrayedOut, const ImageResource_t eIconFocussed)
 
void SetIconPos (const eC_Value &vIconPosX, const eC_Value &vIconPosY)
 
- Public Member Functions inherited from CGUIButton
 CGUIButton (CGUICompositeObject *const pParent, 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)
 
 CGUIButton (CGUICompositeObject *const pParent, const CGUIRect &kRect, const eC_String &rkText, CGUICommandPtr pCommandObject, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIButton (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)
 
 CGUIButton (CGUICompositeObject *const pParent, const eC_Value &vX, const eC_Value &vY, CGUICommandPtr pCommandObject, const ImageResource_t &eBtnStandard, const ImageResource_t &eBtnPressed=DUMMY_IMAGE, const ImageResource_t &eBtnHighlighted=DUMMY_IMAGE, const ImageResource_t &eBtnGrayedOut=DUMMY_IMAGE, const ImageResource_t &eBtnFocused=DUMMY_IMAGE, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIButton (CGUICompositeObject *const pParent, const CGUIRect &kRect, const TextResource_t &eTextID, CGUICommandPtr pCommandObject, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIButton (const CGUIButton &kSource)
 
 CGUIButton ()
 
virtual ~CGUIButton ()
 
CGUIRect GetBlitRect () const
 
BlitType_t GetBlitType () const
 
void GetImages (ImageResource_t &eBtnStandard, ImageResource_t &eBtnPressed, ImageResource_t &eBtnHighlighted, ImageResource_t &eBtnGrayedOut, ImageResource_t &eBtnFocused)
 
CGUINinePatchGetNinePatch ()
 
CGUIButtonoperator= (const CGUIButton &kSource)
 
void SetBlitRect (const CGUIRect &kBlitRect)
 
void SetBlitType (const BlitType_t &eBlitType)
 
void SetImages (const ImageResource_t &eBtnStandard, const ImageResource_t &eBtnPressed, const ImageResource_t &eBtnHighlighted, const ImageResource_t &eBtnGrayedOut, const ImageResource_t &eBtnFocused)
 
void SetStandardImages ()
 
- 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))
 
virtual eC_Bool DoClick (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 eC_Bool SetValue (const CGUIValue &rkValue)
 
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

virtual void ReadFromStream ()
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- 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

ImageResource_t m_eIconFocussed
 
ImageResource_t m_eIconGrayedOut
 
ImageResource_t m_eIconHighlighted
 
ImageResource_t m_eIconNormal
 
ImageResource_t m_eIconPressed
 
eC_UByte m_ubIconAlpha
 m_ubIconAlpha stores the alpha value which is used for the icon blit in all button states.
 
eC_Value m_vIconPosX
 m_vIconPosX stores X-Position of icon. This is relative to the control.
 
eC_Value m_vIconPosY
 m_vIconPosY stores Y-Position of icon. This is relative to the control.
 
- Protected Attributes inherited from CGUIButton
BlitType_t m_eBlitType
 used blitting-type
 
ImageResource_t m_eBtnFocused
 the focused image
 
ImageResource_t m_eBtnGrayedOut
 the grayed out image
 
ImageResource_t m_eBtnHighlighted
 the highlighted image
 
ImageResource_t m_eBtnNormal
 the standard image
 
ImageResource_t m_eBtnPressed
 the pressed image
 
CGUIRect m_kBlitRect
 used blitting-rect for manual-layout
 
CGUINinePatch m_kNinePatch
 the nine patch
 
- Protected Attributes inherited from CGUIBaseButton
CGUICommandPtr m_pCommandObject
 Holds the attached command.
 
CGUITextm_pkLabel
 Holds the label.
 

Additional Inherited Members

- Public Types inherited from CGUIButton
enum  BlitType_t { BBT_CENTER, BBT_MANUAL_LAYOUT, BBT_STRETCH, BBT_TILED }
 enum for blitting-type 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 [] = "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

Button specialization that shows a state-dependent icon.

icon_button.png
The "icon button" control is an enhanced button. It uses additional to its text an image as icon. This image can be changed separately and can be located at an arbitrary position and dimension on the button (Class: CGUIIconButton). The "icon button" supports nine patch images (CGUINinePatch).

This control shows an additional icon on the button. The user is responsible for the icon image size and its position.

Example:

// Create an icon button.
CGUIIconButton* pkIconButton = new CGUIIconButton(this,
eC_FromInt(0), eC_FromInt(0),
eC_FromInt(30), eC_FromInt(30),
eC_FromInt(0), eC_FromInt(0),
"",
NULL, // Replace the NULL with your command.
OBJ_ICONBUTTON);
// Set images of icon.
// Before calling this method, please add image IDs to UserImageResource.h.
// After that call GETRESMANAGER.RegisterImageResource() to register images for image IDs.
pkIconButton->SetIconImages(
ICON_STANDARD,
ICON_PRESSED,
ICON_HIGHLIGHTED,
ICON_GRAYEDOUT,
ICON_FOCUSED);
// Set position of icon inside the control.
pkIconButton->SetIconPos(eC_FromInt(10), eC_FromInt(10));

Constructor & Destructor Documentation

◆ CGUIIconButton() [1/5]

CGUIIconButton::CGUIIconButton ( CGUICompositeObject *const  pParent,
const eC_Value &  vX,
const eC_Value &  vY,
const eC_Value &  vWidth,
const eC_Value &  vHeight,
const eC_Value &  vXIconPos,
const eC_Value &  vYIconPos,
const eC_String &  pkText,
CGUICommandPtr  pCommandObject,
const ObjectHandle_t eID = NO_HANDLE 
)

CGUIIconButton constructor.

Parameters
pParentPointer to the designated parent object.
vXX-position relative to its parent object.
vYY-position relative to its parent object.
vWidthWidth of the button.
vHeightHeight of the button.
vXIconPosX-position of image relative this object.
vYIconPosY-position of image relative this object.
pkTextText string that will be displayed on the Button.
pCommandObjectPointer to command object, which will be executed in reaction to a click.
eIDObject Identifier of this button (choose NO_HANDLE if none is required).

◆ CGUIIconButton() [2/5]

CGUIIconButton::CGUIIconButton ( CGUICompositeObject *const  pParent,
const CGUIRect kRect,
const eC_Value &  vXIconPos,
const eC_Value &  vYIconPos,
const eC_String &  rkText,
CGUICommandPtr  pCommandObject,
const ObjectHandle_t eID = NO_HANDLE 
)

CGUIIconButton constructor.

Parameters
pParentPointer to the designated parent object.
kRectdimensions of object with respect to parent object.
vXIconPosX-position of image relative this object.
vYIconPosY-position of image relative this object.
rkTextText string that will be displayed on the Button.
pCommandObjectPointer to command object, which will be executed in reaction to a click.
eIDObject Identifier of this button (choose NO_HANDLE if none is required).

◆ CGUIIconButton() [3/5]

CGUIIconButton::CGUIIconButton ( CGUICompositeObject *const  pParent,
const eC_Value &  vX,
const eC_Value &  vY,
const eC_Value &  vWidth,
const eC_Value &  vHeight,
const eC_Value &  vXIconPos,
const eC_Value &  vYIconPos,
const TextResource_t eTextID,
CGUICommandPtr  pCommandObject,
const ObjectHandle_t eID = NO_HANDLE 
)

CGUIIconButton constructor.

Parameters
pParentPointer to the designated parent object.
vXX-position relative to its parent object.
vYY-position relative to its parent object.
vWidthWidth of the button.
vHeightHeight of the button.
vXIconPosX-position of image relative this object.
vYIconPosY-position of image relative this object.
eTextIDID of text string to be displayed on the Button.
pCommandObjectPointer to command object, which will be executed in reaction to a click.
eIDObject Identifier of this button (choose NO_HANDLE if none is required).

◆ CGUIIconButton() [4/5]

CGUIIconButton::CGUIIconButton ( CGUICompositeObject *const  pParent,
const CGUIRect kRect,
const eC_Value &  vXIconPos,
const eC_Value &  vYIconPos,
const TextResource_t eTextID,
CGUICommandPtr  pCommandObject,
const ObjectHandle_t eID = NO_HANDLE 
)

CGUIIconButton constructor.

Parameters
pParentPointer to the designated parent object.
kRectdimensions of object with respect to parent object.
vXIconPosX-position of image relative this object.
vYIconPosY-position of image relative this object.
eTextIDID of text string to be displayed on the Button.
pCommandObjectPointer to command object, which will be executed in reaction to a click.
eIDObject Identifier of this button (choose NO_HANDLE if none is required).

◆ CGUIIconButton() [5/5]

CGUIIconButton::CGUIIconButton ( const CGUIIconButton kSource)

Copy-constructor of the CGUIProgressBar class.

Parameters
kSourceSource object to be copied.

Member Function Documentation

◆ DoDraw()

eC_Bool CGUIIconButton::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 CGUIButton.

Reimplemented in CGUIMenuItem.

◆ GetIconAlpha()

eC_UByte CGUIIconButton::GetIconAlpha ( )
inline

Gets the transparency, which is used for the icon blit in all button states.

Returns
The alpha value which is used for the icon blit.

◆ GetIconImages()

void CGUIIconButton::GetIconImages ( ImageResource_t eIconNormal,
ImageResource_t eIconPressed,
ImageResource_t eIconHighlighted,
ImageResource_t eIconGrayedOut,
ImageResource_t eIconFocussed 
) const
inline

Function to get icons of the controls.

Parameters
eIconFocussedImage of the icon when button is in Focussed state.
eIconHighlightedImage of the icon when button is in Highlighted state.
eIconPressedImage of the icon when button is in Pressed state.
eIconNormalImage of the icon when button is in Normal state.
eIconGrayedOutImage of the icon when button is in Gryed-Out state.

◆ GetIconPos()

void CGUIIconButton::GetIconPos ( eC_Value &  vIconPosX,
eC_Value &  vIconPosY 
) const

Returns the position of the icon.

Parameters
[out]vIconPosXX Position of icon relative to control.
[out]vIconPosYY Position of icon relative to control.

◆ operator=()

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

Operator= method of the CGUIProgressBar class.

Parameters
kSourceSource object to be copied.
Returns
Copied object.

◆ ReadFromStream()

void CGUIIconButton::ReadFromStream ( )
protectedvirtual

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

Reimplemented in CGUIMenuItem.

◆ SetIconAlpha()

void CGUIIconButton::SetIconAlpha ( const eC_UByte  ubIconAlpha)
inline

Sets the transparency, which is used for the icon blit in all button states.

Parameters
[in]ubIconAlphaThe alpha value to use.

◆ SetIconImages()

void CGUIIconButton::SetIconImages ( const ImageResource_t  eIconNormal,
const ImageResource_t  eIconPressed,
const ImageResource_t  eIconHighlighted,
const ImageResource_t  eIconGrayedOut,
const ImageResource_t  eIconFocussed 
)

Function to set icons of the controls.

Parameters
eIconFocussedImage of the icon when button is in Focussed state.
eIconHighlightedImage of the icon when button is in Highlighted state.
eIconPressedImage of the icon when button is in Pressed state.
eIconNormalImage of the icon when button is in Normal state.
eIconGrayedOutImage of the icon when button is in Gryed-Out state.

◆ SetIconPos()

void CGUIIconButton::SetIconPos ( const eC_Value &  vIconPosX,
const eC_Value &  vIconPosY 
)

Function to set position of icon inside the control.

Parameters
vIconPosXX Position of icon relative to control.
vIconPosYY Position of icon relative to control.

◆ WriteToStream()

void CGUIIconButton::WriteToStream ( const eC_Bool  bWriteClassID = false)
protectedvirtual

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

Reimplemented in CGUIMenuItem.

Member Data Documentation

◆ m_eIconFocussed

ImageResource_t CGUIIconButton::m_eIconFocussed
protected

m_eIconFocussed is used to draw the icon when icon is in Focussed state.

See also
SetIconImages function

◆ m_eIconGrayedOut

ImageResource_t CGUIIconButton::m_eIconGrayedOut
protected

m_eIconGrayedOut is used to draw the icon when icon is in Grayed-Out state.

See also
SetIconImages function

◆ m_eIconHighlighted

ImageResource_t CGUIIconButton::m_eIconHighlighted
protected

m_eIconHighlighted is used to draw the icon when icon is in Highlighted state.

See also
SetIconImages function

◆ m_eIconNormal

ImageResource_t CGUIIconButton::m_eIconNormal
protected

m_eIconNormal is used to draw the icon when icon is in Normal state.

See also
SetIconImages function

◆ m_eIconPressed

ImageResource_t CGUIIconButton::m_eIconPressed
protected

m_eIconPressed is used to draw the icon when icon is in Pressed state.

See also
SetIconImages function

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