BCGSuite for MFC
CBCGPCircularProgressIndicatorImpl

Detailed Description

The CBCGPCircularProgressIndicatorImpl implements the functionality of a circular progress indicator.

A circular progress indicator contains the following elements (can be shown optionally):

  • frame
  • progress bar
  • progress value
  • text label

To use a circular progress indicator in an application perform the following steps:

See also
CBCGPCircularGaugeImpl
+ Inheritance diagram for CBCGPCircularProgressIndicatorImpl:

Public Member Functions

 CBCGPCircularProgressIndicatorImplConstructor.
 
 GetColorsReturns the gauge colors (color theme)
 
 GetLabelGets the text label.
 
 GetOptionsReturns the gauge options
 
 GetPosGets a progress bar position.
 
 GetRangeGets the current lower and upper limits, or range, of the progress indicator.
 
 IsMarqueeStartedTells whether marquee animation was started.
 
 IsMarqueeStyleTells whether gauge has a marquee style.
 
 OffsetPosChanges to the progress indicator current position by specifc offset.
 
 SetColorsApplies one of predefined color themes to the gauge.
 
 SetColorsApplies custom color theme to the gauge.
 
 SetLabelSets the text label.
 
 SetOptionsApplies options to the gauge.
 
 SetPosSets a progress position.
 
 SetRangeSets the upper and lower limits of the progress indicator.
 
 SetStepSpecifies the step increment for a progress indicator.
 
 StartMarqueeStarts a marquee animation.
 
 StepItAdvances the current position for a progress indicator by the step increment.
 
- Public Member Functions inherited from CBCGPCircularGaugeImpl
 CBCGPCircularGaugeImplConstructor.
 
 AddPointerAdds a new pointer.
 
 AddScaleAdds a new scale.
 
 AddSubGaugeAdds a sub-gauge.
 
 EnableEquidistantLabelsEnables/disables tick mark equidistant labels.
 
 EnableLabelsRotationEnables/disables tick mark labels rotation around the gauge center.
 
 EnableShapeByTicksAreaEnables/disables gauge shape
 
 GetCapSizeReturns a gauge caps size.
 
 GetColorsReturns the circular gauge colors (color theme)
 
 GetColorThemeReturns a currently selected color theme or (-1) if gauge has a custom theme.
 
 GetPointersCountReturns the number of all gauge pointers.
 
 GetSubGaugeByIDGets sub gauge by identifier.
 
 GetSubGaugesGets all subgauges.
 
 GetTextFormatGets the circular gauge text labels format.
 
 GetTicksAreaFinishAngleReturns scale finish angle.
 
 GetTicksAreaStartAngleReturns scale start angle
 
 IsClosedTells whether scale has a closed range.
 
 IsEquidistantLabelsTells whether tick mark labels are equidistant.
 
 IsLabelRotationTells whether tick mark labels are rotated around the gauge center.
 
 IsShapeByTicksAreaReturns TRUE if the gauge shape is specified by the scale angles
 
 ModifyPointerModifies the pointer appearance.
 
 RemoveAllSubGaugesRemoves all sub-gauges.
 
 RemovePointerRemoves a pointer by index.
 
 RemoveSubGaugeRemoves a sub-gauge.
 
 RotateScaleRotate the circular gauge's scale to the specific angle.
 
 SetCapSizeModify a gauge cap size.
 
 SetClosedRangeSets closed range for the specified scale.
 
 SetColorsApplies one of predefined color themes to the gauge.
 
 SetColorsApplies custom color theme to the gauge.
 
 SetTextFormatSets the circular gauge text labels format.
 
 SetTicksAreaAnglesDefines scale angles.
 
 SetValueSets a gauge value.
 
- Public Member Functions inherited from CBCGPGaugeImpl
 AddColoredRangeAdds a new colored range to a gauge.
 
 AddColoredRangeAdds a new colored range to a gauge.
 
 AddLevelBarAdds a new level bar to a gauge.
 
 AddLevelBarAdds a new level bar to a gauge.
 
 GetColoredRangeReturns a colored range for a scale.
 
 GetCornerRadiusReturns a gauge corner radius (in pixels).
 
 GetDefaultInteractivePointerRetrieves an index of pointer used in the interactive mode by default.
 
 GetDefaultInteractiveScaleRetrieves an index of scale used in the interactive mode by default.
 
 GetFrameSizeGets a gauge frame size (in pixels)
 
 GetLevelBarReturns a level bar for a scale.
 
 GetLevelBarsCountGets level bars count.
 
 GetScaleReturns a scale for a gauge.
 
 GetVisualEffectsRetrieves gauge visual effects.
 
 IsInteractiveModeTells whether an interactive mode is active or not.
 
 RemoveAllColoredRangesRemoves all colored ranges.
 
 RemoveAllLevelBarsRemoves all level bars.
 
 RemoveAllScalesRemoves scales.
 
 RemoveLevelBarRemoves the level bar.
 
 RemoveScaleRemoves a scale.
 
 SetCornerRadiusSpecifies a gauge corner radius
 
 SetDefaultInteractivePointerSpecifies a pointer that will be used in the interactive mode by default.
 
 SetDefaultInteractiveScaleSpecifies a scale that will be used in the interactive mode by default.
 
 SetFrameSizeSets a gauge frame size (in pixels).
 
 SetInteractiveModeEnabler or disables a gauge interactive mode.
 
 SetScaleOffsetFromFrameSets the scale offset from the gauge frame.
 
 SetTickMarkStyleSpecifies the gauge tick mark style.
 
 SetVisualEffectsSpecifies gauge visual effects.
 
- Public Member Functions inherited from CBCGPBaseVisualObject
 CBCGPBaseVisualObjectConstructor.
 
 CBCGPBaseVisualObjectCopy constructor.
 
 CopyToClipboardCopies visual object to the Clipboard.
 
 EnableImageCacheEnables or disables visual object image cache.
 
 ExportToBitmapExports the visual object to bitmap.
 
 ExportToFileExports the visual object to a file (BMP or PNG).
 
 ExportToImageExports the visual object to an image.
 
 GetDataGets an internal data object.
 
 GetDataAnimationTypeGets data animation type.
 
 GetDataCountReturns a number of data objects.
 
 GetEditFlagsGets editing flags.
 
 GetFillBrushRetrieves a visual object's background brush
 
 GetIDGets the object identifier.
 
 GetNameGets the object name.
 
 GetParentContainerGets the parent visual container.
 
 GetRectGets the object bounding rectangle.
 
 GetSelectedThemeObtain a currently selected visual theme.
 
 GetUserDataGets user-defined data associated with this object.
 
 GetValueGets the object value.
 
 GetVisualEffectRetrieves a visual effect
 
 IsAutoDestroyTells whether this object will be destroyed automatically.
 
 IsEditModeTells whether this object has the edit mode.
 
 IsEnabledTells whether the visual object is enabled.
 
 IsImageCacheTells whether image cache is enabled for this object.
 
 IsSelectedTells whether this object is selected in the parent container.
 
 IsVisibleTells whether the visual object is visible.
 
 RedrawRedraws this object.
 
 RedrawRectRedraws a specified rectangle.
 
 SetAutoDestroySpecifies whether the object should be destroyed automatically.
 
 SetDataAnimationTypeSets data animation type.
 
 SetEditFlagsSets editing flags.
 
 SetFillBrushSets a new fill brush.
 
 SetIDSets the object identifier.
 
 SetNameSets an object name.
 
 SetSelectedSelects or unselects the object in the parent container.
 
 SetUserDataSets user-defined data associated with this object.
 
 SetVisibleShows or hides the visual object.
 
 SetVisualEffectSets a visual effect.
 

Additional Inherited Members

- Public Types inherited from CBCGPGaugeImpl
enum  BCGP_SUB_GAUGE_POS