TToolBar class

In unit ComCtrls

Implements an application tool bar with buttons or other visual controls.

Declaration

pascal

TToolBar = class(TToolWindow)

Inheritance

Description

TToolBar is TToolWindow descendant which implements a control used to arrange and display buttons and other controls. The buttons are used to provide direct access to features or functions in the application, much like a menu.

A tool bar is normally aligned to an edge for the parent control so that it spans its width or height. The default alignment places the tool bar along the top edge of the parent control.

In basic usage, TToolBar allows TToolButton instances with the same height and width to be added to the control. The buttons can be displayed as check boxes, drop downs (combo-boxes), or drop down buttons as well. The tool bar can be configured to display images and/or captions, as well as dividers (thin) or separators (dividers with extra spacing) between buttons.

Other visual controls can be created using the tool bar as the parent control. These controls are resized to the width or height (depending on alignment) for the tool bar.

The tool bar can be configured to wrap buttons or child controls when the controls will not fit within the dimension for the tool bar alignment. Other visual aspects can be controlled, like use of edges around the tool bar or a flat appearance.

Use the Buttons property to access and maintain the tool buttons on the control. Use Controls to access other visual control types on the tool bar.

Use the OnPaint event handler to perform custom drawing on the tool bar control when the Paint method is called. Use the OnPaintButton event handler to perform custom drawing for individual tool buttons on the control.

TToolBar is the ancestor for the TExtendedTabToolBar in the LazControls package.

Properties

`ButtonCount`	public	Number of Buttons defined for the tool bar control.
`Buttons`	public	Lists with the tool buttons on the tool bar.
`ButtonList`	public	Contains the Buttons defined for the tool bar control.
`RowCount`	public	Number of rows needed to display the buttons for the control.
`ButtonDropWidth`	public	Width for the drop-down button indicator.
`Align`	published	Specifies the placement of the control inside its Parent.
`Anchors`	published	The set of anchor definitions for this control.
`AutoSize`	published	Allows automatic adjustment of the size for the control, according to its content.
`BorderSpacing`	published	Determines the inner and outer border spacing for this control.
`BorderWidth`	published	Width of the Border around the control; default is zero.
`ButtonHeight`	published	Contains the height for buttons on the tool bar control.
`ButtonWidth`	published	Contains the width for buttons on the tool bar control.
`Caption`	published	The text displayed for the control.
`ChildSizing`	published	Provides a grid (table) layout for the children of this control.
`Constraints`	published	Contains the minimum and maximum Width and Height for the control.
`Color`	published	The background color for the control.
`DisabledImages`	published	List with images displayed when a tool button is not enabled.
`DragCursor`	published	The cursor shape shown during a drag operation.
`DragKind`	published	Indicates the action performed for a drag operation: drag-and-drop or drag-and-dock.
`DragMode`	published	Determines how a drag operation is started for the control.
`DropDownWidth`	published	Width of the drop down arrow button.
`EdgeBorders`	published	Indicates which edges on the tool bar are drawn with a border.
`EdgeInner`	published	Specifies the drawing style used for the inner border of the control.
`EdgeOuter`	published	Specifies the drawing style used for the outer border of the control.
`Enabled`	published	Determines whether the control responds to mouse or keyboard input.
`Flat`	published	Indicates if the control is drawn with a flat appearance.
`Font`	published	The font to be used for text display in this control.
`Height`	published	Height for the tool bar control.
`HotImages`	published	List with images displayed when a button is "hot" or hovered.
`Images`	published	List with images displayed when a tool button is enabled.
`ImagesWidth`	published	Width for the images displayed on the tool bar.
`Indent`	published	Number of pixels reserved as indentation spacing before buttons and controls on the tool bar.
`List`	published	Indicates whether buttons on the tool bar are displayed using a list style.
`Menu`	published
`ParentColor`	published	Use the Color from the Parent control, when enabled.
`ParentFont`	published	Indicates if the Font from the Parent control is used in the control.
`ParentShowHint`	published	If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True.
`PopupMenu`	published	A context-sensitive menu that pops up when the right mouse button is clicked over this control.
`ShowCaptions`	published	Indicates whether captions are displayed on tool bar buttons.
`ShowHint`	published	Enables Hint display for the control.
`TabOrder`	published	Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`TabStop`	published	Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys.
`Transparent`	published	Indicates whether the control is drawn with transparency.
`Visible`	published	Allows the control, and all of its children, to be displayed or hidden.
`Wrapable`	published	Controls wrapping of tool buttons to the next row when they are too long for the orientation on the tool bar.
`Orientation`	published	Indicates the orientation and layout direction for the buttons on the tool bar.

Methods

`IsVertical`	protected	Indicates if the tool bar is oriented to display buttons and controls vertically.
`WSRegisterClass`	protected	Registers the tool bar class in the widgetset.
`AdjustClientRect`	protected	Adjusts the client rectangle when the tool bar is drawn.
`ButtonHeightIsStored`	protected	Implements the storage specifier for the ButtonHeight property.
`ButtonWidthIsStored`	protected	Implements the storage specifier for the ButtonWidth property.
`DropDownWidthIsStored`	protected	Implements the storage specifier for the DropDownWidth property.
`GetControlClassDefaultSize`	protected	Gets the default size for new instances of the class type.
`DoAutoSize`	protected	Defers auto-sizing actions to the AlignControls method.
`CalculatePreferredSize`	protected	Calculates the preferred size (width and height) for the control.
`CheckMenuDropdown`	protected	Determines whether the specified button has a drop-down menu item which must be checked.
`ClickButton`	protected	Calls the Click method for the specified tool button.
`CreateWnd`	protected	Performs actions needed when the Handle for the control is created.
`AlignControls`	protected	Performs actions to align the tool bar buttons in the specified rectangle.
`FindButtonFromAccel`	protected	Gets the tool bar button with the specified accelerator key.
`FontChanged`	protected	Performs actions needed when the Font has changed for the control.
`Loaded`	protected	Performs actions needed when the control has finished loading from the LCL streaming mechanism.
`Notification`	protected	Handles notifications for components added or removed from the control.
`Paint`	protected	Draws the tool bar on the Canvas for the control.
`RepositionButton`	protected	Repositions the tool button at the specified position in Buttons.
`RepositionButtons`	protected	Repositions the tool buttons on the tool bar.
`WrapButtons`	protected	Calculates sizes and positions for buttons and controls, and handles wrapping to new rows or columns (when enabled).
`CNDropDownClosed`	protected	Handles the CN_DROPDOWNCLOSED control notification message.
`DoAutoAdjustLayout`	protected	Applies layout changes using the specified policy and scaling proportions to the control.
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destroy - destructor for TToolBar: frees buttons and links then calls inherited Destroy.
`EndUpdate`	public	Finishes an update process for the tool bar.
`FlipChildren`	public	Disables reversing right and left alignment for child controls.
`GetEnumerator`	public	Gets a TToolBarEnumerator enumerator for the class instance.
`SetButtonSize`	public	Sets the width and height for Buttons on the control to the specified values.
`CanFocus`	public	Always returns False for TToolBar.

Events

`OnClick`	published	Notification handler for mouse clicks.
`OnContextPopup`	published	Invoked when a context-sensitive pop-up menu is requested.
`OnDblClick`	published	Event handler signalled when a mouse double click occurs in the control.
`OnDragDrop`	published	Event handler signalled when an object is dropped onto the control.
`OnDragOver`	published	Event handler signalled when a control is dragged over the control instance.
`OnPaintButton`	published	Event handler signalled to draw a button on the tool bar.
`OnEndDrag`	published	Event handler signalled for the end of a drag-drop operation.
`OnEnter`	published	Event handler signalled when the control receives focus.
`OnExit`	published	Event handler signalled when the control loses focus.
`OnMouseDown`	published	Event handler signalled when a mouse down event is handled for the control.
`OnMouseEnter`	published	Event handler signalled when the mouse pointer has entered the control.
`OnMouseLeave`	published	Event handler signalled when the mouse pointer has left the control.
`OnMouseMove`	published	Event handler signalled when the mouse pointer is moved in the control.
`OnMouseUp`	published	Event handler signalled when a mouse up event is handled for the control.
`OnMouseWheel`	published	Event handler for mouse wheel turned.
`OnMouseWheelDown`	published	Event handler signalled for a downward movement of the mouse wheel.
`OnMouseWheelUp`	published	Event handler signalled for an upward movement of the mouse wheel.
`OnPaint`	published	Event handler signalled when the Paint method is called for the control.
`OnResize`	published	Notification handler for a resize of the control.
`OnChangeBounds`	published	Event handler signalled when the Bounds for the control have been changed.
`OnStartDrag`	published	Event handler signalled for the start of a dragging operation.