CBCGPColorBar

Detailed Description

The CBCGPColorBar class provides the functionality of the regular docking control bar specially designed to handle various color selection issues in the document/application. The list of built-in features (no additional programming required) includes:

• automatically adjusted list of document colors
• ability to save and restore its state in conjunction with the document state
• "automatic" button
• custom color selection by using CBCGPColorPickerCtrl control
• "tear-off" state (when created from CBCGPColorMenuButton)

Usually, you don't need to create the CBCGPColorBar object directly. It's creation should be handled by CBCGPColorMenuButton (used from menu / toolbar) or by CBCGPColorButton otherwise. You have to perform the following steps to incorporate the CBCGPColorBar functionality into your application:

• Create a regular menu button and assign it some ID, for example ID_CHAR_COLOR.
• In your frame window class override CBCGPFrameWnd::OnShowPopupMenu method and replace the regular menu button by CBCGPColorMenuButton object (call CBCGPToolBar::ReplaceButton).

It's advised to set all the desired styles and enable/disable required features of the CBCGPColorBar during CBCGPColorMenuButton creation, because it will create dynamically the CBCGPColorBar object when the BCGP Framework calls CreatePopupMenu().

CBCGPColorBar object notifies its parents about user selection by sending ON_COMMAND message, where the command ID is the identifier that was assigned to the replaced menu button (ID_CHAR_COLOR in the example above).

See also

CBCGPColorMenuButton, CBCGPColorButton, CBCGPColorPickerCtrl, CBCGPFrameWnd, CBCGPToolBar

Inheritance diagram for CBCGPColorBar:

Public Member Functions
	Create	Creates a Windows control and performs additional initializations
	CreateControl	Creates the Windows control and performs additional initialization steps for the color bar control.
	EnableAutomaticButton	Shows or hides the automatic button
	EnableBorder	Shows or hides a border around color bar.
	EnableOtherButton	Enables ability to show a new dialog box to select an alternative color
	GetColor	Retrieves the current selected color
	GetCommandID	Retrieves a control's command ID
	GetHorzMargin	Returns the horizontal margin - the spacing between the left or right color cell and the client area bounds.
	GetVertMargin	Returns the vertical margin - the spacing between the top or bottom color cell and the client area bounds.
	HasBorder	Tells whether a border around color bar is visible, or hidden.
	OnDrawPaletteColorBox	Called by the framework when the palette color box should be drawn.
	SetColor	Sets a new selected color
	SetCommandID	Sets a new command ID
	SetDocumentColors	Sets the displayed colors from a specific document
	SetHorzMargin	Sets the horizontal margin - the spacing between the left or right color cell and the client area bounds.
	SetVertMargin	Sets the vertical margin - the spacing between the top or bottom color cell and the client area bounds.
Public Member Functions inherited from CBCGPToolBar
	AreTextLabels	Tells whether toolbar buttons should display text labels below images.
	ButtonToIndex	Given a pointer to CBCGPToolbarButton object returns the button's index.
	CanBeClosed	Returns nonzero if the toolbar can be closed by the user.
	CanBeRestored	Returns nonzero if the application can revert a toolbar to its original state after customization.
	CommandToIndex	Given a toolbar button's command ID returns the button's index.
	Create	Creates the control bar control and attaches it to a CBCGPToolBar object.
	CreateEx	Creates a CBCGPToolBar object with additional styles.
	EnableCustomizeButton	Enables or disables an additional "customize" button on the toolbar.
	EnableCustomizeButton	Enables or disables an additional "customize" button on the toolbar.
	EnableLargeIcons	Enables and disables large icons (images) on toolbar buttons.
	EnableTextLabels	Enables and disables text labels below toolbar button's images.
	GetAllButtons	Gives read-only access to the internal list of toolbar buttons.
	GetButton	Given an index returns a toolbar button.
	GetButtonInfo	Given an index of toolbar button, returns an information about this button.
	GetButtonSize	Returns the current size of a toolbar's buttons.
	GetButtonStyle	Returns a style of a toolbar button.
	GetButtonText	Returns a text label of a toolbar button.
	GetButtonText	Returns a text label of a toolbar button.
	GetColumnWidth	Returns the width of toolbar buttons.
	GetControlValue	Retrieves the toolbar item value (e.g., text of the edit box).
	GetCount	Returns a number of buttons on a toolbar.
	GetGrayDisabledButtons	Tells whether the images of the toolbar's disabled buttons should be grayed out or taken from the collection of disabled images.
	GetHighlightedButton	Returns a highlighted toolbar button.
	GetHotBorder	Tells whether the border presentation appears or not.
	GetHwndLastFocus	Returns a handle to window that previously had the input focus.
	GetImageSize	Retrieves the size of toolbar images.
	GetImagesOffset	Retrieves the offset of the toolbar images in the shared (global) collection of toolbar images.
	GetItemID	Given a toolbar button's index retrieves the button's command ID.
	GetItemRect	Given a toolbar button's index returns the button's bounding rectangle.
	GetRouteCommandsViaFrame	Determines whether the toolbar commands are routed via its direct owner (if not NULL) or via the parent frame.
	HideEmptyMenus	Specifies whether toolbar/menu bar items with an empty items should be hidden.
	HitTest	Determines which toolbar button is at a specified position.
	InsertButton	Inserts a button into list of toolbar buttons.
	InsertSeparator	Insets the separator at a specified position.
	IsHideEmptyMenus	Tells whether toolbar/menu bar items with an empty items should be hidden.
	IsToolBarImagesInDropDownMenus	Tells whether toolbar images should be displayed in drop-down menus.
	IsUserDefined	Determines whether a toolbar is the user-defined toolbar.
	LoadBitmap	Loads toolbar images from the application resources.
	LoadBitmapEx	Loads toolbar images from the application resources including large images.
	LoadState	Loads a toolbar state from the Windows registry.
	LoadToolBar	Loads toolbar from the resources.
	LoadToolBarEx	Loads toolbar images from the resources using CBCGPToolBarParams helper that allows to handle large images.
	OnCreateButton	called by the framework to create a toolbar button or control from the XML node.
	OnReset	Called when a toolbar is reverted to its original state.
	RemoveAllButtons	Removes all buttons from a toolbar.
	RemoveButton	Removes a button from a toolbar.
	RemoveStateFromRegistry	Removes a toolbar's state from the Windows registry.
	ReplaceButton	Replaces a toolbar button with another toolbar button.
	ResetImages	Reset all toolbar images except user-defined to the default state.
	RestoreOriginalstate	Restores an original state of a toolbar.
	SaveState	Stores a toolbar's state into the Windows registry.
	SetButtonInfo	Sets properties for a toolbar button.
	SetButtons	Removes existing buttons from a toolbar and inserts a collection of new buttons.
	SetButtonText	Sets a new text label for a toolbar button.
	SetGrayDisabledButtons	Sets a special mode, when images of disabled buttons are grayed or taken from a collection of disabled images.
	SetHeight	Call this function to set the height of a toolbar.
	SetHotBorder	Sets a flag indicating whether toolbar buttons are hot-tracked or not.
	SetLockedSizes	Sets the size of locked toolbar buttons and locked images.
	SetPermament	Sets a flag indicating that a toolbar is permanent and can't be closed.
	SetRouteCommandsViaFrame	Sets a flag indicating whether the toolbar commands are routed via its direct owner (if not NULL) or via the parent frame.
	SetToolBarBtnText	Sets a new text label to the specified toolbar button, and specifies whether the toolbar button's text and image should be displayed or not.
	SetUseToolBarImagesInDropDownMenus	Specifies whether toolbar images should be used in drop-down menus.
Public Member Functions inherited from CBCGPControlBar
	CalcInsideRect	Calculates the inside rectangle of a control bar taking into account the borders and grippers.
	CanBeDocked	Determines whether a control bar can be docked at the specified dock bar.
	CanBeTabbedDocument	Tells whether control bar can be converted to tabbed document.
	Create	Creates the Windows control bar and attaches it to the CBCGPControlBar object.
	CreateDefaultMiniframe	Creates a mini-frame window for a control bar when it's being floated.
	CreateEx	Creates the Windows control bar and attaches it to the CBCGPControlBar object.
	DockControlBar	Docks the control bar to a dock bar.
	DoesAllowSiblingBars	Indicates whether it is possible to dock another control bar at the same row where this control bar is docked.
	FloatControlBar	Makes the control bar floating.
	GetBorders	Returns the width of the control bar borders.
	GetExclusiveRowMode	Tells whether the control bar is in exclusive row mode or not.
	OnBeforeFloat	Called by the framework when a control bar is about to float.
	OnPressCloseButton	Called by the framework when user presses the close button on control bar's caption.
	SetBorders	Sets the border values of the control bar.
	SetBorders	Sets the border values of the control bar.
	SetExclusiveRowMode	Enables or disables the exclusive row mode.
	SetMiniFrameRTC	Sets the runtime class information about the default mini-frame window.
	ToggleAutoHide	Toggles autohide mode.
Public Member Functions inherited from CBCGPBaseControlBar
	AddControlBar	Adds a control bar to docking manager.
	AdjustDockingLayout	Redirects a call to docking manager to adjust docking layout.
	CanAcceptBar	Determines whether another control bar can be docked to this control bar.
	CanAutoHide	Determines whether the control bar can be switched to autohide mode.
	CanBeAttached	Called by the framework to determine if the control bar can be docked to another control bar or frame window.
	CanBeResized	Determines whether this control bar can be resized.
	CanFloat	Determines whether the control bar can float.
	CreateEx	Creates a Windows control.
	DoesAllowDynInsertBefore	Determines whether it is possible to dynamically insert a control bar before this control bar.
	EnableGripper	Enables/disables the control caption (gripper).
	GetBarIcon	Returns control bar icon.
	GetBarStyle	Returns the control bar style.
	GetBCGStyle	Returns the library specific control bar styles.
	GetCaptionHeight	Returns the gripper (caption) height.
	GetCurrentAlignment	Returns the current control bar alignment.
	GetDockRow	Returns a pointer to a dock bar row.
	GetDockSite	Returns a pointer to dock site.
	GetEnabledAlignment	Returns the enabled alignment.
	GetParentMiniFrame	Returns a pointer to the parent mini-frame window.
	GetParentTabWnd	Retrieves a pointer to the parent tabbed window.
	HideInPrintPreviewMode	Tells the framework whether control bar should be hidden in print preview mode.
	IsDocked	Determines whether the control bar is docked or not.
	IsHorizontal	Determines whether the control bar is docked horizontally.
	IsMDITabbed	Tells whether control bar is placed on MDI child window as tabbed document.
	IsVisible	Determines whether a control bar is visible or not.
	OnControlBarContextMenu	Called by the framework when it needs to build a menu with the list of control bars.
	OnRemoveFromMiniFrame	Called by the framework when a control bar is being removed from its parent mini-frame window.
	SetBarAlignment	Sets the current alignment for a control bar.
	SetBarStyle	Sets a control bar style
	SetDockMode	Sets a new docking method for a control bar.
	ShowControlBar	Shows or hides a control bar.

Static Public Member Functions
	SetColorName	Sets a new color name for a specific color
Static Public Member Functions inherited from CBCGPToolBar
	AddBasicCommand	Adds a command to a list of basic commands.
	AddToolBarForImageCollection	Loads a bitmap with toolbar images from the resources and adds it to the collection of toolbar images.
	AutoGrayInactiveImages	Enables a mode when disabled images are generated automatically by the library.
	CleanUpImages	Frees the system resources allocated for toolbar images.
	EnableContentDialogsForControlsInMenu	Enables displaying the dialogs with the corresponding toolbar control from the menu item with control's ID.
	EnableQuickCustomization	Enables and disables the "quick" customization of toolbars by pressing the "Alt" key and dragging a button to a new location.
	GetAllToolbars	Gives read-only access to all toolbars in the application.
	GetBasicCommands	Gives read-only access to the global collection of basic commands defined in the application.
	GetColdImages	Returns a pointer to collection of cold images.
	GetCommandButtons	Returns a collection of buttons with the same command ID form all the application toolbars.
	GetDefaultImage	Returns an index of the default image for a toolbar button with the specified command ID.
	GetDisabledImages	Returns a pointer to collection of disabled images.
	GetDisabledMenuImages	Returns a pointer to collection of disabled menu images.
	GetHotTextColor	Retrieves a text color of a toolbar button in highlighted state.
	GetImages	Retrieves a pointer to the collection of toolbar images.
	GetLargeColdImages	Returns a pointer to collection of large cold images.
	GetLargeDisabledImages	Returns a pointer to collection of large disabled images.
	GetLargeImages	Returns a pointer to collection of large images.
	GetMenuButtonSize	Retrieves the size of menu buttons.
	GetMenuImages	Returns a pointer to collection of menu images.
	GetMenuImageSize	Retrieves the size of menu images.
	GetShowTooltips	Determines whether tool tips are shown for toolbar buttons.
	GetUserImages	Returns a pointer to the global collection of user-defined toolbar images.
	IsAutoGrayInactiveImages	Tells whether the option "automatic gray of inactive images" is enabled or disabled.
	IsBasicCommand	Determines whether the specified command is a basic command.
	IsCommandPermitted	Determines whether the command is allowed to be executed or not.
	IsCommandRarelyUsed	Determines whether the specified command is rarely used or not.
	IsCustomizeMode	Tells whether the framework is in the customization mode or not.
	IsGrayDisabledImages	Tells whether the toolbar disabled images should be grayed or not.
	IsLargeIcons	Tells whether the application toolbars currently display large icons.
	IsLastCommandFromButton	Determines whether the last command was sent from a toolbar button.
	IsLook2000	Tells whether the application's GUI elements have Microsoft Office 2000 look and feel.
	LoadParameters	Loads general (global) toolbar parameters from the Windows registry.
	ResetAll	Restores all toolbars to an original state.
	ResetAllImages	Resets all images.
	SetBasicCommands	Sets basic commands.
	SetCommandUsageOptions	Allows to customize the appearance method of recently used menus.
	SetCustomizeMode	Switches the customize mode for all toolbars on and off.
	SetGrayDisabledImages	Specifies whether the toolbar disabled images should be grayed or not.
	SetHotTextColor	Sets the text color for selected toolbar buttons to the specified color.
	SetLargeIcons	Sets a flag indicating whether toolbar buttons display large icons or regular icons.
	SetLook2000	Sets a flag indicating whether the application GUI elements have Microsoft Office 2000 look and feel.
	SetMenuSizes	Sets the size of buttons and their images for toolbars working in the "menu mode".
	SetNonPermittedCommands	Sets a list of commands, which are not allowed to be executed by the user.
	SetShowTooltips	Turns tool tips on and off.
	SetSizes	Sets sizes for all toolbar buttons and images.
	SetUserImages	Sets user-defined images.

Protected Member Functions
	CBCGPColorBar	Constructs a CBCGColorBar object
	CBCGPColorBar	Constructs a CBCGColorBar object
	CBCGPColorBar	Constructs a CBCGColorBar object
	AdjustLocations	Called by the framework as a part of WM_SIZE message processing
	AllowChangeTextLabels	Specifies whether the color's text labels are changeable
	AllowShowOnList	Specifies whether the CBCGColorBar object may appear in toolbar list during customization process.
	CalcSize	Called by the framework as a part of layout calculation process
	OnKey	Called by the framework when user presses a keyboard button
	OnUpdateCmdUI	Called by the framework when the user-interface item for the CBCGColorBar command ID should be updated
	OpenColorDialog	Called by the framework when user is about to open a color dialog
	ShowCommandMessageString	Sends to its owner the WM_SETMESSAGESTRING message
Protected Member Functions inherited from CBCGPToolBar
	CalcMaxButtonHeight	Calculates the maximal button height.
	DrawButton	Called when a toolbar's button need to be repainted.
Protected Member Functions inherited from CBCGPControlBar
	OnBeforeDock	Called by the framework when the control bar is about to be docked.

Additional Inherited Members
Public Types inherited from CBCGPToolBar
enum	CustomizeButtonStyle
Public Attributes inherited from CBCGPPopupMenuBar
	m_bDisableSideBarInXPMode	If TRUE, the gray bar in XP mode won't be displayed. The default value is FALSE.
Public Attributes inherited from CBCGPControlBar
	m_recentDockInfo	Contains the recent docking information.
Static Public Attributes inherited from CBCGPToolBar
	m_bDontScaleImages	Prevents image scaling when image sizes don't match button sizes.
	m_bDPIAwareControlWidths	If this global member is TRUE, toolbar control (such as combo boxes or edit boxes) widthes width will be automatically scaled according to current DPI.
	m_dblLargeImageRatio	Specifies the ratio for large images.
Static Public Attributes inherited from CBCGPControlBar
	m_bHandleMinSize	Enables consistent handling of minimal size.
Protected Attributes inherited from CBCGPToolBar
	m_bDontScaleLocked	Prevents scaling of locked images when image sizes don't match button sizes.