[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 463

type TCustomTabControl = class(TCustomControl)

protected

  function CanChange; virtual;

  

CanChange - returns True if the control can be changed

  function CanShowTab(); virtual;

  

CanShowTab - returns True if the specified (indexed) Tab can be shown

  procedure Change; virtual;

  

Change - software emulation of the OnChange event

  procedure DrawTab(); virtual;

  

DrawTab - software emulation of the OnDrawTab event

  function GetImageIndex(); virtual;

  

GetImageIndex - software emulation of the OnGetImageIndex event

  procedure Loaded; override;

  

Loaded makes a number of checks, using client size if specified, and copying appropriate flags, fonts, text etc, makes list of child controls to notify them of any changes, then calls inherited Loaded

  procedure CreateWnd; override;

  

CreateWnd - Creates the Window

  procedure DestroyHandle; override;

  

DestroyHandle - removes the handle for this window

  procedure Notification(); override;

  

Notification - calls inherited Notification, then takes action depending on Operation

  procedure SetTabIndex(); virtual;

  

SetTabIndex - set the index of the current tab to the specified value

  procedure UpdateTabImages;

  

UpdateTabImages - bring the images of the tabs up to date

  procedure ImageListChange();

  

ImageListChange - method for signalling a change to the image list

  procedure DoSetBounds(); override;

  

Perform the actual setting of the boundary rectangle.

protected

  class function GetControlClassDefaultSize; override;

  

GetControlClassDefaultSize returns its own defaults, overriding inherited values

protected

  procedure Paint; override;

  

The default paint handler for the class

  procedure AdjustDisplayRectWithBorder(); virtual;

  procedure AdjustClientRect(); override;

  

AdjustClientRect - method for adjusting the size and position of the client control

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

  

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

  property OnChange: TNotifyEvent; [rw]

  

OnChange - event handler for a change in the Tabs

  property OnChanging: TTabChangingEvent; [rw]

  

OnChanging - event handler while Tab is changing

  property OnDrawTab: TDrawTabEvent; [rw]

  

OnDrawTab - event handler for drawing a Tab

  property OnGetImageIndex: TTabGetImageEvent; [rw]

  

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

  

Style - Tabs, buttons or flat buttons?

  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

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 IndexOfTabAt();

  

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

  function GetHitTestInfoAt();

  

GetHitTestInfoAt - returns information about hit tests at location X, Y

  function IndexOfTabWithCaption();

  

IndexOfTabWithCaption - returns the index value of the tab that has the specified Caption

  function TabRect();

  

TabRect - the rectangle occupied by the specified Tab

  function RowCount;

  

RowCount - the number of rows in the list of tabs

  procedure ScrollTabs();

  

ScrollTabs - scroll through the list of tabs by an amount specifid by Delta

  procedure BeginUpdate;

  

BeginUpdate - start the Update procedure

  procedure EndUpdate;

  

EndUpdate - finish the update procedure

  function IsUpdating;

  

IsUpdating - returns True if in process of updating

  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;

  

Is the control in the sequence of controls accessed by successive presses of the Tab key?

end;

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

|

TCustomControl

  

TCustomControl - a base class for many window controls

|

TWinControl

|

TControl

|

TLCLComponent

  

TLCLComponent - base class for LCL components

|

TComponent,IUnknown,IInterfaceComponentReference

|

TPersistent

|

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.