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

TStatusBar

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

TStatusBar - a strip along the bottom of a form for displaying information on current status

Declaration

Source position: comctrls.pp line 120

type TStatusBar = class(TWinControl) end;

protected

  class procedure WSRegisterClass; override;

  

Registers this component class with the current WidgetSet.

  procedure BoundsChanged; override;

  

Invoked when the Bounds of the control have been changed. Override as required.

  procedure CreateWnd; override;

  

CreateWnd calls inherited method, then fixes handles if needed

  procedure DestroyWnd; override;

  

DestroyWnd calls inherited method and frees handles

  procedure Loaded; override;

  

Loaded calls inherited method and fixes handles if needed

  procedure UpdateHandleObject(); virtual;

  

UpdateHandleObject - updates all panel parts that have been changed

  procedure CalculatePreferredSize(); override;

  

CalculatePreferredSize calls inherited method then supplies its own values if any are missing

  procedure SetBiDiMode(); override;

  function CreatePanel; virtual;

  

CreatePanel - returns a created Status Panel

  function CreatePanels; virtual;

  

CreatePanels - returns a set of created panels

  function GetPanelClass; virtual;

  

GetPanelClass - returns a class of status panel

  function DoSetApplicationHint(); virtual;

  

DoSetApplicationHint - specifies a hint string and returns True if successful

  function DoHint; virtual;

  

DoHint - shows the hint and returns True if successful (uses OnHint event handler)

  procedure DrawPanel(); virtual;

  

DrawPanel calls the OnDrawPanel event handler if assigned

  procedure LMDrawItem(); message;

  

LMDrawItem - LCL message handler for drawing the item on the current canvas

  procedure DoAutoAdjustLayout(); override;

public

  constructor Create(); override;

  

Create - constructor for TStatusBar: calls inherited Create and initialises a number of local variables

  destructor Destroy; override;

  

Destroy - destructor for TStatusBar: frees canvas and panels, then calls inherited Destroy

  procedure InvalidatePanel(); virtual;

  

InvalidatePanel - renders the panel with specified index non-valid

  procedure BeginUpdate;

  

BeginUpdate - starts the update process

  procedure EndUpdate;

  

EndUpdate - finishes the update process

  function ExecuteAction(); override;

  

ExecuteAction: if required action is a Hint-related, sets the Hint in place, otherwise calls inherited method

  function GetPanelIndexAt();

  function SizeGripEnabled;

  

SizeGripEnabled - returns True if the size-grip (an area at the bottom of the statusbar where a mouse can grip to change the size) is enabled

  function UpdatingStatusBar;

  

UpdatingStatusBar - returns True if the status bar is being updated

  property Canvas: TCanvas; [r]

  

The Canvas where the Panels of the StatusBar are to be Painted

published

  property Action: TBasicAction;

  

The Action associated with this control.

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property AutoHint: Boolean; [rw]

  

AutoHint - if True, a hint is automatically shown when mouse hovers over status bar. Default False

  property AutoSize: Boolean;

  

TStatusBar default is True

  property BiDiMode: TBiDiMode;

  property BorderSpacing: TControlBorderSpacing;

  property BorderWidth: TBorderWidth;

  property Color: TColor;

  

The background color of the control.

  property Constraints: TSizeConstraints;

  

The minimal and maximal Width and Height of this 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 Enabled: Boolean;

  

Determines whether the control reacts on mouse or keyboard input.

  property Font: TFont;

  property Panels: TStatusPanels; [rw]

  

Panels - the list of strings to be placed in the sub-panels of TStatusBar

  property ParentBiDiMode: Boolean;

  property ParentColor: Boolean;

  property ParentFont: Boolean;

  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;

  property SimpleText: TCaption; [rw]

  

SimpleText - a character string containing the information to be displayed in the Status Bar

  property SimplePanel: Boolean; [rw]

  

SimplePanel - boolean. Is there just one continuous panel or several sub-panels?

  property SizeGrip: Boolean; [rw]

  

SizeGrip - an area at the bottom of the statusbar where a mouse can grip to change the size: True if this is working

  property ShowHint: Boolean;

  

Enables the Hint display.

  property UseSystemFont: Boolean; [rw]

  property Visible: Boolean;

  

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

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  property OnContextPopup: TContextPopupEvent;

  

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

  property OnCreatePanelClass: TSBCreatePanelClassEvent; [rw]

  

Event handler for creating a StatusBar Panel class

  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 OnDrawPanel: TDrawPanelEvent; [rw]

  property OnEndDock: TEndDragEvent;

  

Notification handler for the end of a docking operation.

  property OnEndDrag: TEndDragEvent;

  

Notification handler for the end of a dragging operation.

  property OnHint: TNotifyEvent; [rw]

  

Event handler for showing a hint when required

  property OnMouseDown: TMouseEvent;

  

Event handler for mouse button going down.

  property OnMouseEnter: TNotifyEvent;

  property OnMouseLeave: TNotifyEvent;

  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 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.

Inheritance

TStatusBar

  

TStatusBar - a strip along the bottom of a form for displaying information on current status

|

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

Description

TStatusBar - a strip along the bottom of a form for displaying information on current status

The bar may consist of a single SimplePanel in which case the displayed text is contained in SimpleText.

However if SimplePanel is false, then there can be multiple panels or sub-sections of the status bar whose properties are described in Panels.

The property SimpleText can be assigned programatically to display the value of some variable, such as the position of the Splitter in the example

Example

procedure TTrivialForm1.Splitter1Moved(Sender: TObject);
begin
  StatusBar1.SimpleText := IntToStr(Splitter1.Left);
end;
The latest version of this document can be found at lazarus-ccr.sourceforge.net.