CBCGPStepProgressBarRenderer

Detailed Description

The CBCGPStepProgressBarRenderer class implements drawing of a time line of the tasks and indicates the execution progress.

It provides the following features and benefits:

• Horizontal and vertical layouts. The vertical layout can be in the inverse direction (from bottom to top).
• Header and footer step text labels.
• Separate icon sets for the completed and pending steps.
• The progress bar, located on the baseline, indicates the current step's progress.
• The current step can be outlined.

Inheritance diagram for CBCGPStepProgressBarRenderer:

Public Types
enum	BCGPStepProgressBarLayout
Public Types inherited from CBCGPAnimationManager
enum	BCGPAnimationType

Public Member Functions
	CBCGPStepProgressBarRenderer	Constructor.
	DoDraw	Draw the step progress bar on the given device content.
	GetCompletedColor	Retrieves the color of the completed steps.
	GetCompletedSteps	Retrieves the completed steps number.
	GetCurrentStepProgress	Retrieves the current step progress.
	GetLayout	Retrieves a step progress layout.
	GetOptimalSize	Retrieves the optimal size of the step progress bar.
	IsHighlightCompletedStepsTextLabels	Tells whether the completed steps labels are highlighted.
	IsOutlineCurrentStep	Tells whether the current step is outlined.
	IsReversedOrder	Tells whether the vertically-oriented steps progress bar has the reversed order.
	IsStepCompleted	Tells whether the specified step is completed.
	SetCompletedColor	Specifies the color of the completed steps.
	SetCompletedIcons	Specfies the step progress bar icons for completed steps.
	SetCompletedSteps	Specifies the completed steps number.
	SetCurrentStepProgress	Specifies the current step progress.
	SetHeaders	Specfies the step progress bar header labels.
	SetHeaders	Specfies the step progress bar header labels.
	SetHighlightCompletedStepsTextLabels	Specifies whether the completed steps labels should be highlighted.
	SetIcons	Specfies the step progress bar icons.
	SetLayout	Specifies a step progress layout.
	SetOutlineCurrentStep	Specifies whether the current step is outlined.
	SetReversedOrder	Specifies whether the vertically-oriented steps progress bar has the reversed order.
	SetSteps	Specfies the step progress bar step labels.
	SetSteps	Specfies the step progress bar steps.
Public Member Functions inherited from CBCGPAnimationManager
	CBCGPAnimationManager	Default constructor.
	GetAnimatedValue	Gets current animated value.
	GetAnimationDuration	Gets animation duration.
	GetLastAnimationError	Gets the animation error returned by recent call to Windows Animation API.
	IsAnimated	Checks if animation is running.
	StartAnimation	Starts an animation.
	StartFlashAnimation	Starts "flash" animation.
	StopAnimation	Stops an animation.
Public Member Functions inherited from CBCGPGraphicsManagerHelper
	SetGraphicsManagerType	Specifies a graphics manager type.

Additional Inherited Members
Static Public Member Functions inherited from CBCGPAnimationManager
	IsAnimationSupportedByOS	Checks if animation is supported by OS.
Protected Member Functions inherited from CBCGPAnimationManager
	OnAnimationIdle	Called by the framework in an animation idle time.
Protected Member Functions inherited from CBCGPGraphicsManagerHelper
	DoGraphicsManagerDraw	Call this method to initiate a window content drawing using the graphics manager.
	DoGraphicsManagerDraw	Call this method to initiate a window content drawing using the graphics manager.