TCustomControlBar class

In unit ExtCtrls

Implements a panel used to maintain and manage tool bars and tool buttons on a form.

Declaration

pascal

TCustomControlBar = class(TCustomPanel)

Inheritance

Descends from it: TControlBar

Description

TCustomControlBar is a TCustomPanel descendant used to maintain and manage tool bars and tool buttons added to the container.

Internally, it uses a TCtrlBands member to represent the TToolBar, TToolButton, or TCoolBar classes added to the container. Use InsertControl and RemoveControl to maintain items in the container at run-time, or use the design-time support provided in the Lazarus Form Designer.

Properties

`AutoDock`	public	Not used in the current LCL implementation.
`AutoDrag`	public	Indicates if the control allows a band to be dragged even when DragManager is not used.
`AutoSize`	public	Indicates if bands are automatically sized and positioned on the control bar.
`DockSite`	public	Allows drag-docking of controls onto this control.
`DrawingStyle`	public	Fill style used for bands on the control bar.
`GrabberCursor`	public
`GradientDirection`	public	Controls the direction for a gradient drawn on the control bar.
`GradientStartColor`	public	Specifies the initial color used in a gradient drawn on the control bar.
`GradientEndColor`	public	Specifies the ending color used in a gradient drawn on the control bar.
`Picture`	public	Optional image drawn before the visible bands for the control bar.
`RowSize`	public	Height used for a band or a row of bands displayed on the control bar.
`RowSnap`	public	Indicates if a band or row of bands snaps to the height for the control bar.

Methods

`AlignControlToBand`	protected	Aligns the control for the specified band and updates its coordinates for use in subsequent resize operations.
`AlignControlsToBands`	protected	Aligns visible control bands in the container.
`CalcBandHeight`	protected	Calculates the vertical space needed for a band the control bar.
`CalcBandHeightSnapped`	protected	Calculates the vertical space needed for a band on the control bar when RowSnap is enabled.
`CalcInnerBevelWidth`	protected	Calculates the cumulative width for all borders and bevels used on the control bar.
`CalcLowestBandBottomPx`	protected	Gets the largest value in the Bottom property for visible bands on the control bar.
`CalculatePreferredSize`	protected	Calculates the preferred height and width used during auto-sizing.
`ChangeCursor`	protected	Changes the cursor to the specified shape.
`CheckBandsSizeAndVisibility`	protected	Updates the size and visibility for TCtrlBand instances defined in the control bar.
`CMBiDiModeChanged`	protected	Handles the CM_BIDIMODECHANGED message.
`CMBorderChanged`	protected	Handles the CM_BORDERCHANGED message.
`CreateWnd`	protected	Ensures the default values taken from Cursor and Width are assigned when the window handle is created.
`DoBandMove`	protected	Signals the OnBandMove event handler for the specified control and drawing rectangle.
`DoBandPaint`	protected	Signals the OnBandPaint event handler using the specified arguments.
`DragControl`	protected	Signals an assigned OnBandDrag event handler and starts a drag operation for the specified control.
`DragOver`	protected	Called when an object is dragged over this control; Determines whether a drop is acceptable, using the OnDragOver handler.
`GetControlInfo`	protected	Signals the OnBandInfo event handler to store control information to the arguments for the method.
`InitializeClass`	protected	Class constructor which initializes class constants.
`InitializeBand`	protected	Configures a control bar band and calculates its row position, order, and geometry including client decorations.
`InitializeMove`	protected	Prepares visible bands on the control bar for a drag and drop operation.
`Loaded`	protected	Performs actions needed when component loading has been completed.
`IsBandOverlap`	protected	Determines if the display rectangles for two bands overlap.
`MouseDown`	protected	Handles a mouse down message in the control.
`MouseMove`	protected	Handles a mouse move message including dragging a control band.
`MouseUp`	protected	Handles a mouse up message that ends a drag operation for a control band.
`MoveBand`	protected	Performs actions needed when a band is moved to new position.
`NormalizeRows`	protected	Orders visible bands on the control by their coordinates, and hides empty rows.
`Paint`	protected	Draws the control with its image, decorations, and visible bands.
`PictureChanged`	protected	Redraws the image on the control bar when the Picture property has been changed.
`Resize`	protected	Signals the OnResize event handler (when assigned) and re-aligns bands and their controls.
`SetCursor`	protected	Sets the Cursor to the specified TCursor shape.
`ShiftBands`	protected	Shifts the positions for a range of bands by the specified amount.
`SortVisibleBands`	protected	Calculates the number of visible bands (and controls) and optionally sorts visible bands to reflect their Top and Left coordinates.
`WMSize`	protected	Handles the LM_SIZE message for the control.
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`BeginUpdate`	public	Increments the internal counter used to track the number of active update requests.
`EndUpdate`	public	Decrements the internal counter used to track update requests, and calls Invalidate when the counter reaches zero (0).
`FlipChildren`	public	Flips the horizontal display coordiantes for child controls.
`HitTest`	public	Gets the control for the visible band under the specified mouse coordinates.
`InsertControl`	public	Creates and stores a new band for the specified control.
`MouseToBandPos`	public	Gets the visible band on the control bar at the specified mouse coordinates.
`RemoveControl`	public	Removes the band with the specified control.
`StickControls`	public	Aligns controls to both their bands and the control bar.

Events

`OnBandDrag`	public	Event handler signalled when a drag operation is about to begin for a band on the control bar.
`OnBandInfo`	public	Event handler signalled to get the insets rectangles, preferred size, and row count for the control bar.
`OnBandMove`	public	Event handler signalled when a control band is moved on the control bar.
`OnBandPaint`	public	Event handler signalled to render a visible band on the specified control with the specified paint options.
`OnCanResize`	public	Not used in the current implementation of TCustomControlBar / TControlBar.
`OnPaint`	public	Event handler signalled to perform default drawing in the inherited Paint method.

Fields

`cFullGrabber`	protected	Space needed for the width of the grabber including the control bar and its border.
`FBands`	protected	Member with the list of TCtrlBand instances for the control bar.
`FBandMove`	protected	Member with the band move status flag for the control bar.
`FCursorLock`	protected	Member with the cursor lock flag set when ChangeCursor is called.
`FDefCursor`	protected	Member with the default cursor shape for the control bar.
`FGrabberCursor`	protected
`FHoveredBand`	protected	Member with the band under the mouse cursor during a drag operation.
`FInitDrag`	protected	Member with the initial coordinates for the band being dragged on the control bar.
`FInnerBevelWidth`	protected	Member with the width for inner bevels following a CM_BORDERCHANGED control message.
`FLockResize`	protected	Member with a flag set to prevent resizing while the row size is updated for the control bar.
`FPrevWidth`	protected	Member with the Width for the control bar after its Handle is created.
`FVisiBands`	protected	Member with the visible bands for the control bar.
`FVisiBandsEx`	protected	Member with the visible bands on the control bar excluding a band being dragged.
`FUpdateCount`	public	Member with the update counter for the control bar.

Types and constants

`cBandBorderH`	protected	Space reserved for the horizontal border in a control bar.
`cBandBorderV`	protected	Space reserved for the vertical border in a control bar
`cGrabWidth`	protected	Space reserved as the width of the grabber in a control bar.