BCGControlBar Pro for MFC
CBCGPRibbonProgressBar

Detailed Description

A CBCGPRibbonProgressBar object visually indicates the progress of a lengthy operation.

It can operate in two modes - regular and infinite. In the regular mode the progress is filled from left to right and stops when reaches the maximum value. In the infinite mode the progress is filled from minimum value to maximum and back.

Use CBCGPRibbonProgressBar::SetRange to define the range, CBCGPRibbonProgressBar::SetPos to set the current progress, CBCGPRibbonProgressBar::SetInfiniteMode to turn the infinite mode on and off.

See also
CBCGPRibbonBar, CBCGPBaseRibbonElement
+ Inheritance diagram for CBCGPRibbonProgressBar:

Public Member Functions

 CBCGPRibbonProgressBarConstructs a CBCGPRibbonProgressBar object
 
 GetPosReturns the current progress.
 
 GetRangeMaxReturns the maximum value of the current range.
 
 GetRangeMinReturns minimum value of the current range.
 
 IsInfiniteModeTells whether the progress bar is working in infinite mode.
 
 IsNarrowChannelTells whether a progress bar has a narrow channel. This flag is suitable for Visual Studio 2012 or higher themes only.
 
 IsVerticalTells whether the progress bar has vertical orientation.
 
 SetInfiniteModeSets infinite mode.
 
 SetNarrowChannelSpecifies whether a progress bar has a narrow channel. This flag is suitable for Visual Studio 2012 or higher themes only.
 
 SetPosSets the current progress.
 
 SetRangeSets minimum and maximum values.
 
- Public Member Functions inherited from CBCGPBaseRibbonElement
 CanBeAddedToQATTells whether ribbon element can be added to QAT.
 
 CanBeRemovedFromQATTells whether ribbon element can be removed from QAT.
 
 GetApplicationModesGets application modes where this control is visible.
 
 GetBackstageAttachedViewReturns a ribbon element, which is placed at the right side of backstage and controlled by this ribbon element.
 
 GetCompactSizeReturns compact size of ribbon element.
 
 GetControlValueRetrieves the ribbon control value
 
 GetCursorAllows to specify a Ribbon control's custom mouse cursor.
 
 GetDataRetrieves a user-defined data associated with ribbon element.
 
 GetDescriptionReturns ribbon element description.
 
 GetIDReturns ribbon element command ID.
 
 GetImageSizeReturns image size of ribbon element.
 
 GetIntermediateSizeReturns the size of ribbon element in "intermediate" state.
 
 GetKeysReturns key tip associated with ribbon element.
 
 GetMenuKeysReturns key tips associated with split button.
 
 GetRectReturns bounding rectangle of ribbon element.
 
 GetSimplifiedModeTypeRetrieves a ribbon element appearance in the Ribbon simplified mode.
 
 GetSizeReturns current size of ribbon element.
 
 GetTextReturns ribbon element text.
 
 GetToolTipTextReturns tooltip text of ribbon element.
 
 HasCompactModeTells whether the ribbon element has "compact mode".
 
 HasIntermediateModeTells whether the ribbon element has "intermediate mode".
 
 HasLargeModeTells whether the ribbon element has "large mode".
 
 IsBackstageViewModeTells whether a ribbon element works in "backstage view" mode.
 
 IsCheckedTells whether ribbon element is checked.
 
 IsCompactModeTells whether ribbon element is in compact mode.
 
 IsDisabledTells whether ribbon element is disabled.
 
 IsDroppedDownTells whether ribbon element is dropped down (displays a popup menu).
 
 IsFocusedTells whether ribbon element is focused.
 
 IsHiddenInFullModeTells whether a ribbon element is invisible in the Ribbon classic (non-simplified) mode.
 
 IsHighlightedTells whether ribbon element is highlighted.
 
 IsPressedTells whether ribbon element is pressed.
 
 OnDPIChangedCalled by the framework when the Ribbon DPI is changed
 
 OnShowPopupMenuCalled when ribbon element is going to display a popup menu.
 
 SetApplicationModesSets application modes where this control is visible.
 
 SetDataAssociates a user-defined data with ribbon element.
 
 SetDescriptionSets ribbon element description.
 
 SetIDSets command ID of ribbon element.
 
 SetKeysSets a key tip for ribbon element.
 
 SetSimplifiedModeTypeSpecifies a ribbon element appearance in the Ribbon simplified mode.
 
 SetTextSets text to ribbon element.
 
 SetToolTipTextSets tooltip text for ribbon element.
 

Additional Inherited Members

- Public Types inherited from CBCGPBaseRibbonElement
enum  RibbonElementLocation
 
enum  RibbonImageType
 
enum  RibbonSimplifiedModeType
 
- Protected Member Functions inherited from CBCGPBaseRibbonElement
 OnBeforeDestroyParentMenuBarCalled by the framework before the parent menu windo is destroyed.
 
 OnProcessKeyCalled by the framework when a ribbon element should process keyboard input.
 
 OnSetFocusCalled by the framework when a ribbon element receives or loses the input focus.