[Overview][Constants][Types][Classes][Procedures and functions][Index] Reference for unit 'ComCtrls' (#lcl)

TToolBar

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

Declaration

Source position: comctrls.pp line 2168

type TToolBar = class(TToolWindow) end;

protected

Const

  cDefButtonWidth = 23

  cDefButtonHeight = 22

  FPrevVertical: Boolean;

  function IsVertical; virtual;

  class procedure WSRegisterClass; override;

  

Registers this component class with the current WidgetSet.

  procedure AdjustClientRect(); override;

  

Override this method when the ClientRect of a control differs from the default value.

  function ButtonHeightIsStored;

  function ButtonWidthIsStored;

  function DropDownWidthIsStored;

  class function GetControlClassDefaultSize; override;

  

GetControlClassDefaultSize - returns its own defaults, overriding the inherited values

  procedure DoAutoSize; override;

  procedure CalculatePreferredSize(); override;

  

Override this method to return the preferred height and width.

  function CheckMenuDropdown(); virtual;

  

CheckMenuDropdown - returns True if there is a checked dropdown menu

  procedure ClickButton(); virtual;

  

ClickButton - software emulation of the OnClick event

  procedure CreateWnd; override;

  

Creates the interface object (widget) and assigns it to Handle.

  procedure AlignControls(); override;

  function FindButtonFromAccel();

  

FindButtonFromAccel - returns the Button corresponding to the specified accelerator key

  procedure FontChanged(); override;

  

FontChanged - method to cope with change in font

  procedure Loaded; override;

  

Called when the control has been loaded from a resource, transfers the loaded property values to the widget.

  procedure Notification(); override;

  

Notification handler for insertion or deletion of components.

  procedure Paint; override;

  

Override this method in your derived class with your own paint handler.

  procedure RepositionButton();

  

RepositionButton - method for re-positioning a button

  procedure RepositionButtons();

  

RepositionButtons - method for re-positioning several buttons

  function WrapButtons();

  

WrapButtons - returns True if changing to NewHeight and NewWidth causes wrapping of buttons

  procedure CNDropDownClosed(); message;

  procedure DoAutoAdjustLayout(); override;

public

  constructor Create(); override;

  

Create - constructor for TToolBar: calls inherited Create and sets many formatting and size defaults

  destructor Destroy; override;

  

Destroy - destructor for TToolBar: frees buttons and links then calls inherited Destroy

  procedure EndUpdate; override;

  

EndUpdate - finishes the update process

  procedure FlipChildren(); override;

  

Flip children horizontally. That means mirroring the Left position and anchoring.

  function GetEnumerator;

  procedure SetButtonSize();

  

SetButtonSize - stores new values for height and width

  function CanFocus; override;

  

Is this control allowed to receive the focus when parent form is visible?

  property ButtonCount: Integer; [r]

  

ButtonCount - the number of buttons on the ToolBar

  property Buttons []: TToolButton; [r]

  

Lists the tool buttons (TToolButton) in the toolbar.

  property ButtonList: TList; [r]

  

ButtonList - the list of Buttons (as a TList)

  property RowCount: Integer; [r]

  

RowCount - the number of Rows of Buttons

  property ButtonDropWidth: Integer; [r]

published

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property Anchors: TAnchors;

  property AutoSize: Boolean;

  

Allows to automatically adjust the size of the control, according to its content.

  property BorderSpacing: TControlBorderSpacing;

  

Determines the inner and outer border spacing for this control.

  property BorderWidth: TBorderWidth;

  

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

  property ButtonHeight: Integer; [rws]

  

ButtonHeight - the height of the buttons

  property ButtonWidth: Integer; [rws]

  

ButtonWidth - the width of the buttons

  property Caption: TCaption;

  

The text describing the control to the user.

  property ChildSizing: TControlChildSizing;

  

Parameters for child control arrangement and spacing.

  property Constraints: TSizeConstraints;

  

The minimal and maximal Width and Height of this control.

  property Color: TColor;

  

The background color of the control.

  property DisabledImages: TCustomImageList; [rw]

  

The Images on the Image List that are NOT selected for display

  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 DropDownWidth: Integer; [rws]

  

Width of the drop down arrow button.

  property EdgeBorders: TEdgeBorders;

  

EdgeBorders - which borders form the edge

  property EdgeInner: TEdgeStyle;

  

EdgeInner - this toolbar has an inner edge

  property EdgeOuter: TEdgeStyle;

  

EdgeOuter - this toolbar has an outer edge

  property Enabled: Boolean;

  

Determines whether the control reacts on mouse or keyboard input.

  property Flat: Boolean; [rw]

  

Should the toolbuttons be displayed Flat (rather than in relief)? Default false

  property Font: TFont;

  

The font to be used for text display in this control.

  property Height: Integer;

  

The vertical size of the control.

  property HotImages: TCustomImageList; [rw]

  

The Images on the Image list that are selected for display

  property Images: TCustomImageList; [rw]

  

The Images to be displayed on the buttons

  property Indent: Integer; [rw]

  

Indent - the amount by which the buttons should be indented Default is 1

  property List: Boolean; [rw]

  

Should the contents of the toolbar be displayed as a List? Default false

  property ParentColor: Boolean;

  

If true, the Color of the control will be the same as the one from the Parent. Default is true.

  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 PopupMenu: TPopupMenu;

  

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

  property ShowCaptions: Boolean; [rw]

  

ShowCaptions - should the captions be shown for the buttons? (Default False)

  property ShowHint: Boolean;

  

Enables the Hint display.

  property TabOrder: TTabOrder;

  

Determines the sequence of controls, reachable when the user presses the Tab key.

  property TabStop: Boolean;

  

Allows the user to navigate to this control, by pressing the Tab key.

  property Transparent: Boolean; [rw]

  

Is the ToolBar to be Transparent? Default False

  property Visible: Boolean;

  

Allows to show or hide the control, and all of its children.

  property Wrapable: Boolean; [rw]

  

Wrapable - enables wrapping buttons to the next row if there are too many for the current row

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  property OnContextPopup: TContextPopupEvent;

  

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

  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 OnPaintButton: TToolBarOnPaintButton; [rw]

  property OnEndDrag: TEndDragEvent;

  

Notification handler for the end of a dragging operation.

  property OnEnter: TNotifyEvent;

  

Handler for control receiving the focus.

  property OnExit: TNotifyEvent;

  

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

  property OnMouseDown: TMouseEvent;

  

Event handler for mouse button going down.

  property OnMouseEnter: TNotifyEvent;

  

Event handler for mouse entering the area of the control.

  property OnMouseLeave: TNotifyEvent;

  

Event handler for mouse leaving the area of the control.

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler for mouse button going up.

  property OnMouseWheel: TMouseWheelEvent;

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  property OnPaint: TNotifyEvent; [rw]

  property OnResize: TNotifyEvent;

  

Notification handler for a resize of the control.

  property OnChangeBounds: TNotifyEvent;

  

Event handler for a change of the Bounds of the control.

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

Inheritance

TToolBar

|

TToolWindow

  

|

TCustomControl

  

The base class for windowed controls which paint themselves.

|

TWinControl

  

The base class for controls which can contain other (child) controls.

|

TControl

  

The base class for visible controls.

|

TLCLComponent

  

The base class for LCL components associated with widgets.

|

TComponent

?

TObject

The latest version of this document can be found at lazarus-ccr.sourceforge.net.