CBCGPRibbonFrameCaptionBar

Detailed Description

The Frame Caption Bar (CBCGPRibbonFrameCaptionBar) replaces a standard frame caption. You may add to it custom buttons, MDI tabs and specify a custom system icon.

Inheritance diagram for CBCGPRibbonFrameCaptionBar:

Public Member Functions
	EnableMDITabs	Enables or disables the MDI tabs.
	GetMDITabsOptions	Gets MDI tabs options. If MDI tabs are not enabled, this function returns NULL.
Public Member Functions inherited from CBCGPRibbonBar
	CBCGPRibbonBar	Constructor.
	ActivateContextCategory	Activates context category.
	AddBackstageCategory	Adds backstage category.
	AddCaptionCustomButton	Adds a custom caption button.
	AddCategory	Adds a new category to ribbon control.
	AddCategory	Adds a new category to ribbon control.
	AddContextCategory	Adds a context category.
	AddContextCategory	Adds a context category.
	AddMainCategory	Creates main ribbon panel.
	AddToTabs	Adds a ribbon element at the right side of ribbon control.
	AreQuickAccessToolbarLabels	Tells whether Quick Access Toolbar text labels are visible.
	Create	Creates the Windows control and attaches it to CBCGPRibbonBar.
	DoOpenPinnedFile	Called by the framework when user clicks on the pinned file in the recent files list.
	EnableAnimation	Enables and disables animation during the switch between Ribbon tabs in some Visual themes.
	EnableBackstagePageCaptions	Enables the backstage view page captions.
	EnableCommandSearch	Enables the Ribbon command search.
	EnableCustomization	Enables the Ribbon bar customization.
	EnableKeyTips	Enables or disables key tips feature for the Ribbon control.
	EnableMinimizeButton	Shows or hides a minimize button.
	EnablePrintPreview
	EnableStartPage	Enables the start page.
	EnableToolTips	Enables or disables tooltips on the ribbon control.
	FindByData	Finds a ribbon element by associated user-defined data.
	FindByID	Finds a ribbon element by its command ID.
	FindCategoryIndexByData	Returns category index by user-defined data associated with category.
	ForceRecalcLayout	Adjusts the layout of the Ribbon bar controls.
	GetActiveCategory	Returns a pointer to active category.
	GetApplicationModes	Gets currently selected application modes.
	GetBackgroundImage	Gets the Ribbon background image.
	GetBackstageCategory	Retrieves a pointer to backstage category.
	GetBackstagePageTransitionEffect	Gets backstage page transition effect.
	GetBackstagePageTransitionTime	Gets backstage page transition time.
	GetBackstageViewIconsStyle	Retrieves an icon style of the Ribbon backstage items.
	GetCaptionButtonIconStyle	Returns caption button icon style.
	GetCaptionCustomButton	Retrivies a custom caption button by index.
	GetCaptionCustomButtonsCount	Returns custom caption buttons count.
	GetCategory	Returns a category located at the specified index.
	GetCategoryCount	Returns a number of categories in ribbon bar.
	GetCategoryIndex	Returns category index.
	GetCommandSearchOptions	Gets the command search ("Tell me") options.
	GetContextName	Retrieves context name.
	GetControlValue	Retrieves the ribbon bar control value (e.g., text of the edit box).
	GetCustomizationOptions	Gets Ribbon bar customization options.
	GetDefaultBackstagePage	Gets default backstage page.
	GetDefaultHeight	Returns a default (recommended) Ribbon Bar height. Should be used in the dialog mode only
	GetElementsByID	Returns an array of all elements with specified ID.
	GetExportedFileDefaultName	Called by t5he framework to obtain a default name of the ribbon customization data file.
	GetGalleryIconsLook	Gets Ribbon gallery icons appearance.
	GetGalleryIconsLookInDarkThemes	Gets Ribbon gallery icons appearance in the dark themes.
	GetIconsAppearance	Retrieves the Ribbon images appearance.
	GetIconsAppearanceInDarkThemes	Retrieves the Ribbon images appearance in the dark themes.
	GetImagesLuminosity	Gets Ribbon images luminosity.
	GetImagesLuminosityInDarkThemes	Gets Ribbon images luminosity in the dark themes.
	GetKeyTipsDelay	Returns key tips delay.
	GetMainButton	Provides access to main ribbon button.
	GetMainCategory	Provides access to main ribbon category.
	GetMinimizeButton	Called by the framework when a Ribbon minimize button is created.
	GetMinimizeButtonLocation	Returns the minimize button location.
	GetQuickAccessCommands	Retrieves the list of commands whose elements are located on Quick Access Toolbar.
	GetQuickAccessIconsStyle	Retrieves an icon style of the Ribbon quick access toolbar items.
	GetQuickAccessToolbarEditFlags	Tells which Quick Access Toolbar customization features are available for the user (in the Quick Access Toolbar editing menu).
	GetSimplifiedModeOptions	Obtains the simplified mode options.
	GetTabIconsStyle	Retrieves an icon style of the Ribbon buttons located on the tabs row.
	GetVisibleElements	Gets visible elements.
	HasBackstagePageCaptions	Tells whether backstage pages have captions.
	HasMinimizeButton	Tells whether minimize button is displayed or hidden.
	HideAllContextCategories	Hides all context categories.
	HideSingleTab	Specifies whether a single Ribbon tab should be hidden.
	HitTest	Returns a pointer to a ribbon element located at the specified point.
	IsAnimationEnabled	Returns nonzero if the animation during tab activation is enabled.
	IsAutoHideModeAvailable	Tells whether the Ribbon bar auto-hide mode is available in the current visual theme.
	IsAutoStartPage	Check whether a start page is automatically displayed on application startup.
	IsBackstageMode	Tells whether backstage mode is turned on or off.
	IsBackstageViewActive	Tells whether backstage view is currently active, or not.
	IsCommandSearchEnabled	Tells whether the a command search is enabled.
	IsCustomizationEnabled	Tells whether a Ribbon bar customization is enabled.
	IsDefaultSystemMenu	Tells whether the default system menu is used instead of the themed menu.
	IsDialogMode	Tells whether the Ribbon Bar was crated as child of the dialog box or property page.
	IsGrayDisabledImages	Tells whether the Ribbon disabled images should be grayed or not.
	IsHideSingleTab	Tells whether a single Ribbon tab should be hidden.
	IsInAutoHideMode	Tells whether the Ribbon bar is in auto-hide mode.
	IsKeyTipEnabled	Tells whether the key tips feature is enabled, or not.
	IsMinimized	Tells whether the Ribbon bar is minimized or not.
	IsPrintPreviewEnabled	Tells whether the library-defined "Print Preview" tab is allowed.
	IsQuickAccessToolbarOnTop	Tells whether Quick Access Toolbar is located on the top, or on the bottom of ribbon control.
	IsQuickAccessToolbarVisible	Tells whether Quick Access Toolbar is visible.
	IsReplaceFrameCaption	Tells whether ribbon control replaces main frame caption, or is located under the frame caption.
	IsScenicLook	Tells whether the current look of Ribbon is scenic or regular.
	IsSimplifiedMode	Tells whether the Ribbon bar is in simplified mode.
	IsStartPageEnabled	Tells whether a start page is enabled.
	IsToolTipDescrEnabled	Tells whether tooltip descriptions are enabled or disabled.
	IsToolTipEnabled	Tells whether tooltips are enabled or disabled for the ribbon control.
	IsTouchMode	whether the Ribbon bar touch mode is currently activated.
	LoadFromBuffer	Loads a Ribbon Bar schema from a memory buffer containing XML definition of the schema.
	LoadFromVSRibbon	Loads a Ribbon Bar schema from Visual Studio Ribbon resource.
	LoadFromVSRibbon	Loads a Ribbon Bar schema from Visual Studio Ribbon resource.
	LoadFromXML	Loads a Ribbon Bar schema from XML.
	LoadFromXML	Loads a Ribbon Bar schema from XML.
	OnFilterSearchResult	Called before a search result is added to the list of results.
	OnPrepareLightImages	Called by the framework when a "light" (appeared on dark background) images needs to be prepared.
	RecalcLayout	Re-calculates the Ribbon bar layout.
	RemoveAllCaptionCustomButtons	Removes all custom caption buttons.
	RemoveAllCategories	Removes all categories.
	RemoveAllFromTabs	Removes all ribbon elements from tab area.
	RemoveCategory	Removes a category located at the specified index,
	ReplaceRibbonElementByID	Replaces ribbon controls that have a specific identifier with a new control.
	SetActiveCategory	Activates the specified category.
	SetApplicationModes	Sets Ribbon application modes.
	SetAutoHideMode	Enables or disables the Ribbon bar auto-hide mode.
	SetBackgroundImage	Sets the Ribbon bar's background image
	SetBackgroundImage	Sets the Ribbon bar's background image
	SetBackstageMode	Turns backstage mode on or off.
	SetBackstagePageTransitionEffect	Sets backstage page transition effect.
	SetBackstageViewIconsStyle	Specifies an icon style of the Ribbon backstage items.
	SetCaptionButtonIconStyle	Specifies a Ribbon caption button icon style.
	SetCommandSearchOptions	Specifies the command search ("Tell me") options.
	SetDefaultBackstagePage	Sets default backstage page.
	SetDefaultSystemMenu	Specifies the Ribbon system menu style.
	SetElementKeys	Sets the specified key tips for all Ribbon's elements with specified command ID.
	SetGrayDisabledImages	Specifies whether the Ribbon disabled images should be grayed or not.
	SetIconsAppearance	Specifies the Ribbon images appearance.
	SetIconsAppearanceInDarkThemes	Specifies the Ribbon images appearance in the dark themes.
	SetImagesLuminosity	Specifies the Ribbon images luminosity.
	SetImagesLuminosityInDarkThemes	Specifies the Ribbon images luminosity in the dark themes.
	SetMainButton	Sets main ribbon button.
	SetMinimizeButtonLocation	Specifies the minimize button location.
	SetQuickAccessCommands	Places ribbon elements on Quick Access Toolbar.
	SetQuickAccessDefaultState	Sets the current QAT state.
	SetQuickAccessIconsStyle	Specifies an icon style of the Ribbon quick access toolbar items.
	SetQuickAccessToolbarEditFlags	Specifies which Quick Access Toolbar customization features are available for the user (in the Quick Access Toolbar editing menu).
	SetQuickAccessToolbarLabels	Specifies whether Quick Access Toolbar text labels are visible.
	SetQuickAccessToolbarOnTop	Relocates Quick Access Toolbar on the top, or on the bottom of ribbon control.
	SetQuickAccessToolbarVisible	Shows or hides the Ribbon Quick Access Toolbar.
	SetScenicLook	Sets or unsets scenic look for Ribbon Bar.
	SetSimplifiedMode	Enables or disables the Ribbon bar simplified mode.
	SetSimplifiedModeOptions	Specifies the simplified mode options.
	SetTabButtonIcons	Sets icons for the buttons located on the same row as tabs (on the right side).
	SetTabIconsStyle	Specifies an icon style of the Ribbon buttons located on the tabs row.
	ShowBackstagePrintView	Activates backstage "Print" page.
	ShowBackstageRecentView	Activates backstage "Recent" page.
	ShowBackstageView	Activates a backstage page.
	ShowBackstageView	Activates a backstage page.
	ShowCategory	Shows or hides category.
	ShowContextCategories	Shows or hides context categories with specified context ID.
	ShowStartPage	Activates a start page.
	ToggleMinimizeState	Toggles minimized and normal Ribbon control state.
Public Member Functions inherited from CBCGPControlBar
	AdjustSizeImmediate	Immediately recalculates layout of a control bar.
	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.
	OnAfterChangeParent	Called by the framework when the parent of a control bar has changed.
	OnAfterFloat	Called by the framework when a control bar has floated.
	OnBeforeChangeParent	Called by the framework when the parent of the control bar is about to be changed as a result of docking or floating operation.
	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.
	OnShowControlBarMenu	Called by the framework when a special control bar menu is about to be displayed.
	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.
	AdjustLayout	Called by the framework when a control bar should adjust its internal layout according to a new size or position.
	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.
	CanBeClosed	Determines whether the control bar may be hidden.
	CanBeResized	Determines whether this control bar can be resized.
	CanFloat	Determines whether the control bar can float.
	CanFocus	Specifies whether a control bar can receive focus.
	CreateEx	Creates a Windows control.
	DoesAllowDynInsertBefore	Determines whether it is possible to dynamically insert a control bar before this control bar.
	EnableDocking	Enables docking to the main frame.
	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.
	GetCurrentAlignment	Returns the current control bar alignment.
	GetDockMode	Returns the current dock mode for the control bar.
	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.
	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.
	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.
Public Member Functions inherited from CBCGPAnimationManager
	CBCGPAnimationManager	Default constructor.
	GetAnimatedValue	Gets current animated value.
	GetAnimationDuration	Gets animation duration.
	GetLastAnimationError	Gets the animation error returned by recent call to Windows Animation API.
	IsAnimated	Checks if animation is running.
	StartAnimation	Starts an animation.
	StartFlashAnimation	Starts "flash" animation.
	StopAnimation	Stops an animation.

Additional Inherited Members
Public Types inherited from CBCGPAnimationManager
enum	BCGPAnimationType
Static Public Member Functions inherited from CBCGPAnimationManager
	IsAnimationSupportedByOS	Checks if animation is supported by OS.
Public Attributes inherited from CBCGPControlBar
	m_recentDockInfo	Contains the recent docking information.
Static Public Attributes inherited from CBCGPControlBar
	m_bHandleMinSize	Enables consistent handling of minimal size.
Protected Member Functions inherited from CBCGPControlBar
	OnAfterDock	Called by the framework when a control bar has been docked.
	OnBeforeDock	Called by the framework when the control bar is about to be docked.
Protected Member Functions inherited from CBCGPBaseControlBar
	DoPaint	Paints the control bar.
Protected Member Functions inherited from CBCGPAnimationManager
	OnAnimationIdle	Called by the framework in an animation idle time.