TControlBar class

In unit ExtCtrls

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

Declaration

pascal

TControlBar = class(TCustomControlBar)

Inheritance

Description

TControlBar implements a panel used to maintain and manage tool bars and tool buttons on a form. TControlBar is a TCustomControlBar descendant, and sets the visibility for properties from the ancestor class.

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

`Canvas`	public	The drawing surface for the control.
`Align`	published	Specifies the placement of the control inside its Parent.
`Anchors`	published	The set of anchor definitions for this control.
`AutoDock`	published	Not used in the current LCL implementation.
`AutoDrag`	published	Indicates if the control allows a band to be dragged even when DragManager is not used.
`AutoSize`	published	Indicates if bands are automatically sized and positioned on the control bar.
`BevelInner`	published	Drawing style for the inner bevel on the control.
`BevelOuter`	published	Drawing style for the outer bevel on the control.
`BevelWidth`	published	Width for a bevel on the panel in pixels.
`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	Contains the background color for the panel.
`Constraints`	published	Contains the minimum and maximum Width and Height for the control.
`DockSite`	published	Allows drag-docking of controls onto this control.
`DoubleBuffered`	published	When enabled, it reduces flicker when the control is painted.
`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.
`DrawingStyle`	published	Fill style used for bands on the control bar.
`Enabled`	published	Determines whether the control responds to mouse or keyboard input.
`GrabberCursor`	published
`GradientDirection`	published	Controls the direction for a gradient drawn on the control bar.
`GradientEndColor`	published	Specifies the ending color used in a gradient drawn on the control bar.
`GradientStartColor`	published	Specifies the initial color used in a gradient drawn on the control bar.
`ParentColor`	published	Indicates if the control is drawn using the color in the parent control.
`ParentDoubleBuffered`	published	Value for the DoubleBuffered property in a Parent control.
`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.
`Picture`	published	Optional image drawn before the visible bands for the control bar.
`PopupMenu`	published	A context-sensitive menu that pops up when the right mouse button is clicked over this control.
`RowSize`	published	Height used for a band or a row of bands displayed on the control bar.
`RowSnap`	published	Indicates if a band or row of bands snaps to the height for the control bar.
`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	Enables or disables navigation using the Tab key.
`Visible`	published	Allows the control, and all of its children, to be displayed or hidden.

Events

`OnBandDrag`	published	Event handler signalled when a drag operation is about to begin for a band on the control bar.
`OnBandInfo`	published	Event handler signalled to get the insets rectangles, preferred size, and row count for the control bar.
`OnBandMove`	published	Event handler signalled when a control band is moved on the control bar.
`OnBandPaint`	published	Event handler signalled to render a visible band on the specified control with the specified paint options.
`OnCanResize`	published	Not used in the current implementation of TCustomControlBar / TControlBar.
`OnClick`	published	Notification handler for mouse clicks.
`OnConstrainedResize`	published	This handler can supply specific Constraints (size limits), when the control is resized.
`OnContextPopup`	published	Invoked when a context-sensitive pop-up menu is requested.
`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.
`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.
`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.
`OnEnter`	published	Event handler signalled when the control receives focus.
`OnExit`	published	Event handler signalled when the control loses focus.
`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.
`OnPaint`	published	Event handler signalled to perform default drawing in the inherited Paint method.
`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.