Class TGUITabControl

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TGUITabControl = class(TGUIElement)

Description

A standard tab control.

Hierarchy

Overview

Methods

Public function AddTab(const Caption: StringType; ID: LongInt = -1): TGUITab; inline;
Public function GetTab(Index: LongInt): TGUITab; inline;
Public function SetActiveTab(Tab: TGUIElement): Boolean; inline;

Properties

Public property ActiveTab: LongInt read GetActiveTab write SetActiveTabByIndex;
Public property TabCount: LongInt read GetTabCount;
Public property TabExtraWidth: LongInt read GetTabExtraWidth write SetTabExtraWidth;
Public property TabHeight: LongInt read GetTabHeight write SetTabHeight;
Public property TabMaxWidth: LongInt read GetTabMaxWidth write SetTabMaxWidth;
Public property TabVerticalAlignment: TGUIAlignment read GetTabVerticalAlignment write SetTabVerticalAlignment;

Description

Methods

Public function AddTab(const Caption: StringType; ID: LongInt = -1): TGUITab; inline;

Adds a new tab.

Parameters
Caption
The tab's caption.
ID
The optional GUI ID to identify the tab.
Returns

The new tab on success, nil on failure.

Public function GetTab(Index: LongInt): TGUITab; inline;

Fetches a tab based on its index.

Parameters
Index
The tab's zero-based index.
Returns

The tab on success, nil if there is no such object.

Public function SetActiveTab(Tab: TGUIElement): Boolean; inline;

Sets the active tab directly.

Parameters
Tab
the tab to activate.
Returns

True if successful, false otherwise.

Properties

Public property ActiveTab: LongInt read GetActiveTab write SetActiveTabByIndex;

The index of the active tab.

Public property TabCount: LongInt read GetTabCount;

The number of tabs in this control.

Public property TabExtraWidth: LongInt read GetTabExtraWidth write SetTabExtraWidth;

The extra width added to tabs on each side of the text.

Public property TabHeight: LongInt read GetTabHeight write SetTabHeight;

The height of a tab.

Public property TabMaxWidth: LongInt read GetTabMaxWidth write SetTabMaxWidth;

The maximal width of a tab.
Setting this value to 0 (which is the default) means "no width restriction".

Public property TabVerticalAlignment: TGUIAlignment read GetTabVerticalAlignment write SetTabVerticalAlignment;

The tab's vertical alignment, which can be either gaUpperLeft or gaLowerRight.


Generated by PasDoc 0.12.1 on 2012-09-14 17:32:22