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

TCustomTabControl

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

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

Declaration

Source position: comctrls.pp line 373

type TCustomTabControl = class(TWinControl) end;

protected

  PageClass: TCustomPageClass;

  

PageClass - the class of page that is included in this NoteBook

  function GetPageClass; virtual;

  function GetListClass; virtual;

  procedure SetOptions(); virtual;

  

  procedure AddRemovePageHandle(); virtual;

  

  procedure CNNotify(); message;

  

  class procedure WSRegisterClass; override;

  

Registers this component class with the current WidgetSet.

  procedure CreateWnd; override;

  

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

  procedure Loaded; override;

  

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

  procedure DoChange; virtual;

  procedure InitializeWnd; override;

  procedure Change; virtual;

  

Change - software emulation of the OnChange event

  procedure KeyDown(); override;

  procedure ReadState(); override;

  

  function DialogChar(); override;

  

Do something useful with accelerators etc.

  procedure InternalSetPageIndex();

  procedure ShowControl(); override;

  

Asks the parent to show ourself.

  function IndexOfTabAt();

  

IndexOfTabAt - returns the index value of the Tab located at specified X, Y

  function IndexOfPageAt();

  procedure UpdateTabProperties; virtual;

  

UpdateTabProperties - apply all pending changes to the Tab

  class function GetControlClassDefaultSize; override;

  

GetControlClassDefaultSize returns its own defaults, overriding inherited values

  procedure Notification(); override;

  

Notification handler for insertion or deletion of components.

  property ActivePageComponent: TCustomPage; [rw]

  

ActivePageComponent - the actual contents of the currently selected Page

  property ActivePage: string; [rws]

  

ActivePage - the name (string) of the Page that is currently selected and is available for interaction

  function GetPage(); virtual;

  

  function GetPageCount; virtual;

  

  procedure InsertPage(); virtual;

  

  procedure RemovePage(); virtual;

  

  function CanChange; virtual;

  

CanChange - returns True if the control can be changed

  property DisplayRect: TRect; [r]

  

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

  property HotTrack: Boolean; [rw]

  

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

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

  

Style - Tabs, buttons or flat buttons?

  property Tabs: TStrings; [rw]

  

Tabs - the actual Tabs expressed as strings

  property TabIndex: Integer; [rw]

  

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

  property OnChange: TNotifyEvent; [rw]

  

OnChange - event handler for a change in the Tabs

  property OnDrawTab: TDrawTabEvent; [rw] deprecated ;

  

OnDrawTab - event handler for drawing a Tab

public

  constructor Create(); override;

  

Create - constructor for TCustomTabControl: calls inherited Create, sets initial bounds, forms links and sets some defaults

  destructor Destroy; override;

  

Destroy - destructor for TCustomTabControl: frees links and tabs, then calls inherited Destroy

  function TabIndexAtClientPos(); deprecated ;

  

TabIndexAtClientPos - the index value of the Tab at the specified position ClientPos

  function TabRect();

  

TabRect - the rectangle occupied by the specified Tab

  function GetImageIndex(); virtual;

  

GetImageIndex - software emulation of the OnGetImageIndex event

  function IndexOf(); virtual;

  

IndexOf - returns the index value of a specified page

  function CustomPage();

  

CustomPage - returns the page specified by Index

  function CanChangePageIndex; virtual;

  

CanChangePageIndex - determine whether it is permissible to change the index of the page

  function GetMinimumTabWidth; virtual;

  

GetMinimumTabWidth - find the smallest permissible tab width

  function GetMinimumTabHeight; virtual;

  

GetMinimumTabHeight - find the least permissible height for a tab

  function GetCapabilities; virtual;

  

GetCapabilities - returns the set of capabilities

  function TabToPageIndex();

  function PageToTabIndex();

  procedure DoCloseTabClicked(); virtual;

  

DoCloseTabClicked - perform the action associated with clicking the Close tab for this page (OnCloseTabClicked)

  property Images: TCustomImageList; [rw]

  

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 OnChanging: TTabChangingEvent; [rw]

  

OnChanging - event handler while Tab is changing

  property OnCloseTabClicked: TNotifyEvent; [rw]

  

OnCloseTabClicked - event handler for clicking on the Close button to close a tab

  property OnGetImageIndex: TTabGetImageEvent; [rw]

  

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

  property Options: TCTabControlOptions; [rw]

  

The set of Options for the Notebook: Show close buttons on the tabs, multi-line tabs

  property Page []: TCustomPage; [r]

  

The current Page of the Notebook

  property PageCount: Integer; [r]

  

PageCount - the number of Pages in the Notebook

  property PageIndex: Integer; [rw]

  

PageIndex - Index number of the current page

  property Pages: TStrings; [rw]

  

The contents of the Pages in the Notebook (as Strings)

  property ShowTabs: Boolean; [rw]

  

ShowTabs - if True (default condition), show the tabs for each page

  property TabHeight: SmallInt; [rw]

  

TabHeight - height of the tabs

  property TabPosition: TTabPosition; [rw]

  

TabPosition - top, bottom, left or right

  property TabWidth: SmallInt; [rw]

  

TabWidth - width of the tabs

published

  property TabStop: Boolean;

  

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

Inheritance

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

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

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.