ComCtrls unit

comctrls.pp contains classes and types like those found in the Delphi comctrls.pp unit.

The following components are added to the Lazarus IDE:

Common Controls Tab

• TTrackbar
• TProgressBar
• TTreeView
• TListView
• TStatusBar
• TToolBar
• TCoolBar
• TUpDown
• TPageControl
• TTabControl
• THeaderControl

The following components are added but not displayed on the component palette:

• TToolButton
• TTabSheet

comctrls.pp is part of the Lazarus Component Library ( LCL).

Classes and records

ETreeNodeError	class	Exception type raised for an error retrieving a tree node.
ETreeViewError	class	Exception type raised for errors in a tree view.
TCoolBand	class	Implements a band displayed on the TCoolBar control.
TCoolBands	class	Implements a collection for TCoolBand items.
TCoolBar	class	Implements a Rebar-like control with resizable bands.
TCustomCoolBar	class	Defines a Rebar-like control with resizable bands.
TCustomHeaderControl	class	TCustomHeaderControl - base class for THeaderControl, a header strip of user-designed sections which allow selection of pages or actions.
TCustomListView	class	TCustomListView is the base class for TListView.
TCustomListViewEditor	class	Provides multi-platform editing capabilities for a list view control.
TCustomPage	class	The base class for TTabSheet.
TCustomProgressBar	class	Implements the base class for progress bar controls.
TCustomTabControl	class	Implements the base class for tabbed controls in the LCL.
TCustomTrackBar	class	TCustomTrackBar - the base class for TTrackBar.
TCustomTreeView	class	The base class for TTreeView.
TCustomUpDown	class	TCustomUpDown - base class for TUpDown - a pair of arrow-like buttons which are used to increment or decrement some controlled variable; often attached to a scroll-bar but can also control a digital numeric display.
TDelphiNodeDataInfo	record	Record structure used to represent Tree Node Data in Delphi DFM resources.
TDelphiNodeInfo	record	Record structure for Tree Node information (for Delphi compatibility).
THeaderControl	class	THeaderControl, a header strip of user-designed sections which allow selection of pages or actions.
THeaderSection	class	Implements a section displayed on a TCustomHeaderControl / THeaderControl instance.
THeaderSections	class	Implements a collection for sections in a TCustomHeaderControl control.
TIconOptions	class	Contains text wrapping and icon layout settings for a list view control.
TListColumn	class	Represents an individual column in a multi-column list control.
TListColumns	class	A collection for TListColumn instances defined for a multi-column list view control.
TListItem	class	Represents the items created in TCustomListView and descendants.
TListItems	class	Implements a container for list items on a list view control.
TListItemsEnumerator	class	Implements an enumerator for TListItem values in a TListItems container.
TListView	class	TListView - a window showing a list of Items which may or may not have associated icons.
TNBBasePages	class	Ancestor for the TNBPages class.
TNBNoPages	class	Re-implements an empty page container for TCustomTabControl controls.
TNBPages	class	Implements a list of pages used in TCustomTabControl.
TNodeCache	record	TNodeCache - a cache (temporary storage record) for a TTreeNode and its index.
TNoteBookStringsTabControl	class	Implements the tabbed page control used in TNoteBookStringsTabControl.
TOldTreeNodeInfo	record	TOldTreeNodeInfo - record type (old version) for Tree Node information.
TOwnerDataListItem	class	List item class used in a list view control when OwnerData (virtual) mode is enabled.
TOwnerDataListItems	class	Container for the items in a list view control when owner data (virtual) mode is enabled.
TPageControl	class	Implements a multi-page component with a series of tabs.
TProgressBar	class	TProgress Bar - a bar that depicts what proportion of a process has been completed.
TStatusBar	class	Displays a panel along the bottom of a form with current status information.
TStatusPanel	class	Implements a panel displayed in TStatusBar.
TStatusPanels	class	A collection of panels displayed on a status bar control.
TTabControl	class	TTabControl - a series of Tabs along the edge of a display area; selection of a Tab governs the contents of the DisplayRect.
TTabControlNoteBookStrings	class	TTabControlNoteBookStrings - instance of TTabControlStrings for use with a TNoteBook.
TTabControlStrings	class	TTabControlStrings - the Strings that appear on the tabs of TTabControl.
TTabSheet	class	An individual page used in TPageControl.
TToolBar	class	Implements an application tool bar with buttons or other visual controls.
TToolBarEnumerator	class	Implements an enumerator for the buttons defined on a tool bar.
TToolButton	class	TToolButton is a button control used in a TToolBar object.
TToolButtonActionLink	class	TToolButtonActionLink - links a ToolButton on the ToolBar to an Action on an ActionList.
TTrackBar	class	TTrackBar: a device which allows the user to determine the value of a variable using a quasi-analog slider.
TTreeNode	class	Implements a tree node displayed in a TTreeView control.
TTreeNodeExpandedState	class	Class used to save and restore the expanded state of a TTreeView.
TTreeNodeInfo	record	TTreeNodeInfo - record structure for (new) Tree Node information.
TTreeNodes	class	Implements a container for TTreeNode instances.
TTreeNodesEnumerator	class	Implements an enumerator for items in the TTreeNodes container.
TTreeView	class	TTreeView is a control that displays a hierarchical list of items.
TUpDown	class	TUpDown - a pair of arrow-like buttons which are used to increment or decrement some controlled variable; often attached to a scroll-bar but can also control a digital numeric display.

Procedures and functions

CompareExpandedNodes	function	Function to compare the node text in two tree nodes.
CompareTextWithExpandedNode	function	Function to compare the given text with the nodetext of the specified tree node.
DbgS	function	Generates a list of tab control options for display in the debugger.
Register	procedure	Registers components in the Lazarus IDE.
RegisterCustomPage	procedure	Calls WSRegisterCustomPage to register a custom page using the widgetset classes.
RegisterCustomTabControl	procedure	Registers TCustomTabControl and its widgetset class type when needed.

Types

PDelphiNodeInfo	type	A pointer to TDelphiNodeInfo.
PNodeCache	type	PNodeCache - pointer to TNodeCache type.
TAddMode	enumeration	Enumerated type with values used to determine where a node should be placed in a tree.
TCoolBandMaximize	enumeration	Not used in the current LCL implementation.
TCTabControlCapabilities	set	Set type used to store values from the TCTabControlCapability enumeration.
TCTabControlCapability	enumeration	Represents the capabilities which can be enabled for a notebook or tab control.
TCTabControlOption	enumeration	Represents the LCL options available for TCustomTabControl.
TCTabControlOptions	set	Set type used to store values from the TCTabControlOption enumeration.
TCustomDrawResult	set	Set type used to store TCustomDrawResultFlag enumeration values.
TCustomDrawResultFlag	enumeration	Represents flags returned as custom drawing results.
TCustomDrawStage	enumeration	TCustomDrawStage a series of constants to define the drawing stages for custom-drawn controls.
TCustomDrawState	set	TCustomDrawState - set of TCustomDrawStateFlag.
TCustomDrawStateFlag	enumeration	TCustomDrawStateFlag - series of flags to define the DrawState.
TCustomDrawTarget	enumeration	TCustomDrawTarget - enumerated type controlling how a target object is drawn.
TCustomHCCreateSectionClassEvent	procedure type	Specifies the event handler signalled to get the class type for a new section on a THeaderControl instance.
TCustomPageClass	type	Class reference used to create a new TCustomPage instance.
TCustomSectionNotifyEvent	procedure type	TCustomSectionNotifyEvent - generic event notification method for header section.
TCustomSectionTrackEvent	procedure type	TCustomSectionTrackEvent - generic event handling method for custom tracking a header section.
TDisplayCode	enumeration	TDisplayCode - enumerated type denoting how items are displayed.
TDragBand	enumeration	Represents the drag actions for TCoolBar.
TDrawPanelEvent	procedure type	Specifies an event handler used to draw a panel in a status bar.
TDrawTabEvent	procedure type	Specifies an event handler used to draw the tab at the given index to a display rectangle on a tab control.
TGrabStyle	enumeration	Represent drawing styles available for the grab bar in TCustomCoolBar.
THeaderSectionClass	type	Class reference used to create new THeaderSection instances.
THeaderSectionState	enumeration	Enumerated type which represents selection states for THeaderSection.
THideSelectionMode	enumeration	Controls the display logic used when HideSelection is enabled for a tree view control.
THitTest	enumeration	Represents permissible results for a hit test.
THitTests	set	Set type used to store values from the THitTest enumeration.
TIconArrangement	enumeration	Represents icon arrangement options in a list view control.
TItemChange	enumeration	TItemChange - enumerated type for kind of change: in text, in image, or in state.
TItemFind	enumeration	Represents a search mechanism used to locate the data for a list view item.
TListColumnClass	type
TListHotTrackStyle	enumeration	Represents cursor shapes displayed during hot tracking in a control.
TListHotTrackStyles	set	Set type used to store values from TListHotTrackStyle.
TListItemClass	type	Class reference used to create new instances of TListItem.
TListItemFlag	enumeration	TListItemFlag - enumerated type, a flag denoting a list item is being destroyed or created.
TListItemFlags	set	Set type used to store TListItemFlag enumeration values.
TListItemsFlag	enumeration	Widgetset flags applied to the TListItems container.
TListItemsFlags	set	Set type used to store TListItemsFlag enumeration values.
TListItemState	enumeration	Represents state values for items in a list view control.
TListItemStates	set	Set type used to store value(s) from the TListItemState enumeration.
TListViewFlag	enumeration	Represents flag values used in TCustomListView when sorting or validating items in the control.
TListViewFlags	set	Set type used to store values from the TListViewFlag enumeration.
TListViewImageList	enumeration	Represents the image list sizes used in TCustomListView.
TListViewProperties	set	Set type used to store values from the TListViewProperty enumeration.
TListViewProperty	enumeration	Represents Boolean properties used in TCustomListView.
TLVAdvancedCustomDrawEvent	procedure type	Specifies an event handler signalled to perform advanced custom drawing for an owner-drawn list view control.
TLVAdvancedCustomDrawItemEvent	procedure type	Specifies an event handler signalled to perform advanced custom drawing for a list view item with stage and state information.
TLVAdvancedCustomDrawSubItemEvent	procedure type	Specifies an event handler signalled to perform advancing drawing for a list view sub-item with stage and state information.
TLVChangeEvent	procedure type	Event handler signalled when a property value for a list view item is changed.
TLVChangingEvent	procedure type	Defines an event handler signalled when a widgetset class is updating an item on a list view control.
TLVCheckedItemEvent	procedure type	Specifies an event handler signalled when the checked state for an item on a list view control has been changed.
TLVColumnClickEvent	procedure type	Specifies an event handler signalled for a mouse click on a list view column.
TLVColumnRClickEvent	procedure type	Specifies an event handler signalled for a right mouse click on a list view column.
TLVCompare	procedure type	Specifies a routine used to compare the values in two items in a list view control.
TLVCompareEvent	procedure type	Specifies an event handler signalled to compare two items in a List View control.
TLVCreateItemClassEvent	procedure type	Specifies an event handler signalled to get the class type needed to create a new list view item.
TLVCustomDrawEvent	procedure type	Specifies an event handler signalled to custom draw a list view control.
TLVCustomDrawItemEvent	procedure type	Specifies an event handler signalled to custom draw an item on a list view control.
TLVCustomDrawSubItemEvent	procedure type	Specifies an event handler signalled to draw the SubItem value for a list item on a list view control.
TLVDataEvent	type	Specifies an event handler signalled to get the arbitrary data for an item on a list view control.
TLVDataFindEvent	procedure type	Specifies an event handler used to locate a list view item using the specified search parameters and criteria.
TLVDataHintEvent	procedure type	Specifies a handler routine for data hint events in TListView.
TLVDataStateChangeEvent	procedure type	Not used in the current LCL implementation.
TLVDeletedEvent	procedure type	Specifies an event handler signalled when a list view item is deleted.
TLVDrawItemEvent	procedure type	Specifies an event handler signalled to perform default drawing for an item on a list view control.
TLVEditedEvent	procedure type	Specifies an event handler signalled when an edit action is completed for an item on a list view control.
TLVEditingEvent	procedure type	Specifies an event handler signalled when an edit action is started for an item on a list view control.
TLVInsertEvent	type	Specifies an event handler signalled when a list item is added to a list view control.
TLVSelectItemEvent	procedure type	Specifies an event handler signalled when the selected state is changed for an item on a list view control.
TMultiSelectStyle	set	Set type used to store value(s) from TMultiSelectStyles.
TMultiSelectStyles	enumeration	Represents available multi-select styles.
TNBBasePagesClass	type	Class reference used to create new instances of TNBBasePages.
TNodeAttachMode	enumeration	Location where a new tree node is attached to its Parent, Child, or Sibling nodes.
TNodeState	enumeration	Enumerated type denoting the state for a TreeNode.
TNodeStates	set	Set type used to store TNodeState value(s).
TNoteBookStringsTabControlClass	type	Class type reference for TNoteBookStringsTabControl
TOnDragOverTreeView	procedure type
TPageFlag	enumeration	Contains values which can be assigned to the Flags property in TCustomPage.
TPageFlags	set	Set type used to store TPageFlag enumeration values.
TPanelPart	enumeration	Lists the possible parts that make up a status panel.
TPanelParts	set	Set type used to store TPanelPart values.
TProgressBarOrientation	enumeration	Represents the orientations used for a progress bar.
TProgressBarState	enumeration	Represents state values used when drawing a progress bar.
TProgressBarStyle	enumeration	Represents the visual display styles used for a progress bar.
TSBCreatePanelClassEvent	procedure type	Specifies an event handler signalled to get the class type for a new status bar panel.
TSearchDirection	enumeration	Represents a search direction used to locate the list view item that is the nearest match.
TSectionDragEvent	procedure type	TSectionDragEvent - generic event handling method for dragging a header section.
TSectionTrackState	enumeration	Enumerated type with tracking states for a header section.
TSortDirection	enumeration	Represents the sort direction used for items in a list view control.
TSortIndicator	enumeration	Represents the sort indicators available for a column in a list view control.
TSortType	enumeration	Indicates the sort mechanism used for the items in tree view and list view controls.
TStatusPanelBevel	enumeration	Enumerated type with the bevel styles used on status bar panels.
TStatusPanelClass	type	Class reference used to create new instances of TStatusPanel.
TStatusPanelStyle	enumeration	Represents the style used for a panel on a status bar.
TTabChangingEvent	procedure type	TTabChangingEvent - generic event handling method for a change in a notebook Tab.
TTabGetImageEvent	procedure type	Specifies an event handler type used to get the position in an image list for the image on a tab.
TTabPosition	enumeration	Represents the position for a tab relative to its page.
TTabStyle	enumeration	TTabStyle - enumerated type for tab style: normal, buttons or flat buttons.
TTickMark	enumeration	TTickMark - enumerated type denoting position of tick marks relative to the track bar.
TTickStyle	enumeration	TTickStyle - enumerated type denoting style of tick marks.
TToolBarFlag	enumeration	Contains values used as status flags in the TToolBar control.
TToolBarFlags	set	Set type used to store values from the TToolBarFlag enumeration.
TToolBarOnPaintButton	procedure type	Specifies an event handler signalled to draw a button on a tool bar with a given state.
TToolBarOrientation	enumeration	Represents the orientations used in the TToolBar control.
TToolButtonActionLinkClass	type	TToolButtonActionLinkClass - class of TToolButtonActionLink.
TToolButtonFlag	enumeration	Represents flag values that can be used in a TToolButton instance.
TToolButtonFlags	set	Set type used to store values from the TToolButtonFlag enumeration.
TToolButtonStyle	enumeration	Enumerated type with values representing the display styles and behaviors for buttons on a TToolBar control.
TTrackBarOrientation	enumeration	Enumerated type with values that represent the orientation for a track bar.
TTrackBarScalePos	enumeration	TTrackBarScalePos - enumerated type denoting position of the scale for a track bar.
TTreeNodeArray	type	Pointer to a TTreeNode type which is the first instance in an allocated block of memory.
TTreeNodeChangeReason	enumeration	Represents reason codes passed to event handlers when a tree node has been changed.
TTreeNodeClass	type	Class type used to create new TTreeNode instances.
TTreeNodeCompare	procedure type	TTreeNodeCompare - generic function to compare Tree Nodes: returns -1 if Node1 is less than Node2, zero if equal, +1 if Node1 is greater.
TTreeViewExpandSignType	enumeration	Represents symbols types used for expanded or collapsed tree nodes.
TTreeViewInsertMarkType	enumeration	Represents insert mark locations used in TCustomTreeView.
TTreeViewOption	enumeration	TTreeViewOption - enumerated type containing the permissible values for Options in TreeViews.
TTreeViewOptions	set	Set type used to store values from the TTreeViewOption enumeration.
TTreeViewState	enumeration	TTreeViewState - enumerated type containing the permissible values for state of a TTreeView.
TTreeViewStates	set	Set type used to store values from the TTreeViewState enumeration.
TTVAdvancedCustomDrawEvent	procedure type	TTVAdvancedCustomDrawEvent - generic event handler method for Tree View advanced custom drawing.
TTVAdvancedCustomDrawItemEvent	procedure type	TTVAdvancedCustomDrawItemEvent - generic event handler method for Tree View Item advanced custom drawing.
TTVChangedEvent	procedure type	Specifies an event handler signalled when a tree node has been changed.
TTVChangingEvent	procedure type	Specifies an event handler signalled when a tree node is about to be changed.
TTVCollapsingEvent	procedure type	TTVCollapsingEvent - generic event handling method for collapsing a Tree Node if AllowCollapse is True.
TTVCompareEvent	procedure type	TTVCompareEvent - generic event handling method for comparing two Tree Nodes.
TTVCreateNodeClassEvent	procedure type	Specifies an event handler signalled to get the class type used to create a new node for a tree view control.
TTVCustomCreateNodeEvent	procedure type	TTVCustomCreateNodeEvent - generic event handling method for Tree View node creation.
TTVCustomDrawArrowEvent	procedure type	Specifies an event handler signalled to draw a custom arrow (expand/collapse indicator) for a node on a tree view control.
TTVCustomDrawEvent	procedure type	TTVCustomDrawEvent - generic event handling method for Tree View custom drawing.
TTVCustomDrawItemEvent	procedure type	TTVCustomDrawItemEvent - generic event handling method for Tree View Item custom drawing.
TTVEditedEvent	procedure type	TTVEditedEvent - generic event handling method for a node that has been edited.
TTVEditingEndEvent	procedure type	Specifies an event handler signalled when an edit action for a tree view control has been completed.
TTVEditingEvent	procedure type	TTVEditingEvent - generic event handling method for editing a specified node if AllowEdit is True.
TTVExpandedEvent	procedure type	TTVExpandedEvent - generic event handling method for a Tree Node that has been expanded.
TTVExpandingEvent	procedure type	TTVExpandingEvent - generic event handling method for expanding a tree node if AllowExpansion is True.
TTVGetNodeText	procedure type	Specifies an event handler used to get the text for a tree node.
TTVHasChildrenEvent	procedure type	Specifies an event handler signalled to determine if a given tree node has child nodes.
TTVNodeChangedEvent	procedure type	Specifies an event handler signalled when values in a tree node have been changed.
TUDAlignButton	enumeration	Contains values used to align the buttons on a TUpDown control.
TUDBtnType	enumeration	Represents the buttons used in a TCustomUpDown control.
TUDChangingEvent	procedure type	Specifies an event handler signalled prior to changing the value in a TUpDown control.
TUDChangingEventEx	procedure type	Specifies an event handler signalled prior to changing the value in a TUpDown control.
TUDClickEvent	procedure type	Specifies an event handler signalled for a button click on a TUpDown control.
TUDOrientation	enumeration	Indicates the orientation for the arrows on a TUpDown control.
TUpDownDirection	enumeration	Indicates whether a value in a TUpDown control is being increased, decreased, or not changed.
TViewStyle	enumeration	Represents the view styles available for the items in a list view control.
TWidth	type	Range type with values allowed in width propertied in TListColumn.

Constants

CN_DROPDOWNCLOSED	constant	Control notification message constant.
DefaultMultiSelectStyle	constant	Default value(s) used for the MultiSelectStyle property in TCustomTreeView.
DefaultTreeNodeExpandSignSize	constant	Default size used for expand and collapse indicators in TCustomTreeView.
DefaultTreeNodeHeight	constant	Default value used as the height for a TTreeNode instance.
DefaultTreeViewOptions	constant	A set of TreeViewOptions which are set be default.
LCLStreamID	constant	A constant with the identifier for a LCL stream.
TCN_First	constant	Represents the first tab control notification message.
TCN_SELCHANGE	constant	Represents the selection changed notification message for tab controls.
TCN_SELCHANGING	constant	Represents the selection changing notification message for tab controls.

Uses

• SysUtils
• Types
• Classes
• Math
• AVL_Tree
• LCLStrConsts
• LResources
• LCLIntf
• LCLType
• LCLProc
• LMessages
• WSLCLClasses
• WSReferences
• Graphics
• ImgList
• ActnList
• Themes
• Menus
• Controls
• Forms
• StdCtrls
• ExtCtrls
• ToolWin
• Buttons
• GraphType
• LazUTF8
• LazLoggerBase
• LazTracer
• LazUtilities
• IntegerList