CGUIScrollingTextField Class Reference

Draws a smooth scrolling text field with configurable speed. More...

#include <GUIScrollingTextField.h>

Inheritance diagram for CGUIScrollingTextField:

Public Member Functions
	CGUIScrollingTextField ()
	Default constructor to be used by the factory.
	CGUIScrollingTextField (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const eC_String &kText, const eC_Bool &bMultiLine=false, const eC_Bool &bAnimationActive=false, const eC_Bool &bScrollVertical=false, const eC_Int &iAnimationTime=30, const eC_Int &iAnimationStepSize=1, const ImageResource_t &eBackgroundImg=DUMMY_IMAGE, const ObjectHandle_t &eID=NO_HANDLE)
	CGUIScrollingTextField (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const TextResource_t &eTextID, const eC_Bool &bMultiLine=false, const eC_Bool &bAnimationActive=false, const eC_Bool &bScrollVertical=false, const eC_Int &iAnimationTime=30, const eC_Int &iAnimationStepSize=1, const ImageResource_t &eBackgroundImg=DUMMY_IMAGE, const ObjectHandle_t &eID=NO_HANDLE)
	CGUIScrollingTextField (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_String &kText, const eC_Bool &bMultiLine=false, const eC_Bool &bAnimationActive=false, const eC_Bool &bScrollVertical=false, const eC_Int &iAnimationTime=30, const eC_Int &iAnimationStepSize=1, const ImageResource_t &eBackgroundImg=DUMMY_IMAGE, const ObjectHandle_t &eID=NO_HANDLE)
	CGUIScrollingTextField (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const TextResource_t &eTextID, const eC_Bool &bMultiLine=false, const eC_Bool &bAnimationActive=false, const eC_Bool &bScrollVertical=false, const eC_Int &iAnimationTime=30, const eC_Int &iAnimationStepSize=1, const ImageResource_t &eBackgroundImg=DUMMY_IMAGE, const ObjectHandle_t &eID=NO_HANDLE)
	CGUIScrollingTextField (const CGUIScrollingTextField &kSource)
	~CGUIScrollingTextField ()
	Destructor.
eC_Bool	GetAnimationActive () const
void	Init (const eC_Bool bAnimationActive, const eC_Bool bScrollVertical, const eC_Int iAnimationTime, const eC_Int iAnimationStepSize)
CGUIScrollingTextField &	operator= (const CGUIScrollingTextField &kSource)
virtual void	ReadFromStream ()
void	SetAnimationActive (eC_Bool bAnimationActive)
void	SetScrollVertical (eC_Bool bScrollVertical)
virtual void	WriteToStream (const eC_Bool bWriteClassID=false)
Public Member Functions inherited from CGUITextField
	CGUITextField ()
	CGUITextField (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const eC_String &kText, const eC_Bool &bMultiLine=false, const ImageResource_t &eBackgroundImg=DUMMY_IMAGE, const ObjectHandle_t &eID=NO_HANDLE)
	CGUITextField (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const TextResource_t &eTextID, const eC_Bool &bMultiLine=false, const ImageResource_t &eBackgroundImg=DUMMY_IMAGE, const ObjectHandle_t &eID=NO_HANDLE)
	CGUITextField (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_String &kText, const eC_Bool &bMultiLine=false, const ImageResource_t &eBackgroundImg=DUMMY_IMAGE, const ObjectHandle_t &eID=NO_HANDLE)
	CGUITextField (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const TextResource_t &eTextID, const eC_Bool &bMultiLine=false, const ImageResource_t &eBackgroundImg=DUMMY_IMAGE, const ObjectHandle_t &eID=NO_HANDLE)
	CGUITextField (const CGUITextField &kSource)
	~CGUITextField ()
eC_Bool	DoDraw ()
CGUITextField &	operator= (const CGUITextField &kSource)
virtual void	ReadFromStream ()
void	SetBackgroundImage (const ImageResource_t &eBackgroundImg)
virtual void	WriteToStream (const eC_Bool bWriteClassID=false)
Public Member Functions inherited from CGUIBaseTextField
	CGUIBaseTextField ()
	CGUIBaseTextField (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const eC_String &kText, const eC_Bool &bMultiLine=false, const eC_UInt &uiBackgroundColor=0x00000000, const ObjectHandle_t &eID=NO_HANDLE)
	CGUIBaseTextField (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const TextResource_t &eTextID, const eC_Bool &bMultiLine=false, const eC_UInt &uiBackgroundColor=0x00000000, const ObjectHandle_t &eID=NO_HANDLE)
	CGUIBaseTextField (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_String &kText, const eC_Bool &bMultiLine=false, const eC_UInt &uiBackgroundColor=0x00000000, const ObjectHandle_t &eID=NO_HANDLE)
	CGUIBaseTextField (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const TextResource_t &eTextID, const eC_Bool &bMultiLine=false, const eC_UInt &uiBackgroundColor=0x00000000, const ObjectHandle_t &eID=NO_HANDLE)
	CGUIBaseTextField (const CGUIBaseTextField &kSource)
	~CGUIBaseTextField ()
virtual eC_Bool	DoDraw ()
eC_UInt	GetBackgroundColor () const
CGUIText *	GetLabel ()
const CGUIText *	GetLabel () const
CGUIBaseTextField &	operator= (const CGUIBaseTextField &kSource)
virtual void	ReadFromStream ()
void	SetBackgroundColor (const eC_UInt &uiBackgroundColor)
void	SetBackgroundColor (const GlobalProperty_t &eBackgroundColor)
virtual void	SetHeight (const eC_Value &vNewHeight)
void	SetLabel (const eC_String &rkText)
void	SetLabel (const TextResource_t &eTextID)
void	SetText (CGUIText *pkText)
virtual eC_Bool	SetValue (const CGUIValue &rkValue)
virtual void	SetWidth (const eC_Value &vNewWidth)
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 ()
Public Member Functions inherited from CGUIColorPropertyObserver
	CGUIColorPropertyObserver ()
	default-constructor
	~CGUIColorPropertyObserver ()
	destructor
eC_UInt	AddColorProperty (const eC_Bool &bColorIsProperty, const eC_UInt &uiColorValue, const GlobalProperty_t &eColorProperty)
void	AddColorProperty (const eC_UInt &uiIndex, const eC_Bool &bColorIsProperty, const eC_UInt &uiColorValue, const GlobalProperty_t &eColorProperty)
ColorValue_t	GetColorProperty (const eC_UInt &uiIndex) const
eC_UInt	GetColorValue (const eC_UInt &uiIndex) const
virtual void	OnColorPropertyChange ()
virtual void	OnNotification ()
	Called by CGUISubject whenever an observed object triggers an update. More...
void	RemoveColorProperty (const eC_UInt &uiIndex)
void	SetColorProperty (const eC_UInt &uiIndex, const ColorValue_t &kColorValue)
void	SetColorProperty (const eC_UInt &uiIndex, const eC_UInt &uiColorValue)
void	SetColorProperty (const eC_UInt &uiIndex, const GlobalProperty_t &eColorProperty)
Public Member Functions inherited from CGUIObserver
	CGUIObserver ()
	Default constructor.
virtual	~CGUIObserver ()
	Default destructor. Notifies all subjects of destruction.
const eC_TListDoubleLinked< CGUISubject * > &	GetSubjectList () const
virtual void	OnNotification ()
	Called by CGUISubject whenever an observed object triggers an update. More...
virtual void	OnNotification (const CGUIObject *const pkUpdatedObject)
virtual void	OnNotification (const CGUIValue &kObservedValue, const CGUIObject *const pkUpdatedObject, const eC_UInt uiX=0, const eC_UInt uiY=0)
virtual void	OnNotification (const eC_String &kMessage)
void	SetAutoDelete (const eC_Bool bAutoDelete)

Additional Inherited Members
Public Types inherited from CGUIObject
enum	FourWayFocus_t { FOCUS_LEFT , FOCUS_RIGHT , FOCUS_UP , FOCUS_DOWN }
Static Public Attributes inherited from CGUIBaseTextField
static const eC_Char	XMLTAG_BASETEXTFIELD []
	xml-tag for the class itself
static const eC_Char	XMLTAG_BASETEXTFIELD_BACKGROUNDCOLOR []
	xml-tag for background-color
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 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 Member Functions inherited from CGUIObserver
virtual void	AddSubject (CGUISubject *pSubjectToAdd)
virtual void	RemoveSubject (CGUISubject *pSubjectToRemove)
Protected Attributes inherited from CGUITextField
ImageResource_t	m_eBackgroundImg
	ID of the background image.
CGUINinePatch	m_kNinePatch
	the nine patch
Protected Attributes inherited from CGUIBaseTextField
CGUIText *	m_pkText
	The text displayed by this text field.

Detailed Description

Draws a smooth scrolling text field with configurable speed.

Deprecated:

With the introduction of CGUIScrollingText this class is redundant and will be removed in future releases.

Constructor & Destructor Documentation

CGUIScrollingTextField() [1/5]

CGUIScrollingTextField::CGUIScrollingTextField	(	CGUICompositeObject *const	pkParent,
		const eC_Value &	vX,
		const eC_Value &	vY,
		const eC_Value &	vWidth,
		const eC_Value &	vHeight,
		const eC_String &	kText,
		const eC_Bool &	bMultiLine = false,
		const eC_Bool &	bAnimationActive = false,
		const eC_Bool &	bScrollVertical = false,
		const eC_Int &	iAnimationTime = 30,
		const eC_Int &	iAnimationStepSize = 1,
		const ImageResource_t &	eBackgroundImg = DUMMY_IMAGE,
		const ObjectHandle_t &	eID = NO_HANDLE
	)

Constructs a scrolling text field from a string and area values.

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 textfield
vHeight	Height of the textfield
kText	text string to be displayed on the textfield
bMultiLine	Whether the internal CGUIText is multi-line
bAnimationActive	Used for saving the current state of animation (on/off).
bScrollVertical	True for scrolling vertical, else False.
iAnimationTime	The time between two animating steps.
iAnimationStepSize	StepSize in pixels for each animation step.
eBackgroundImg	image-id of the background image
eID	Object Identifier of this textfield (choose NO_HANDLE if none is required)

CGUIScrollingTextField() [2/5]

CGUIScrollingTextField::CGUIScrollingTextField	(	CGUICompositeObject *const	pkParent,
		const CGUIRect &	kRect,
		const eC_String &	kText,
		const eC_Bool &	bMultiLine = false,
		const eC_Bool &	bAnimationActive = false,
		const eC_Bool &	bScrollVertical = false,
		const eC_Int &	iAnimationTime = 30,
		const eC_Int &	iAnimationStepSize = 1,
		const ImageResource_t &	eBackgroundImg = DUMMY_IMAGE,
		const ObjectHandle_t &	eID = NO_HANDLE
	)

Constructs a scrolling text field from a string and a rectangle area.

Parameters

pkParent	Pointer to the designated parent object
kRect	Position and size of the text field
kText	text string to be displayed on the textfield
bMultiLine	Whether the internal CGUIText is multi-line
bAnimationActive	Used for saving the current state of animation (on/off).
bScrollVertical	True for scrolling vertical, else False.
iAnimationTime	The time between two animating steps.
iAnimationStepSize	StepSize in pixels for each animation step.
eBackgroundImg	image-id of the background image
eID	Object Identifier of this textfield (choose NO_HANDLE if none is required)

CGUIScrollingTextField() [3/5]

CGUIScrollingTextField::CGUIScrollingTextField	(	CGUICompositeObject *const	pkParent,
		const eC_Value &	vX,
		const eC_Value &	vY,
		const eC_Value &	vWidth,
		const eC_Value &	vHeight,
		const TextResource_t &	eTextID,
		const eC_Bool &	bMultiLine = false,
		const eC_Bool &	bAnimationActive = false,
		const eC_Bool &	bScrollVertical = false,
		const eC_Int &	iAnimationTime = 30,
		const eC_Int &	iAnimationStepSize = 1,
		const ImageResource_t &	eBackgroundImg = DUMMY_IMAGE,
		const ObjectHandle_t &	eID = NO_HANDLE
	)

Constructs a scrolling text field from a text ID and area values.

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 textfield
vHeight	Height of the textfield
eTextID	ID of text string to be displayed on the text field
bMultiLine	Whether the internal CGUIText is multi-line
bAnimationActive	Used for saving the current state of animation (on/off).
bScrollVertical	True for scrolling vertical, else False.
iAnimationTime	The time between two animatin steps.
iAnimationStepSize	StepSize in pixels for each animation step.
eBackgroundImg	image-id of the background image
eID	Object Identifier of this textfield (choose NO_HANDLE if none is required)

CGUIScrollingTextField() [4/5]

CGUIScrollingTextField::CGUIScrollingTextField	(	CGUICompositeObject *const	pkParent,
		const CGUIRect &	kRect,
		const TextResource_t &	eTextID,
		const eC_Bool &	bMultiLine = false,
		const eC_Bool &	bAnimationActive = false,
		const eC_Bool &	bScrollVertical = false,
		const eC_Int &	iAnimationTime = 30,
		const eC_Int &	iAnimationStepSize = 1,
		const ImageResource_t &	eBackgroundImg = DUMMY_IMAGE,
		const ObjectHandle_t &	eID = NO_HANDLE
	)

Constructs a scrolling text field from a text ID and a rectangle area.

Parameters

pkParent	Pointer to the designated parent object
kRect	Position and size of the text field
eTextID	ID of text string to be displayed on the text field
bMultiLine	Whether the internal CGUIText is multi-line
bAnimationActive	Used for saving the current state of animation (on/off).
bScrollVertical	True for scrolling vertical, else False.
iAnimationTime	The time between two animating steps.
iAnimationStepSize	StepSize in pixels for each animation step.
eBackgroundImg	image-id of the background image
eID	Object Identifier of this textfield (choose NO_HANDLE if none is required)

CGUIScrollingTextField() [5/5]

CGUIScrollingTextField::CGUIScrollingTextField

(

const CGUIScrollingTextField &

kSource

)

Copy constructor

Parameters

kSource

Where to copy from

Member Function Documentation

GetAnimationActive()

eC_Bool CGUIScrollingTextField::GetAnimationActive

(

)

const

Returns

Returns if scrolling is active.

Init()

void CGUIScrollingTextField::Init	(	const eC_Bool	bAnimationActive,
		const eC_Bool	bScrollVertical,
		const eC_Int	iAnimationTime,
		const eC_Int	iAnimationStepSize
	)

Common code for all constructors

Parameters

bAnimationActive	Whether animation is active
bScrollVertical	Whether to scroll vertically
iAnimationTime	Animation time
iAnimationStepSize	Animation step size

operator=()

CGUIScrollingTextField & CGUIScrollingTextField::operator=

(

const CGUIScrollingTextField &

kSource

)

Assignment operator

Parameters

kSource

Where to copy from

Returns

Where to assign to

ReadFromStream()

virtual void CGUIScrollingTextField::ReadFromStream ( )

virtual

Reads all object 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 CGUITextField.

SetAnimationActive()

void CGUIScrollingTextField::SetAnimationActive

(

eC_Bool

bAnimationActive

)

Activates or deactivates scrolling of the text

Parameters

bAnimationActive

True if text should animate, False if not.

SetScrollVertical()

void CGUIScrollingTextField::SetScrollVertical

(

eC_Bool

bScrollVertical

)

Sets the direction of the scrolling text.

Parameters

bScrollVertical

True for vertical scrolling text, false for horizontal scrolling

WriteToStream()

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

virtual

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

Parameters

bWriteClassID

This flag is used to select if writing of ControlID, leading and trailing tags is performed.

Reimplemented from CGUITextField.

---

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

• GUIScrollingTextField.h