CGUIAbstractBar Class Reference

Base class for bars. More...

#include <GUIAbstractBar.h>

Inheritance diagram for CGUIAbstractBar:

Public Member Functions
void	AnimateToValue (const eC_Int iTargetValue)
eC_Bool	Decrease ()
virtual void	DoAnimate (const eC_Value &vTimes=eC_FromInt(1))
eC_UInt	GetAnimationInterval () const
eC_UInt	GetAnimationSpeed () const
const CGUIRange &	GetRange () const
eC_Bool	Increase ()
virtual eC_Bool	OnValueChange ()
void	SetAnimationInterval (const eC_UInt &ruiAnimationInterval)
void	SetAnimationSpeed (const eC_UInt &ruiAnimationSpeed)
void	SetBase (CGUIRange::Base_t eBase)
void	SetLevel (eC_Value vPercent)
void	SetLevelPercentage (eC_UInt uiPercentage)
void	SetMaximumLevelIsAlwaysValid (eC_Bool bNotOnlyMultiplesOfStepSize)
void	SetMaxValue (eC_Int iMaxValue)
void	SetMinValue (eC_Int iMinValue)
void	SetRange (eC_Int iMinValue, eC_Int iMaxValue)
void	SetStepSize (eC_UInt uiIntValues)
void	SetStepSizeLevel (eC_Value vPercent)
void	SetStepSizeLevelPercentage (eC_UInt uiPercentage)
virtual eC_Bool	SetValue (const CGUIValue &rkValue)
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 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	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 ()

Protected Member Functions
	CGUIAbstractBar ()
	CGUIAbstractBar (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
	CGUIAbstractBar (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)
	CGUIAbstractBar (const CGUIAbstractBar &kSource)
CGUIAbstractBar &	operator= (const CGUIAbstractBar &kSource)
virtual void	ReadFromStream ()
virtual void	WriteToStream (const eC_Bool bWriteClassID=false)
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

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 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 Attributes inherited from CGUIObject
UUID_t	m_kUUID
	UUID of object.

Detailed Description

Base class for bars.

It is meant to be the base class for controls like progress bar and slider and does not include any visualization code therefore the class cannot be used standalone.

A key feature of this class is that it calls InvalidateArea() for all functions that might change the status of the derived control in such a way that the visual appearance needs to be updated. Especially all get-functions do not imply such graphics updates therefore they do not have corresponding interface functions in this class but they may rather be called directly on the CGUIRange member of this class.

Constructor & Destructor Documentation

CGUIAbstractBar() [1/4]

CGUIAbstractBar::CGUIAbstractBar ( )

protected

CGUIAbstractBar standard constructor.

See also

CGUIObject().

CGUIAbstractBar() [2/4]

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

protected

CGUIAbstractBar constructor.

Parameters

pkParent	Pointer to parent object.
vX	X position relative to its parent object.
vY	Y position relative to its parent object.
vWidth	Width of this object.
vHeight	Height of this object.
eID	Object Identifier of this object

CGUIAbstractBar() [3/4]

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

protected

CGUIAbstractBar constructor.

Parameters

pkParent	Pointer to parent object.
kRect	Structure containing x- and y-coordinates as well as width and height.
eID	Object Identifier of this object

CGUIAbstractBar() [4/4]

CGUIAbstractBar::CGUIAbstractBar ( const CGUIAbstractBar &  kSource )

protected

Copy-constructor of the CGUIAbstractBar class.

Parameters

kSource

Source object to be copied.

Member Function Documentation

AnimateToValue()

void CGUIAbstractBar::AnimateToValue

(

const eC_Int

iTargetValue

)

Animates to the given target value. This is done by increasing/decreasing the current value in steps whose size is given by SetAnimationSpeed(). The given target value is automatically clipped to the current range and rounded to the current step size.

Parameters

iTargetValue

Value to which to animate.

Decrease()

eC_Bool CGUIAbstractBar::Decrease ( )

inlinevirtual

Calls the corresponding CGUIRange function and InvalidateArea().

Returns

always false

Reimplemented from CGUIBehaviour.

Reimplemented in CGUIProgressBar, and CGUIRadialProgressBar.

DoAnimate()

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

Reimplemented in CGUIGauge, and CGUIProgressBar.

GetAnimationInterval()

eC_UInt CGUIAbstractBar::GetAnimationInterval ( ) const

inline

Returns the timer interval in milliseconds for animation.

Returns

Millisecond interval for animation

GetAnimationSpeed()

eC_UInt CGUIAbstractBar::GetAnimationSpeed ( ) const

inline

Returns the speed for animated scrolling

Returns

Value delta per animation step

GetRange()

const CGUIRange & CGUIAbstractBar::GetRange ( ) const

inline

Only constant functions like get-functions of CGUIRange may be called directly on m_kRange from outside of this class. This is why a "const CGUIRange&" is returned. All others must be called via this wrapper class.

Returns

const CGUIRange& The current range

Increase()

eC_Bool CGUIAbstractBar::Increase ( )

inlinevirtual

Calls the corresponding CGUIRange function and InvalidateArea().

Returns

always false

Reimplemented from CGUIBehaviour.

Reimplemented in CGUIProgressBar, and CGUIRadialProgressBar.

OnValueChange()

virtual eC_Bool CGUIAbstractBar::OnValueChange ( )

inlinevirtual

Virtual method which gets called whenever the value of the corresponding GUIRange changes. This will be done prior to notifying any observers subscribed to this GUIAbstractBar. Derived classes can override this method to implement specific behavior in reaction to a change of the contained value.

In particular, it is possible to override the default invalidation-behavior, which will invalidate the entire object. If a derived class implements an optimized invalidation algorithm, it must return TRUE, indicating to the base-class that it has already taken care of invalidation. If you are not familiar with Guiliani's invalidation mechanisms, return FALSE.

Returns

True if an implementation of a derived class has implemented its own invalidation algorithm, False otherwise

Reimplemented in CGUIGauge, and CGUISegmentBar.

operator=()

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

protected

Assignment operator of the CGUIAbstractBar class.

Parameters

kSource

Source object to be copied.

Returns

Copied object.

ReadFromStream()

virtual void CGUIAbstractBar::ReadFromStream ( )

protectedvirtual

Reads all object attributes from streaming file. Only for use with GUIFactory. GUIStreamingFileReader has to be set in CGUI::Init().

See also

CGUIFactory

Reimplemented from CGUIObject.

Reimplemented in CGUIBaseSlider, CGUICircularSlider, CGUIGauge, CGUIKnob, CGUIProgressBar, CGUIRadialBar, CGUIRadialProgressBar, CGUIRadialSlider, CGUIRangeSlider, CGUISegmentBar, and CGUISlider.

SetAnimationInterval()

void CGUIAbstractBar::SetAnimationInterval ( const eC_UInt &  ruiAnimationInterval )

inline

Sets timer interval in milliseconds for animation.

Parameters

ruiAnimationInterval

Millisecond interval for animation

SetAnimationSpeed()

void CGUIAbstractBar::SetAnimationSpeed ( const eC_UInt &  ruiAnimationSpeed )

inline

Sets speed for animation. This is the delta by which the value will be changed when animating to a value via AnimateToValue()

Parameters

ruiAnimationSpeed

Value delta per animation step

SetBase()

void CGUIAbstractBar::SetBase ( CGUIRange::Base_t  eBase )

inline

Calls the corresponding CGUIRange function and InvalidateArea().

Parameters

eBase

base-point

SetLevel()

void CGUIAbstractBar::SetLevel ( eC_Value  vPercent )

inline

Calls the corresponding CGUIRange function and InvalidateArea().

Parameters

vPercent

level

SetLevelPercentage()

void CGUIAbstractBar::SetLevelPercentage ( eC_UInt  uiPercentage )

inline

Calls the corresponding CGUIRange function and InvalidateArea().

Parameters

uiPercentage

level-percentage

SetMaximumLevelIsAlwaysValid()

void CGUIAbstractBar::SetMaximumLevelIsAlwaysValid ( eC_Bool  bNotOnlyMultiplesOfStepSize )

inline

Calls the corresponding CGUIRange function and InvalidateArea().

Parameters

bNotOnlyMultiplesOfStepSize

only multiples of stepsize valid

SetMaxValue()

void CGUIAbstractBar::SetMaxValue ( eC_Int  iMaxValue )

inline

Calls the corresponding CGUIRange function and InvalidateArea().

Parameters

iMaxValue

maximum value

SetMinValue()

void CGUIAbstractBar::SetMinValue ( eC_Int  iMinValue )

inline

Calls the corresponding CGUIRange function and InvalidateArea().

Parameters

iMinValue

minimum value

SetRange()

void CGUIAbstractBar::SetRange ( eC_Int  iMinValue, eC_Int  iMaxValue  )

inline

Calls the corresponding CGUIRange function and InvalidateArea().

Parameters

iMinValue	minimum value
iMaxValue	maximum value

SetStepSize()

void CGUIAbstractBar::SetStepSize ( eC_UInt  uiIntValues )

inline

Calls the corresponding CGUIRange function and InvalidateArea().

Parameters

uiIntValues

step-size

SetStepSizeLevel()

void CGUIAbstractBar::SetStepSizeLevel ( eC_Value  vPercent )

inline

Calls the corresponding CGUIRange function and InvalidateArea().

Parameters

vPercent

step-size-level

SetStepSizeLevelPercentage()

void CGUIAbstractBar::SetStepSizeLevelPercentage ( eC_UInt  uiPercentage )

inline

Calls the corresponding CGUIRange function and InvalidateArea().

Parameters

uiPercentage

step-size-level-percentage

SetValue()

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

inlinevirtual

Sets the value of this bar.

See also

CGUIRange::SetValue()

Parameters

rkValue

The CGUIValue containing the new value

Returns

Always True.

Reimplemented from CGUIObject.

Reimplemented in CGUICircularSlider, CGUIKnob, CGUIRadialSlider, and CGUIRangeSlider.

WriteToStream()

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

protectedvirtual

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 CGUIObject.

Reimplemented in CGUIGauge, CGUIBaseSlider, CGUICircularSlider, CGUIKnob, CGUIProgressBar, CGUIRadialBar, CGUIRadialProgressBar, CGUIRadialSlider, CGUIRangeSlider, CGUISegmentBar, and CGUISlider.

---

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

• GUIAbstractBar.h