[Overview][Constants][Types][Classes][Procedures and functions][Index] |
[Properties (by Name)] [Methods (by Name)] [Events (by Name)]
Implements the base class for tabbed controls in the LCL.
Source position: comctrls.pp line 373
type TCustomTabControl = class(TWinControl) |
||
protected |
||
procedure DoAutoAdjustLayout(); override; |
|
Performs actions needed to apply the specified auto-adjust layout policy. |
function GetPageClass; virtual; |
|
Gets the class type used to create new page instances in the control. |
function GetListClass; virtual; |
|
Gets the class type used to access a list of pages in the control. |
procedure SetOptions(); virtual; |
|
Sets the value for the Options property. |
procedure AddRemovePageHandle(); virtual; |
|
Notifies the widgetset class when a page handle is added or removed in the control. |
procedure CNNotify(); message; |
|
Handles the CN_NOTIFY message for the control. |
class procedure WSRegisterClass; override; |
|
Registers this component class with the current WidgetSet. |
procedure CreateWnd; override; |
|
Creates the Handle for the widgetset object and displays the selected tab and page. |
procedure Loaded; override; |
|
Notifies the widgetset class of the active page when the control Handle is allocated. |
procedure DoChange; virtual; |
|
Performs actions needed when the active page for the control has been changed. |
procedure InitializeWnd; override; |
|
Copies cached control properties to the just created widget. |
procedure Change; virtual; |
|
Performs actions to show or hide pages when the current page is changed. |
procedure KeyDown(); override; |
|
Handles page navigation using the Tab key. |
procedure ReadState(); override; |
|
Updates control flags and reads the data for the component. |
function DialogChar(); override; |
|
Handles an accelerator key for the active page in the tabbed control. |
procedure InternalSetPageIndex(); |
|
Updates the internal page index without triggering an OnChange event. |
procedure ShowControl(); override; |
|
Makes the specified page object the active page in the tabbed control. |
function IndexOfTabAt(); |
|
IndexOfTabAt returns the index value for the Tab located at the specified client coordinates. |
function IndexOfPageAt(); |
|
Gets the index for the page at the specified client coordinates. |
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; |
|
Handles the notification when a component is added to or removed from the control. |
property ActivePageComponent: TCustomPage; [rw] |
|
The active TCustomPage instance for the tabbed control. |
property ActivePage: string; [rws] |
|
Caption for the active page in the tabbed control. |
function GetPage(); virtual; |
|
Gets the value for the indexed Page property. |
function GetPageCount; virtual; |
|
Gets the value for the PageCount property. |
procedure InsertPage(); virtual; |
|
Updates the control when the specified page is inserted into the page list. |
procedure RemovePage(); virtual; |
|
Updates the control when the page at the specified position is removed from the page list. |
function CanChange; virtual; |
|
Signals the OnChanging event handler prior to updates to PageIndex. |
property DisplayRect: TRect; [r] |
|
Rectangular area used to display information for the tabbed control. |
property Tabs: TStrings; [rw] |
|
Contains the list of pages accessible in the tabbed control. |
property TabIndex: Integer; [rw] |
|
Contains the ordinal position for the active Tab in the control. |
property OnChange: TNotifyEvent; [rw] |
|
Event handler signalled when the active page (or tab) for the control is changed. |
public |
||
constructor Create(); override; |
|
Create - constructor for TCustomTabControl: calls inherited Create creates a page list, then sets initial bounds and default values for local variables and properties. |
destructor Destroy; override; |
|
Destroy - destructor for TCustomTabControl: clears and frees pages and list, then calls inherited Destroy. |
function TabRect(); |
|
Gets the client rectangle for the control adjusted to the parent (when needed). |
function GetImageIndex(); virtual; |
|
Gets the ordinal position for the image displayed on the tab for the specified page. |
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(); |
|
Gets the real page index for the specified tab. |
function PageToTabIndex(); |
|
Maps the LCL page to the tab index in the widgetset class. |
procedure DoCloseTabClicked(); virtual; |
|
DoCloseTabClicked - perform the action associated with clicking the Close tab for this page (OnCloseTabClicked). |
property HotTrack: Boolean; [rw] |
|
HotTrack - the property whereby the item under the mouse pointer becomes emphasized. |
property Images: TCustomImageList; [rw] |
|
Images - the list of images associated with the pages of this notebook. |
property ImagesWidth: Integer; [rw] |
|
Width for the Images used in the control. |
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 OnChanging: TTabChangingEvent; [rw] |
|
OnChanging - event handler for changing a tab. |
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 getting an image index. |
property Options: TCTabControlOptions; [rw] |
|
The set of Options for the Notebook: Show close buttons on the tabs, multi-line tabs. |
property OwnerDraw: Boolean; [rw] |
|
OwnerDraw - is the calling routine (Owner) allowed to specify the drawing method? |
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 list of page names in the control. |
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 ShowTabs: Boolean; [rw] |
|
Shows the tabs for each page when set to True (default). |
|
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] |
|
Width of the tabs displayed on the control. |
published |
||
property TabStop: Boolean; |
|
Enables or disables navigation using the Tab key. |
end; |
|
Implements the base class for tabbed controls in the LCL. |
|
| | ||
|
Implements a windowed control which can contain other child controls. |
|
| | ||
|
The base class for visible controls. |
|
| | ||
|
The base class for LCL components which have an associated widget. |
|
| | ||
TComponent |
||
? | ||
TObject |
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
A tab control has a series of Tabs and it may or may not contain pages.
|
MultiPageControls - controls that offer a selection of alternative pages for display. |