Professional User Interface Suite, Copyright FOSS Software Inc. Help Published with Permission.

Classes

~CExtBarButton Destructor.
CalculateLayout Calculates the size of the button.
CanBePressedInDisabledState Returns true if the button should handle the click event even if it is disabled.
CanStartCommandDrag Returns true if the button can be drag-n-dropped by user in customizable toolbar.
CExtBarButton Default constructor.
ChildButtonAdd Appends the button to the list of child buttons whose parent button is specified with pTBB.
ChildButtonGetAt Returns a pointer to the child button by index or NULL there is no button with the specified index.
ChildButtonGetCount Returns the number of child buttons.
ChildButtonGetIndexOf Returns an index of the child button by pointer or a negative value if there is no button pointed by pTBB.
ChildButtonInsertAt Inserts the button object into the list of child buttons.
ChildButtonRemove Removes the button from list of child buttons, optionally destroys it and returns true if successful of false otherwise.
ChildButtonRemoveAll Removes and optionally destroys all child buttons.
ChildButtonRemoveAt Removes one or more child buttons, optionally destroys the removed button(s) and returns the number of removed buttons.
ChildButtonSetAt Replaces the button in the list of child buttons with the specified button.
CtrlGet Returns a pointer to the CWnd object associated with the button or NULL if the button is not based on the window control.
CtrlDetach Detaches control from the toolbar button and returns a pointer to the CWnd object of the detached control. Returns NULL if the button is not based on the window control.
CtrlSet Binds the window to the button.
GetAutoChangeID Returns the flag indicating whether the button with a popup menu should automatically change its command identifier.
GetBar Returns a pointer to the toolbar object.
GetCmdID Returns the basic or effective command identifier of the button. The basic identifier is always used as a unique identifier of the button, while the effective one - as the WPARAM parameter of WM_COMMAND messages.
GetCmdNode Returns the initial or current command tree node of the button.
GetCmdTargetWnd Returns a pointer to the window object which should receive WM_COMMAND messages.
GetCtrlVisibleVertically Returns the flag indicating whether the window associated with the button placed on the vertically docked toolbar is visible.
GetIcon Returns a reference to the button icon or a reference to an empty icon object if there is no icon associated with the button.
GetIconPtr Returns a pointer to the button icon or NULL if the button has no icon.
GetInitialResizingStateH Retrieves information for the procedure of resizing the button in the customize mode. Returns 0 if the button can not be resized. Returns -1 if the left side of the button can be dragged. Returns 1 if the right side of the button can be dragged.
GetMenu Returns either the HMENU-menu handle associated with the button or NULL if there is no HMENU-handle attached to the button.
GetNoRotateVerticalLayout Returns the flag indicating whether the layout of the button placed on the vertically-docked toolbar should be the same as it is on the horizontally-docked toolbar.
GetSafeBar Returns a pointer to the toolbar object which contains this button. Returns NULL if the toolbar is not created as window.
GetSeparatedDropDown Returns true if the button has a separate dropdown arrow.
GetStyle Returns the button styles (i.e. the TBBS_flags).
GetText Returns the button text.
IsAbleToTrackMenu Returns true if the popup menu of the button can be displayed.
IsAppendMdiWindowsMenu Returns true if the list of open MDI child frames should be appended to the popup menu of the button.
IsChildButton Returns flag which indicates whether the pointer to the toolbar button object is child of this button.
IsContainerOfPopupLikeMenu Returns true if the button stores a popup menu.
IsCustomizeActiveItem Returns true if the button is the selected customizable UI item and if the customize mode is on.
IsDisabled Returns true if the button is disabled.
IsDisplayScreenTip Returns true if the tooltip to the button is enabled.
IsDisplayShortcutKeysOnScreenTip Returns a flag indicating whether the shortcut key information is included in the tooltip text.
IsEnabled Returns the flag indicating whether the button is enabled.
IsHorzBarOrientation Returns the flag which specifies the toolbar of this button has horizontal button layout.
IsHover Returns the flag which specifies a hover state of the button.
IsIndeterminate Returns the flag indicating whether the button is in an indeterminate state.
IsLargeIcon Returns a flag indicating whether the button is displayed with a double-sized icon.
IsNoRibbonLayout Returns the flag indicating whether the button should not use ribbon bar layout in ribbon controls.
IsPaintAble Returns the flag indicating whether the button is visible in the specified device context.
IsPaintDropDown Returns false if the drop down button should look like simple push button. Returns true otherwise.
IsPressed Returns the flag indicating whether the button is displayed when it is in a pressed state.
IsPressedTracking Returns the flag indicating whether the toolbar object is currently tracking the mouse click event over this button.
IsRibbonPaintingMode Returns the flag indicating whether the button should be painted using the style specific for ribbon control if the currently installed paint manager supports it.
IsSeparator Returns the flag indicating whether the button is a separator.
IsVisible Returns flag specifying visibility of the button.
IsWrap Returns the flag indicating whether the button wraps for the specified wrap type.
ModifyStyle Modifies button styles (i.e. the TBBS_flags).
Paint Paints the button.
PaintChildren Paints the child buttons.
PaintCompound Paints the button, child buttons and the chain of parent buttons.
PaintParentChain Paints the chain if parent buttons.
ParentButtonGet Returns a pointer to the parent button or NULL if it has no parent.
ParentButtonSet Sets the pointer to the parent button.
PutToPopupMenu Adds the button to the specified pop-up menu.
Rect Returns a rectangular area of the button in client coordinates of the toolbar object.
RectDropDown Returns the arrow rectangular in client coordinates of the toolbar object.
RectWithoutDropDown Returns the rectangular part of the button which not include the drop down arrow are in client coordinates of the toolbar object.
RedrawButton Repaints the button.
Ribbon_GetNode Returns the initial or current ribbon command tree node of the button.
RibbonILE_Get Returns the effective informativeness level of the button.
RibbonILE_GetCollapsed Returns the effective informativeness level of the button which corresponds to the collapsed group button state.
RibbonILE_Set Sets the effective informativeness level of the button and returns true if successful or false otherwise.
RibbonILE_SetCollapsed Sets the effective informativeness level of the button which corresponds to the collapsed state of the group button and returns true if successful or false otherwise.
RibbonILV_CalcSize Measures the size of the button in pixels for the specified visual informativeness level.
RibbonILV_fromILE Computes and returns the visual informativeness level which corresponds to the specified effective informativeness level.
RibbonILV_Get Returns the minimum, maximum or current visual informativeness level of the button.
RibbonILV_Set Assigns a new minimum, maximum or current visual informativeness level of the button.
RibbonWrapFromILE Returns true if the button is the last button in the row/column, with the specified effective informativeness level.
SetAppendMdiWindowsMenu Sets/resets the flag which indicates if the list of open MDI child frames should be appended to the popup menu of the button.
SetAutoChangeID Sets/resets the flag indicating whether the button with a popup menu should automatically change its command identifier.
SetBar Assigns the pointer to a toolbar object.
SetBasicCmdNode Sets the initial command tree node.
SetCmdID Modifies the basic command identifier of the button or the effective one. The basic identifier is always used as a unique identifier of the button, while the effective one - as the WPARAM parameter of WM_COMMAND messages.
SetCtrlVisibleVertically Sets/resets the flag indicating whether the window associated with the button on the vertically docked toolbar is visible.
SetCustomizeActiveItem Marks the button as active and selected UI item in the customize mode.
SetCustomizedCmdNode Sets the current command tree node.
SetHover Sets/resets a hover state of the button.
SetMenu Assigns an HMENU-menu handle to the button.
SetNoRotateVerticalLayout Sets/resets the flag indicating whether the layout of the button placed on the vertically docked toolbar should be the same as it is on the horizontally docked toolbar.
SetRect Sets a rectangular area of the button in client coordinates of the toolbar object.
SetSeparatedDropDown Sets/resets the flag indicating whether the button has a separate dropdown arrow.
SetStyle Sets button styles (i.e. the TBBS_flags).
SetVertDocked Notifies the button of a change of the toolbar layout type.
SetWrap Sets/resets flag indicating whether the button wraps for the specified wrap type.
Show Shows/hides the button.
Size Returns the size of the button.

Overridables

OnClick Called when the left button of the button is pressed or released over the button area.
OnCustomizeNodeInit Called to create a command tree node with the properties of the button. The method returns the newly created and initialized CExtCustomizeCmdTreeNode object.
OnCustomizeUpdateProps Called when the button updates its properties stored in the command tree node. If pNode parameter is NULL, the method uses its internal, initial command tree node.
OnDblClick Called when the left part of the button is double clicked and returns true if the event is handled.
OnDeliverCmd Called when the button generates the WM_COMMAND messages.
OnFlatTrackingStart Invoked when the menu bar or ribbon control enters the keyboard-based selection algorithm for its buttons. This method displays key tips for ribbon buttons.
OnFlatTrackingStop Invoked when the menu bar or ribbon control exits the keyboard-based selection algorithm for its buttons.
OnGetTrackPopupFlags Called to compute flags of the popup menu that is displayed when clicking on the button.
OnHelpHitTest Performs hit testing for the Help Finder tool. Should return either the button identifier or -1 (if there is no help provided for the button area at the specified point).
OnHover Called when the mouse pointer enters/leaves the button area.
OnHovering Called when the mouse pointer is over the button area.
OnPressedTrackingStart Called by the Prof-UIS framework to inform the button about the mouse click event and entering the temporarily pressed state.
OnPressedTrackingStop Called by the Prof-UIS framework to inform the button about leaving the temporarily pressed state.
OnQueryCustomAccentEffectForIcon Invoked to get the accent color for painting the disabled icon. If COLORREF(-1) is returned, the disabled icon is painted using the accent color of the default paint manager style.
OnQueryFlatTrackingEnabled Returns true if this button can be selected when the menu bar or ribbon control tracks the keyboard-based button selection algorithm.
OnSetCursor Called when the button is to set the mouse pointer. The method returns true in case the mouse pointer is changed.
OnToolHitTest Called for initialization of the pTI tooltip information structure. Should return either the button identifier or -1 (if the tooltip cannot be displayed at the specified point).
OnTrackPopup Called when the menu button should display its popup menu. The method returns UINT(-1L).
OnUpdateCmdUI Invokes MFC command updating for the button.

Operators

operator CRect Returns a rectangular area of the button in client coordinates of the toolbar object.
operator CSize Returns the size of the button.
operator HMENU Returns either the HMENU-menu handle associated with the button or NULL if there is no HMENU-handle attached to the button.

See Also

CExtBarButton Overview | Hierarchy Chart