CGUILayerContainer Class Reference

#include <GUILayerContainer.h>

Inheritance diagram for CGUILayerContainer:

Public Member Functions
	CGUILayerContainer ()
	CGUILayerContainer (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
	CGUILayerContainer (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)
virtual	~CGUILayerContainer ()
virtual eC_Bool	DoDraw ()
virtual eC_Bool	DoPostDraw ()
eC_Bool	GetApplyClipping () const
eC_UInt	GetLayerID () const
eC_Bool	GetUserContent () const
virtual void	HandleDraw (const CGUIRect &kClipRect)
virtual void	ReadFromStream ()
void	SetApplyClipping (const eC_Bool &bApplyClipping)
virtual void	SetInvisible (const eC_Bool &bInvisible)
void	SetLayerID (const eC_UInt &uiLayerID)
void	SetUserContent (const eC_Bool &bUserContent)
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 (const 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 (const CGUIObject *pkObject)
CGUICompositeObject &	operator= (const CGUICompositeObject &kSource)
eC_Bool	RaiseOneLevel (const 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 (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	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
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	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
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 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_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 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

Detailed Description

This container-control enables the user to define and access layers and use them for different purposes. Its functionality depends on the presence and configuration of a DC-Wrapper. If no DC-Wrapper is currently active, this control will behave like a normal CGUICompositeObject and will not be able to display user-content.

It can be used e.g. to display inputs from different sources directly on the screen without the need of Guiliani to know how to handle the data. Data from camera-inputs can be used as well as generated image-data from the application.

When activating the attribute "UserContent" Guiliani does not alter the contents of the container and expects the application to update and maintain the contents. The DC-Wrapper is only told to refresh the respective layer on user behalf.

The attribute "LayerID" is a virtual identification which needs to correspond to the layer-configuration of the layer contained in the DC-Wrapper

See also

CDCWrap()

It is possible to create complex layer-structures containing multiple layers containing both Guiliani-content and user-controlled content. A possible scenario would be having a dialog containing Guiliani-controls with a placeholder for a stream of video-data and on top of this another container with buttons (coming from Guiliani) to control this data.

+---------------------------+
|0G                         |
|      +-------------+      |
|      |1U           |      |
|      |             |      |
|      |             |      |
|      +-------------+      |
|      |2G           |      |
|      +-------------+      |
+---------------------------+

The numbers in the upper-left corner represent the ID for the layers, the following letter if this layer is controlled by Guiliani (G) or the user (U).

Constructor & Destructor Documentation

CGUILayerContainer() [1/3]

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

CGUILayerContainer 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.
eID	Object Identifier of this composite object.

CGUILayerContainer() [2/3]

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

CGUILayerContainer constructor.

Parameters

pkParent	Pointer to the designated parent object.
kRect	Size and position relative to parent.
eID	Object Identifier of this composite object.

~CGUILayerContainer()

virtual CGUILayerContainer::~CGUILayerContainer ( )

virtual

CGUILayerContainer destructor.

CGUILayerContainer() [3/3]

CGUILayerContainer::CGUILayerContainer

(

)

Standard constructor.

See also

CGUIObject().

Member Function Documentation

DoDraw()

virtual eC_Bool CGUILayerContainer::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 CGUIObject.

DoPostDraw()

virtual eC_Bool CGUILayerContainer::DoPostDraw ( )

virtual

This slot may be implemented by derived classes to add visualization code which is executed after any child object have been drawn. Unlike DoDraw, which is being called BEFORE any children are being drawn, this method will be automatically called by the framework AFTER all children have been drawn.

Returns

True if anything was drawn, False otherwise

Reimplemented from CGUICompositeObject.

GetApplyClipping()

eC_Bool CGUILayerContainer::GetApplyClipping

(

)

const

Returns if clipping is currently used

Returns

true if clipping is used, otherwise false

GetLayerID()

eC_UInt CGUILayerContainer::GetLayerID

(

)

const

Returns the currently used layer-id

Returns

layer-id

GetUserContent()

eC_Bool CGUILayerContainer::GetUserContent

(

)

const

Returns if user-content is currently displayed

Returns

true if user-content is present, otherwise false

HandleDraw()

virtual void CGUILayerContainer::HandleDraw ( const CGUIRect &  ClipRect )

virtual

This method visualizes this object and the objects it contains (child objects). Internally this does all necessary clipping and checking against the currently invalidated region. Note that erroneous overriding of this method may result in corrupted graphical output of the GUI.

Parameters

ClipRect

The clipping rectangle

Reimplemented from CGUICompositeObject.

ReadFromStream()

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

SetApplyClipping()

void CGUILayerContainer::SetApplyClipping

(

const eC_Bool &

bApplyClipping

)

Sets if the container should apply clipping when included inside another layer-container

Parameters

bApplyClipping

SetInvisible()

virtual void CGUILayerContainer::SetInvisible ( const eC_Bool &  bInvisible )

virtual

Set only this composite object invisible or visible. This method simply calls the base implementation CGUIObject::SetInvisible(). If you also want to set the children's visibility, use SetInvisible(const eC_Bool&, const eC_Bool&) instead.

Parameters

bInvisible

The new visibility state of this composite object.

See also

SetInvisible(const eC_Bool&, const eC_Bool&)

Reimplemented from CGUICompositeObject.

SetLayerID()

void CGUILayerContainer::SetLayerID

(

const eC_UInt &

uiLayerID

)

Set the layer-id which should be used

Parameters

uiLayerID

layer-id

SetUserContent()

void CGUILayerContainer::SetUserContent

(

const eC_Bool &

bUserContent

)

Sets if the container is used to display user-content

Parameters

bUserContent

WriteToStream()

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

• GUILayerContainer.h