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

#include <GUITabContainer.h>

Inheritance diagram for CGUITabContainer:

Public Member Functions

 CGUITabContainer ()
 
 CGUITabContainer (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)
 
 CGUITabContainer (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
 
virtual ~CGUITabContainer ()
 This destructor is automatically virtual, as the base class destructor is virtual.
 
virtual eC_Bool AddObject (CGUITabItem *pkTabItem)
 
virtual eC_Bool AddObject (CGUIObject *pkObject)
 
eC_Bool GetButtonAutoSize () const
 
void GetButtonImages (ImageResource_t &eImageNotSelectedStandard, ImageResource_t &eImageNotSelectedHighlighted, ImageResource_t &eImageNotSelectedPressed, ImageResource_t &eImageNotSelectedFocussed, ImageResource_t &eImageNotSelectedGrayedOut, ImageResource_t &eImageSelectedStandard, ImageResource_t &eImageSelectedHighlighted, ImageResource_t &eImageSelectedPressed, ImageResource_t &eImageSelectedFocussed, ImageResource_t &eImageSelectedGrayedOut)
 
void GetButtonMaxSize (eC_Value &vWidth, eC_Value &vHeight) const
 
CGUICommonEnums::Alignment_t GetButtonPosition () const
 
void GetButtonSize (eC_Value &vWidth, eC_Value &vHeight) const
 
void GetButtonTextColor (ColorValue_t &kColorStandard, ColorValue_t &kColorHighlighted, ColorValue_t &kColorPressed, ColorValue_t &kColorGrayedOut)
 
eC_Bool GetCenterButtons () const
 
CGUITabClientAreaGetClientArea ()
 
eC_UInt GetCurrentTabIndex () const
 
FontResource_t GetFontID () const
 
CGUINinePatchGetNinePatch ()
 
eC_UInt GetNumberOfTabs () const
 
virtual void ReadFromStream ()
 
void RefreshButtons ()
 
virtual void RemoveObject (CGUIObject *pkObject)
 
void SetButtonAutoSize (const eC_Bool &bButtonAutoSize)
 
void SetButtonImages (const ImageResource_t &eImageNotSelectedStandard, const ImageResource_t &eImageNotSelectedHighlighted, const ImageResource_t &eImageNotSelectedPressed, const ImageResource_t &eImageNotSelectedFocussed, const ImageResource_t &eImageNotSelectedGrayedOut, const ImageResource_t &eImageSelectedStandard, const ImageResource_t &eImageSelectedHighlighted, const ImageResource_t &eImageSelectedPressed, const ImageResource_t &eImageSelectedFocussed, const ImageResource_t &eImageSelectedGrayedOut)
 
void SetButtonMaxSize (const eC_Value &vWidth, const eC_Value &vHeight)
 
void SetButtonPosition (const CGUICommonEnums::Alignment_t &eTabButtonPosition)
 
void SetButtonSize (const eC_Value &vWidth, const eC_Value &vHeight)
 
void SetButtonTextColor (const ColorValue_t &kColorStandard, const ColorValue_t &kColorHighlighted, const ColorValue_t &kColorPressed, const ColorValue_t &kColorGrayedOut)
 
void SetCenterButtons (const eC_Bool &bCenterButtons)
 
void SetCurrentTabIndex (const eC_UInt &uiIndex)
 
void SetFontID (const FontResource_t &eFontID)
 
virtual void SetHeight (const eC_Value &vY)
 
virtual void SetWidth (const eC_Value &vX)
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUICompositeObject
 CGUICompositeObject ()
 
 CGUICompositeObject (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)
 
 CGUICompositeObject (CGUICompositeObject *const pParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUICompositeObject (const CGUICompositeObject &kSource)
 
virtual ~CGUICompositeObject ()
 This destructor is automatically virtual, as the base class destructor is virtual.
 
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 CGUIObjectFindObject (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)
 
const CGUIObjectGetAndCheckObjectByID (ObjectHandle_t eObjID, const eC_String &kObjectName) const
 
CGUIObjectGetAndCheckObjectByID (ObjectHandle_t eObjID, const eC_String &kObjectName)
 
CGUIObjectGetChild (const eC_UInt uIndex) const
 
CGUIObjectGetChild (const eC_UInt uIndex)
 
const ObjectPtrListGetChildObjectsList () const
 
const ObjectPtrListGetDrawOrderList () const
 
eC_Int GetIndexOfChild (const CGUIObject *pkObject) const
 
eC_UInt GetNumberOfChildren () const
 
CGUIObjectGetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false)
 
const CGUIObjectGetObjectByID (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)
 
CGUICompositeObjectoperator= (const CGUICompositeObject &kSource)
 
eC_Bool RaiseOneLevel (const CGUIObject *pkObject)
 
virtual void RefreshLayout (CGUILayouter::eMovedEdges_t eMovedEdges) const
 
void RemoveAllChildren ()
 
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 SetInvisible (const eC_Bool &bInvisible)
 
virtual void SetInvisible (const eC_Bool &bInvisible, const eC_Bool &bChildrenInvisible)
 
- 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 DoDraw ()
 
virtual eC_Bool DoDrawSnapshot ()
 
virtual void EnableSnapshotDrawing ()
 
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
 
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)
 
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)
 
void SetID (const ObjectHandle_t &eID)
 
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 (const CGUIValue &rkValue)
 
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 DoClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
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 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 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 ()
 

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 [] = "Children"
 XML comment tag to be used before writing children to a stream.
 
static const eC_Char XMLTAG_ENDCHILDREN [] = "/Children"
 XML comment tag to be used after writing children to a stream.
 
- 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"
 
- Protected Member Functions inherited from CGUICompositeObject
virtual eC_Bool FourWayNext (FourWayFocus_t eFocusDirection)
 
ObjectPtrListGetChildObjectsList ()
 
virtual void HandleDraw (const CGUIRect &ClipRect)
 
- Protected Member Functions inherited from CGUIObject
virtual eC_Bool CreateBitmapPlane ()
 
- 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
 

Detailed Description

tab_container.png
The Tab-Container can be used to group together various child-elements where only one child will be displayed at a time. This can be used to create tabbed dialogs containing settings for the application or to create sub-pages in a dialog to save up space and group them into logical units.

This container will help grouping elements into to sub-groups while only one group will be displayed and the others can be switched. Each child-element is a CGUITabItem and will be inserted into the clientarea of the tab-container. The placement and sizes of the buttons can globally set as well as the images and font used for the buttons. Each CGUITabItem has a text-attribute which will be displayed on its corresponding tab-button.

Constructor & Destructor Documentation

◆ CGUITabContainer() [1/3]

CGUITabContainer::CGUITabContainer ( )

CGUICompositeObject standard constructor.

See also
CGUIObject().

◆ CGUITabContainer() [2/3]

CGUITabContainer::CGUITabContainer ( 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 constructor.

Parameters
pkParentPointer to the designated parent object.
vXX-position relative to its parent object
vYY-position relative to its parent object
vWidthWidth of the composite object
vHeightHeight of the composite object
eIDObject Identifier of this composite object (choose NO_HANDLE if none is required)

◆ CGUITabContainer() [3/3]

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

CGUICompositeObject constructor.

Parameters
pkParentPointer to the designated parent object.
kRectBounding rectangle relative to parent.
eIDObject Identifier of this composite object (choose NO_HANDLE if none is required)

Member Function Documentation

◆ AddObject() [1/2]

eC_Bool CGUITabContainer::AddObject ( CGUITabItem pkTabItem)
virtual

add a new TabItem to the Container

Parameters
pkTabItemTabItem to insert
Returns
true if successful, else false

◆ AddObject() [2/2]

eC_Bool CGUITabContainer::AddObject ( CGUIObject pkObject)
virtual

add a new object to the Container

Parameters
pkObjectobject to insert
Returns
true if successful, else false

Reimplemented from CGUICompositeObject.

◆ GetButtonAutoSize()

eC_Bool CGUITabContainer::GetButtonAutoSize ( ) const

check if auto-size is active

Returns
true if active

◆ GetButtonImages()

void CGUITabContainer::GetButtonImages ( ImageResource_t eImageNotSelectedStandard,
ImageResource_t eImageNotSelectedHighlighted,
ImageResource_t eImageNotSelectedPressed,
ImageResource_t eImageNotSelectedFocussed,
ImageResource_t eImageNotSelectedGrayedOut,
ImageResource_t eImageSelectedStandard,
ImageResource_t eImageSelectedHighlighted,
ImageResource_t eImageSelectedPressed,
ImageResource_t eImageSelectedFocussed,
ImageResource_t eImageSelectedGrayedOut 
)

get images for buttons in the buttonbox

Parameters
eImageNotSelectedStandardimage if not selected
eImageNotSelectedHighlightedimage if not selected
eImageNotSelectedPressedimage if not selected
eImageNotSelectedFocussedimage if not selected
eImageNotSelectedGrayedOutimage if not selected
eImageSelectedStandardimage if selected
eImageSelectedHighlightedimage if selected
eImageSelectedPressedimage if selected
eImageSelectedFocussedimage if selected
eImageSelectedGrayedOutimage if grayed out

◆ GetButtonMaxSize()

void CGUITabContainer::GetButtonMaxSize ( eC_Value &  vWidth,
eC_Value &  vHeight 
) const

get maximum sizes for buttons for auto-size

Parameters
vWidth
vHeight

◆ GetButtonPosition()

CGUICommonEnums::Alignment_t CGUITabContainer::GetButtonPosition ( ) const

Get the the position of the buttonbox

Returns
position

◆ GetButtonSize()

void CGUITabContainer::GetButtonSize ( eC_Value &  vWidth,
eC_Value &  vHeight 
) const

Get sizes for buttons

Parameters
vWidth
vHeight

◆ GetButtonTextColor()

void CGUITabContainer::GetButtonTextColor ( ColorValue_t kColorStandard,
ColorValue_t kColorHighlighted,
ColorValue_t kColorPressed,
ColorValue_t kColorGrayedOut 
)

get the text-colors for tab-buttons

Parameters
kColorStandardtext-color for standard
kColorHighlightedtext-color for highlighted
kColorPressedtext-color for pressed
kColorGrayedOuttext-color for grayed out

◆ GetCenterButtons()

eC_Bool CGUITabContainer::GetCenterButtons ( ) const

get if buttons are centered

Returns
true if centered

◆ GetClientArea()

CGUITabClientArea * CGUITabContainer::GetClientArea ( )

Returns a pointer to the client-area of the TabContainer

Returns
pointer to client-area

◆ GetCurrentTabIndex()

eC_UInt CGUITabContainer::GetCurrentTabIndex ( ) const

Get the index of currently visible tab

Returns
index

◆ GetFontID()

FontResource_t CGUITabContainer::GetFontID ( ) const

get the font-id used for the tab-buttons

Returns
font-id

◆ GetNinePatch()

CGUINinePatch & CGUITabContainer::GetNinePatch ( )

Return the nine-patch used for images

Returns
nine-patch

◆ GetNumberOfTabs()

eC_UInt CGUITabContainer::GetNumberOfTabs ( ) const

Get the number of total tabs in container

Returns
number of tabs

◆ ReadFromStream()

void CGUITabContainer::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
CGUIStreamingControlExceptionWhen 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.

◆ RefreshButtons()

void CGUITabContainer::RefreshButtons ( )

Refresh layout of buttons

◆ RemoveObject()

void CGUITabContainer::RemoveObject ( CGUIObject pkObject)
virtual

Removes an object from the list of child objects. This will not delete the object! If you wish to physically delete an object, you should use the C++ delete operator. The destructor of the object will then remove the object from the child list by calling this method.

Parameters
pkObjectThe object to be removed

Reimplemented from CGUICompositeObject.

◆ SetButtonAutoSize()

void CGUITabContainer::SetButtonAutoSize ( const eC_Bool &  bButtonAutoSize)

set auto-size active

Parameters
bButtonAutoSize

◆ SetButtonImages()

void CGUITabContainer::SetButtonImages ( const ImageResource_t eImageNotSelectedStandard,
const ImageResource_t eImageNotSelectedHighlighted,
const ImageResource_t eImageNotSelectedPressed,
const ImageResource_t eImageNotSelectedFocussed,
const ImageResource_t eImageNotSelectedGrayedOut,
const ImageResource_t eImageSelectedStandard,
const ImageResource_t eImageSelectedHighlighted,
const ImageResource_t eImageSelectedPressed,
const ImageResource_t eImageSelectedFocussed,
const ImageResource_t eImageSelectedGrayedOut 
)

set images for buttons in the buttonbox

Parameters
eImageNotSelectedStandardimage if not selected
eImageNotSelectedHighlightedimage if not selected
eImageNotSelectedPressedimage if not selected
eImageNotSelectedFocussedimage if not selected
eImageNotSelectedGrayedOutimage if not selected
eImageSelectedStandardimage if selected
eImageSelectedHighlightedimage if selected
eImageSelectedPressedimage if selected
eImageSelectedFocussedimage if selected
eImageSelectedGrayedOutimage if grayed out

◆ SetButtonMaxSize()

void CGUITabContainer::SetButtonMaxSize ( const eC_Value &  vWidth,
const eC_Value &  vHeight 
)

sets maximum sizes for buttons when auto-size is active

Parameters
vWidth
vHeight

◆ SetButtonPosition()

void CGUITabContainer::SetButtonPosition ( const CGUICommonEnums::Alignment_t eTabButtonPosition)

Sets position of the buttonbox

Parameters
eTabButtonPositionposition of buttonbox

◆ SetButtonSize()

void CGUITabContainer::SetButtonSize ( const eC_Value &  vWidth,
const eC_Value &  vHeight 
)

sets sizes for buttons when auto-size is not active

Parameters
vWidth
vHeight

◆ SetButtonTextColor()

void CGUITabContainer::SetButtonTextColor ( const ColorValue_t kColorStandard,
const ColorValue_t kColorHighlighted,
const ColorValue_t kColorPressed,
const ColorValue_t kColorGrayedOut 
)

set the text-colors for tab-buttons

Parameters
kColorStandardtext-color for standard
kColorHighlightedtext-color for highlighted
kColorPressedtext-color for pressed
kColorGrayedOuttext-color for grayed out

◆ SetCenterButtons()

void CGUITabContainer::SetCenterButtons ( const eC_Bool &  bCenterButtons)

set center buttons

Parameters
bCenterButtonsif true the buttons are centered according to the currently set alignment

◆ SetCurrentTabIndex()

void CGUITabContainer::SetCurrentTabIndex ( const eC_UInt &  uiIndex)

Set the current active tab-index

Parameters
uiIndexindex of tab

◆ SetFontID()

void CGUITabContainer::SetFontID ( const FontResource_t eFontID)

set the font-id used for the tab-buttons

Parameters
eFontIDfont-id

◆ SetHeight()

void CGUITabContainer::SetHeight ( const eC_Value &  vY)
virtual

Overridden SetHeight method. A composite object will call DoLayout() on itself when its width/height is changed if its associated layouter is independent of the parent's size. Afterwards in any case its direct children's DoLayout() of their layouters are called.

Parameters
vYThe new height

Reimplemented from CGUICompositeObject.

◆ SetWidth()

void CGUITabContainer::SetWidth ( const eC_Value &  vX)
virtual

Overridden SetWidth method. A composite object will call DoLayout() on itself when its width/height is changed if its associated layouter is independent of the parent's size. Afterwards in any case its direct children's DoLayout() of their layouters are called.

Parameters
vXThe new width

Reimplemented from CGUICompositeObject.

◆ WriteToStream()

void CGUITabContainer::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 CGUICompositeObject.


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