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

TTabControl

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

TTabControl - a series of Tabs along the edge of a display area; selection of a Tab governs the contents of the DisplayRect

Declaration

Source position: comctrls.pp line 783

type TTabControl = class(TCustomTabControl) end;

protected

  procedure SetOptions(); override;

  procedure AddRemovePageHandle(); override;

  function CanChange; override;

  function CanShowTab(); virtual;

  procedure Change; override;

  procedure CreateWnd; override;

  procedure DestroyHandle; override;

  procedure Notification(); override;

  procedure SetDragMode(); override;

  procedure SetTabIndex(); virtual;

  procedure UpdateTabImages;

  procedure ImageListChange();

  procedure DoSetBounds(); override;

  class function GetControlClassDefaultSize; override;

  procedure PaintWindow(); override;

  procedure Paint; virtual;

  procedure AdjustDisplayRectWithBorder(); virtual;

  procedure AdjustClientRect(); override;

  function CreateTabNoteBookStrings; virtual;

public

  constructor Create(); override;

  destructor Destroy; override;

  function IndexOfTabAt();

  function GetHitTestInfoAt();

  function GetImageIndex(); override;

  function IndexOfTabWithCaption();

  function TabRect();

  function RowCount;

  procedure ScrollTabs();

  procedure BeginUpdate;

  procedure EndUpdate;

  function IsUpdating;

  property DisplayRect: TRect; [r]

  

DisplayRect - the rectangular area to be used for displaying information determined by the identity of the selected Tab

published

  property HotTrack: Boolean; [rw]

  

HotTrack - the property whereby the item under the mouse pointer becomes emphasised

  property Images: TCustomImageList;

  

Images - the list of Images available for display in the DisplayRect

  property MultiLine: Boolean; [rw]

  

MultiLine - whether the Tab's caption is allowed to have multiple lines

  property MultiSelect: Boolean; [rw]

  

MultiSelect - whether multiple Tabs are allowed to be selected at the same time (e.g. by pressing Shift or Ctrl while selecting)

  property OnChange: TNotifyEvent; [rw]

  

OnChange - event handler for a change in the Tabs

  property OnChanging: TTabChangingEvent;

  

OnChanging - event handler while Tab is changing

  property OnDrawTab: TDrawTabEvent; deprecated ;

  

OnDrawTab - event handler for drawing a Tab

  property OnGetImageIndex: TTabGetImageEvent;

  

OnGetImageIndex - event handler for finding the index value of the required image

  property OwnerDraw: Boolean; [rw]

  

OwnerDraw - is the calling routine (Owner) allowed to specify the drawing method?

  property RaggedRight: Boolean; [rw]

  

RaggedRight - un-justified or un-aligned text

  property ScrollOpposite: Boolean; [rw]

  

ScrollOpposite - is scrolling to happen in the opposite direction to usual?

  property Style: TTabStyle;

  

Style - Tabs, buttons or flat buttons?

  property TabPosition: TTabPosition;

  

TabPosition - top, bottom, left or right

  property TabHeight: SmallInt; [rw]

  

TabHeight - height of the tabs

  property TabIndex: Integer; [rw]

  

TabIndex - index value of current Tab. If none selected, default value of -1 is returned

  property Tabs: TStrings; [rw]

  

Tabs - the actual Tabs expressed as strings

  property TabStop: Boolean; [rw]

  

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

  property TabWidth: SmallInt; [rw]

  

TabWidth - width of the tabs

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property BiDiMode: TBiDiMode;

  property BorderSpacing: TControlBorderSpacing;

  

Determines the inner and outer border spacing for this control.

  property Constraints: TSizeConstraints;

  

The minimal and maximal Width and Height of this control.

  property DockSite: Boolean;

  

Allows to drag-dock other controls into 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;

  

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

  property OnChangeBounds: TNotifyEvent;

  

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

  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 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 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 OnGetSiteInfo: TGetSiteInfoEvent;

  

OnGetSiteInfo - event handler for getting information about the current site

  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.

  property OnUnDock: TUnDockEvent;

  

Event handler for control being undocked from this DockSite.

  property ParentBiDiMode: Boolean;

  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 ShowHint: Boolean;

  

Enables the Hint display.

  property TabOrder: TTabOrder;

  

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

  property Visible: Boolean;

  

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

Inheritance

TTabControl

  

TTabControl - a series of Tabs along the edge of a display area; selection of a Tab governs the contents of the DisplayRect

|

TCustomTabControl

  

TCustomTabControl - base class for TTabControl, a series of Tabs along the edge of a display area; selection of a Tab governs the contents of the DisplayRect

|

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

TTabControl - a series of Tabs along the edge of a display area; selection of a Tab governs the contents of the DisplayRect

Use TTabControl by selecting its icon from the Common Controls tab of the IDE Component Palette and placing it at the desired location on the Form. Use the Form Designer and Object Inspector to adjust its shape, size, alignment, anchoring and other properties. Tabs can be aded or removed from the component by selecting it, then right-clicking with the mouse to get a pop-up menu whose first item is 'Add Tab'. Once created, the Tabs can be edited by selecting the Tabs entry in the Object Inspector and selecting the ellipsis (...) which will cause a pop-up String editor to appear. The tabs can be given new captions, moved up and down the list or removed altogether as required.

Each Tab has an Index (starting from 0) and this index can be used to specify an entry from Images for display in the DisplayRect.

See also

Multi-PageControls

  

Multi-PageControls - controls that offer a selection of alternative pages for display

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