Guiliani  Version 2.4 revision 5970 (build 3)
CGUIScrollingText Class Reference

A specialization of the GUIText which implements text scrolling. More...

#include <GUIScrollingText.h>

Inheritance diagram for CGUIScrollingText:

Public Types

enum  ScrollingCondition_t {
  SCROLL_ALWAYS, SCROLL_FOCUSED, SCROLL_CUT_TEXT_ALWAYS, SCROLL_CUT_TEXT_FOCUSED,
  SCROLL_MANUALLY
}
 Possible animation conditions. More...
 
- Public Types inherited from CGUIText
enum  HorAligned_t { H_LEFT, H_CENTERED, H_RIGHT, H_PROPERTY }
 Possible horizontal alignments. More...
 
enum  TextColorTypeFlags_t { TEXT_COLOR_STANDARD_IS_PROPERTY = 1, TEXT_COLOR_HIGHLIGHTED_IS_PROPERTY = 2, TEXT_COLOR_GRAYED_OUT_IS_PROPERTY = 4, TEXT_COLOR_PRESSED_IS_PROPERTY = 8 }
 Enumeration indicating if a property or a color value is used for each text color.
 
enum  VerAligned_t { V_TOP, V_CENTERED, V_BOTTOM }
 Possible vertical alignments. More...
 

Public Member Functions

 CGUIScrollingText (const CGUIObject *const pParentObject, const eC_String &kText, const eC_Value &vXPos=eC_FromInt(0), const eC_Value &vYPos=eC_FromInt(0), const eC_Bool &bSingleLine=true)
 
 CGUIScrollingText (const CGUIObject *const pParentObject, const eC_String *const pkText, const eC_Value &vXPos=eC_FromInt(0), const eC_Value &vYPos=eC_FromInt(0), const eC_Bool &bSingleLine=true)
 
 CGUIScrollingText (const CGUIObject *const pParentObject, const TextResource_t &eTextID, const eC_Value &vXPos=eC_FromInt(0), const eC_Value &vYPos=eC_FromInt(0), const eC_Bool &bSingleLine=true)
 
 CGUIScrollingText (const CGUIText &rkText)
 
 CGUIScrollingText (const CGUIScrollingText &rkScrollingText)
 
 CGUIScrollingText ()
 
void AdaptText ()
 
virtual CGUIScrollingTextClone () const
 
virtual void DoAnimate (const eC_Value &vTimes=eC_FromInt(1))
 
eC_Value GetRelXPos () const
 
eC_Value GetRelYPos () const
 
eC_Value GetTextHeight () const
 
eC_Value GetTextWidth () const
 
virtual void ReadFromStream ()
 
void ResetTextPosition ()
 
void SetAnimationActive (const eC_Bool bAnimationActive)
 
void SetAnimationInterval (const eC_UInt uiAnimationInterval)
 
void SetAnimationMode (const ScrollingCondition_t eScrollingCondition)
 
void SetAnimationStepSize (const eC_Int iAnimationStepSize)
 
void SetRelXPos (const eC_Value &vRelXPos)
 
void SetRelYPos (const eC_Value &vRelYPos)
 
void SetScrollVertical (const eC_Bool bScrollVertical)
 
void SetTextHeight (const eC_Value &vTextHeight)
 
void SetTextWidth (const eC_Value &vTextWidth)
 
virtual void WriteToStream (const eC_Bool bWriteTextType=false)
 
- Public Member Functions inherited from CGUIText
 CGUIText (const CGUIObject *const pParentObject, const eC_String &kText, const eC_Value &vXPos=eC_FromInt(0), const eC_Value &vYPos=eC_FromInt(0), const eC_Bool &bSingleLine=true)
 
 CGUIText (const CGUIObject *const pParentObject, const eC_String *const pkText, const eC_Value &vXPos=eC_FromInt(0), const eC_Value &vYPos=eC_FromInt(0), const eC_Bool &bSingleLine=true)
 
 CGUIText (const CGUIObject *const pParentObject, const TextResource_t &eTextID, const eC_Value &vXPos=eC_FromInt(0), const eC_Value &vYPos=eC_FromInt(0), const eC_Bool &bSingleLine=true)
 
 CGUIText (const CGUIText &kTextToBeCopied)
 
virtual ~CGUIText ()
 Destructor.
 
void FitHeightToContainedText ()
 
void GetAdjustment (eC_Value &vXAdjustment, eC_Value &vYAdjustment) const
 
eC_Bool GetAutoSize () const
 
const CGUIObjectGetContainingObject () const
 
FontResource_t GetFont () const
 
eC_Int GetFontSize () const
 
eC_Float GetFontSpacing () const
 
HorAligned_t GetHorAlign () const
 
virtual eC_Value GetLineSpacing () const
 
eC_UInt GetNumberOfLines ()
 
virtual void GetRequiredOrgTextSpace (eC_Value &vTextWidth, eC_Value &vTextHeight)
 
virtual eC_Value GetRequiredTextHeightForWidth (eC_Value vAvailableWidth=0)
 
virtual void GetRequiredTextSpace (eC_Value &vTextWidth, eC_Value &vTextHeight)
 
const CGUIRectGetSpecificClipRect () const
 
const eC_String * GetText () const
 
void GetTextColor (eC_UInt &uiTextColorStandard, eC_UInt &uiTextColorHighlighted, eC_UInt &uiTextColorGrayedOut, eC_UInt &uiTextColorPressed) const
 
void GetTextColor (GlobalProperty_t &eTextColorStandard, GlobalProperty_t &eTextColorHighlighted, GlobalProperty_t &eTextColorGrayedOut, GlobalProperty_t &eTextColorPressed) const
 
eC_UInt GetTextColorGrayedOut () const
 
eC_UInt GetTextColorHighlighted () const
 
eC_UInt GetTextColorPressed () const
 
eC_UInt GetTextColorStandard () const
 
TextResource_t GetTextID () const
 
VerAligned_t GetVerAlign () const
 
void InvalidateArea ()
 
eC_Bool IsBidi () const
 
eC_Bool IsTextCut ()
 
eC_Bool IsTextID () const
 
eC_Bool IsTextSingleLine () const
 
CGUITextoperator= (const CGUIText &kSource)
 
void SetAdjustment (const eC_Value &vXAdjustment, const eC_Value &vYAdjustment)
 
void SetAligned (const VerAligned_t &eVerAligned=V_TOP, const HorAligned_t &eHorAligned=H_LEFT)
 
void SetAlignedHorizontal (const HorAligned_t &eHorAligned=H_LEFT)
 
void SetAlignedVertical (const VerAligned_t &eVerAligned=V_TOP)
 
void SetAutoSize (const eC_Bool &bAutoSize)
 
void SetContainingObject (const CGUIObject *const pParent)
 
virtual void SetFont (const FontResource_t &eFontID)
 
void SetFontSpacing (const eC_Float &fFontSpacing)
 
virtual void SetLineSpacing (const eC_Value vLineSpacing)
 
void SetRelRect (const CGUIRect &kRect)
 
void SetSpecificClipRect (const CGUIRect &kRect)
 
void SetTextAlignmentProperty (const GlobalProperty_t &eTextAlignmentProperty)
 
virtual void SetTextColor (const eC_UInt &uiTextColorStandard, const eC_UInt &uiTextColorHighlighted, const eC_UInt &uiTextColorGrayedOut, const eC_UInt &uiTextColorPressed)
 
virtual void SetTextColor (const GlobalProperty_t &eTextColorStandard, const GlobalProperty_t &eTextColorHighlighted, const GlobalProperty_t &eTextColorGrayedOut, const GlobalProperty_t &eTextColorPressed)
 
void SetTextColorGrayedOut (const eC_UInt &uiTextColorGrayedOut)
 
void SetTextColorGrayedOut (const GlobalProperty_t &eTextColorPropertyGrayedOut)
 
void SetTextColorHighlighted (const eC_UInt &uiTextColorHighlighted)
 
void SetTextColorHighlighted (const GlobalProperty_t &eTextColorPropertyHighlighted)
 
void SetTextColorPressed (const eC_UInt &uiTextColorPressed)
 
void SetTextColorPressed (const GlobalProperty_t &eTextColorPropertyPressed)
 
void SetTextColorStandard (const eC_UInt &uiTextColorStandard)
 
void SetTextColorStandard (const GlobalProperty_t &eTextColorPropertyStandard)
 
virtual void SetTextID (const TextResource_t &eTextID)
 
virtual void SetTextSingleLine (const eC_Bool &bSingleLine)
 
void SetTextString (const eC_String *pkTextString)
 
virtual void SetTextString (const eC_String &kTextString)
 
- 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 ()
 
void RemoveColorProperty (const eC_UInt &uiIndex)
 
void SetColorProperty (const eC_UInt &uiIndex, const eC_UInt &uiColorValue)
 
void SetColorProperty (const eC_UInt &uiIndex, const GlobalProperty_t &eColorProperty)
 
void SetColorProperty (const eC_UInt &uiIndex, const ColorValue_t &kColorValue)
 
- 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 (const eC_String &kMessage)
 
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)
 
void SetAutoDelete (const eC_Bool bAutoDelete)
 
- Public Member Functions inherited from CGUIStreamableObject
const eC_String & GetXMLTag () const
 
void SetXMLTag (const eC_String &kXMLTag)
 
- Public Member Functions inherited from CGUIAnimatable
virtual ~CGUIAnimatable ()
 Destructor. Removes all existing animation callbacks.
 
virtual eC_Bool IsAnimating () const
 
virtual void StartAnimation ()
 
virtual void StopAnimation ()
 

Protected Member Functions

void CheckScrollingCondition ()
 
eC_Bool IsScrollingTextCut () const
 
void PreparePrint ()
 
void PrintText ()
 Calls the base implementation and resets the cliprect that is manipulated in PreparePrint().
 
void UpdateIsTextCut ()
 Helper function for AdaptText() that updates m_bIsTextCut.
 
- Protected Member Functions inherited from CGUIText
virtual void CollectHyphenationMarks (eC_String &rkStr, eC_UInt uiOffset)
 
eC_Bool ContainsHyphenationMarks (const eC_String &kStr) const
 
void CreateLocalTextCopy ()
 
virtual void FitString (ExtendedString_t &rkResultStrData, const eC_String &rkStrToAnalyse, eC_String &rkRestStr, eC_UInt &uiOffset)
 
virtual eC_Value GetPrintLineAbsXPos (const eC_Value vWidth)
 
virtual eC_Value GetPrintLineAbsXPos (const eC_UInt uiLine)
 
virtual eC_Value GetPrintLineAbsXPos ()
 
eC_Value GetRequiredTextHeight () const
 
eC_Value GetRequiredTextWidth () const
 
virtual eC_Value GetVerStartAbsYPos ()
 
virtual void OnNotification ()
 
eC_Bool PrepareClipRect ()
 
void ReadFontColors (const eC_UInt uiVersion)
 
void SetRequiredTextHeight (eC_Value vRequiredTextHeight)
 
void SetRequiredTextWidth (eC_Value vRequiredTextWidth)
 
void SetTextCut (const eC_Bool bIsCut)
 
void WriteFontColors ()
 Helper function for WriteStream().
 
- Protected Member Functions inherited from CGUIObserver
virtual void AddSubject (CGUISubject *pSubjectToAdd)
 
virtual void RemoveSubject (CGUISubject *pSubjectToRemove)
 
- 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
 

Additional Inherited Members

- Static Public Member Functions inherited from CGUIText
static eC_String GetEllipsisString ()
 
static eC_String GetHyphenString ()
 
static void SetEllipsisString (const eC_String &kEllipsis)
 
static void SetHyphenString (const eC_String &kHyphen)
 
- Static Public Attributes inherited from CGUIText
static const eC_Char XMLTAG_TEXT_COLOR_GRAYEDOUT [] = "TextColorGrayedOut"
 xml-tag for grayedout-color
 
static const eC_Char XMLTAG_TEXT_COLOR_HIGHLIGHTED [] = "TextColorHighlighted"
 xml-tag for highlighted-color
 
static const eC_Char XMLTAG_TEXT_COLOR_PRESSED [] = "TextColorPressed"
 xml-tag for pressed-color
 
static const eC_Char XMLTAG_TEXT_COLOR_PROPERTY_FLAGS [] = "ColorPropertyFlags"
 XML tag to be used when writing text colors into a stream. More...
 
static const eC_Char XMLTAG_TEXT_COLOR_STANDARD [] = "TextColorStandard"
 xml-tag for standard-color
 
static const eC_Char XMLTAG_TEXTID [] = "TextID"
 XML tag to be used when writing a text ID into a stream.
 
static const eC_Char XMLTAG_TEXTTYPEID [] = "TextTypeID"
 XML tag to be used when writing a text type ID into a stream.
 
- Static Public Attributes inherited from CGUIStreamableObject
static const eC_Char XMLTAG_CLASSVERSION [] = "ClassVersion"
 
- Protected Types inherited from CGUIText
typedef eC_TListDoubleLinked< ExtendedString_tExtendedStringList_t
 The extended string list is a double-linked list of extended strings.
 
typedef eC_TListDoubleLinked< eC_UInt > UIntList
 Double linked List of unsigned integers.
 
- Protected Attributes inherited from CGUIText
eC_Bool m_bAdaptText
 
eC_Bool m_bSingleLine
 Indicates whether this text is single- or multi-line.
 
eC_Bool m_bTextIDLocalCopy
 
eC_Bool m_bTextIsBiDi
 Indicates whether the text is a BiDi-text.
 
eC_Bool m_bUseEllipsis
 use ellipsis if text is too long
 
HorAligned_t m_eHorAligned
 Horizontal alignment.
 
GlobalProperty_t m_eTextAlignmentProperty
 Property used for the text color for alignment. By default, this value is DUMMY_PROPERTY, i.e. a fixed alignment is used.
 
VerAligned_t m_eVerAligned
 Vertical alignment.
 
UIntList m_kHyphens
 List of hyphen positions in the original text.
 
ExtendedStringList_t m_kListStringsExtended
 List of strings to be printed, and their cached width and height.
 
const CGUIObjectm_pkParentObject
 The object containing (and printing) this text.
 
eC_String * m_pkText
 
eC_Value m_vLineHeight
 The height of one text line with this text's font.
 
eC_Value m_vLineSpacing
 The line spacing factor.
 
eC_Value m_vRelXPos
 X position of this text's printing area relative to the parent object.
 
eC_Value m_vRelYPos
 Y position of this text's printing area relative to the parent object.
 
eC_Value m_vRequiredOrgTextHeight
 
eC_Value m_vRequiredOrgTextWidth
 
eC_Value m_vTextHeight
 Height of this text's printing area.
 
eC_Value m_vTextWidth
 Width of this text's printing area.
 
eC_Value m_vXAdjustment
 Printing adjustment for m_vRelXPos.
 
eC_Value m_vYAdjustment
 Printing adjustment for m_vRelYPos.
 
- Static Protected Attributes inherited from CGUIText
static const ExtendedString_t ms_ckEmptyExtendedString
 An empty Extended String.
 
static const eC_String ms_ckEmptyString
 An empty string.
 
static const eC_String ms_ckSingleSpace
 A single space character for text size calculations.
 

Detailed Description

A specialization of the GUIText which implements text scrolling.

The scrollable text is a specialization of the GUIText which implements text scrolling. It is possible to scroll always, only when the parent object is focused, or when the text is truncated.

It is possible to scroll the text horizontally or vertically. The animation speed can be configured by setting the animation interval and the animation step size.

When scrolling, the text will always be clipped on the original text dimensions.

Platform Specific Limitations

GUIScrollingText Text alignments will have no effect in the direction of scrolling. I.e., vertical alignment will be ignored for vertically scrolling text.(Class CGUIScrollingText) See CGUIScrollingText Platform Specific Limitations.

Member Enumeration Documentation

◆ ScrollingCondition_t

Possible animation conditions.

Enumerator
SCROLL_ALWAYS 

The text will always be scrolled.

SCROLL_FOCUSED 

The text will be scrolled when its parent object is focused.

SCROLL_CUT_TEXT_ALWAYS 

The text will be scrolled when the text is truncated.

SCROLL_CUT_TEXT_FOCUSED 

The text will be scrolled when the text is truncated and the parent object is focused.

SCROLL_MANUALLY 

The Animation can be started or stopped manually by calling SetAnimationActive().

Constructor & Destructor Documentation

◆ CGUIScrollingText() [1/6]

CGUIScrollingText::CGUIScrollingText ( const CGUIObject *const  pParentObject,
const eC_String &  kText,
const eC_Value &  vXPos = eC_FromInt(0),
const eC_Value &  vYPos = eC_FromInt(0),
const eC_Bool &  bSingleLine = true 
)

Constructs a scrolling string text. By default, the text width and height are set to the width and height of the parent object minus the relative positions.

Parameters
pParentObjectPointer to object containing the text.
kTextReference of text string.
vXPosX position of text relative to the parent.
vYPosY position of text relative to the parent.
bSingleLinetrue: text is always displayed in a single line, false: lines can be wrapped.

◆ CGUIScrollingText() [2/6]

CGUIScrollingText::CGUIScrollingText ( const CGUIObject *const  pParentObject,
const eC_String *const  pkText,
const eC_Value &  vXPos = eC_FromInt(0),
const eC_Value &  vYPos = eC_FromInt(0),
const eC_Bool &  bSingleLine = true 
)

Constructs a scrolling string text. By default, the text width and height are set to the width and height of the parent object minus the relative positions.

Parameters
pParentObjectPointer to object containing the text.
pkTextPointer of text string.
vXPosX position of text relative to the parent.
vYPosY position of text relative to the parent.
bSingleLinetrue: text is always displayed in a single line, false: lines can be wrapped.

◆ CGUIScrollingText() [3/6]

CGUIScrollingText::CGUIScrollingText ( const CGUIObject *const  pParentObject,
const TextResource_t eTextID,
const eC_Value &  vXPos = eC_FromInt(0),
const eC_Value &  vYPos = eC_FromInt(0),
const eC_Bool &  bSingleLine = true 
)

Constructs a scrolling ID text. By default, the text width and height are set to the width and height of the parent object minus the relative positions.

Parameters
pParentObjectPointer to object containing the text.
eTextIDID of the internationalized text.
vXPosX position of text relative to the parent.
vYPosY position of text relative to the parent.
bSingleLinetrue: text is always displayed in a single line, false: lines can be wrapped.

◆ CGUIScrollingText() [4/6]

CGUIScrollingText::CGUIScrollingText ( const CGUIText rkText)

Constructs a Scrolling text using the attributes of a GUIText.

Parameters
rkTextThe GUIText to copy from.

◆ CGUIScrollingText() [5/6]

CGUIScrollingText::CGUIScrollingText ( const CGUIScrollingText rkScrollingText)

Copy-constructor.

Parameters
rkScrollingTextThe GUIScrollingText to copy from.

◆ CGUIScrollingText() [6/6]

CGUIScrollingText::CGUIScrollingText ( )

Default constructor used for streaming.

Member Function Documentation

◆ AdaptText()

void CGUIScrollingText::AdaptText ( )
virtual

Calls the base implementation and checks if the cut conditions have changed by calling CheckScrollingCondition().

Reimplemented from CGUIText.

◆ CheckScrollingCondition()

void CGUIScrollingText::CheckScrollingCondition ( )
protected

Checks the scrolling conditions and calls SetAnimationActiveInternal() to start or stop the animation. This method has to be called when conditions changed.

◆ Clone()

CGUIScrollingText * CGUIScrollingText::Clone ( ) const
virtual

Clones the instance of the GUIScrollingText object.

Returns
Pointer to the cloned GUIScrollingText object.

Reimplemented from CGUIText.

◆ DoAnimate()

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

Animates the smooth scrolling text.

Parameters
vTimesThe factor of the elapsed time based on the set animation interval.

Reimplemented from CGUIAnimatable.

◆ GetRelXPos()

eC_Value CGUIScrollingText::GetRelXPos ( ) const
virtual

Get the x-position of the text area.

Returns
The width of the text area.

Reimplemented from CGUIText.

◆ GetRelYPos()

eC_Value CGUIScrollingText::GetRelYPos ( ) const
virtual

Get the y-position of the text area.

Returns
The height of the text area.

Reimplemented from CGUIText.

◆ GetTextHeight()

eC_Value CGUIScrollingText::GetTextHeight ( ) const
virtual

Get the height of the text area.

Returns
The height of the text area.

Reimplemented from CGUIText.

◆ GetTextWidth()

eC_Value CGUIScrollingText::GetTextWidth ( ) const
virtual

Get the width of the text area.

Returns
The width of the text area.

Reimplemented from CGUIText.

◆ IsScrollingTextCut()

eC_Bool CGUIScrollingText::IsScrollingTextCut ( ) const
inlineprotected
Returns
Determines if the text would be cut if it was not scrolling.

◆ PreparePrint()

void CGUIScrollingText::PreparePrint ( )
protectedvirtual

Calls CheckScrollingCondition() and calls base class implementation. The cliprect is set to ensure that the text is not drawn outside of the original (non animating) text area.

Reimplemented from CGUIText.

◆ ReadFromStream()

void CGUIScrollingText::ReadFromStream ( )
virtual

Reads attributes from the streaming file. Only for use with GUIFactoryManager.

See also
CGUIObject::ReadFromStream()

Reimplemented from CGUIText.

◆ ResetTextPosition()

void CGUIScrollingText::ResetTextPosition ( )

Reset the text position and the text size to original values, as it is done when the animation is stopped.

◆ SetAnimationActive()

void CGUIScrollingText::SetAnimationActive ( const eC_Bool  bAnimationActive)

Activates or deactivates scrolling of the text. This call is ignored when the scrolling condition is not set to SCROLL_MANUALLY. In this case the animation is ONLY triggered internally.

Parameters
bAnimationActiveTrue if text should animate, False if not.

◆ SetAnimationInterval()

void CGUIScrollingText::SetAnimationInterval ( const eC_UInt  uiAnimationInterval)

Sets the time between to animation steps.

Parameters
uiAnimationIntervalThe time between two animation steps in ms.

◆ SetAnimationMode()

void CGUIScrollingText::SetAnimationMode ( const ScrollingCondition_t  eScrollingCondition)

Set the scrolling condition.

Parameters
eScrollingConditionThe Scrolling condition. The animation will be started as soon as the condition is fulfilled.

◆ SetAnimationStepSize()

void CGUIScrollingText::SetAnimationStepSize ( const eC_Int  iAnimationStepSize)

Sets the animation step size.

Parameters
iAnimationStepSizeThe step size in pixel for each animation step.

◆ SetRelXPos()

void CGUIScrollingText::SetRelXPos ( const eC_Value &  vRelXPos)
virtual

When not animating the base implementation is called to set the text position. When animating, the position of the scroll area is updated.

Parameters
vRelXPosThe new text position.

Reimplemented from CGUIText.

◆ SetRelYPos()

void CGUIScrollingText::SetRelYPos ( const eC_Value &  vRelYPos)
virtual

When not animating the base implementation is called to set the text position. When animating, the position of the scroll area is updated.

Parameters
vRelYPosThe new text position.

Reimplemented from CGUIText.

◆ SetScrollVertical()

void CGUIScrollingText::SetScrollVertical ( const eC_Bool  bScrollVertical)

Sets the direction of the scrolling text.

Parameters
bScrollVerticalTrue for vertical scrolling text, false for horizontal scrolling.

◆ SetTextHeight()

void CGUIScrollingText::SetTextHeight ( const eC_Value &  vTextHeight)
virtual

When not animating the base implementation is called to set the text height. When animating, the height of the scroll area is updated. The scrolling conditions are checked when the next redraw is triggered.

Parameters
vTextHeightThe new height for the text.

Reimplemented from CGUIText.

◆ SetTextWidth()

void CGUIScrollingText::SetTextWidth ( const eC_Value &  vTextWidth)
virtual

When not animating the base implementation is called to set the text width. When animating, the width of the scroll area is updated. The scrolling conditions are checked when the next redraw is triggered.

Parameters
vTextWidthThe new width for the text.

Reimplemented from CGUIText.

◆ WriteToStream()

void CGUIScrollingText::WriteToStream ( const eC_Bool  bWriteTextType = false)
virtual

Called by the framework when writing streaming files. When deriving a new text class in an application, re-implement this method.

Parameters
bWriteTextTypeIndicates whether the ID needs to be written. If the framework calls this method, it passes true here. The base class implementation has to be called with false (default). If called with true, the first two tags written must be this text's XML name tag (see GetXMLTag()) and its text type ID. After all attributes are written, the name tag has to be written again as a closing tag (preceded by a slash).

Reimplemented from CGUIText.


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