CBCGPProgressDlg

Detailed Description

The CBCGPProgressDlg class implements a modeless dialog that allows to display a progress of a lengthy operation.

This dialog offers the following features:

• Progress indicator
• Progress percentage
• Owner-draw header
• Animation
• Theme support

To display a progress dialog you need to perform the following steps:

• Construct a dialog object: m_pProgressDlg = new CMyProgressDlg(&m_Header);
• Enable theme (optionally): m_pProgressDlg->EnableVisualManagerStyle();
• Construct and fill the CBCGPProgressDlgParams structure.
• Create the dialog: m_pProgressDlg->Create(params, this);

Important: to avoid the dialog (as well as your application) "freezing" during a long-time process, we strongly recommend to make any time-consuming processes (such as data loading) in the working thread and pass the execution percentage the progress dialog using some user-defined message.

Take a look at the ProgressDialogDemo sample for more information.

Inheritance diagram for CBCGPProgressDlg:

Public Member Functions
	CBCGPProgressDlg	The constructor.
	Create	Creates and displays a progress dialog.
	GetParameters	Returns current parameters.
	GetPos	Gets the current position of the progress bar.
	OffsetPos	Advances the progress bar control's current position by the increment specified by nPos and redraws the bar to reflect the new position.
	RedrawHeader	Redraws a progress dialog header.
	SetMessage	Sets the first message.
	SetMessage2	Sets the second message
	SetPos	Sets the current position for a progress bar control and redraws the bar to reflect the new position.
	SetPos	Sets the current position for a progress bar control and redraws the bar to reflect the new position.
	StepIt	Advances the current position for a progress bar control by the step increment and redraws the bar to reflect the new position.
Public Member Functions inherited from CBCGPDialog
	CBCGPDialog	Constructs a CBCGPDialog object
	CBCGPDialog	Constructs a CBCGPDialog object
	AutoResizeControls	Enable auto-resizing check boxes, radio buttons and static labels.
	ClosePopupDlg	Closes the popup dialog.
	DoDrawSpecialAreaOnNC	Initiates drawing of specific area on the dialog box edges (non-client area). If you're calling this method, you should handle BCGM_ONDRAWNCSPECIALAREA registered message in your dialog class.
	EnableAero	Adds DWM ("Glass") support either to whole dialog, or to some of its margins.
	EnableDragClientArea	Allows to drag the dialog box by clicking inside the client area.
	EnableExpand	Enables expanding and collapsing of the dialog's part.
	EnableExpand	Enables expanding and collapsing of the dialog's part.
	EnableLayout	Enables or disables layout manager for a dialog box
	EnableLoadWindowPlacement	Enables loading/saving window placement from/to the registry.
	EnableVisualManagerStyle	Adds visual theme support to the dialog
	Expand	Expands or collapses the dialog box.
	GetAeroMargins	Retrieves the dialog DWM (glass) margins.
	GetInfoTipControl	Gets a dialog control with currently active info tip.
	GetLayout	Returns a pointer to layout manager.
	HasAeroMargins	Tells whether a window has "DWM (glass) margins.
	HasBackgroundImage	Tells whether the dialog has background image.
	IsAutoPrepareComboListStyles	Tells whether all child list box and combo boxes should be recreated by adding "owner-draw fixed" and "has strings" Windows styles.
	IsControlsDefaultDlgBackground	Tells whether controls background redrawing is optimized.
	IsDragClientAreaEnabled	Tells whether a drag client area is enabled.
	IsExpandAreaSpecialBackground	Tells whether a dialog expanded area has a special background.
	IsExpanded	Tells whether the dialog box is expanded.
	IsGroupBoxesDrawByParent	Tells whether group box control is rendered by parent window.
	IsLayoutEnabled	Tells whether layout management is enabled for a dialog box.
	IsMFCResourceLayout	Tells whether the dialog uses MFC resource (loaded from the dialog resource) layout.
	IsOwnerDrawCaption	Tells whether a dialog has an owner-draw caption.
	IsVisualManagerNCArea	Tells whether a non-client area of the window uses visual manager style.
	IsVisualManagerStyle	Tells whether a window uses visual manager style.
	IsWindowPlacementEnabled	Tells whether loading/saving window placement from/to the registry is enabled.
	IsWsCaptionStyle	Tells whether a window with themed non-client area is created with WS_CAPTION style.
	OnAfterExpand	Called by the framework after the dialog was expanded.
	OnBeforeExpand	Called by the framework before the dialog is expanded.
	RemoveInfoTips	Removes all previously added information tips.
	SetBackgroundColor	Sets a new background color
	SetBackgroundImage	Sets the dialog box's background image
	SetBackgroundImage	Sets the dialog box's background image
	SetControlInfoTip	Adds an information tip to the dialog child control specified by control ID.
	SetControlInfoTip	Adds an information tip to the dialog child control specified by window.
	SetControlsDefaultDlgBackground	Enables/disables child controls background optimized redrawing.
	SetEditBoxesVerticalAlignment	Specifies vertical alignment for all edit boxes located on the window (single-line only).
	SetExpandAreaSpecialBackground	Specifies whether a dialog expanded area has a special (usually darker) background.
	SetGroupBoxesDrawByParent	Enables drawing group box controls by the parent window.

Protected Member Functions
	OnDrawHeader	Called by a progress dialog to draw the header (banner) above the progress control.
	OnDrawHeaderOnNCArea	Called by a progress dialog to draw the header (banner) above the progress control on the dialog's non-client area.

Additional Inherited Members
Public Types inherited from CBCGPDialog
enum	BackgroundLocation
Protected Attributes inherited from CBCGPDialog
	m_bDisableShadows	Specifies whether the dialog custom shadows should be disabled.