CGUIExpandingComposite Class Reference

#include <GUIExpandingComposite.h>

Inheritance diagram for CGUIExpandingComposite:

Public Member Functions
	CGUIExpandingComposite ()
	CGUIExpandingComposite (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const eC_String &kHeadline="Headline", const ObjectHandle_t &eID=NO_HANDLE)
	CGUIExpandingComposite (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_String &kHeadline="Headline", const ObjectHandle_t &eID=NO_HANDLE)
virtual	~CGUIExpandingComposite ()
	This destructor is automatically virtual, as the base class destructor is virtual.
eC_Bool	AddObject (CGUIObject *pkObject)
void	AdjustContainer ()
virtual void	DoAnimate (const eC_Value &vTimes=eC_FromInt(1))
void	Expand ()
eC_Bool	GetAnimated () const
void	GetAnimationDuration (eC_UInt &uiDurationCollapse, eC_UInt &uiDurationExpand) const
CGUIRepositionCompositeObject *	GetContainer () const
CGUICheckBox *	GetExpandButton () const
FontResource_t	GetFontID () const
eC_String	GetHeadline () const
void	GetImages (ImageResource_t &eImageCollapsed, ImageResource_t &eImageExpanded) const
eC_Bool	IsExpanded () const
virtual void	ReadFromStream ()
void	SetAnimated (const eC_Bool &bAnimated)
void	SetAnimationDuration (const eC_UInt &uiDurationCollapse, const eC_UInt &uiDurationExpand)
void	SetFontID (const FontResource_t &eFontID)
void	SetHeadline (const eC_String &kHeadline)
virtual void	SetHeight (const eC_Value &vY)
void	SetImages (const ImageResource_t &eImageCollapsed, const ImageResource_t &eImageExpanded)
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 pkParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
	CGUICompositeObject (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 (const CGUICompositeObject &kSource)
virtual	~CGUICompositeObject ()
	This destructor is automatically virtual, as the base class destructor is virtual.
virtual eC_Bool	AddObject (CGUIObject *pkObject)
eC_Bool	BringToFront (CGUIObject *pkObject)
eC_Bool	CanBeCyclicFocussed () const
virtual eC_Bool	DoPostDraw ()
void	DrawOnTop (CGUIObject *pkObject)
void	DrawOnTopOf (CGUIObject *const pkObject, CGUIObject *const pDrawOnTopOf)
virtual CGUIObject *	FindObject (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)
CGUIObject *	GetAndCheckObjectByID (ObjectHandle_t eObjID, const eC_String &kObjectName)
const CGUIObject *	GetAndCheckObjectByID (ObjectHandle_t eObjID, const eC_String &kObjectName) const
CGUIObject *	GetChild (const eC_UInt uIndex)
CGUIObject *	GetChild (const eC_UInt uIndex) const
const ObjectPtrList &	GetChildObjectsList () const
const ObjectPtrList &	GetDrawOrderList () const
eC_Int	GetIndexOfChild (const CGUIObject *pkObject) const
eC_UInt	GetNumberOfChildren () 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
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 (CGUIObject *pkObject)
CGUICompositeObject &	operator= (const CGUICompositeObject &kSource)
eC_Bool	RaiseOneLevel (CGUIObject *pkObject)
virtual void	ReadFromStream ()
virtual void	RefreshLayout (CGUILayouter::eMovedEdges_t eMovedEdges) const
void	RemoveAllChildren ()
virtual void	RemoveObject (CGUIObject *pkObject)
void	Rotate (const eC_UInt &ruiDegrees, const eC_Bool &rbFirst=false)
eC_Bool	SendToBack (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	SetHeight (const eC_Value &vY)
virtual void	SetInvisible (const eC_Bool &bInvisible)
virtual void	SetInvisible (const eC_Bool &bInvisible, const eC_Bool &bChildrenInvisible)
virtual void	SetWidth (const eC_Value &vX)
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
UUID_t	GetUUID () 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)
void	SetUUID (const UUID_t &kUUID)
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	DoScale (const eC_Value &vDelta)
virtual eC_Bool	DoUserEvent (CGUIEvent *const pEvent)
virtual void	OnCreate ()
virtual void	OnDataPool (const DataPoolResource_t &eID)
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	DoScroll (const eC_Value &vAbsX, const eC_Value &vAbsY, const eC_Value &vDelta, const eC_Bool &bModifierActive)
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 CGUIObject
enum	FourWayFocus_t { FOCUS_LEFT , FOCUS_RIGHT , FOCUS_UP , FOCUS_DOWN }
Static Public Member Functions inherited from CGUIStreamableObject
static UUID_t	GenerateUUID ()
Static Public Attributes inherited from CGUICompositeObject
static const eC_Char	XMLTAG_CHILDREN []
	XML comment tag to be used before writing children to a stream.
static const eC_Char	XMLTAG_ENDCHILDREN []
	XML comment tag to be used after writing children to a stream.
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_UUID []
	XML tag to be used when writing a UUID 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 const eC_Char	XMLTAG_BEHAVIOURCOUNT []
	XML tag for count.
Static Public Attributes inherited from CGUIStreamableObject
static const eC_Char	XMLTAG_CLASSVERSION []
Protected Member Functions inherited from CGUICompositeObject
virtual eC_Bool	FourWayNext (FourWayFocus_t eFocusDirection)
ObjectPtrList &	GetChildObjectsList ()
virtual void	HandleDraw (const CGUIRect &ClipRect)
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 CGUIObject
UUID_t	m_kUUID
	UUID of object.

Detailed Description

A CGUIExpandingComposite is a container which can expand/collapse via a click-event on its group-heading. This can be used to save space when different groups with many child-elements are displayed.

Constructor & Destructor Documentation

CGUIExpandingComposite() [1/3]

CGUIExpandingComposite::CGUIExpandingComposite

(

)

CGUICompositeObject standard constructor.

See also

CGUIObject().

CGUIExpandingComposite() [2/3]

CGUIExpandingComposite::CGUIExpandingComposite	(	CGUICompositeObject *const	pkParent,
		const eC_Value &	vX,
		const eC_Value &	vY,
		const eC_Value &	vWidth,
		const eC_Value &	vHeight,
		const eC_String &	kHeadline = "Headline",
		const ObjectHandle_t &	eID = NO_HANDLE
	)

CGUICompositeObject constructor.

Parameters

pkParent	Pointer to the designated parent object.
vX	X-position relative to its parent object
vY	Y-position relative to its parent object
vWidth	Width of the composite object
vHeight	Height of the composite object
kHeadline	Text to be displayed in the group-heading
eID	Object Identifier of this composite object (choose NO_HANDLE if none is required)

CGUIExpandingComposite() [3/3]

CGUIExpandingComposite::CGUIExpandingComposite	(	CGUICompositeObject *const	pkParent,
		const CGUIRect &	kRect,
		const eC_String &	kHeadline = "Headline",
		const ObjectHandle_t &	eID = NO_HANDLE
	)

CGUICompositeObject constructor.

Parameters

pkParent	Pointer to the designated parent object.
kRect	Bounding rectangle relative to parent.
kHeadline	Text to be displayed in the group-heading
eID	Object Identifier of this composite object (choose NO_HANDLE if none is required)

Member Function Documentation

AddObject()

eC_Bool CGUIExpandingComposite::AddObject ( CGUIObject *  pkObject )

virtual

Add a new object to the container. This method is overridden, since new objects should be inserted into the client-area

Parameters

pkObject

object to add

Returns

true if successful, else false

Reimplemented from CGUICompositeObject.

AdjustContainer()

void CGUIExpandingComposite::AdjustContainer

(

)

adjust the container size if visibility of elements have changed

DoAnimate()

virtual void CGUIExpandingComposite::DoAnimate ( const eC_Value &  vTimes = eC_FromInt(1) )

virtual

Called when the timer of an animation callback belonging to this animatable has expired.

Parameters

vTimes

The factor of the registered callback time in relation to the actually elapsed time. For example, the elapsed time is 80ms, and the standard time is 50ms, then vTimes is 1.6. If the given time in GETTIMER.AddAnimationCallback is 0, It will be set to -1.

Reimplemented from CGUIAnimatable.

Expand()

void CGUIExpandingComposite::Expand

(

)

Expand the container

GetAnimated()

eC_Bool CGUIExpandingComposite::GetAnimated

(

)

const

Return animated-state

Returns

true if animated

GetAnimationDuration()

void CGUIExpandingComposite::GetAnimationDuration	(	eC_UInt &	uiDurationCollapse,
		eC_UInt &	uiDurationExpand
	)		const

Get animation-duration

Parameters

uiDurationCollapse	duration for collapse in ms
uiDurationExpand	duration for expand in ms

GetContainer()

CGUIRepositionCompositeObject * CGUIExpandingComposite::GetContainer

(

)

const

Get the group-cotainer

Returns

pointer to the group-container

GetExpandButton()

CGUICheckBox * CGUIExpandingComposite::GetExpandButton

(

)

const

Get the group-heading (CGUICheckBox) to modify attributes

Returns

pointer to the group-heading

GetFontID()

FontResource_t CGUIExpandingComposite::GetFontID

(

)

const

Get font for headline

Returns

font-id

GetHeadline()

eC_String CGUIExpandingComposite::GetHeadline

(

)

const

Return headline

Returns

GetImages()

void CGUIExpandingComposite::GetImages	(	ImageResource_t &	eImageCollapsed,
		ImageResource_t &	eImageExpanded
	)		const

Get images for expand-button

Parameters

eImageCollapsed	collapsed image
eImageExpanded	expanded image

IsExpanded()

eC_Bool CGUIExpandingComposite::IsExpanded

(

)

const

Get the current expanded-state

Returns

true if expanded

ReadFromStream()

virtual void CGUIExpandingComposite::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

CGUIStreamingControlException

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

SetAnimated()

void CGUIExpandingComposite::SetAnimated

(

const eC_Bool &

bAnimated

)

Set if collapse/expand will be animated

Parameters

bAnimated

if true will animate

SetAnimationDuration()

void CGUIExpandingComposite::SetAnimationDuration	(	const eC_UInt &	uiDurationCollapse,
		const eC_UInt &	uiDurationExpand
	)

Set animation-duration

Parameters

uiDurationCollapse	duration for collapse in ms
uiDurationExpand	duration for expand in ms

SetFontID()

void CGUIExpandingComposite::SetFontID

(

const FontResource_t &

eFontID

)

Set font for headline

Parameters

eFontID

font-id

SetHeadline()

void CGUIExpandingComposite::SetHeadline

(

const eC_String &

kHeadline

)

Set string for the healdine

Parameters

kHeadline

SetHeight()

virtual void CGUIExpandingComposite::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

vY	The new height

Reimplemented from CGUICompositeObject.

SetImages()

void CGUIExpandingComposite::SetImages	(	const ImageResource_t &	eImageCollapsed,
		const ImageResource_t &	eImageExpanded
	)

Set images for expand-button

Parameters

eImageCollapsed	collapsed image
eImageExpanded	expanded image

SetWidth()

virtual void CGUIExpandingComposite::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

vX	The new width

Reimplemented from CGUICompositeObject.

WriteToStream()

virtual void CGUIExpandingComposite::WriteToStream ( const eC_Bool  bWriteClassID = false )

virtual

Writes all object attributes to the streaming file. StreamWriter has to be initialized. Only for use with GUIStreamWriter.

Parameters

bWriteClassID

This flag is used to select if writing of ControlID, leading and trailing tags is performed. Only GUIStreamWriter and GUICompositeObject have to set this flag true.

See also

CGUIStreamWriter

Reimplemented from CGUICompositeObject.

---

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

• GUIExpandingComposite.h