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

A bitmap based progress bar. More...

#include <GUIProgressBar.h>

Inheritance diagram for CGUIProgressBar:

Public Types

enum  LoopMode_t { LM_LOOP_MODE, LM_REVERTLOOP_MODE, LM_FILL_UP, LM_FILL_UP_TILE }
 Loop modes for PBT_PROGRESSBAR_TYPE_ACTIVITY. More...
 
enum  ProgressBarType_t { PBT_PROGRESSBAR_TYPE_NORMAL, PBT_PROGRESSBAR_TYPE_ACTIVITY }
 Progress bar types. More...
 
- Public Types inherited from CGUIObject
enum  FourWayFocus_t { FOCUS_LEFT, FOCUS_RIGHT, FOCUS_UP, FOCUS_DOWN }
 

Public Member Functions

 CGUIProgressBar (CGUICompositeObject *const pParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIProgressBar (CGUICompositeObject *const pParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ImageResource_t &eBackground, const ImageResource_t &eForeground, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIProgressBar (CGUICompositeObject *const pParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIProgressBar (CGUICompositeObject *const pParent, const CGUIRect &kRect, const ImageResource_t &eBackground, const ImageResource_t &eForeground, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIProgressBar (const CGUIProgressBar &kSource)
 
 ~CGUIProgressBar ()
 Destructor.
 
eC_Bool Decrease ()
 
virtual void DoAnimate (const eC_Value &vTimes=eC_FromInt(1))
 
virtual eC_Bool DoDraw ()
 
eC_Value GetBarHeight () const
 
eC_Value GetBarWidth () const
 
eC_Value GetBarXPos () const
 
eC_Value GetBarYPos () const
 
eC_UInt GetForegroundColor () const
 
eC_Value GetFullRangeSize () const
 
LoopMode_t GetLoopMode () const
 
CGUINinePatchGetNinePatch ()
 
ProgressBarType_t GetTypeOfProgressBar () const
 
eC_Bool Increase ()
 
virtual eC_Bool IsHighlightable () const
 
eC_Bool IsVertical () const
 
CGUIProgressBaroperator= (const CGUIProgressBar &kSource)
 
virtual void ReadFromStream ()
 
void SetBarHeight (const eC_Value &vHeight)
 
void SetBarRect (CGUIRect &kBarRect)
 
void SetBarWidth (const eC_Value &vWidth)
 
void SetBarXPos (const eC_Value &vX)
 
void SetBarYPos (const eC_Value &vY)
 
void SetForegroundColor (const eC_UInt &uiForegroundColor)
 
void SetForegroundColor (const GlobalProperty_t &eForegroundColor)
 
void SetFullRangeSize (const eC_Value &vSize)
 
virtual void SetHeight (const eC_Value &vHeight)
 
void SetImages (const ImageResource_t eForeground, const ImageResource_t eBackground)
 
void SetLoopMode (LoopMode_t eLM)
 
void SetTypeOfProgressBar (ProgressBarType_t eType)
 
void SetVertical (eC_Bool bVert)
 
virtual void SetWidth (const eC_Value &vWidth)
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUIAbstractBar
void AnimateToValue (const eC_Int iTargetValue)
 
eC_UInt GetAnimationInterval () const
 
eC_UInt GetAnimationSpeed () const
 
const CGUIRangeGetRange () const
 
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 (CGUICompositeObject *const pParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIObject (CGUICompositeObject *const pParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIObject ()
 
 CGUIObject (const CGUIObject &kSource)
 
virtual ~CGUIObject ()
 
void AddValueObserver (CGUIObserver *pObserver)
 
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 DoDrawSnapshot ()
 
virtual void EnableSnapshotDrawing ()
 
virtual CGUIObjectFindObject (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
 
CGUIBehaviourDecoratorGetBehaviour ()
 
const CGUIBehaviourDecoratorGetBehaviour () const
 
GUIBitmapPlaneID_t GetBitmapID () const
 
CGUIBitmapPlaneGetBitmapPlane () 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
 
CDataPoolConnectorGetDataPoolConnector ()
 
eC_Value GetDistanceBottom () const
 
eC_Value GetDistanceRight () const
 
eC_Value GetHalfHeight () const
 
eC_Value GetHalfWidth () const
 
eC_Value GetHeight () const
 
ObjectHandle_t GetID () const
 
CGUILayouterGetLayouter ()
 
const CGUILayouterGetLayouter () const
 
ObjectHandle_t GetNeighborBottomID () const
 
ObjectHandle_t GetNeighborLeftID () const
 
ObjectHandle_t GetNeighborRightID () const
 
ObjectHandle_t GetNeighborTopID () const
 
CGUIObjectGetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false)
 
const CGUIObjectGetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false) const
 
CGUIRect GetOriginRect () const
 
CGUICompositeObjectGetParent ()
 
const CGUICompositeObjectGetParent () 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
 
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)
 
CGUIObjectoperator= (const CGUIObject &kSource)
 
virtual void RefreshLayout (CGUILayouter::eMovedEdges_t eMovedEdges) const
 
void RemoveValueObserver (CGUIObserver *pObserver)
 
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 *pBehaviour)
 
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)
 
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 pParent)
 
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)
 
- 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 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
 
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 ()
 
- 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.
 
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)
 

Protected Member Functions

void CopyAttributes (const CGUIProgressBar &kSource)
 
void DeInit ()
 Deinitialize the control and free the resources.
 
virtual void DrawTypeActivityBar ()
 
virtual void DrawTypeNormalBar ()
 
eC_Bool IncrementValue (eC_Bool bInc)
 
void Init (const ImageResource_t &eForeground, const ImageResource_t &eBackground)
 
- Protected Member Functions inherited from CGUIAbstractBar
 CGUIAbstractBar ()
 
 CGUIAbstractBar (CGUICompositeObject *const pParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIAbstractBar (CGUICompositeObject *const pParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIAbstractBar (const CGUIAbstractBar &kSource)
 
CGUIAbstractBaroperator= (const CGUIAbstractBar &kSource)
 
- 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

eC_Bool m_bLoopDirection
 Indicates the direction in which the bar will be moving in Activity mode.
 
ImageResource_t m_eImgBackground
 Background image ID.
 
ImageResource_t m_eImgForeground
 Foreground image ID.
 
LoopMode_t m_eLoopMode
 Loop mode used in the progress bar with activity type.
 
ProgressBarType_t m_eProgressBarType
 The progress bar type.
 
CGUICommonEnums::Orientation_t m_eStyle
 Indicates whether the progress bar is a vertical bar or horizontal bar.
 
CGUINinePatch m_kNinePatch
 Nine patch borders for scaling the foreground image.
 
eC_Value m_vBarHeight
 The height of the progressing area.
 
eC_Value m_vBarWidth
 The width of the progressing area.
 
eC_Value m_vBarX
 The x position of the progressing area relative to the control.
 
eC_Value m_vBarY
 The y position of the progressing area relative to the control.
 

Additional Inherited Members

- Static Public Attributes inherited from CGUIObject
static const eC_Char XMLTAG_ALPHA [] = "Alpha"
 XML tag to be used writing alpha-value into a stream.
 
static const eC_Char XMLTAG_CLICKTHROUGH [] = "ClickThrough"
 XML tag to be used writing clickthrough-state into a stream.
 
static const eC_Char XMLTAG_CONTROLCLASSID [] = "ControlClassID"
 XML tag to be used when writing a control class ID into a stream.
 
static const eC_Char XMLTAG_DISABLED [] = "Disabled"
 XML tag to be used writing disabled-state into a stream.
 
static const eC_Char XMLTAG_FOCUSSABLE [] = "Focussable"
 XML tag to be used writing focussable-state into a stream.
 
static const eC_Char XMLTAG_GRAYEDOUT [] = "GrayedOut"
 XML tag to be used writing grayedout-state into a stream.
 
static const eC_Char XMLTAG_HEIGHT [] = "Height"
 XML tag to be used writing height into a stream.
 
static const eC_Char XMLTAG_INVISIBLE [] = "Invisible"
 XML tag to be used writing invisible-state into a stream.
 
static const eC_Char XMLTAG_OBJECTID [] = "ObjectID"
 XML tag to be used writing object id into a stream.
 
static const eC_Char XMLTAG_OVERRIDDENNEIGHBORS [] = "OverriddenNeighbors"
 XML tag to be used writing overridden neighbors into a stream.
 
static const eC_Char XMLTAG_WIDTH [] = "Width"
 XML tag to be used writing width into a stream.
 
static const eC_Char XMLTAG_XPOS [] = "XPos"
 XML tag to be used writing x-position into a stream.
 
static const eC_Char XMLTAG_YPOS [] = "YPos"
 XML tag to be used writing y-position into a stream.
 
- Static Public Attributes inherited from CGUIBehaviour
static const eC_Char XMLTAG_BEHAVIOURCLASSID [] = "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 [] = "ClassVersion"
 

Detailed Description

A bitmap based progress bar.

progress_bar.png
The "progress bar" control is used to give the user an indication of how long an operation is going to take, and show that the running task is still in progress. It can also be used for every kind of bar graph visualization. The "progress bar" control consists of two images, one for the background and one for the bar itself (Class: CGUIProgressBar). The "progress bar" supports nine patch images (CGUINinePatch).

A progress bar control is used to give the user an indication of how long an operation is going to take, and to show that the application has not frozen.

The progress bar can be oriented vertically or horizontally. It has two types named normal type or activity type. A normal type progress bar indicates fractions of a maximum amount. It fills the progressing area from left to right or bottom to up normally. This can be reversed by using the SetBase() API.

The activity mode is used to indicate an indeterminate progress bar, i.e. the duration of an operation can not be determined. There are several Loop-Modes which define how the progressbar is animated in this case.

Normally the progressing area is determined by the given foreground image. It can not exceed the whole control's dimension. The range can be changed with SetFullRangeSize().

If the Foreground image is smaller than the bar itself, it will be scaled to the required size. You can customize the foreground image's scaling behaviour through it's CGUINinePatch. The background image will automatically be scaled by leaving the left and right half untouched and only stretching the middle pixel(s) to reach the desired size.

If the Foreground image is at least the same size as the bar itself, it will not be scaled/stretched. Instead it will be "cut off" to the required size.

Example:

// Create a progress bar.
CGUIProgressBar* pkProgressBar = new CGUIProgressBar(this,
eC_FromInt(0), eC_FromInt(0),
eC_FromInt(100), eC_FromInt(30),
NO_HANDLE);
// Set images.
// Before calling this method, please add image IDs to UserImageResource.h.
// After that call GETRESMANAGER.RegisterImageResource() to register images for image IDs.
pkProgressBar->SetImages(IMG_FOREGROUND,
IMG_BACKGROUND);
// Set the type of progress bar.
// Set the type of looping mode to be used when type activity.

Member Enumeration Documentation

◆ LoopMode_t

Loop modes for PBT_PROGRESSBAR_TYPE_ACTIVITY.

Enumerator
LM_LOOP_MODE 

The full bar travels from start to end repeatedly.

LM_REVERTLOOP_MODE 

Cycles the full bar from start to end and reverts direction from end to start repeatedly.

LM_FILL_UP 

Fills up the bar from start to end until full and starts again empty repeatedly.

LM_FILL_UP_TILE 

Fills up the bar tiled.

◆ ProgressBarType_t

Progress bar types.

Enumerator
PBT_PROGRESSBAR_TYPE_NORMAL 

Traditional progress bar. The bar is static and a level or percentage of progress is shown in the control.

PBT_PROGRESSBAR_TYPE_ACTIVITY 

The bar inside the control moves from one end to another as specified by the looping mode (see LoopMode_t enumerator for information on loop modes). Apart from this an animation interval and step size has to be set (see SetAnimationInterval() and SetStepSize()) to define animation speed. Bar dimensions are set by using SetFullRangeSize().

Constructor & Destructor Documentation

◆ CGUIProgressBar() [1/5]

CGUIProgressBar::CGUIProgressBar ( CGUICompositeObject *const  pParent,
const eC_Value &  vX,
const eC_Value &  vY,
const eC_Value &  vWidth,
const eC_Value &  vHeight,
const ObjectHandle_t eID = NO_HANDLE 
)

Constructor. By default, the progress bar type is set to be PBT_PROGRESSBAR_TYPE_NORMAL. The level range is from 0 to 100. The step size is set to 1 pixel. The dimension of the bar is determined after the foreground image is set. Here it is set to be 0 by 0.

Parameters
pParentPointer to parent object.
vXX position relative to its parent object.
vYY position relative to its parent object.
vWidthWidth of the control.
vHeightHeight of the control.
eIDobject handle for the control.

◆ CGUIProgressBar() [2/5]

CGUIProgressBar::CGUIProgressBar ( CGUICompositeObject *const  pParent,
const eC_Value &  vX,
const eC_Value &  vY,
const eC_Value &  vWidth,
const eC_Value &  vHeight,
const ImageResource_t eBackground,
const ImageResource_t eForeground,
const ObjectHandle_t eID = NO_HANDLE 
)

Constructor. By default, the progress bar type is set to be PBT_PROGRESSBAR_TYPE_NORMAL. The level range is from 0 to 100. The step size is set to 1 pixel. The dimension of the bar is determined by the foreground image. It can not exceed the dimension of the control.

Parameters
pParentPointer to parent object.
vXX position relative to its parent object.
vYY position relative to its parent object.
vWidthWidth of the control.
vHeightHeight of the control.
eBackgroundBackground image of the control.
eForegroundForeground image of the control.
eIDObject handle for the control.

◆ CGUIProgressBar() [3/5]

CGUIProgressBar::CGUIProgressBar ( CGUICompositeObject *const  pParent,
const CGUIRect kRect,
const ObjectHandle_t eID = NO_HANDLE 
)

Constructor. By default, the progress bar type is set to be PBT_PROGRESSBAR_TYPE_NORMAL. The level range is from 0 to 100. The step size is set to 1 pixel. The dimension of the bar is determined after the foreground image is set. Here it is set to be 0 by 0.

Parameters
pParentPointer to parent object.
kRectrectangle area
eIDobject handle for the control.

◆ CGUIProgressBar() [4/5]

CGUIProgressBar::CGUIProgressBar ( CGUICompositeObject *const  pParent,
const CGUIRect kRect,
const ImageResource_t eBackground,
const ImageResource_t eForeground,
const ObjectHandle_t eID = NO_HANDLE 
)

Constructor. By default, the progress bar type is set to be PBT_PROGRESSBAR_TYPE_NORMAL. The level range is from 0 to 100. The step size is set to 1 pixel. The dimension of the bar is determined by the foreground image. It can not exceed the dimension of the control.

Parameters
pParentPointer to parent object.
kRectrectangle area
eBackgroundBackground image of the control.
eForegroundForeground image of the control.
eIDObject handle for the control.

◆ CGUIProgressBar() [5/5]

CGUIProgressBar::CGUIProgressBar ( const CGUIProgressBar kSource)

Copy-constructor of the CGUIProgressBar class.

Parameters
kSourceSource object to be copied.

Member Function Documentation

◆ CopyAttributes()

void CGUIProgressBar::CopyAttributes ( const CGUIProgressBar kSource)
protected

Copy attributes from source control to this control.

Parameters
kSourceSource object to be copied.

◆ Decrease()

eC_Bool CGUIProgressBar::Decrease ( )
virtual

Decreases the level/percentage of the bar by the value that is set with SetStepSize().

Returns
True if successful, False otherwise

Reimplemented from CGUIAbstractBar.

◆ DoAnimate()

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

Called when the timer of an animation callback belonging to this animatable has expired.

Parameters
vTimesThe 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 CGUIAbstractBar.

◆ DoDraw()

eC_Bool CGUIProgressBar::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.

◆ DrawTypeActivityBar()

void CGUIProgressBar::DrawTypeActivityBar ( )
protectedvirtual

Draw the activity bar.

◆ DrawTypeNormalBar()

void CGUIProgressBar::DrawTypeNormalBar ( )
protectedvirtual

Draw the normal bar

◆ GetBarHeight()

eC_Value CGUIProgressBar::GetBarHeight ( ) const
inline

Returns the height of the bar.

Returns
height of bar

◆ GetBarWidth()

eC_Value CGUIProgressBar::GetBarWidth ( ) const
inline

Returns the width of the bar.

Returns
bar-wdith

◆ GetBarXPos()

eC_Value CGUIProgressBar::GetBarXPos ( ) const
inline

Returns the X position of the bar.

Returns
x-position of bar

◆ GetBarYPos()

eC_Value CGUIProgressBar::GetBarYPos ( ) const
inline

Returns the Y position of the bar.

Returns
y-position of bar

◆ GetForegroundColor()

eC_UInt CGUIProgressBar::GetForegroundColor ( ) const

Get the currently set foreground-color which is used when DUMMY_IMAGE is set

Returns
foreground-color

◆ GetFullRangeSize()

eC_Value CGUIProgressBar::GetFullRangeSize ( ) const
inline
Returns
The bar's full range size.

◆ GetLoopMode()

LoopMode_t CGUIProgressBar::GetLoopMode ( ) const
inline

This function return the mode in which the ProgressBar will loop.

See also
SetLoopMode()
Returns
Loop mode for the control

◆ GetNinePatch()

CGUINinePatch& CGUIProgressBar::GetNinePatch ( )
inline

Grants access to the nine patch which is used for scaling the foreground image.

Returns
Nine patch used to display the object

◆ GetTypeOfProgressBar()

ProgressBarType_t CGUIProgressBar::GetTypeOfProgressBar ( ) const
inline

This function gets the type of progress bar to be shown in the control.

Returns
Progress bar type

◆ Increase()

eC_Bool CGUIProgressBar::Increase ( )
virtual

Increases the level/percentage of the bar by the value that is set with SetStepSize().

Returns
True if successful, False otherwise

Reimplemented from CGUIAbstractBar.

◆ IncrementValue()

eC_Bool CGUIProgressBar::IncrementValue ( eC_Bool  bInc)
protected

Internal method called by Increase() and Decrease().

Parameters
bInctrue to increase a step, false to decrease a step.
Returns
Always True

◆ Init()

void CGUIProgressBar::Init ( const ImageResource_t eForeground,
const ImageResource_t eBackground 
)
protected

Help function to initialize the control.

Parameters
eForegroundbar-image
eBackgroundbackground-image

◆ IsHighlightable()

virtual eC_Bool CGUIProgressBar::IsHighlightable ( ) const
inlinevirtual

This method checks if an object is highlightable. This refers to whether it can be highlighted via the event handler. If true the event handler may mark this object as the currently highlighted one. Thus, there is no special flag in CGUIObject that determines if an object is highlightable. The default determination is that the control is in none of the following states:

  • invisible
  • grayed-out
  • disabled if so the return value will be true. NOTE: when an object is not highlightable, it will never receive DoMouseEnter and DoMouseLeave-events
    Returns
    True if highlightable, False otherwise

Reimplemented from CGUIObject.

◆ IsVertical()

eC_Bool CGUIProgressBar::IsVertical ( ) const
inline

Gets the drawing flag to see whether the progress bar is a vertical one or horizontal one.

Returns
true if vertical

◆ operator=()

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

Operator= method of the CGUIProgressBar class.

Parameters
kSourceSource object to be copied.
Returns
Copied object.

◆ ReadFromStream()

void CGUIProgressBar::ReadFromStream ( )
virtual

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

◆ SetBarHeight()

void CGUIProgressBar::SetBarHeight ( const eC_Value &  vHeight)

Sets the height of the bar.

See also
SetBarRect();
Parameters
vHeightheight to set.

◆ SetBarRect()

void CGUIProgressBar::SetBarRect ( CGUIRect kBarRect)
inline

Sets the position of the bar by given rect. Note that this does not affect the entire object's size/position, but only the "progressing area" of the actual bar inside of it.

Parameters
kBarRectRect to set.

◆ SetBarWidth()

void CGUIProgressBar::SetBarWidth ( const eC_Value &  vWidth)

Sets the width of the bar.

See also
SetBarRect();
Parameters
vWidthwidth to set.

◆ SetBarXPos()

void CGUIProgressBar::SetBarXPos ( const eC_Value &  vX)

Sets the X position of the bar.

See also
SetBarRect();
Parameters
vXX position.

◆ SetBarYPos()

void CGUIProgressBar::SetBarYPos ( const eC_Value &  vY)

Sets the Y position of the bar.

See also
SetBarRect();
Parameters
vYY position.

◆ SetForegroundColor() [1/2]

void CGUIProgressBar::SetForegroundColor ( const eC_UInt &  uiForegroundColor)

Sets the currently used foreground-color which is used when DUMMY_IMAGE is set

Parameters
uiForegroundColorforeground-color

◆ SetForegroundColor() [2/2]

void CGUIProgressBar::SetForegroundColor ( const GlobalProperty_t eForegroundColor)

Sets the currently used foreground-color which is used when DUMMY_IMAGE is set

Parameters
eForegroundColorforeground-color

◆ SetFullRangeSize()

void CGUIProgressBar::SetFullRangeSize ( const eC_Value &  vSize)

The function SetFullRangeSize is used to set the range of bar inside the Progress bar control. If the bar is drawn vertically, the bar's height is changed, otherwise, the bar's width is changed.

Parameters
vSizeBar's range.

◆ SetHeight()

void CGUIProgressBar::SetHeight ( const eC_Value &  vHeight)
virtual

Change the height of this control. The progressing area is changed proportionally.

Parameters
vHeightHeight of the control.

Reimplemented from CGUIObject.

◆ SetImages()

void CGUIProgressBar::SetImages ( const ImageResource_t  eForeground,
const ImageResource_t  eBackground 
)

Sets the foreground and background images. If the bar area dimension is not determined previously, it is set here.

Parameters
eForegroundForeground image of the control.
eBackgroundBackground image of the control.

◆ SetLoopMode()

void CGUIProgressBar::SetLoopMode ( LoopMode_t  eLM)
inline

This function defines the mode in which the ProgressBar will loop, if it is of type PBT_PROGRESSBAR_TYPE_ACTIVITY. This will not have any effect for ProgressBars of type PBT_PROGRESSBAR_TYPE_NORMAL

Parameters
eLMLoop mode for the control.

◆ SetTypeOfProgressBar()

void CGUIProgressBar::SetTypeOfProgressBar ( ProgressBarType_t  eType)

This function sets the type of progress bar to be shown in the control.

Parameters
eTypeProgress bar type.

◆ SetVertical()

void CGUIProgressBar::SetVertical ( eC_Bool  bVert)
inline

Change the draw direction of this control. This decides whether the control is a vertical progress bar or a horizontal progress bar.

Parameters
bVertVertical draw flag.

◆ SetWidth()

void CGUIProgressBar::SetWidth ( const eC_Value &  vWidth)
virtual

Change the width of this control. The progressing area is changed proportionally.

Parameters
vWidthWidth of the control.

Reimplemented from CGUIObject.

◆ WriteToStream()

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

Writes all object attributes to the streaming file. StreamWriter has to be initialized. Only for use with GUIStreamWriter.

Parameters
bWriteClassIDThis 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 CGUIAbstractBar.


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