Class XbpToolBarButton() Foundation

Class function of the XbpToolBarButton class

Superclass
Description

Instances of the XbpToolBarButton class are used to interact with the buttons defined for an instance of the XbpToolBar class. The life cycle of an XbpToolBarButton is closely tied to that of its encompassing toolbar object. Tool bar buttons cannot exist on their own but are implicitly created when adding buttons to a toolbar.

An Xbase++ application interacts with instances of the XbpToolBarButton class when it comes to manipulating properties of a button already displayed in a tool bar object. Both the methods XbpToolBar:addItem() and XbpToolBar:getItem() return a reference to an XbpToolBarButton object. By assigning values to the button object's instance variables, the application can control the caption and/or image displayed by the tool bar button, for example.

Instance Variables
:bottom
Specifies the position of the lower border of a tool bar button.
:caption
Specifies the caption displayed in a tool bar button.
:description
Specifies the description of the tool bar button.
:disabledImage
Specifies the image displayed by a disabled tool bar button.
:enabled
Specifies whether the tool bar button is enabled.
:height
Specifies the height of a tool bar button.
:hotImage
Specifies the image displayed by a tool bar button when the mouse is positioned over it.
:image
Specifies the image displayed by a tool bar button.
:index
Specifies the ordinal position of the tool bar button.
:key
Specifies a key string that uniquely identifies a tool bar button.
:left
Specifies the horizontal position of a tool bar button.
:mixedState
Specifies whether a tool bar button may be in an indeterminate state.
:pressed
Specifies whether a tool bar button is currently pressed (selected).
:style
Specifies the style of a tool bar button.
:tooltipText
Specifies the tooltip text to be displayed by a tool bar button.
:top
Specifies the position of the upper border of a tool bar button.
:visible
Specifies whether a tool bar button is visible.
:width
Specifies the width of a tool bar button.
Manipulation
:addItem()
Adds an item to the menu of a drop-down tool bar button.
:clear()
Removes all menu items defined for a tool bar button's drop-down menu.
:delItem()
Removes a menu item from a tool bar button's drop-down menu.
:getItem()
Retrieves a menu item from a tool bar button's drop-down menu.
:numItems()
Returns the number of menu items defined in a tool bar (button's) drop-down menu.
Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.