CGUISplitContainer Class Reference

#include <GUISplitContainer.h>

Inheritance diagram for CGUISplitContainer:

Public Member Functions
	CGUISplitContainer ()
	CGUISplitContainer (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
	CGUISplitContainer (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	~CGUISplitContainer ()
	This destructor is automatically virtual, as the base class destructor is virtual.
virtual eC_Bool	AddObject (CGUIObject *pkObject)
eC_Bool	AddObject (CGUIObject *pkObject, const eC_UInt &uiIndex)
void	CenterSplitterHandle ()
virtual eC_Bool	DoButtonDown (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoButtonUp (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoDoubleClick (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoDrag (const eC_Value &vDeltaX, const eC_Value &vDeltaY, const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoDragEnd (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoMouseEnter (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoMouseLeave (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoMouseMove (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoPostDraw ()
void	GetHandleColor (eC_UInt &uiColor, eC_UInt &uiColorHighlighted) const
eC_UInt	GetHandleEnlarge () const
void	GetHandleImage (ImageResource_t &eImage, ImageResource_t &eImageHighlighted) const
CGUICommonEnums::Orientation_t	GetHandleOrientation ()
eC_Value	GetHandlePosition ()
eC_Value	GetHandleSize ()
eC_Bool	IsInsideSplitter (const eC_Value &vAbsX, const eC_Value &vAbsY) const
virtual void	ReadFromStream ()
virtual void	RemoveObject (CGUIObject *pkObject)
void	SetHandleColor (const eC_UInt &uiColor, const eC_UInt &uiColorHighlighted)
void	SetHandleColor (const GlobalProperty_t &eColor, const GlobalProperty_t &eColorHighlighted)
void	SetHandleEnlarge (const eC_UInt &uiHandleEnlarge)
void	SetHandleImage (const ImageResource_t &eImage, const ImageResource_t &eImageHighlighted)
void	SetHandleOrientation (const CGUICommonEnums::Orientation_t &eOrientation)
void	SetHandlePosition (const eC_Value &vPosition)
void	SetHandleSize (const eC_Value &vSize)
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 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 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 CGUISplitContainer can be used to create container with two subsections and to arrange various controls. The dividing handle can either be horizontal or vertical. Even more complex divisions can be created by nesting CGUISplitContainer inside the client-area.

For best results the use of either Repositioning-CompositeObjects or Layouters is recommended, so that the children adapt to the changed size of their parent.

To move the dividing handle simply drag it to the new position. When double-clicking on the handle it will be moved to the middle of the container.

Constructor & Destructor Documentation

CGUISplitContainer() [1/3]

CGUISplitContainer::CGUISplitContainer

(

)

CGUICompositeObject standard constructor.

See also

CGUIObject().

CGUISplitContainer() [2/3]

CGUISplitContainer::CGUISplitContainer	(	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

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 (choose NO_HANDLE if none is required)

CGUISplitContainer() [3/3]

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

CGUICompositeObject constructor.

Parameters

pkParent	Pointer to the designated parent object.
kRect	Bounding rectangle relative to parent.
eID	Object Identifier of this composite object (choose NO_HANDLE if none is required)

Member Function Documentation

AddObject() [1/2]

virtual eC_Bool CGUISplitContainer::AddObject ( CGUIObject *  pkObject )

virtual

Add a new Object to the list of child objects. This will automatically set the child's parent-pointer to this object.

Parameters

pkObject

The object to be added

Returns

False if the object is already a child of this control or pkObject is NULL, otherwise true.

Reimplemented from CGUICompositeObject.

AddObject() [2/2]

eC_Bool CGUISplitContainer::AddObject	(	CGUIObject *	pkObject,
		const eC_UInt &	uiIndex
	)

Add object at specified index

Parameters

pkObject	object to add
uiIndex	target index inside container

Returns

true on success

CenterSplitterHandle()

void CGUISplitContainer::CenterSplitterHandle

(

)

centers the position of the handle after a doubleclick

DoButtonDown()

virtual eC_Bool CGUISplitContainer::DoButtonDown ( const eC_Value &  vAbsX, const eC_Value &  vAbsY  )

virtual

Called when the mouse button or finger is pressed down over an object.

Note

DoButtonDown() should work on the absolute positions of this object, that were set at the time of the passed redraw, as the user expects to click on what he sees and not to click on the object in a newer and probably intermediate state that he currently does not see in this state. Thus, to calculate the relative position (where the object was pressed relative to the origin of this object) from the vAbsY argument you must do it like this: vMyRelYPos = vAbsY - GetAbsYPos().

Parameters

vAbsX	X-position in screen coordinates where the click occurred
vAbsY	Y-position in screen coordinates where the click occurred

Returns

True The event has been handled.
False The event has not been handled. In this base implementation always returns False.

Reimplemented from CGUIBehaviour.

DoButtonUp()

virtual eC_Bool CGUISplitContainer::DoButtonUp ( const eC_Value &  vAbsX, const eC_Value &  vAbsY  )

virtual

Called when the mouse button or finger is released. The object under the mouse at the time of releasing will receive this event.

Note

DoButtonUp() should work on the absolute positions of this object, that were set at the time of the passed redraw, as the user expects to click on what he sees and not to click on an object in a newer and probably intermediate state that he currently does not see in this state. Thus, to calculate the relative position (where the button was released relative to the origin of this object) from the vAbsY argument you must do it like this: vMyRelYPos = vAbsY - GetAbsYPos().

Parameters

vAbsX	X-position in screen coordinates where the mouse was released.
vAbsY	Y-position in screen coordinates where the mouse was released.

Returns

True The event has been handled.
False The event has not been handled. In this base implementation always returns False.

Reimplemented from CGUIBehaviour.

DoDoubleClick()

virtual eC_Bool CGUISplitContainer::DoDoubleClick ( const eC_Value &  vAbsX, const eC_Value &  vAbsY  )

virtual

Called when an object is clicked twice within a given time span.

See also

CGUIEventHandler::SetDoubleClickTime()

Note

DoDoubleClick() should work on the absolute positions of this object, that were set at the time of the passed redraw, as the user expects to click on what he sees and not to click on the object in a newer and probably intermediate state that he currently does not see in this state. Thus, to calculate the relative position (where the two clicks were done relative to the origin of this object) from the vAbsY argument you must do it like this: vMyRelYPos = vAbsY - GetAbsYPos().

Parameters

vAbsX	X-position in screen coordinates where the click occurred
vAbsY	Y-position in screen coordinates where the click occurred

Returns

True The event has been handled.
False The event has not been handled. In this base implementation it always returns False.

Reimplemented from CGUIBehaviour.

DoDrag()

virtual eC_Bool CGUISplitContainer::DoDrag ( const eC_Value &  vDeltaX, const eC_Value &  vDeltaY, const eC_Value &  vAbsX, const eC_Value &  vAbsY  )

virtual

Called when the object receives a Drag event. Drags are typically created if the mouse is being used while a mouse-button is being pressed, or if the user moves his finger over a touchscreen.

Parameters

vDeltaX	relative movement in x-direction since the last call of DoDrag/ButtonDown
vDeltaY	relative movement in y-direction since the last call of DoDrag/ButtonDown
vAbsX	current X-position in screen coordinates of the mouse
vAbsY	current Y-position in screen coordinates of the mouse

Returns

True If the event has been handled.
false Else.

Reimplemented from CGUIBehaviour.

DoDragEnd()

virtual eC_Bool CGUISplitContainer::DoDragEnd ( const eC_Value &  vAbsX, const eC_Value &  vAbsY  )

virtual

Called on the dragged object (=the object on which the initial ButtonDown-event occurred) when the mouse button is released after a drag event.

Parameters

vAbsX	current X-position in screen coordinates of the mouse
vAbsY	current Y-position in screen coordinates of the mouse

Returns

True If the event has been handled.
false Else.

Reimplemented from CGUIBehaviour.

DoMouseEnter()

virtual eC_Bool CGUISplitContainer::DoMouseEnter ( const eC_Value &  vAbsX, const eC_Value &  vAbsY  )

virtual

Called when the mouse enters the area which is covered by an object. If several objects cover the same region, the topmost one receives the event. Objects will not receive DoMouseEnter events if they are not highlightable.

See also

CGUIObject::IsHighlightable()

Parameters

vAbsX	X-position in screen coordinates where the mouse entered the object
vAbsY	Y-position in screen coordinates where the mouse entered the object

Returns

True If the event has been handled.
false Else.

Reimplemented from CGUIBehaviour.

DoMouseLeave()

virtual eC_Bool CGUISplitContainer::DoMouseLeave ( const eC_Value &  vAbsX, const eC_Value &  vAbsY  )

virtual

Called when the mouse leaves the area which is covered by an object. Objects will not receive DoMouseLeave events if they are not highlightable.

See also

CGUIObject::IsHighlightable()

Parameters

vAbsX	X-position of the mouse in screen coordinates after it left the object
vAbsY	Y-position of the mouse in screen coordinates after it left the object

Returns

True If the event has been handled.
false Else.

Reimplemented from CGUIBehaviour.

DoMouseMove()

virtual eC_Bool CGUISplitContainer::DoMouseMove ( const eC_Value &  vAbsX, const eC_Value &  vAbsY  )

virtual

Called when the mouse is moved within the area covered by an object. If several objects cover the same region, the topmost one receives the event. Objects will not receive DoMouseEnter events if they are not highlightable.

See also

CGUIObject::IsHighlightable()

Parameters

vAbsX	X-position of the mouse in screen coordinates
vAbsY	Y-position of the mouse in screen coordinates

Returns

True If the event has been handled.
false Else.

Reimplemented from CGUIBehaviour.

DoPostDraw()

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

GetHandleColor()

void CGUISplitContainer::GetHandleColor	(	eC_UInt &	uiColor,
		eC_UInt &	uiColorHighlighted
	)		const

Get the currently set color for the handle

Parameters

uiColor	color for the handle
uiColorHighlighted	color for the handle if highlighted

GetHandleEnlarge()

eC_UInt CGUISplitContainer::GetHandleEnlarge

(

)

const

Get the enlargement for the splitter-handle

Returns

enlargement in pixel

GetHandleImage()

void CGUISplitContainer::GetHandleImage	(	ImageResource_t &	eImage,
		ImageResource_t &	eImageHighlighted
	)		const

Get the currently set image for the handle

Parameters

eImage	image for the handle
eImageHighlighted	image for the handle if highlighted

GetHandleOrientation()

CGUICommonEnums::Orientation_t CGUISplitContainer::GetHandleOrientation

(

)

get the orientation of the splitter-handle

Returns

orientation of the splitter-handle

GetHandlePosition()

eC_Value CGUISplitContainer::GetHandlePosition

(

)

get the position of the splitter-handle

Returns

position of the splitter-handle

GetHandleSize()

eC_Value CGUISplitContainer::GetHandleSize

(

)

get the size of the splitter-handle

Returns

size of the splitter-handle

IsInsideSplitter()

eC_Bool CGUISplitContainer::IsInsideSplitter	(	const eC_Value &	vAbsX,
		const eC_Value &	vAbsY
	)		const

return true if the given coordinates are inside the splitter area

Parameters

vAbsX
vAbsY

Returns

true if inside

ReadFromStream()

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

RemoveObject()

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

pkObject

The object to be removed

Reimplemented from CGUICompositeObject.

SetHandleColor() [1/2]

void CGUISplitContainer::SetHandleColor	(	const eC_UInt &	uiColor,
		const eC_UInt &	uiColorHighlighted
	)

Set the color for the handle using color-code

Parameters

uiColor	color for the handle
uiColorHighlighted	color for the handle if highlighted

SetHandleColor() [2/2]

void CGUISplitContainer::SetHandleColor	(	const GlobalProperty_t &	eColor,
		const GlobalProperty_t &	eColorHighlighted
	)

Set the color for the handle using property

Parameters

eColor	color-property for the handle
eColorHighlighted	color-property for the handle if highlighted

SetHandleEnlarge()

void CGUISplitContainer::SetHandleEnlarge

(

const eC_UInt &

uiHandleEnlarge

)

Enlarge the sensitive area of the splitter-handle

Parameters

uiHandleEnlarge

enlarge in each direction

SetHandleImage()

void CGUISplitContainer::SetHandleImage	(	const ImageResource_t &	eImage,
		const ImageResource_t &	eImageHighlighted
	)

Set the image for the handle. if no image is set, the color is used for drawing.

Parameters

eImage	image for handle
eImageHighlighted	image for handle if highlighted

SetHandleOrientation()

void CGUISplitContainer::SetHandleOrientation

(

const CGUICommonEnums::Orientation_t &

eOrientation

)

set the orientation of the splitter-handle

Parameters

eOrientation

orientation to use for the splitter-handle

SetHandlePosition()

void CGUISplitContainer::SetHandlePosition

(

const eC_Value &

vPosition

)

set the position of the splitter-handle

Parameters

vPosition

position to use for the splitter-handle

SetHandleSize()

void CGUISplitContainer::SetHandleSize

(

const eC_Value &

vSize

)

sets the size of the splitter-handle

Parameters

vSize

size to use for the splitter-handle

SetHeight()

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

SetWidth()

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

• GUISplitContainer.h