Sign in Join
FPDoc Onlineexperiment

TCustomTabControl class

In unit ComCtrls

Implements the base class for tabbed controls in the LCL.

Declaration

pascal
TCustomTabControl = class(TWinControl)

Inheritance

  1. TCustomTabControl
  2. TWinControl
  3. TControl
  4. TLCLComponent
  5. TComponent
  6. TPersistent
  7. TObject

Descends from it: TLazDockPages TPageControl TTabControl

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

A tab control has a series of Tabs and it may or may not contain pages.

See also

Properties

ActivePageComponentprotectedThe active TCustomPage instance for the tabbed control.
ActivePageprotectedCaption for the active page in the tabbed control.
SwitchingToPageIndexprotected
DisplayRectprotectedRectangular area used to display information for the tabbed control.
TabsprotectedContains the list of pages accessible in the tabbed control.
TabIndexprotectedContains the ordinal position for the active Tab in the control.
HotTrackpublicEnables or disables drawing a "hot-lighted" tab when the mouse pointer is hovered over the control.
ImagespublicContains the images displayed on the tabs for the control.
ImagesWidthpublicWidth for the Images used in the control.
MultiLinepublicIndicates whether the caption on a tab can have multiple lines of text.
MultiSelectpublicIndicates whether multiple tabs can be simultaneously selected on the tabbed control.
OptionspublicThe set of Options enabled for the tabbed control.
OwnerDrawpublicReads and write the value for the OwnerDraw property in Tabs.
PagepublicProvides indexed access to the page objects used on the tabbed control.
PageCountpublicReturns the number of page objects stored in the internal page list for the tabbed control.
PageIndexpublicOrdinal position for the selected page on the tabbed control.
PagespublicThe list of captions for the page objects on the control.
RaggedRightpublicEnables or disables justified text in the captions for tabs on the control.
ScrollOppositepublicIndicates whether unused multi-line tabs are scrolled to the side opposite of the tab position.
ShowTabspublicEnables display of tabs on the control when set to True (default).
StylepublicIndicates the appearance or display style used for the tabs on the control.
TabHeightpublicHeight in pixels for the tabs on the control.
TabPositionpublicIndicates the edge where the tabs for the control are aligned.
TabWidthpublicWidth in pixels for the tabs on the control.
WheelSelectPagepublic
TabStoppublishedEnables or disables navigation using the Tab key.

Methods

DoAutoAdjustLayoutprotectedPerforms actions needed to apply the specified auto-adjust layout policy.
GetPageClassprotectedGets the class type used to create new page instances in the control.
GetListClassprotectedGets the class type used to create the page list class for the control.
SetOptionsprotectedSets the value for the Options property.
AddRemovePageHandleprotectedNotifies the widgetset class when a page handle is added or removed in the control.
CNNotifyprotectedHandles the CN_NOTIFY message for the control.
WSRegisterClassprotectedRegisters this component class with the current WidgetSet.
CreateWndprotectedCreates the Handle for the widgetset object and displays the selected tab and page.
LoadedprotectedNotifies the widgetset class of the active page when the control Handle is allocated.
DoChangeprotectedPerforms actions needed when the active page for the control has been changed.
InitializeWndprotectedCopies cached control properties and initializes a new tab control instance.
ChangeprotectedPerforms actions to show or hide pages when the current page is changed.
KeyDownprotectedHandles page navigation using the Tab key.
ReadStateprotectedUpdates control flags and reads the data for the component.
DialogCharprotectedHandles an accelerator key for the active page in the tabbed control.
InternalSetPageIndexprotectedUpdates the internal page index without triggering an OnChange event.
ShowControlprotectedMakes the specified page object the active page in the tabbed control.
IndexOfTabAtprotectedReturns the ordinal position for the visible tab located at the specified client coordinates.
IndexOfPageAtprotectedGets the ordinal position for the page object located at the specified client coordinates.
UpdateTabPropertiesprotectedApplies property changes for all of the pages on the tab control to the widgetset class instances.
GetControlClassDefaultSizeprotectedGetControlClassDefaultSize returns its own defaults, overriding inherited values.
NotificationprotectedHandles a notification when a component is added to or removed from the control.
WMSetFocusprotectedHandler for receiving Focus event.
GetPageprotectedGets the value for the indexed Page property.
GetPageCountprotectedGets the value for the PageCount property.
InsertPageprotectedInserts the specified page into the page list and updates both the page and the control.
RemovePageprotectedRemoves the page object at the specified position in the page list and updates the visible tabs on the control.
MaybeSelectFirstControlOnPageprotectedUpdates the ActiveControl on the parent form when the specified page becomes active.
CanChangeprotectedSignals the OnChanging event handler prior to updates to PageIndex.
CreatepublicConstructor for the class instance.
DestroypublicDestroy - destructor for TCustomTabControl: clears and frees pages and list, then calls inherited Destroy.
TabRectpublicGets the client rectangle for the specified tab adjusted to the parent.
GetImageIndexpublicGets the ordinal position for the image displayed on the tab for the specified page.
IndexOfpublicGets the ordinal position in the page list for the specified page object.
CustomPagepublicGets the page object at the specified position as a TCustomPage type.
CanChangePageIndexpublicCanChangePageIndex - determine whether it is permissible to change the index of the page.
GetMinimumTabWidthpublicGets the smallest tab width allowed on the tabbed control.
GetMinimumTabHeightpublicGets the smallest tab height allowed on the tabbed control.
GetCapabilitiespublicGets the set of platform-specific tab control options supported for the widgetset.
TabToPageIndexpublicGets the real page index for the specified tab.
PageToTabIndexpublicMaps a LCL page index to a tab index in the widgetset class.
DoCloseTabClickedpublicPerforms actions needed when the tab for the specified page object is closed.

Events

OnChangeprotectedEvent handler signalled when the active page (or tab) for the control is changed.
OnChangingpublicEvent handler signalled prior to changing the active tab/page on the tabbed control.
OnCloseTabClickedpublicEvent handler signalled when a tab is closed.
OnGetImageIndexpublicEvent handler signalled to get the image index for a tab on the tabbed control.

Inherited

From TWinControl (235)

AddControl AdjustClientRect AlignControls AllAutoSized AutoAdjustLayout AutoSizeDelayed AutoSizeDelayedHandle AutoSizeDelayedReport AutoSizePhases BeginUpdateBounds BorderStyle BorderWidth BoundsLockCount BroadCast Brush BrushCreated CachedClientHeight CachedClientWidth CalculatePreferredSize CanFocus CanSetFocus CanTab ChangeScale ChildClassAllowed ChildHandlesCreated ChildKey ChildSizing ClientRectNeedsInterfaceUpdate CMBiDiModeChanged CMBorderChanged CMDoubleBufferedChanged CMEnabledChanged CMEnter CMExit CMParentDoubleBufferedChanged CMShowHintChanged CMShowingChanged CMVisibleChanged CNChar CNKeyDown CNKeyUp CNSysKeyDown CNSysKeyUp ContainsControl ControlAtPos ControlCount ControlKeyDown ControlKeyUp Controls ControlsAligned CreateBrush CreateDockManager CreateHandle CreateParams CreateParented CreateParentedControl CreateSubClass CustomAlignInsertBefore CustomAlignPosition DefaultHandler DefWndProc DesignerDeleting DestroyHandle DestroyWnd DisableAlign DoAddDockClient DoAdjustClientRectChange DoAlignChildControls DoAllAutoSize DoAutoSize DoChildSizingChange DockClientCount DockClients DockDrop DockManager DockOver DockSite DoConstraintsChange DoDockClientMsg DoDockOver DoDragMsg DoEnter DoExit DoFlipChildren DoFloatMsg DoGetDockCaption DoKeyDownBeforeInterface DoKeyPress DoKeyUpBeforeInterface DoRemainingKeyDown DoRemainingKeyUp DoRemoveDockClient DoSendBoundsToInterface DoSendShowHideToInterface DoSetBounds DoubleBuffered DoUnDock DoUndockClientMsg DoUTF8KeyPress EnableAlign EndUpdateBounds EraseBackground FinalizeWnd FindChildControl FindNextControl FixDesignFontsPPIWithChildren FixupTabList FlipChildren Focused FontChanged FormEndUpdated GetAdjustedLogicalClientRect GetBorderStyle GetChildren GetChildrenRect GetClientOrigin GetClientRect GetControlIndex GetControlOrigin GetDeviceContext GetDockCaption GetEnumeratorControls GetEnumeratorControlsReverse GetMouseCapture GetParentHandle GetPreferredSizeClientFrame GetSiteInfo GetTabOrderList GetTextLen GetTopParentHandle Handle HandleAllocated HandleNeeded InsertControl IntfGetDropFilesTarget IntfUTF8KeyPress Invalidate InvalidateBoundsRealized InvalidateClientRectCache InvalidatePreferredChildSizes IsClientHeightStored IsClientWidthStored IsControlMouseMsg IsFlipped IsResizing IsSpecialSubControl KeyDownAfterInterface KeyDownBeforeInterface KeyPress KeyUp KeyUpAfterInterface KeyUpBeforeInterface LockRealizeBounds MainWndProc NotifyControls OnAlignInsertBefore OnAlignPosition OnDockDrop OnDockOver OnEnter OnExit OnGetDockCaption OnGetSiteInfo OnKeyDown OnKeyPress OnKeyUp OnUnDock OnUTF8KeyPress PaintControls PaintHandler PaintTo PaintWindow ParentDoubleBuffered ParentFormHandleInitialized ParentHandlesAllocated ParentWindow PerformTab RealGetText ReAlign RealizeBounds RealizeBoundsRecursive RealSetText ReloadDockedControl RemoveControl RemoveFocus Repaint ScaleBy ScaleControls ScrollBy ScrollBy_WS SelectFirst SelectNext SendDialogChar SendMoveSizeMessages SetBorderStyle SetBounds SetChildZPosition SetColor SetControlIndex SetDockManager SetFocus SetShape SetTempCursor Showing TabOrder UnlockRealizeBounds Update UpdateControlState UpdateDockCaption UpdateShowing UseDockManager UTF8KeyPress VisibleDockClientCount WindowHandle WMChar WMContextMenu WMDestroy WMEnter WMEraseBkgnd WMExit WMKeyDown WMKeyUp WMKillFocus WMMove WMNotify WMPaint WMShowWindow WMSize WMSysChar WMSysKeyDown WMSysKeyUp WMWindowPosChanged WndProc WriteLayoutDebugReport WSSetText

From TControl (363)

AccessibleDescription AccessibleName AccessibleRole AccessibleValue Action ActionChange ActionLink ActiveDefaultControlChanged AddHandler AddHandlerOnBeforeDestruction AddHandlerOnChangeBounds AddHandlerOnEnabledChanged AddHandlerOnEnabledChanging AddHandlerOnKeyDown AddHandlerOnMouseWheel AddHandlerOnResize AddHandlerOnVisibleChanged AddHandlerOnVisibleChanging AdjustSize Align AnchorAsAlign AnchorClient AnchoredControlCount AnchoredControls AnchorHorizontalCenterTo AnchorParallel Anchors AnchorSame AnchorSide AnchorSideBottom AnchorSideChanged AnchorSideLeft AnchorSideRight AnchorSideTop AnchorToCompanion AnchorToNeighbour AnchorVerticalCenterTo AssignTo AutoSize AutoSizing AutoSizingAll AutoSizingLockCount BaseBounds BaseParentClientSize BeforeDestruction BeforeDragStart BeginAutoDrag BeginAutoSizing BeginDrag BiDiMode BorderSpacing BoundsChanged BoundsRect BoundsRectForNewParent BringToFront CalculateDockSizes CanAutoSize Caption CaptureChanged CaptureMouseButtons ChangeBounds Changed CheckChildClassAllowed CheckNewParent CheckOnChangeBounds Click ClientHeight ClientOrigin ClientRect ClientToParent ClientToScreen ClientWidth CMChanged CMCursorChanged CMHintShow CMHitTest CMMouseEnter CMMouseLeave CMParentBiDiModeChanged CMParentColorChanged CMParentFontChanged CMParentShowHintChanged CMSysFontChanged CMTextChanged CNPreferredSizeChanged Color ColorIsStored ConstrainedResize Constraints ControlFontClass ControlOrigin ControlState ControlStyle ControlToScreen CreateAccessibleObject CreateControlBorderSpacing CreateFloatingDockSite Cursor DblClick DefineProperties DesktopFont DisableAutoSizing DoBorderSpacingChange DoCallKeyEventHandler DoCallMouseWheelEventHandler DoCallNotifyHandler Dock Docked DockOrientation DockTrackNoTarget DoContextPopup DoDock DoEndDock DoEndDrag DoFixDesignFontPPI DoMouseDown DoMouseUp DoMouseWheel DoMouseWheelDown DoMouseWheelHorz DoMouseWheelLeft DoMouseWheelRight DoMouseWheelUp DoOnChangeBounds DoOnParentHandleDestruction DoOnResize DoOnShowHint DoScaleFontPPI DoStartDock DoStartDrag DragCanceled DragCursor DragDrop Dragging DragKind DragMode DragOver EditingDone EnableAutoSizing Enabled EnabledChanged EnabledChanging EndAutoSizing EndDrag ExecuteCancelAction ExecuteDefaultAction FindSubComponent FixDesignFontsPPI Floating FloatingDockSiteClass Font ForeignAnchorSideChanged FormIsUpdating GetAccessibleObject GetAction GetActionLinkClass GetAnchorsDependingOnParent GetCachedText GetCanvasScaleFactor GetChildAccessibleObjectAtPos GetClientScrollOffset GetColorResolvingParent GetCursor GetDefaultColor GetDefaultDockCaption GetDefaultHeight GetDefaultWidth GetDockEdge GetDragImages GetEnabled GetFloating GetFloatingDockSiteClass GetLogicalClientRect GetMousePosFromMessage GetPalette GetParentBackground GetParentComponent GetPopupMenu GetPreferredSize GetRGBColorResolvingParent GetScrolledClientRect GetSelectedChildAccessibleObject GetSidePosition GetTextBuf GetTopParent HandleObjectShouldBeVisible HasHelp HasParent Height HeightIsAnchored HelpContext HelpKeyword HelpType Hide Hint HostDockSite InitiateAction InvalidateControl InvalidatePreferredSize IsAParentAligning IsBorderSpacingInnerBorderStored IsCaptionStored IsControl IsControlVisible IsEnabled IsParentColor IsParentFont IsParentOf IsProcessingPaintMsg IsRightToLeft IsVisible Left LMCaptureChanged LoadedAll LRDockWidth ManualDock ManualFloat MouseCapture MouseDown MouseEnter MouseInClient MouseLeave MouseMove MouseUp OnChangeBounds OnClick OnConstrainedResize OnContextPopup OnDblClick OnDragDrop OnDragOver OnEditingDone OnEndDock OnEndDrag OnMouseDown OnMouseEnter OnMouseLeave OnMouseMove OnMouseUp OnMouseWheel OnMouseWheelDown OnMouseWheelHorz OnMouseWheelLeft OnMouseWheelRight OnMouseWheelUp OnQuadClick OnResize OnShowHint OnStartDock OnStartDrag OnTripleClick Parent ParentBackground ParentBiDiMode ParentColor ParentDestroyingHandle ParentFont ParentFontChanged ParentShowHint ParentToClient Perform PopupMenu PositionDockRect QuadClick ReadBounds Refresh RemoveAllHandlersOfObject RemoveHandler RemoveHandlerOnBeforeDestruction RemoveHandlerOnChangeBounds RemoveHandlerOnEnabledChanged RemoveHandlerOnEnabledChanging RemoveHandlerOnKeyDown RemoveHandlerOnMouseWheel RemoveHandlerOnResize RemoveHandlerOnVisibleChanged RemoveHandlerOnVisibleChanging ReplaceDockedControl RequestAlign Resize Scale96ToFont Scale96ToForm Scale96ToScreen ScaleConstraints ScaleDesignToForm ScaleFontsPPI ScaleFontTo96 ScaleFontToScreen ScaleFormTo96 ScaleFormToDesign ScaleScreenTo96 ScaleScreenToFont ScreenToClient ScreenToControl SendToBack SessionProperties SetAction SetAlign SetAnchors SetAutoSize SetBiDiMode SetBoundsKeepBase SetCursor SetDragMode SetEnabled SetHint SetInitialBounds SetName SetParent SetParentBackground SetParentBiDiMode SetParentComponent SetTextBuf SetVisible SetZOrder ShouldAutoAdjust Show ShowHelp ShowHint TBDockHeight Text TextChanged Top TripleClick UndockHeight UndockWidth UpdateAnchorRules UpdateBaseBounds UpdateMouseCursor UpdateRolesForForm UseRightToLeftAlignment UseRightToLeftReading UseRightToLeftScrollBar Visible VisibleChanged VisibleChanging Width WidthIsAnchored WindowProc WMCancelMode WMLButtonDBLCLK WMLButtonDown WMLButtonQuadCLK WMLButtonTripleCLK WMLButtonUp WMMButtonDBLCLK WMMButtonDown WMMButtonQuadCLK WMMButtonTripleCLK WMMButtonUp WMMouseHWheel WMMouseMove WMMouseWheel WMRButtonDBLCLK WMRButtonDown WMRButtonQuadCLK WMRButtonTripleCLK WMRButtonUp WMXButtonDBLCLK WMXButtonDown WMXButtonQuadCLK WMXButtonTripleCLK WMXButtonUp

From TLCLComponent (6)

DecLCLRefCount GetWSComponentClass IncLCLRefCount LCLRefCount NewInstance WidgetSetClass

From TComponent (64)

_AddRef _Release CanObserve ChangeName ComObject ComponentCount ComponentIndex Components ComponentState ComponentStyle DesignInfo DestroyComponents Destroying ExecuteAction FindComponent FreeNotification FreeOnRelease GetChildOwner GetChildParent GetDeltaStreams GetEnumerator GetIDsOfNames GetNamePath GetObservers GetOwner GetTypeInfo GetTypeInfoCount iicrGetComponent InsertComponent Invoke IsImplementorOf Loading Name ObserverAdded Observers OnGetDeltaStreams Owner PaletteCreated QueryInterface ReadDeltaState ReadDeltaStream ReferenceInterface RemoveComponent RemoveFreeNotification RemoveFreeNotifications SafeCallException SetAncestor SetChildOrder SetDesigning SetDesignInstance SetInline SetSubComponent Tag ToString TToStringNameMode UpdateAction Updated UpdateRegistry Updating ValidateContainer ValidateInsert ValidateRename VCLComObject WriteState

From TPersistent (4)

Assign FPOAttachObserver FPODetachObserver FPONotifyObservers

From TObject (35)

AfterConstruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName QualifiedClassName StringMessageTable SystemHasExtendedRTTI UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.