Unit 'ExtCtrls' Package
[Overview][Types][Classes][Procedures and functions][Index] [#lcl]

TControlBar

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

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

Declaration

Source position: extctrls.pp line 1619

type TControlBar = class(TCustomControlBar)

public

  property Canvas: TCanvas;

  

The drawing surface for the control.

published

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property AutoDock: Boolean;

  

Not used in the current LCL implementation.

  property AutoDrag: Boolean;

  

Indicates if the control allows a band to be dragged even when DragManager is not used.

  property AutoSize: Boolean;

  

Indicates if bands are automatically sized and positioned on the control bar.

  property BevelInner: TPanelBevel;

  

Drawing style for the inner bevel on the control.

  property BevelOuter: TPanelBevel;

  

Drawing style for the outer bevel on the control.

  property BevelWidth: TBevelWidth;

  

BevelWidth - the Width of the panel's bevel in pixels.

  property BiDiMode: TBiDiMode;

  

Indicates whether text controls use in bi-directional reading.

  property BorderWidth: TBorderWidth;

  

Width of the Border around the control; default is zero.

  property Color: TGraphicsColor;

  

Contains the background color for the panel.

  property Constraints: TSizeConstraints;

  

Contains the minimum and maximum Width and Height for the control.

  property DockSite: Boolean;

  

Allows drag-docking of controls onto this control.

  property DoubleBuffered: Boolean;

  

Allows to reduce flicker in the painting of the control.

  property DragCursor: TCursor;

  

The cursor shape shown while the control is dragged.

  property DragKind: TDragKind;

  

The operation when the control is dragged - Drag or Dock.

  property DragMode: TDragMode;

  

Allows the user to drag the control.

  property DrawingStyle: TBandDrawingStyle;

  

Fill style used for bands on the control bar.

  property Enabled: Boolean;

  

Determines whether the control responds to mouse or keyboard input.

  property GradientDirection: TGradientDirection;

  

Controls the direction for a gradient drawn on the control bar.

  property GradientEndColor: TGraphicsColor;

  

Specifies the ending color used in a gradient drawn on the control bar.

  property GradientStartColor: TGraphicsColor;

  

Specifies the initial color used in a gradient drawn on the control bar.

  property ParentColor: Boolean;

  

Indicates if the control is drawn using the color in the parent control.

  property ParentDoubleBuffered: Boolean;

  

Value for the DoubleBuffered property in a Parent control.

  property ParentFont: Boolean;

  

If True, the Font of the control will be the same as the one from the Parent. Default is True.

  property ParentShowHint: Boolean;

  

If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True.

  property Picture: TPicture;

  

Optional image drawn before the visible bands for the control bar.

  property PopupMenu: TPopupMenu;

  

A context-sensitive menu that pops up when the right mouse button is clicked over this control.

  property RowSize: TRowSize;

  

Height used for a band or a row of bands displayed on the control bar.

  property RowSnap: Boolean;

  

Indicates if a band or row of bands snaps to the height for the control bar.

  property ShowHint: Boolean;

  

Enables Hint display for the control.

  property TabOrder: TTabOrder;

  

Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.

  property TabStop: Boolean;

  

Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys.

  property Visible: Boolean;

  

Allows the control, and all of its children, to be displayed or hidden.

  property OnBandDrag: TBandDragEvent;

  

Event handler signalled when a drag operation is about to begin for a band on the control bar.

  property OnBandInfo: TBandInfoEvent;

  

Event handler signalled to get the insets rectangles, preferred size, and row count for the control bar.

  property OnBandMove: TBandMoveEvent;

  

Event handler signalled when a control band is moved on the control bar.

  property OnBandPaint: TBandPaintEvent;

  

Event handler signalled to render a visible band on the specified control with the specified paint options.

  property OnCanResize: TCanResizeEvent;

  

Not used in the current implementation of TCustomControlBar / TControlBar.

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  property OnConstrainedResize: TConstrainedResizeEvent;

  

This handler can supply specific Constraints (size limits), when the control is resized.

  property OnContextPopup: TContextPopupEvent;

  

Invoked when a context-sensitive pop-up menu is requested.

  property OnDockDrop: TDockDropEvent;

  

Notification handler for the drop of a control to be docked.

  property OnDockOver: TDockOverEvent;

  

Event handler for moves of a control over this docksite; determines acceptance or rejection of an possible drop.

  property OnDblClick: TNotifyEvent;

  

Event Handler for double mouse clicks.

  property OnDragDrop: TDragDropEvent;

  

This handler determines the action on an drop onto this control, in a drag-drop operation.

  property OnDragOver: TDragOverEvent;

  

Event handler for a control being dragged over this control.

  property OnEndDock: TEndDragEvent;

  

Notification handler for the end of a docking operation.

  property OnEndDrag: TEndDragEvent;

  

Notification handler for the end of a drag operation.

  property OnEnter: TNotifyEvent;

  

Handler for control receiving the focus.

  property OnExit: TNotifyEvent;

  

Handler for control losing the focus; This is a good place for checking the finished user input.

  property OnGetSiteInfo: TGetSiteInfoEvent;

  

Provides information about the DockSite for the control.

  property OnMouseDown: TMouseEvent;

  

Event handler signalled when a mouse down event is handled for the control.

  property OnMouseEnter: TNotifyEvent;

  

Event handler signalled when the mouse pointer has entered the control.

  property OnMouseLeave: TNotifyEvent;

  

Event handler signalled when the mouse pointer has left the control.

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler signalled when a mouse up event is handled for the control.

  property OnMouseWheel: TMouseWheelEvent;

  

Event handler for mouse wheel turned.

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  

Event handler for downward movement of mouse wheel.

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  

Event handler for upward movement of the mouse wheel.

  property OnPaint: TNotifyEvent;

  

Event handler signalled to perform default drawing in the inherited Paint method.

  property OnResize: TNotifyEvent;

  

Notification handler for a resize of the control.

  property OnStartDock: TStartDockEvent;

  

Event handler for the start of a docking operation.

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

  property OnUnDock: TUnDockEvent;

  

Event handler signalled before a control is undocked from its DockSite.

end;

Inheritance

TControlBar

  

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

|

TCustomControlBar

  

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

|

TCustomPanel

  

The base class for a general container which can hold other objects. It has a customizable border and a central text.

|

TCustomControl

  

The base class for windowed controls which paint themselves.

|

TWinControl

  

Implements a windowed control which can contain other child controls.

|

TControl

  

The base class for visible controls.

|

TLCLComponent

  

|

TObject

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 Typhon Form Designer.

See also

TCustomControlBar

  

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



CT Web help

CodeTyphon Studio