TCoolBar class

In unit ComCtrls

Implements a Rebar-like control with resizable bands.

Declaration

pascal

TCoolBar = class(TCustomCoolBar)

Inheritance

Description

TCoolBar is a TCustomCoolBar descendant which implements a control like the Windows Rebar control. It provides a collection of windowed controls which are displayed in movable, resizable bands.

Each band (or TCoolBand) on the control can have a configurable sizing grip (or grabber), a bitmap, a text label, and a single windowed control. The CoolBar handles the size and position for the control when its band is moved. Each band can have a fixed size, or can automatically re-size to the contained control. Bands can be displayed one band per line, or re-sized and positioned to fill the available width or height for the CoolBar control.

A common use case is hosting multiple toolbars in an application. Separate TToolbar instance are created and configured with event handlers or actions as needed. Each toolbar is assigned as the Control for a band on the cool bar control. A perfect example is the Lazarus IDE, which uses TCoolbar to host the file, view and run toolbars in its interface.

Properties

`Align`	published	Contains the edge in the Parent where the control is aligned.
`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.
`BandBorderStyle`	published	Border style used around bands on the control.
`BandMaximize`	published	Indicates the action used to maximize the width for a band on the control.
`Bands`	published	Collection with the bands defined for the control.
`BiDiMode`	published	Indicates whether text controls use in bi-directional reading.
`BorderWidth`	published	Width of the Border around the control; default is zero.
`Color`	published	The background color for the control.
`Constraints`	published	Contains the minimum and maximum Width and Height for the control.
`DockSite`	published	Allows controls to be drag-and-dock-ed into this control.
`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.
`EdgeBorders`	published	Indicates the edges to be drawn with a border on the control.
`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.
`FixedSize`	published	Indicates if bands on the control have a fixed size.
`FixedOrder`	published	Indicates if the order of the bands on the control is fixed or locked.
`Font`	published	The font to be used for text display in this control.
`GrabStyle`	published	Drawing style used for a grabber or gripper displayed on the control.
`GrabWidth`	published	Width for the grabber on the control.
`HorizontalSpacing`	published	Horizontal space reserved between visual elements on the control.
`Images`	published	Contains images displayed on the bands for the control.
`ImagesWidth`	published	Width for the Images used in the control.
`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.
`Bitmap`	published	Optional image displayed as the background for the cool bar control.
`PopupMenu`	published	If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True.
`ShowHint`	published	Enables Hint display for the control.
`ShowText`	published	Indicates if text captions are displayed for the bands on the control.
`Themed`	published	Enables or disables themed rendering for the control.
`Vertical`	published	Indicates if the control is displayed vertically instead of horizontally.
`VerticalSpacing`	published	Vertical space reserved between visual elements in the control.
`Visible`	published	Allows the control, and all of its children, to be displayed or hidden.

Events

`OnChange`	published	Event handler signalled when Bands are re-sized or re-ordered using the mouse.
`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.
`OnDockDrop`	published	Event handler signalled for the drop of a control to be docked.
`OnDockOver`	published	Event handler signalled when a control is moved over a docksite; determines whether the drop event is accepted or rejected.
`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.
`OnEndDock`	published	Event handler signalled for the end of a drag-dock operation.
`OnEndDrag`	published	Event handler signalled for the end of a drag-drop operation.
`OnGetSiteInfo`	published	Provides information about the DockSite for the control.
`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.
`OnResize`	published	Notification handler for a resize of the control.
`OnStartDock`	published	Event handler for the start of a docking operation.
`OnStartDrag`	published	Event handler signalled for the start of a dragging operation.
`OnUnDock`	published	Event handler signalled before a control is undocked from its DockSite.