TCustomCoolBar class

In unit ComCtrls

Defines a Rebar-like control with resizable bands.

Declaration

pascal

TCustomCoolBar = class(TToolWindow)

Inheritance

Descends from it: TCoolBar

Description

TCustomCoolBar is a TToolWindow descendant which defines 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. A perfect example is the Lazarus IDE, which uses TCoolbar to host the file, view and run toolbars in its interface.

Do not create instances of TCustomCoolBar; use the TCoolBar descendant which sets the visibility for the properties in the control.

Properties

`Align`	public	Contains the edge in the Parent where the control is aligned.
`BandBorderStyle`	public	Border style used around bands on the control.
`BandMaximize`	public	Indicates the action used to maximize the width for a band on the control.
`Bands`	public	Collection with the bands defined for the control.
`Bitmap`	public	Optional image displayed as the background for the cool bar control.
`FixedSize`	public	Indicates if bands on the control have a fixed size.
`FixedOrder`	public	Indicates if the order of the bands on the control is fixed or locked.
`GrabStyle`	public	Drawing style used for a grabber or gripper displayed on the control.
`GrabWidth`	public	Width for the grabber on the control.
`HorizontalSpacing`	public	Horizontal space reserved between visual elements on the control.
`Images`	public	Contains images displayed on the bands for the control.
`ImagesWidth`	public	Width for the Images used in the control.
`ShowText`	public	Indicates if text captions are displayed for the bands on the control.
`Themed`	public	Enables or disables themed rendering for the control.
`Vertical`	public	Indicates if the control is displayed vertically instead of horizontally.
`VerticalSpacing`	public	Vertical space reserved between visual elements in the control.

Methods

`AlignControls`	protected	Aligns the bands (and their controls) using the orientation, layout order, and anchors for the control.
`BitmapOrImageListChange`	protected	Implements the OnChange handler used for Bitmap and Images.
`CalculatePreferredSize`	protected	Calculates the preferred width and height for the control.
`CalculateAndAlign`	protected	Calculates the size and position for visible bands using the orientation, layout, and order for the control.
`CalculateRealIndex`	protected	Gets the real position for the band at the specified visible position.
`ChangeCursor`	protected	Changes the cursor shape when a band, a grabber, or the control background is active.
`CMBiDiModeChanged`	protected	Handles the CM_BIDIMODECHANGED message for the control.
`CreateWnd`	protected	Creates the window handle for the control, and sets the cursor shape for the control background.
`DoFontChanged`	protected	Calculates the text height and width in each of the bands when the font has been changed.
`DrawTiledBitmap`	protected	Tile draws the specified bitmap on the control Canvas to fill the area in ARect.
`FontChanged`	protected	Re-implements the OnChange event handler for the Font in the control.
`IsFirstAtRow`	protected	Checks whether the band at the specified position is the first one on a row.
`IsRowEnd`	protected	Indicates whether the band at the specified position is the last one on a row.
`MouseDown`	protected	Handles mouse down messages for the control.
`MouseMove`	protected	Handles mouse move messages for the control.
`MouseUp`	protected	Handles mouse up messages for the control.
`Notification`	protected	Handles the notification when a component is added to or removed from the control.
`Paint`	protected	Draws the visible bands for the control on its Canvas.
`SetAlign`	protected	Sets the value for the Align property.
`SetAutoSize`	protected	Sets the value for the AutoSize property.
`SetCursor`	protected	Sets the value for the Cursor property.
`WMSize`	protected	Handles the LM_SIZE window message for the control.
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`AutosizeBands`	public	Indicates if a band is automatically resized to its Control.
`EndUpdate`	public	Ends an update process for the control.
`Invalidate`	public	Causes the control to be redrawn.
`InsertControl`	public	Inserts a band for the specified control at the ordinal position in Index.
`MouseToBandPos`	public	Gets the position for the band under the mouse pointer.
`RemoveControl`	public	Removes the band with the specified control.

Events

OnChange public Event handler signalled when Bands are re-sized or re-ordered using the mouse.

Fields

`FBorderEdges`	protected	Members used for the realized EdgeBorders for the control.
`FBorderLeft`	protected	Member used for the realized left border on the control.
`FBorderTop`	protected	Member used for the realized top border on the control.
`FBorderRight`	protected	Member used for the realized right border on the control.
`FBorderBottom`	protected	Member used for the realized bottom border on the control.
`FBorderWidth`	protected	Member used for the total width of realized borders on the control.
`FCursorBkgnd`	protected	Member with the cursor shape when the mouse is over the cool bar background.
`FDragBand`	protected	Member with the band being dragged in the control.
`FDraggedBandIndex`	protected	-1 indicates the space below the last row; other negative values are an invalid area.
`FDragInitPos`	protected	Initial mouse X - position (for resizing Bands).
`FLockCursor`	protected	Member which indicates if the cursor shape can be changed for the control.
`FRightToLeft`	protected	Member which indicates is bands are aligned in reverse (right-to-left) order.
`FTextHeight`	protected	Member with the calculated text height used on the control.
`FVisiBands`	protected	Member with the visible bands for the control.

Types and constants

`cDefGrabStyle`	protected	Default value for the GrabStyle property.
`cDefGrabWidth`	protected	Default value for the GrabWidth property.
`cDefHorSpacing`	protected	Default value for the HorizontalSpacing property.
`cDefVertSpacing`	protected	Default value for the VerticalSpacing property.
`cNewRowBelow`	protected	Free space below the last row.
`cNewRowAbove`	protected	Free space above the first row.