BCGControlBar Pro for MFC: CBCGPRibbonFontComboBox

Detailed Description

The CBCGPRibbonFontComboBox class provides the functionality that allows to place combo boxes with list of fonts on ribbon panels.

Construct a ribbon font combo box button as following:

Copy

CBCGPRibbonFontComboBox (   
    UINT nID,    
    int nFontType = DEVICE_FONTTYPE | RASTER_FONTTYPE | TRUETYPE_FONTTYPE,   
    BYTE nCharSet = DEFAULT_CHARSET,   
    BYTE nPitchAndFamily = DEFAULT_PITCH,
    int nWidth = -1),

where

nID is the command ID
nFontType is the flag which specifies which font types to display in the combo
nCharType specifies the character set
nPitchAndFamily specifies the pitch and family of fonts to be added to the combo
nWidth specifies the width of combo box control on the ribbon.

When a combo box object has been constructed you can add it to a panel using CBCGPRibbonPanel::Add.

Inheritance diagram for CBCGPRibbonFontComboBox:

Public Member Functions
	CBCGPRibbonFontComboBox	Constructs ribbon combo box object.

	AddFont	Adds a font to the fonts list.

	InsertFont	Inserts a font to the fonts list at the given position.

	SetFont	Looks for the specified font and selects it in the combo.

Public Member Functions inherited from CBCGPRibbonComboBox
	CBCGPRibbonComboBox	Constructs ribbon combo box object.

	AddGroup	Adds a group (static, non-clickable item) and returns the index of added group.

	AddItem	Adds a new item and returns the index of added item.

	AddSeparator	Adds separator and returns the index of added separator.

	AreDuplicatedItemsEnabled	Tells whether adding the duplicated items (with the same name) is allowed.

	DeleteItem	Deletes an item from combo box.

	DeleteItem	Deletes an item from combo box.

	DeleteItem	Deletes an item from combo box.

	EnableAutoComplete	Turns autocomplete mode on or off.

	EnableCalculator	Puts a Ribbon combo box control in "Calculator" mode.

	EnableDropDownListResize	Enables or disables resizing of drop down list.

	EnableDuplicatedItems	Specifies whether adding the duplicated items (with the same name) is allowed.

	FindItem	Finds item in combo box and retuns its index.

	GetCount	Returns the number of items in combo box.

	GetCurSel	Returns zero-based index of currently selected item.

	GetItem	Returns an item located at the specified index.

	GetItemData	Returns a user-defined data associated with an item located at the specified index.

	HasEditBox	Tells whether combo box has edit box.

	InsertGroup	Inserts a group (static, non-clickable item) in the given position and returns the index of added group.

	InsertItem	Inserts a new item into combo box.

	InsertSeparator	Inserts a new separator into combo box.

	IsAutoCompleteEnabled	Specifies whether auto complete mode is enabled, or disabled.

	IsCalculatorEnabled	Tells whether a Ribbon combo box works in "Calculator" mode.

	IsResizeDropDownList	Tells whether the drop down list of ribbon combo box can be resized, or not.

	OnCalculatorUserCommand	Called by the library when a custom calculator command is invoked.

	OnSelectItem	Called when an item has been selected in combo box.

	RemoveAllItems	Removes all items from combo box.

	SelectItem	Selects an item in combo box.

	SelectItem	Selects an item in combo box.

	SelectItem	Selects an item in combo box.

	SetDropDownHeight	Sets the height of drop down part of combo box.

Public Member Functions inherited from CBCGPRibbonEdit
	CBCGPRibbonEdit	Constructs ribbon edit box object.

	CreateEdit	Creates in-place edit control.

	EnableSearchMode	Displays or hides "Find" and "Clear" icons at the right side of edit control.

	EnableSpinButtons	Shows or hides spin buttons at the right side of edit control.

	GetEditText	Obtains text from edit box.

	GetPrompt	Returns a prompt (displayed when the edit box text is empty).

	GetSearchPrompt	Returns default text displayed within edit control in "search" mode.

	GetTextAlign	Returns alignment of text.

	IsAutoCompleteList	Tells whither the auto-complete mode is enabled.

	IsDisableFrameAccelTableOnFocus	Tells whether to suppress handling of the keyboard accelerators in the top-level frame when the control is being focused.

	IsReadOnly	Tells whether the Ribbon edit box is read-only or not.

	IsSearchMode	Tells whether "search" mode has been enabled for the edit control.

	SetAutoCompleteList	Specifies whether the auto-complete mode is enabled.

	SetDisableFrameAccelTableOnFocus	Specifies whether to suppress handling of the keyboard accelerators in the top-level frame when the control is being focused.

	SetEditText	Sets a text to edit control..

	SetReadOnly	Sets or unsets read-only flag of the Ribbon edit box.

	SetTextAlign	Sets alignment of text.

	SetWidth	Sets the width of CBCGPRibbonEdit control.

Public Member Functions inherited from CBCGPRibbonButton
	CBCGPRibbonButton	Construct ribbon button object.

	CBCGPRibbonButton	Construct ribbon button object.

	CBCGPRibbonButton	Construct ribbon button object.

	AddSubItem	Allows to create a popup menu on the fly by dynamically adding new ribbon elements.

	ClosePopupDlg	Called by the framework when the popup dialog is closed.

	EnablePopupDialog	Enables the popup dialog associated with this button.

	EnablePopupDialog	Enables the popup dialog associated with this button.

	FindSubItemIndexByID	Returns index of sub-item by its command ID.

	GetImageIndex	Returns button's image index in associated image list.

	GetMenu	Returns a handle to Windows menu assigned to button.

	IsDefaultCommand	Tells whether button can execute its default command.

	IsRightAlignMenu	Tells whether the menu is right aligned, or not.

	OnBeforeShowPopupDlg	Called by the framework before the popup dialog is displayed.

	OnClick	Called by the framework when user clicks a button.

	RemoveAllSubItems	Removes all menu items from popup menu.

	RemoveSubItem	Removes a sub-item.

	SetAlwaysLargeImage	Enables or disables transition to collapsed state.

	SetDefaultCommand	Tells the button that it can execute its default command.

	SetImageIndex	Sets button's image index in associated image list.

	SetMenu	Assigns a popup menu to ribbon button.

	SetMenu	Assigns a popup menu to ribbon button.

	SetRightAlignMenu	Sets popup menu alignment.

Public Member Functions inherited from CBCGPBaseRibbonElement
	CanBeRemovedFromQAT	Tells whether ribbon element can be removed from QAT.

	GetApplicationModes	Gets application modes where this control is visible.

	GetCursor	Allows to specify a Ribbon control's custom mouse cursor.

	GetData	Retrieves a user-defined data associated with ribbon element.

	GetDescription	Returns ribbon element description.

	GetID	Returns ribbon element command ID.

	GetKeys	Returns key tip associated with ribbon element.

	GetMenuKeys	Returns key tips associated with split button.

	GetRect	Returns bounding rectangle of ribbon element.

	GetSimplifiedModeType	Retrieves a ribbon element appearance in the Ribbon simplified mode.

	GetSize	Returns current size of ribbon element.

	GetText	Returns ribbon element text.

	IsBackstageViewMode	Tells whether a ribbon element works in "backstage view" mode.

	IsChecked	Tells whether ribbon element is checked.

	IsCompactMode	Tells whether ribbon element is in compact mode.

	IsDisabled	Tells whether ribbon element is disabled.

	IsFocused	Tells whether ribbon element is focused.

	IsHiddenInFullMode	Tells whether a ribbon element is invisible in the Ribbon classic (non-simplified) mode.

	IsPressed	Tells whether ribbon element is pressed.

	SetData	Associates a user-defined data with ribbon element.

	SetID	Sets command ID of ribbon element.

	SetKeys	Sets a key tip for ribbon element.

	SetSimplifiedModeType	Specifies a ribbon element appearance in the Ribbon simplified mode.

	SetToolTipText	Sets tooltip text for ribbon element.

Additional Inherited Members
Public Types inherited from CBCGPBaseRibbonElement
enum	RibbonElementLocation

enum	RibbonImageType

enum	RibbonSimplifiedModeType

Protected Member Functions inherited from CBCGPRibbonComboBox
	OnCompareStrings	/// Called by the framework when it needs to compare two Ribbon combo box items.

Protected Member Functions inherited from CBCGPRibbonEdit
	CommonInit	Creates the spin control.

Protected Member Functions inherited from CBCGPBaseRibbonElement
	OnBeforeDestroyParentMenuBar	Called by the framework before the parent menu windo is destroyed.

	OnProcessKey	Called by the framework when a ribbon element should process keyboard input.

Detailed Description

Public Member Functions

Additional Inherited Members