This container can be used to create multiple pages of controls which can be swiped page-wise. More...

#include <GUIPageContainer.h>

Inheritance diagram for CGUIPageContainer:

[legend]

Public Member Functions
	CGUIPageContainer ()
	Default constructor.

	CGUIPageContainer (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)

	CGUIPageContainer (const CGUIPageContainer &kToBeCopied)

virtual eC_Bool	AddObject (CGUIObject *pkObject)

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

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

virtual eC_Bool	DoClick (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	DoDraw ()

virtual eC_Bool	DoPostDraw ()

ImageResource_t	GetBGImage () const

void	GetBounceEasing (CGUIEasing::EasingType_t &eEasing, eC_Value &vEasingTime) const

virtual eC_UInt	GetCurrentIndex ()

CGUICommonEnums::Orientation_t	GetDirection () const

eC_Bool	GetDragActive () const

eC_Value	GetDragDistance () const

CGUICommonEnums::Alignment_t	GetIndicatorAlignment () const

void	GetIndicatorImages (ImageResource_t &eImageInactive, ImageResource_t &eImageActive) const

eC_Bool	GetIndicatorsActive () const

void	GetIndicatorSize (eC_Value &vWidth, eC_Value &vHeight) const

CGUINinePatch &	GetNinePatch ()

void	GetNormalEasing (CGUIEasing::EasingType_t &eEasing, eC_Value &vEasingTime) const

eC_Value	GetOverShoot () const

eC_Value	GetSwipeDistance () const

CGUIPageContainer &	operator= (const CGUIPageContainer &kSource)

virtual void	ReadFromStream ()

virtual void	RemoveObject (CGUIObject *pkObject)

virtual void	ScrollTo (eC_UInt uiNodeIndex)

virtual void	ScrollToAnimated (eC_UInt uiNodeIndex)

void	SetBGImage (const ImageResource_t &eBGImage)

void	SetBounceEasing (const CGUIEasing::EasingType_t &eEasing, const eC_Value &vEasingTime)

void	SetDirection (const CGUICommonEnums::Orientation_t &eDirection)

void	SetDragActive (const eC_Bool &bDragActive)

void	SetDragDistance (const eC_Value &vDragDistance)

virtual void	SetHeight (const eC_Value &vY)

void	SetIndicatorAlignment (const CGUICommonEnums::Alignment_t &eAlignment)

void	SetIndicatorImages (const ImageResource_t &eImageInactive, const ImageResource_t &eImageActive)

void	SetIndicatorsActive (const eC_Bool &bIndicatorsActive)

void	SetIndicatorSize (const eC_Value &vWidth, const eC_Value &vHeight)

void	SetNormalEasing (const CGUIEasing::EasingType_t &eEasing, const eC_Value &vEasingTime)

void	SetOverShoot (const eC_Value &vOvershoot)

void	SetSwipeDistance (const eC_Value &vSwipeDistance)

virtual eC_Bool	SetValue (const CGUIValue &rkValue)

virtual void	SetWidth (const eC_Value &vX)

virtual void	StartScrollingAnimation ()

virtual void	StopScrollingAnimation ()

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	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	DoButtonUp (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 can be used to create multiple pages of controls which can be swiped page-wise.

The Page-Container can be used to group together various child-elements where only one child will be displayed at a time and the others can be navigated to via dragging or the page-indicators.

Each child-element will automatically be resized to the size of the container and placed one after the other. Depending on the orientation the elements can be dragged horizontally or vertically to switch from one element to another. Also the indicator-icons can be clicked to switch to a specific page.

A general use-case would be displaying specific information in a page e.g. step-by-step instructions for cooking something or setting up the application based on the user-input.

If manual navigation should not be permitted both dragging and the indicators can be deactivated. The page-switch can be performed via the application depending on the actions on the current page.

This can help creating wizard-styled dialogs where on each page the data will be checked before the next page will be shown.

this container is helpful if e.g. long texts should be displayed when having a small visible area, instead of using a scrolling-container.

Constructor & Destructor Documentation

◆ CGUIPageContainer() [1/2]

CGUIPageContainer::CGUIPageContainer	(	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`
	)

Constructor

Parameters

pkParent	Pointer to the parent object of this image.
vX	The x coordinate of the upper left corner of this image.
vY	The y coordinate of the upper left corner of this image.
vWidth	The width of this image.
vHeight	The height of this image.
eID	This wheel's object ID.

◆ CGUIPageContainer() [2/2]

CGUIPageContainer::CGUIPageContainer ( const CGUIPageContainer & kToBeCopied )

Copy constructor

Parameters

kToBeCopied

Member Function Documentation

◆ AddObject()

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

◆ DoAnimate()

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

◆ DoButtonDown()

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

◆ DoClick()

virtual eC_Bool CGUIPageContainer::DoClick	(	const eC_Value &	vAbsX,
		const eC_Value &	vAbsY
	)

virtual

Called when the object receives a click event. A click can e.g., be the result of a mouse click, a finger press/release sequence on touchscreens, or be triggered by a GK_ACTION keyboard event.

Note: DoClick() 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. Thus, to calculate the relative position (where the mouse button was pressed and released at the same position for in a certain time span, 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 CGUIPageContainer::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 CGUIPageContainer::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.

◆ DoDraw()

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

◆ GetBGImage()

ImageResource_t CGUIPageContainer::GetBGImage ( ) const

Get the background-image

Returns: background-image

◆ GetBounceEasing()

void CGUIPageContainer::GetBounceEasing	(	CGUIEasing::EasingType_t &	eEasing,
		eC_Value &	vEasingTime
	)		const

Get the easing-parameters for bounce-easing

Parameters

eEasing
vEasingTime

◆ GetCurrentIndex()

virtual eC_UInt CGUIPageContainer::GetCurrentIndex ( )

virtual

GetCurrentIndex returns the current focused entry value.

Returns: eC_UInt containing the current focused index.

◆ GetDirection()

CGUICommonEnums::Orientation_t CGUIPageContainer::GetDirection ( ) const

Get direction for container

Returns: direction

◆ GetDragActive()

eC_Bool CGUIPageContainer::GetDragActive ( ) const

Get if drag is active

Returns: true if active

◆ GetDragDistance()

eC_Value CGUIPageContainer::GetDragDistance ( ) const

Get drag-distance

Returns: drag-distance

◆ GetIndicatorAlignment()

CGUICommonEnums::Alignment_t CGUIPageContainer::GetIndicatorAlignment ( ) const

Get alignment of indicator-bar

Returns: alignment

◆ GetIndicatorImages()

void CGUIPageContainer::GetIndicatorImages	(	ImageResource_t &	eImageInactive,
		ImageResource_t &	eImageActive
	)		const

Get the images for the indicator-bar

Parameters

eImageInactive
eImageActive

◆ GetIndicatorsActive()

eC_Bool CGUIPageContainer::GetIndicatorsActive ( ) const

Return whether navigation via indicators is allowed

Returns: true if active

◆ GetIndicatorSize()

void CGUIPageContainer::GetIndicatorSize	(	eC_Value &	vWidth,
		eC_Value &	vHeight
	)		const

Get the sizes for the indicator-bar

Parameters

vWidth
vHeight

◆ GetNinePatch()

CGUINinePatch & CGUIPageContainer::GetNinePatch ( )

inline

Get the nine-patch which is used to draw the background of the wheel

Returns: nine-patch

◆ GetNormalEasing()

void CGUIPageContainer::GetNormalEasing	(	CGUIEasing::EasingType_t &	eEasing,
		eC_Value &	vEasingTime
	)		const

Get easing-parameters for normal easing

Parameters

eEasing
vEasingTime

◆ GetOverShoot()

eC_Value CGUIPageContainer::GetOverShoot ( ) const

Get overshoot

Returns: overshoot

◆ GetSwipeDistance()

eC_Value CGUIPageContainer::GetSwipeDistance ( ) const

Get swipe-distance

Returns: swipe-distance

◆ operator=()

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

Assignment constructor

Parameters

kSource

Returns: copy

◆ ReadFromStream()

virtual void CGUIPageContainer::ReadFromStream ( )

virtual

Reads all attributes from streaming file. This method is called by CGUIFactoryManager after one of the registered factories has created an instance of this class.

Reimplemented from CGUICompositeObject.

◆ RemoveObject()

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

◆ ScrollTo()

virtual void CGUIPageContainer::ScrollTo ( eC_UInt uiNodeIndex )

virtual

Scrolls to the given entry/node index.

Parameters

uiNodeIndex Index of entry/node.

◆ ScrollToAnimated()

virtual void CGUIPageContainer::ScrollToAnimated ( eC_UInt uiNodeIndex )

virtual

Scrolls using animations to the given entry/node value.

Parameters

uiNodeIndex Index of entry/node.

◆ SetBGImage()

void CGUIPageContainer::SetBGImage ( const ImageResource_t & eBGImage )

Set the background-image

Parameters

eBGImage

◆ SetBounceEasing()

void CGUIPageContainer::SetBounceEasing	(	const CGUIEasing::EasingType_t &	eEasing,
		const eC_Value &	vEasingTime
	)

Set easing-parameters for bounce-easing this easing is used when pages at the edges of the container are dragged beyond and then nounce back

Parameters

eEasing
vEasingTime

◆ SetDirection()

void CGUIPageContainer::SetDirection ( const CGUICommonEnums::Orientation_t & eDirection )

Set direction for container

Parameters

eDirection

◆ SetDragActive()

void CGUIPageContainer::SetDragActive ( const eC_Bool & bDragActive )

Set if drag can be used for page-selection. If not pages can only be selected via indicators.

Parameters

bDragActive true or false

◆ SetDragDistance()

void CGUIPageContainer::SetDragDistance ( const eC_Value & vDragDistance )

Set minimum drag-distance, which needs to exceeded before a drag happens

Parameters

vDragDistance

◆ SetHeight()

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

◆ SetIndicatorAlignment()

void CGUIPageContainer::SetIndicatorAlignment ( const CGUICommonEnums::Alignment_t & eAlignment )

Set alignment of indicator-bar

Parameters

eAlignment

◆ SetIndicatorImages()

void CGUIPageContainer::SetIndicatorImages	(	const ImageResource_t &	eImageInactive,
		const ImageResource_t &	eImageActive
	)

Set the images which are used for the indicator-bar

Parameters

eImageInactive
eImageActive

◆ SetIndicatorsActive()

void CGUIPageContainer::SetIndicatorsActive ( const eC_Bool & bIndicatorsActive )

Set navigation via indicators active

Parameters

bIndicatorsActive true if navigation is allowed

◆ SetIndicatorSize()

void CGUIPageContainer::SetIndicatorSize	(	const eC_Value &	vWidth,
		const eC_Value &	vHeight
	)

Set the size which is used to display the indicators

Parameters

vWidth	if 0 the image-width will be used
vHeight	if 0 the image-height will be used

◆ SetNormalEasing()

void CGUIPageContainer::SetNormalEasing	(	const CGUIEasing::EasingType_t &	eEasing,
		const eC_Value &	vEasingTime
	)

Set easing-parameters for normal easing this easing is used when animating from page to page

Parameters

eEasing
vEasingTime

◆ SetOverShoot()

void CGUIPageContainer::SetOverShoot ( const eC_Value & vOvershoot )

Set overshoot for the container. This is the distance the pages on the edges of the container can be dragged beyond.

Parameters

vOvershoot

◆ SetSwipeDistance()

void CGUIPageContainer::SetSwipeDistance ( const eC_Value & vSwipeDistance )

Set swipe-distance, which needs to be exceeded before a page-switch happens

Parameters

vSwipeDistance

◆ SetValue()

virtual eC_Bool CGUIPageContainer::SetValue ( const CGUIValue & rkValue )

virtual

Generic interface for setting object values. The SetValue() API enables you to forward any data of type CGUIValue to any object. How this value finally gets interpreted is up to the receiving object's implementation.

This concept is particularly useful for linking GUI-objects to an external data source. You can for instance forward an integer value as a CGUIValue object to a GUIObject without the need to know whether it is a CGUITextField, or a CGUIProgressBar, or something completely different. The receiving object will interpret the value in the most sensible way. In the given example the integer will be displayed as a string in the Textfield, while it will cause the ProgressBar to fill up to the respective value.

Parameters

rkValue DataPoolEntry containing the value to be handed over to the object on which SetValue was called.

Returns: Always False in base class, normally True if value was applied and False in case of error.

Reimplemented from CGUIObject.

◆ SetWidth()

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

◆ StartScrollingAnimation()

virtual void CGUIPageContainer::StartScrollingAnimation ( )

virtual

Start animation.

◆ StopScrollingAnimation()

virtual void CGUIPageContainer::StopScrollingAnimation ( )

virtual

Stop animation.

◆ WriteToStream()

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

virtual

Writes all attributes to the streaming file. A CGUIStreamWriter has to be initialized first.

Parameters

bWriteClassID This flag is used to select if writing of control class ID, leading and trailing tags is performed.

Reimplemented from CGUICompositeObject.

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

GUIPageContainer.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CGUIPageContainer() [1/2]

◆ CGUIPageContainer() [2/2]

Member Function Documentation

◆ AddObject()

◆ DoAnimate()

◆ DoButtonDown()

◆ DoClick()

◆ DoDrag()

◆ DoDragEnd()

◆ DoDraw()

◆ DoPostDraw()

◆ GetBGImage()

◆ GetBounceEasing()

◆ GetCurrentIndex()

◆ GetDirection()

◆ GetDragActive()

◆ GetDragDistance()

◆ GetIndicatorAlignment()

◆ GetIndicatorImages()

◆ GetIndicatorsActive()

◆ GetIndicatorSize()

◆ GetNinePatch()

◆ GetNormalEasing()

◆ GetOverShoot()

◆ GetSwipeDistance()

◆ operator=()

◆ ReadFromStream()

◆ RemoveObject()

◆ ScrollTo()

◆ ScrollToAnimated()

◆ SetBGImage()

◆ SetBounceEasing()

◆ SetDirection()

◆ SetDragActive()

◆ SetDragDistance()

◆ SetHeight()

◆ SetIndicatorAlignment()

◆ SetIndicatorImages()

◆ SetIndicatorsActive()

◆ SetIndicatorSize()

◆ SetNormalEasing()

◆ SetOverShoot()

◆ SetSwipeDistance()

◆ SetValue()

◆ SetWidth()

◆ StartScrollingAnimation()

◆ StopScrollingAnimation()

◆ WriteToStream()