CBCGPEdit

Detailed Description

The CBCGPEdit class implements the functionality of a simple edit control with a browse button. There are four out-of-the-box modes:

• calculator mode: when the user clicks the browse button a popup calculator appears and the result of arithmetical calculations will be inserted in the edit control
• folder mode: the standard Shell folder selection dialog allows to browse for a folder
• file mode: the standard file dialog allows to browse for a file
• popup dialog mode: when the user clicks the browse button a custom popup dialog appears
• custom mode: allows to display a custom dialog

You should to perform the following steps in order to incorporate the edit control in your application:

• Derive your own class from CBCGPEdit class if you want to implement custom browse mode.
• Override CBCGPEdit::OnBrowse if you implement the custom browse mode. In the overridden method you'll need to execute a custom browse action and update the edit control with the result.
• Embed a CBCGPEdit object into the parent window object.
• If you use the edit control in a dialog, place a simple edit control on the dialog form and replace CEdit with CBCGPEdit in the header file. The control will be created automatically. Otherwise you need to create the Windows edit control using CEdit::Create.
• Depending on the desired mode call one of the following methods in order to enable the browse button and put the control into desired browse mode: EnableCalculatorButton(), EnableFolderBrowseButton(), EnableFileBrowseButton(), EnableBrowseButton() or EnablePopupDialog()
• Call SetBrowseButtonImage() if you want to provide a custom image for the browse button or/and override OnDrawBrowseButton().
• If the edit control is placed on a dialog box, setup data exchange using the ClassWizard.
• If at some point you want to remove the browse button from the edit control, just call EnableBrowseButton() with bEnable set to FALSE.

You can find an example of using CBCGPEdit in BCGPControls example, page3.cpp/h (misc controls).

Inheritance diagram for CBCGPEdit:

Public Member Functions
	ClosePopupDlg	Called by the framework when the popup dialog is closed.
	EnableBrowseButton	Enables or disables the browse button.
	EnableCalculatorButton	Enables browse button and puts the edit control in "calculator mode".
	EnableFileBrowseButton	Enables browse button and puts the edit control in "file browse mode".
	EnableFolderBrowseButton	Enables browse button and puts the edit control in "folder browse mode".
	EnableIconOnLeft	Specifies whether icon should be displayed on the left side.
	EnablePasswordPreview	Enables the password preview mode.
	EnablePopupDialog	Enables drop button and puts the edit control in "popup dialog" mode.
	EnablePopupDialog	Enables drop button and puts the edit control in "popup dialog" mode.
	EnableSearchMode	Enables or disables search mode.
	GetColorTheme	Gets edit box custom color theme.
	GetErrorMessage	Gets error message.
	GetMode	Returns the current browse mode.
	GetPrompt	Returns a prompt (displayed when the edit box text is empty).
	GetSearchPrompt	Returns a text string to be displayed in edit box in "search" mode.
	GetVerticalAlignment	Gets a text vertical alignment.
	IsDisableBrowseButtonInReadOnlyMode	Tells whether edit box "Browse" button is disabled in control read-only mode.
	IsDisableFrameAccelTableOnFocus	Tells whether to suppress handling of the keyboard accelerators in the top-level frame when the control is being focused.
	IsIconOnLeftEnabled	Tells whether edit box has an icon on left.
	IsSearchMode	Specifies whether the edit control is working the "search" mode.
	OnBeforeShowPopupDlg	Called by the framework before the popup dialog is displayed.
	SetBrowseButtonImage	Allows to set a custom button image.
	SetBrowseButtonImage	Allows to set a custom button image.
	SetBrowseButtonImage	Allows to set a custom button image.
	SetBrowseButtonToolTip	Sets browse button tool tip.
	SetColorTheme	Sets a custom color theme.
	SetDisableBrowseButtonInReadOnlyMode	Enables or disables edit box "Browse" button in control read-only mode.
	SetDisableFrameAccelTableOnFocus	Specifies whether to suppress handling of the keyboard accelerators in the top-level frame when the control is being focused.
	SetErrorMessage	Sets a custom error message.
	SetPrompt	Sets a prompt displayed when the edit box text is empty.
	SetVerticalAlignment	Specifies a text vertical alignment (single-line only).

Public Attributes
	m_bOnGlass	Specifies whether a control is located on the "glass" (DWM) area of the parent window.
	m_bVisualManagerStyle	Specifies whether a control has a Visual Manager style look.

Protected Member Functions
	OnAfterUpdate	Called by the framework when the edit control has been updated with the result of browse action.
	OnBrowse	Called by the framework when the user has clicked the browse button.
	OnCalculatorUserCommand	Called by the framework when a custom calculator command should be executed.
	OnDrawBrowseButton	Called by the framework when it needs to draw the browse button.
	OnDrawImageOnLeft	Called by the framework when it needs to draw image (icon) of the left side.
	OnIllegalFileName	Called by the framework when the edit control contains an illegal file name and this name is used in a file dialog.