Several controls commonly used in Lazarus forms
THitTest
- enumerated type giving permissable results of a hit test (position of a mouse click etc relative to objects on a form)
THitTests
- set of THitTest
TStatusPanelStyle
- enumerated type for panel style
TStatusPanelBevel
- enumerated type for panel bevel style
TPanelPart
- enumerated type listing the possible parts that comprise a Panel
TPanelParts
- set ot TPanelPart
TStatusPanel
- one of the panels contained in a StatusBar
GetDisplayName
- looks first at the Text property; if it is blank calls inherited method
TCollectionItem.GetDisplayName
PanelChanged
- method for dealing with a status panel, one or more of whose parts has changed
SetIndex
saves the old index value, checks that the supplied value is different then calls inherited method
TCollectionItem.SetIndex
Create
- constructor for TStatusPanel: sets default width, alignment and bevel, calls inherited Create and loads into StatusBar
TCollectionItem.Create
Destroy
- destructor for TStatusPanel: calls inherited Destroy and removes itself from the StatusBar
TCollectionItem.Destroy
Assign
copies text, width, alignment, bevel and style properties from Source if it is of correct type, otherwise calls inherited Assign (which will probably raise an exception)
TPersistent.Assign
The StatusBar that contains this StatusPanel
Alignment
- whether left- or right-justified or centered
The type of Bevel for the display
Style
- whether text or something drawn by the owner
Text
- the string for display in the StatusBar
The Width of this panel on the StatusBar
TStatusPanels
- the collection of Status Panels in this StatusBar
GetOwner
returns a Status Bar, overriding the inherited method
TPersistent.GetOwner
Create
- constructor for TStatusPanels: calls inherited Create and attaches itself to StatusBar
TCollection.Create
The StatusBar to which this collection of Status Panels belongs
TStatusBar
- a strip along the bottom of a form for displaying information on current status

TStatusBar - a strip along the bottom of a form for displaying information on current status

The bar may consist of a single SimplePanel, in which case the displayed text is contained in SimpleText.

However if SimplePanel is false, then there can be multiple panels or sub-sections of the status bar, whose properties are described in Panels.

The property SimpleText can be assigned programatically to display the value of some variable, such as the position of the Splitter in the example

CreateWnd
calls inherited method, then fixes handles if needed
TWinControl.CreateWnd
DestroyWnd
calls inherited method and frees handles
TWinControl.DestroyWnd
Loaded
calls inherited method and fixes handles if needed
TWinControl.Loaded
UpdateHandleObject
- updates all panel parts that have been changed
Create
- constructor for TStatusBar: calls inherited Create and initialises a number of local variables

Create - constructor for TStatusBar: calls inherited Create and initialises a number of local variables

Among the variables initialised are:

AutoHint (False), Canvas, ControlStyle, Colour, Align, AutoSize, and SimplePanel (True)

TComponent.Create TWinControl.Create
Destroy
- destructor for TStatusBar: frees canvas and panels, then calls inherited Destroy
TComponent.Destroy TWinControl.Destroy
InvalidatePanel
- renders the panel with specified index non-valid
BeginUpdate
- starts the update process
EndUpdate
- finishes the update process
UpdatingStatusBar
- returns True if the status bar is being updated
The Canvas where the Panels of the StatusBar are to be Painted
Panels
- the list of strings to be placed in the sub-panels of TStatusBar

If SimplePanel is false, the contents of Panels is displayed.

Contents can be adjusted with a stringlist editor that pops up when the ellipsis (...) next to Panels in the Object Inspector is selected and allows insertion of an arbitrary number of sub-panels with their own strings

SimpleText
- a character string containing the information to be displayed in the Status Bar

SimpleText - a character string containing the information to be displayed in the Status Bar

This is displayed if SimplePanel is true; otherwise the information in Panels is displayed.

SimplePanel
- boolean. Is there just one continuous panel, or several sub-panels?

SimplePanel - boolean. Is there just one continuous panel, or several sub-panels?

If true, the value of SimpleText is displayed; if false, the contents of Panels is displayed.

Contents can be adjusted with a stringlist editor that pops up when the ellipsis (...) next to Panels is selected and allows insertion of an arbitrary number of sub-panels with their own strings

Event handler for showing a hint when required
TCustomPage
: The base type for Page
TCustomPage
: The base type for the tabbed pages found in notebooks
Multi-PageControls
GetPageIndex
- returns the index of the current page
SetPageIndex
- specifies an index for the current page
TabVisible
- is the Tab for this page visible?
DoHide
- perform the code for the OnHide event handler
DoShow
- perform the code for the OnShow event handler
Create
- constructor for TCustomPage: calls inherited Create then initialises style, visibility, alignment and caption
TControl.Create
PageIndex
- integer index value for this page in the notebook
VisibleIndex
- returns the index number of a visible page
OnHide
- event handler for hiding this page in a notebook
OnShow
- event handler for showing (making visible) this page of a notebook
ImageIndex
- integer index value for the image associated with this page
TCustomPageClass
- class of TCustomPage
TNBPages
- NoteBook Pages: an array of strings containing the names of the pages
TObject.Create
Create
- constructor for TNBPages: calls inherited Create then sets up the list of pages on the notebook
TTabChangingEvent
- generic event handling method for a change in a notebook Tab
TTabPosition
- enumerated type for position of tab relative to page: top, bottom, left or right
TTabStyle
- enumerated type for tab style: normal, buttons or flat buttons
TTabGetImageEvent
- generic event handling method for getting an image for a Tab
TCTabControlOption
- Show the close button on a tab, allow multi-line tabs
TCTabControlOptions
- set of TCTabControlOption
TCustomTabControl
: The base type for TTabControl and TPageControl

TCustom Notebook: The base type for TTabControl and TPageControl

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

Multi-PageControls
PageClass
- the class of page that is included in this NoteBook
DoCreateWnd
- perform th ecode for method CreateWnd
Change
- perform the code for OnChanging
UpdateTabProperties
- apply all pending changes to the Tab
ActivePageComponent
- the actual contents of the currently selected

Page
ActivePage
- the name (string) of the

Page
that is currently selected and is available for interaction
Create
- constructor for TCustomTabControl: calls inherited Create creates a pagelist, then sets initial bounds and default values for local variables and properties
TWinControl.Create
Destroy
- destructor for TCustomTabControl: clears and frees pages and list, then calls inherited Destroy
TWinControl.Destroy
TabIndexAtClientPos
- the index value of the Tab at the specified position

ClientPos
GetImageIndex
- find the index number of the image associated with the specified Page index
IndexOf
- returns the index value of a specified page
CustomPage
- returns the page specified by

Index
CanChangePageIndex
- determine whether it is permissible to change the index of the page
GetMinimumTabWidth
- find the smallest permissible tab width
GetMinimumTabHeight
- find the least permissible height for a tab
DoCloseTabClicked
- perform the action associated with clicking the Close tab for this page (OnCloseTabClicked)
Images
- the list of images associated with the pages of this notebook
OnChanging
- event handler for changing a tab
OnCloseTabClicked
- event handler for clicking on the Close button to close a tab
OnGetImageIndex
- event handler for getting an image index
OnChange
- event handler for a change in the page
The set of Options for the Notebook: Show close buttons on the tabs, multi-line tabs

The set of Options for the Notebook:

nboShowCloseButtons (display a little CloseButton on the Tab next to the label, to allow the user to close that tab),

nboMultiLine (allows multi-line captions on the Tabs)

The current Page of the Notebook
PageCount
- the number of Pages in the Notebook
PageIndex
- Index number of the current page
PageList
- the Indexed list of the Pages in the Notebook
The contents of the Pages in the Notebook (as Strings)
ShowTabs
- if True (default condition), show the tabs for each page
TabPosition
- top, bottom, left or right
GetCapabilities
- returns the set of capabilities
TCTabControlCapability
- enumerated type containing possible capabilities of a notebook
nbcShowCloseButtons, nbcMultiLine, nbcPageListPopup, nbcShowAddTabButton
TCTabControlCapabilities
- set of TCTabControlCapability
TTabStyle
TTabSheet
- individual page of a TPageControl; a more elaborate version of TPage

TTabSheet - individual page of a TPageControl; a more elaborate version of TPage

Contains the following features lacked by TPage:

- Drag/Drop properties
- Ability to Enable/Disable the page
- Ability to make the Tab visible or not

Multi-PageControls HowToUseStdCtrls
calls inherited Create and zeroes ImageIndex
TComponent.Create
Destroy
- destructor for TTabSheet: detaches from the Host Dock Site and calls inherited Destroy
TComponent.Destroy
The PageControl of which this TabSheet is a member
TabIndex
- the Index value or sequence number of this TabSheet
TPageControl
- provides a series of tabs along the edge of a multi-page component, to allow selection of one of the pages (TTabSheet) of the component.

TPageControl - provides a series of tabs along the edge of a multi-page component, to allow selection of one of the pages (TTabSheet) of the component.

To use TPageControl, select its icon from the Common Controls tab of the IDE Component Palette, and place it at the desired location on the Form.

Use the Form Designer and Object Inspector to adjust its shape, size, alignment, anchoring, docking and other properties, then select the object and right click with the mouse to bring up a pop-up menu whose frst item is 'AddPage'. After you have added as many pages as you need, the individual pages can be edited by selecting ActivePage in the Object Inspector, choosing the page required, and editing its properties.

While a given page is selected, it is also possible to drop other controls (such as buttons, memo boxes etc) on to the page from the Component Palette.

Inherits most of its properties from TCustomTabControl

Multi-PageControls
Create
- constructor for TPageControl: sets PageClass to TTabSheet then calls inherited Create
TComponent.Create TCustomTabControl.Create
FindNextPage
- returns the next page (TTabSheet) in the sequence

If GoForward is True, goes to next (higher index) page;

if False, goes to previous (lower index)

SelectNextPage
- goes to next page and selects it
SelectNextPage
- checking that its tab is visible

If GoForward is True, goes to next (higher index) page;

if False, goes to previous (lower index)

If CheckTabVisible is True, will only move if the tab is visible

ActivePageIndex
- index value of currently selected (active) page
Pages
- the actual Pages (TTabSheet) that comprise the component
TCustomTabControl.Pages
ActivePage
- the currently selected active page (TTabSheet)

ActivePage - the currently selected active page (TTabSheet)

Note that this overrides the definition in TCustomTabControl, where ActivePage is defined as a String.

TabIndex
- the Index value of the currently selected Tab
OnChange
- Occurs immediately after a tab is selected.
Occurs immediately after a tab is selected.
OnChanging
- Occurs immediately before a tab is selected.
Occurs immediately before a tab is selected.
TTabControlStrings
- the Strings that appear on the tabs of TTabControl
GetTabIndex
- returns the Index value of the current Tab
SetHotTrack
- specifies the status of HotTrack
SetImages
- specifies the list of images to be used
SetMultiLine
- specifies whether multiline captions are to be used
SetMultiSelect
- specifies whether MultiSelection is available
SetOwnerDraw
- specifies whether an owner-derived drawing can be used
SetRaggedRight
- specifies whether ragged-right (as opposed to right-justified) alignment is to be used
SetScrollOpposite
- specifies whether scrollbars are to operate in the opposite sense to normal
SetTabHeight
- specifies the height of tabs
SetTabIndex
- specfies an index value for a tab
SetTabWidth
- specifies the width of a tab
Create
- constructor for TTabControlStrings: calls inherited Create then sets many local defaults

Create - constructor for TTabControlStrings: calls inherited Create then sets many local defaults

Among the defaults set are:

HotTrack, Multiline, MultiSelect, OwnerDraw, RaggedRight, ScrollOpposite - all False; Tab height and width to zero

TObject.Create
GetHitTestInfoAt
- returns the results of a hit test at the specified location X, Y
GetSize
- returns the size of the tab string
IndexOfTabAt
- returns the Index value of the tab at the specified location, X, Y
RowCount
- number of rows (for a multi-row string)
TabRec
- returns the coordinates of the rectangle for the tab with specified index
ImageListChange
- method for changing the image list
ScrollTabs
- scrolls the tabs by an amount specified by Delta
TabControlBoundsChange
- method for dealing with a change in the bounds of a Tab Control
UpdateTabImages
- bring the tab images up to date
BeginUpdate
increments the Update count
TStrings.BeginUpdate
EndUpdate
decrements the Update count
An exception is raised if the Update count is zero
TStrings.EndUpdate
IsUpdating
- returns True if in the process of updating
The TabControl to which these strings apply
TabIndex
- the index of the current Tab
HotTrack
- the property whereby the item under the mouse pointer becomes emphasised
TCustomListView.HotTrack
The list of Images associated with the Strings for these tabs
MultiLine
- if True, multiple lines may be used in Tab strings
MultiSelect
- if True, multiple tabs can be selected, for example by holding down Shift or Ctrl keys while selecting
OwnerDraw
- if True, Owner object (or calling routine) can specify drawing methods
RaggedRight
- if True, strings are un-justified or un-aligned, with ragged right margin
ScrollOpposite
- if True, scrolling proceeds in opposite direction to usual
TabHeight
- height of the tab
TabWidth
- width of the tab
TTabControlNoteBookStrings
- instance of TTabControlStrings for use with a TNoteBook
Get
returns the text string found on the indexed page
TStrings.Get
GetObject
returns the indexed object from the paged notebook
TStrings.GetObject
NBChanging
- method for dealing with the process for change in a NoteBook
NBGetImageIndex
- obtains the Image Index associated with a given Tab Index in the NoteBook
NBPageChanged
- Method for dealing with a NoteBook page that has changed
Put
writes the supplied string to the indexed page of the notebook
TStrings.Put
PutObject
stores the supplied object at the indexed place in the paged notebook
TStrings.PutObject
TTabControlStrings.SetImages
SetImages
- if the supplied ImageList is of correct type, stores it in the notebook Images area
SetUpdateState
- if Updating is True, calls BeginUpdate; otherwise calls EndUpdate
TStrings.SetUpdateState
SetTabHeight
checks if TabHeight is already equal to AValue, otherwise calls inherited method
TTabControlStrings.SetTabHeight
SetTabWidth
checks if TabWidth is already equal to AValue, otherwise calls inherited method
TTabControlStrings.SetTabWidth

Create - constructor for TTabControlNoteBookStrings: calls inherited Create then sets some default Actions

Among the actions set are:

OnGetImageIndex, OnChanging, OnChange. Notebook is created with a nominated parent

TObject.Create TTabControlStrings.Create
Create
- constructor for TTabControlNoteBookStrings: calls inherited Create then sets some default Actions
Destroy
- destructor for TTabControlNoteBookStrings: frees NoteBook then calls inherited Destroy
TStrings.Destroy
Clear
calls the Clear method for the client Notebook
TStrings.Clear
Delete
calls the Delete method for the client NoteBook
TStrings.Delete
Insert
calls the Insert method for the client NoteBok
TStrings.Insert
The NoteBook for which the tab strings are to be used
TDrawTabEvent
- generic event handling procedure for drawing a tab, with given index at the specified rectangle
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
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
Multi-PageControls
SetHotTrack
- specifies the status of HotTrack
CanChange
- returns True if the control can be changed
CanShowTab
- returns True if the specified (indexed) Tab can be shown
Change
- software emulation of the OnChange event
DrawTab
- software emulation of the OnDrawTab event
GetImageIndex
- software emulation of the OnGetImageIndex event
SetTabIndex
- set the index of the current tab to the specified value
UpdateTabImages
- bring the images of the tabs up to date
ImageListChange
- method for signalling a change to the image list
GetDisplayRectWithBorder
- returns the coordinates of the display rectangle with a border around it
DisplayRect
- the rectangular area to be used for displaying information determined by the identity of the selected Tab
HotTrack
- the property whereby the item under the mouse pointer becomes emphasised
TCustomListView.HotTrack
Images
- the list of Images available for display in the DisplayRect
MultiLine
- whether the Tab's caption is allowed to have multiple lines
MultiSelect
- whether multiple Tabs are allowed to be selected at the same time (eg by pressing Shift or Ctrl while selecting)
OnChange
- event handler for a change in the Tabs
OnChanging
- event handler while Tab is changing
OnDrawTab
- event handler for drawing a Tab
OnGetImageIndex
- event handler for finding the index value of the required image
OwnerDraw
- is the calling routine (Owner) allowed to specify the drawing method?
RaggedRight
- un-justified or un-aligned text
ScrollOpposite
- is scrolling to happen in the opposite direction to usual?
Style
- Tabs, buttons or flat buttons?
TabHeight
- height of the tabs
TabIndex
- index value of current Tab. If none selected, default value of -1 is returned
TabPosition
- top, bottom, left or right
Tabs
- the actual Tabs expressed as strings
TabWidth
- width of the tabs
Create
- constructor for TCustomTabControl: calls inherited Create, sets initial bounds, forms links and sets some defaults
TCustomControl.Create TComponent.Create
Destroy
- destructor for TCustomTabControl: frees links and tabs, then calls inherited Destroy
TCustomControl.Destroy TComponent.Destroy
IndexOfTabAt
- returns the index value of the Tab located at specified X, Y
GetHitTestInfoAt
- returns information about hit tests at location X, Y
TabRect
- the rectangle occupied by the specified Tab
RowCount
- the number of rows in the list of tabs
ScrollTabs
- scroll through the list of tabs by an amount specifid by Delta
BeginUpdate
- start the Update procedure
EndUpdate
- finish the update procedure
IsUpdating
- returns True if in process of updating
TTabControl
- a series of Tabs along the edge of a display area; selection of a Tab governs the contents of the DisplayRect

TTabControl - a series of Tabs along the edge of a display area; selection of a Tab governs the contents of the DisplayRect

Use TTabControl by selecting its icon from the Common Controls tab of the IDE Component Palette and placing it at the desired location on the Form. Use the Form Designer and Object Inspector to adjust its shape, size, alignment, anchoring and other properties. Tabs can be aded or removed from the component by selecting it, then right-clicking with the mouse to get a pop-up menu whose first item is 'Add Tab'. Once created, the Tabs can be edited by selecting the Tabs entry in the Object Inspector, and selecting the ellipsis (...) which will cause a pop-up String editor to appear. The tabs can be given new captions, moved up and down the list, or removed altogether, as required.

Each Tab has an Index (starting from 0) and this index can be used to specify an entry from Images for display in the DisplayRect.

Multi-PageControls
OnGetSiteInfo
- event handler for getting information about the current site
TCustomDrawTarget
- enumerated type controlling how a target object is to be drawn
TCustomDrawStage
a series of constants to define the drawing stages.
So far I've only seen cdPrePaint used in this unit.
TCustomDrawStateFlag
- series of flags to define the DrawState

TCustomDrawStateFlag consists of the following constants:

- cdsSelected,
- cdsGrayed,
- cdsDisabled,
- cdsChecked,
- cdsFocused,
- cdsDefault,
- cdsHot,
- cdsMarked,
- cdsIndeterminate

TCustomDrawState
- set of TCustomDrawStateFlag
TCustomDrawState determines how a item will be drawn.
TSortType
- enumerated type, a series of constants signifying that there is no sorting, or that sorting is according to data, test or both
TListItemState
- enumerated type denoting the state of a list item
TListItemStates
- set of TListItemState
TListItemFlag
- enumerated type, a flag denoting a list item is being destroyed or created
TListItemFlags
- set of TListItemFlag
TListItem
- the ancestor class for the Items in TCustomListView and TListView
Most properties are inherited from ancestors, TPersistent and TObject
Classes.TPersistent Objects.TObject
The current ListItem IsEqual to the item specified in the argument AItem
TPersistent.Assign
Assign
- if source has correct type, copies Caption, Data, ImageIndex and SubItems from source, otherwise calls inherited Assign which probably raises an exception
TObject.Create
Create
- constructor for TListItem: calls inherited Create then initialises flags, states, ImageIndex and SubItems
Destroy
- destructor for TListItem: frees SubItems, sets flags to signify destruction, then calls inherited Destroy
TPersistent.Destroy
Remove an Item from the list
MakeVisible
- render the item visible (if PartialOK is True, only part may be visible)
Caption
- the name given to this item on the list
Cut
this item from the list (but it can be placed on the clipboard)
Pointer to the Data asociated with this item
DropTarget
- returns True if this is a valid target on the list for dropping
Property is true if this item has Focus
The index of this item in the list (integer)
The index of the image associated with this Item in the list
The Owner of the ListItem
Whether this Item has been Selected (often denoted by a check-mark)
The list of SubItems associated with this ListItem
SubItemImages
- the list of Images associated with the SubItems
TListItems
- a list of items with a cache of the last accessed item
TListitems
has a built-in cache of the last accessed item. This will speed up interface updates since Item.Index is often used for the same item updating more properties. If FCacheIndex = -1 then the cache is not valid.
DefineProperties
- calls inherited method, then defines some specific binary properties
TPersistent.DefineProperties
GetCount
- find the number of Items in the list
GetItem
returns the ListItem specified by AIndex
Returns the IndexOf the Item specified by AItem
SetItem
- writes the Index and content of a given Item to a local variable
Add
an Item to the Collection
AddItem
- add the specified AItem to the collection
Clear
- remove all Items from the list
TObject.Create
Create
- constructor for TListItems: calls inherited Create then creates the list
Destroy
destructor for TListItems: frees the individual items on the list, then calls inherited Destroy
TPersistent.Destroy
Remove the Item specified by AIndex from the collection
FindData
- returns the ListItem associated with the specified datapointer
Insert
an item in the list at AIndex, returning the value of the ListItem
InsertItem
- procedure to insert AItem at position AIndex in the list
Count
- the number of items in the collection
An Item in the list, specified by its Index value
Owner
- the ListView that owns this collection of ListItems
ImageIndex
TListColumn
- an individual column in a multi-column List control
SetIndex
- calls inherited method, and if this is a new index value, changes to the new column index
TCollectionItem.SetIndex
GetDisplayName
returns the Caption; if this is blank, calls inherited method
TCollectionItem.GetDisplayName
Create
- constructor for TListColumn: calls inherited Create then sets defaults for size, alignment and index
TCollectionItem.Create
Destroy
- destructor for TListColumn: if update allowed, updates columns then calls inherited Destroy
TCollectionItem.Destroy
Assign
- if source is of correct type, copies alignment, caption, visibility and size properties, otherwise calls inherited Assign which probably raises an exception
TPersistent.Assign
Alignment
- whether text is to be left or right justified or centered
Whether AutoSize is to be operational
A text string or Caption (which may be translated) to be used at the top of the column
ImageIndex
- the index value of the image associated with he ListColumn
MaxWidth
- the maximum width for this column
MinWidth
- the minimum permissable with for the column
Tag
- a general purpose integer variable to be used in association with this column
Visible
- whether this column can be seen
The Width of this column
TListColumns
- a collection of Items of type TListColumn (the columns appearing in a multi-column list)
Create
- constructor for TListColumns: sets ownership then calls inherited Create
TCollection.Create
Destroy
- destructor for TListColumns: calls inherited destructor
TCollection.Destroy
Add
calls inherited method, then adjusts state flags
TCollection.Add
Assign
checks that source is of correct type, then adds new columns and copies items from source into them; otherwise calls inherited Assign which probably raises an exception
TCollection.Assign
TItemChange
- enumerated type for kind of change: in text, in image or in state
TViewStyle
- enumerated type for style of view
TLVChangeEvent
- generic event handler method for change in List View
TLVColumnClickEvent
- generic event handler method for a click on a List View column
TLVColumnRClickEvent
- generic event handler method for a right click on a List View column
TLVCompareEvent
- generic event handler method for List View comparison
TLVDeletedEvent
- generic event handler method for deleted items in List View
TLVInsertEvent
- generic event handler method for List View insertion
TLVSelectItemEvent
- generic event handler method for List View selection
TListViewProperty
- enumerated type: a series of constants denoting the properties of a listview

TListViewProperty - enumerated type: a series of constants denoting the properties of a listview

    lvpAutoArrange,
        lvpCheckboxes,
        lvpColumnClick,
        lvpFlatScrollBars,
        lvpFullDrag,
        lvpGridLines,
        lvpHideSelection,
        lvpHotTrack,
        lvpMultiSelect,
        lvpOwnerDraw,
        lvpReadOnly,
        lvpRowSelect,
        lvpShowColumnHeaders,
        lvpShowWorkAreas,
        lvpWrapText,
        lvpToolTips

TListViewProperties
- set of TListViewProperty
TListViewImageList
- enumerated type denoting the category of image list
TListHotTrackStyle
- enumerated type denoting the style of HotTrack
TListHotTrackStyles
- set of TListHotTrackStyle
TCustomListView
- the base class for TListView

TCustomListView is the base class for TListView. If you want to define your own ListView class, you should derive it from this class.

ItemDeleted
- the specified listitem is removed from the list
ItemInserted
- the specified item is inserted into the list
InitializeWnd
- calls inherited method, then sets various local properties
InitializeWnd
- calls inherited method, then sets style, adds columns, sets imagelists and item depending properties (scroll bars, sorting etc), adds items and sets other miscellaneous properties (default item height, hot track styles, hover time etc)
TWinControl.InitializeWnd
Change
- Internal procedure to simulate the OnChange event

This is an internal procedure which is called after an item has been changed. It is a programmatic method for simulating the OnChange event if the programmer has assigned a method to this event.

ColClick
- procedure to simulate the OnColumnClick event.

ColClick - procedure to simulate the OnColumnClick event.

Can be used programmatically to execute the same code as is used to respond to the OnColumnClick event

Delete
an Item from the List
DoDeletion
- performs the actual deletion
Performs the insertion
DoSelectItem
- perform item selection
Insert an Item into the List
ImageChanged
- procedure to signal that an image has chnaged
AllocBy
- allocate the list by a value
Columns
- define and change the columns of a ListView

Columns is a TCollectionItem and contains all information on the columns of a listview.

ColumnClick
- determines if the OnColumnClick event will be executed.

The ColumnClick property of the ListView enables or disables the OnColumnClick Event. A call to OnColumnClick will only be done when a method has been assigned to the OnColumnClick event and ColumnClick is set to true (default).

DefaultItemHeight
- sets or reads the default height for an item on the list
HideSelection
- if True, the selected item is to be hidden
HoverTime
- the time for which the mouse must hover over the item before its help message is displayed
Items
- the list of entries in the list. Held as a linked list with a cached index of the last accessed item

Items - the list of entries in the list. Held as a linked list with a cached index of the last accessed item

Items is of type TListitems which has a built-in cache of the last accessed item. This speeds up interface updates since Item.Index is often used for the same item updating more properties. If FCacheIndex = -1 then the cache is not valid.

LargeImages
- an ImageList to be used in association with the list of Items

LargeImages - an ImageList to be used in association with the list of Items

A typical application might have two ImageLists: one ofLargeImages and one of SmallImages, containing two versions of the same collection of images, in large and small format; the index numbers of the first list would correspond with those in the second list.

SmallImages could be displayed beside the text strings in the list view, and the programmer would supply code to ensure that when an item with its associated SmallImage was selected, the corresponding LargeImage would be displayed in another window.

A TImageList control needs to be selected and pasted on to the Form Designer, and the ImageList Editor can be opened from the pop-up menu obtained by right-clicking on TImageList icon in the Form Designer. Then in the StringList editor for Items the correct ImageIndex must be allocated to each entry in the list.

MultiSelect
- enables the selection of more than one entry from Items - by pressing SHIFT or CTRL keys while selecting
OwnerData
- if True, the Owner's data are to be displayed
OwnerDraw
- if True, the Owner's Draw method is to be used
ReadOnly
- determines if the list can only be read, and not written or deleted.
ScrollBars
- the kind of scrollbars to be used: none, auto, horizontal or vertical
ShowColumnHeaders
- whether headers for columns are to be displayed
ShowWorkAreas
- if True, the work areas are to be displayed
SmallImages
- an ImageList of small images (icons) to be used in association with the list of Items

SmallImages - an ImageList of small images (icons) to be used in association with the list of Items

A typical application might have two ImageLists: one ofLargeImages and one of SmallImages, containing two versions of the same collection of images, in large and small format; the index numbers of the first list would correspond with those in the second list.

SmallImages could be displayed beside the text strings in the list view, and the programmer would supply code to ensure that when an item with its associated SmallImage was selected, the corresponding LargeImage would be displayed in another window.

A TImageList control needs to be selected and pasted on to the Form Designer, and the ImageList Editor can be opened from the pop-up menu obtained by right-clicking on TImageList icon in the Form Designer. Then in the StringList editor for Items the correct ImageIndex must be allocated to each entry in the list.

SortType
- whether to sort by text, by data, both or not at all
SortColumn
- the column that is being sorted
StateImages
- an imagelist of icons to demonstrate the state of a process or event
ViewStyle
- whether to view as a simple list, a list with large or small icons, or as a report
OnChange
- event handler for a change in the list
OnColumnClick
- event handler for clicking on a coulmn
OnCompare
- event handler for comparing list items
OnDeletion
- event handler for deleting a list item
OnInsert
- event handler for inserting list item
OnSelectItem
- event handler for list item selection
Create
- constructor for TCustomListView: calls inherited Create then initialises columns, the list of items, the canvas and properties and some formats and styles
TComponent.Create TWinControl.Create
Destroy
- destructor for TCustomListView: frees Canvas, calls inherited Destroy and frees columns, links and list items
TComponent.Destroy TWinControl.Destroy
BeginUpdate
- start updating the list view
EndUpdate
- finish updating the list view
BoundingRect
- the coordinates of the rectangle containing the ListView
Canvas
- defines the area on which all graphic material is drawn (Read-only)
CheckBoxes
- determines if the ListView shows checkboxes beside the items on the list
Column
- reads the column information of the listview.

This property can be used to read the information of a column.

The column whose information is to be retrieved is determined by an index (AIndex). As with nearly all indexes, this index is 0 based. In column[0] the caption of the listitem is show, in subsequent column the subitems of the listitem are shown.

To add, change or delete a column use the Columns property

Integer to determine the column of the ListView to retreive information on.
DropTarget
- location where an item from the list is to be dropped
FlatScrollBars
- whether the scroll bars are to be displayed flat (default False)
FullDrag
- if True, the full object is dragged
Whether GridLines are to be shown
HotTrack
- the property whereby the item under the mouse pointer becomes emphasised

HotTrack is the name given to the feature whereby, as the mouse pointer moves over some graphic item (eg a tab, an entry in a list, a button or other control in a form), that item becomes emphasized in some way.

The default list of emphasis possibilities is given by the definition

    TListHotTrackStyle = (htHandPoint, htUnderlineCold, htUnderlineHot)

in other words

- it may be indicated by a hand pointer
- it may be underlined even when Cold (ie the pointer has covered it and moved on, but the underlining remains)
- it may be underlined when Hot (ie when the pointer is directly on the item)

This feature can be used in List Views and in TabControls

TCustomListView.HotTrack
The HotTrackStyles available for this control
ItemFocused
- the item currently receiving focus
RowSelect
- whether the user can select rows of items (across columns). Default false
SelCount
- the number of items selected
Selected
- the current list item that has been selected
TopItem
- the first item on the list
ViewOrigin
- the top left coordinate for the current view
VisibleRowCount
- the number of rows visible in the current view (some items might have scrolled outside the window)
TListView
- a window showing a list of Items, which may or may not have associated icons

TListView - a window showing a list of items, which may or may not have associated icons

At first, this control looks very like TListBox, but it has a much higher degree of complexity. It is capable of displaying Items in Columns of Rows, and it can have images associated with the list Items.

The important information is held in Items, a string-list that can be created using the string-list editor obtained by right-clicking on the ListView in the Form Editor or by clicking on the ellipsis (...) next to the Items entry in the Object Inspector.

A typical application might have two ImageLists: one ofLargeImages and one of SmallImages, containing two versions of the same collection of images, in large and small format; the index numbers of the first list would correspond with those in the second list.

SmallImages (if assigned to a string-list) can be displayed beside the text strings in the list view, and the programmer would supply code to ensure that when an item with its associated Small Image was selected, the corresponding Large Image would be displayed in another window.

One or more TImageList controls need to be selected and pasted on to the Form Designer, and the ImageList Editor can be opened from the pop-up menu obtained by right-clicking on TImageList icon in the Form Designer. The image list can be populated by reading from files. Then in the StringList editor for Items the correct ImageIndex must be allocated to each entry in the list.

TProgressBarOrientation
- enumerated type with a series of constants denoting the orientation of the progress bar
The ancestor class for TProgressBar
TCustomProgressBar
is the ancestor for TProgressBar. If you want to define your own ProgressBar class, you should derive it from this class.
ApplyChanges
- apply any changes that have occurred
InitializeWnd
calls inherited method then applies changes
TWinControl.InitializeWnd
Loaded
calls inherited method then applies changes
TWinControl.Loaded
Create
- constructor for TCustomProgressBar: calls inherited Create, initialises position, orientation and size
TComponent.Create TWinControl.Create
StepIt
- move indicator to new position (current position plus Step)
StepBy
- move indicator by amount specified in Delta
Max
- maximum value for progressbar
Min
- minimum value of progressbar
Orientation
- horizontal or vertical
Position
of indicator along progressbar
Whether Smooth display (True) or stepped
Step
- size of increment for display
BarShowText
- some widget sets allow text to be displayed on the bar to indicate its position (eg 32%)
TProgress Bar
- a bar that depicts what proportion of a process has been completed
TProgress Bar
: a control that appears at or near the bottom of form or window. It depicts the progress of a process, or what proportion of the process is complete. A series of coloured rectangles appears in the control, filling it from left to right or from top to bottom as the process progresses
HowToUseStdCtrls
TUDAlignButton
- enumerated type contains constants for alignment of an UpDown button
TUDOrientation
- enumerated type with constants for orientation of UpDown button (Horizontal or Vertical)
TUDBtnType
- enumerated type with constants describing the buttons of an UpDown control: Next or Previous
TUDClickEvent
- generic event handling procedure for clicking on an UpDown button
TUDChangingEvent
- generic event handling procedure for changes in UpDown button
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

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

The control definition itself does not specify the variable upon which the buttons operate. The application programmer is responsible for supplying an event handler for OnClick to determine which button has been selected (designated btNext or btPrev) and incrementing or decrementing the variable in the control with which the UpDown is associated.

The amount by which the variable is changed is set by the integer property Increment with the optional multiplier Thousands (a boolean property).

For example the UpDown control may be used to move a slider up and down a scale by a specified amount for each click; alternatively, a number may be displayed in a text box, and clicking the buttons of the UpDown control may increment or decrement the number displayed by a specified amount.

OldKeyDown
- the previous (stored) value of the key
AssociateKeyDown
- protected procedure for dealing with action to be taken if an associate key (Shift, Ctrl or Alt) is pressed while the control is active
OnAssociateChangeBounds
- event handler for a change in bounds of the associate control
CanChange
- if True, control can be changed
Notification
calls inherited method; if the operation requires removal of the associate control, this is performed
TControl.Notification
Click
- calls OnClick event handler if it is assigned
TControl.Click
AlignButton
- how to align the button: left or right
ArrowKeys
- if True, the control can be operated by the keyboard's arrow keys, which would simulate a click on the Next or Previous button
Associate
- the associated control whose properties (controlled variable) are to be changed by the UpDown control
Min
- least value of controlled variable
Max
- greatest value of controlled variable
The amount by which the controlled variable is to be increased or decreased on each click
Whether horizontal or vertical
The Position of the UpDown control
If True, multiply all displayed values and the Increment by 1000
If True, displayed control or value starts again from minimum or maximum value if clicking a button would cause incrementing or decrmenting beyond the extreme value
OnChanging
- event handler for a change in the value of the controlled variable
OnClick
- special event handler for a click on up or down button

OnClick - special event handler for a click on up or down button

The event handler must determine whether the [next] or [prev] button was clicked, and therefore whether to increment or decrement the controlled variable and adjust the display

Create
- constructor for TCustomUpDown: calls inherited Create, initialises orientation, max and min, bounds, size and alignment
TComponent.Create TCustomControl.Create
Destroy
- destructor for TCustomUpDown: removes connection with associate control and calls inherited Destroy
TComponent.Destroy TCustomControl.Destroy
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

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

The control definition itself does not specify the variable upon which the buttons operate. The application programmer is responsible for supplying an event handler for OnClick to determine which button has been selected (designated btNext or btPrev) and incrementing or decrementing the variable in the control with which the UpDown is associated.

The amount by which the variable is changed is set by the integer property Increment with the optional multiplier Thousands (a boolean property).

For example the UpDown control may be used to move a slider up and down a scale by a specified amount for each click; alternatively, a number may be displayed in a text box, and clicking the buttons of the UpDown control may increment or decrement the number displayed by a specified amount.

Message constant.
TToolButtonStyle
- enumerated type that determines the style of the tool buttons.

These are the possible values of Style:

- tbsButton - The button appears and functions like a normal button.
- tbsCheck - Clicking the button toggles the Down property. Once selected, the button remains selected until clicked again.
- tbsDivider - The button appears as a vertical line on the toolbar (used to separate other controls).
- tbsDropDown - The button displays a downwards-pointing arrow (suitable for accessing a drop-down menu).
- tbsSeparator - The button appears as an empty space on the toolbar (used to separate other controls).

The button appears and functions like a normal button.
Clicking the button toggles the Down property. Once selected, the button remains selected until clicked again.
The button displays a downwards-pointing arrow (suitable for accessing a drop-down menu).
The button appears as an empty space on the toolbar (used to separate other controls).
The button appears as a vertical line on the toolbar (used to separate other controls).
TToolButtonFlag
- a series of flags that can be set by pressing the mouse on the control

tbfPressed, // set while mouse is pressed on button

tbfArrowPressed // set while mouse is pressed on arrow button

TToolButtonFlags
- set of TToolButtonFlag
TToolButtonActionLink
- links a ToolButton on the ToolBar to an Action on an ActionList
AssignClient
calls inherited method then sets client as ToolButton
TBasicActionLink.AssignClient
SetChecked
- stores the Checked status (True or False)
SetImageIndex
- stores the index value of the associated image
TToolButtonActionLinkClass
- class of TToolButtonActionLink
TToolButton
is a button control in a TToolBar object.

Use TToolButton to implement buttons on a toolbar. While other controls (including TButton and TSpeedButton) can be placed on toolbars, TToolButton utilizes special toolbar features to simplify the configuration of buttons and offers added display options such as pop-up borders and transparency.

To place tool buttons on a toolbar at design time, select the toolbar, right-click, and choose New Button.

TButton TSpeedButton HowToUseStdCtrls
FToolBar
- local variable indicating in which toolbar this button lives
CopyPropertiesFromMenuItem
- method for copying the properties of the corresponding Menu Item, to ensure that ToolButton and MenuItem produce the same behaviour
GetActionLinkClass
- returns the Class of the ActionLink for this ToolButton
TControl.GetActionLinkClass
ActionChange
- a method for changing the action associated with the Button
TControl.ActionChange
AssignTo
calls inherited method: if the destination is of correct type, copies ImageIindex to destination and sets it Checked
TPersistent.AssignTo TControl.AssignTo
BeginUpdate
- start the update process
EndUpdate
- finish the update process
TComponent.Loaded
RefreshControl
- refreshes the drawing of the tool, in case changes have been made
SetToolBar
- records the existence of a new toolbar
UpdateControl
- brings the control up to date
UpdateVisibleToolbar
- updates just the visible part of the toolbar
GroupAllUpAllowed
- returns True if all buttons in a group are allowed to ne 'Up'
Create
- constructor for TToolButton: calls inherited Create and sets initial bounds and style
TComponent.Create TGraphicControl.Create
CheckMenuDropdown
- returns True if there is a checked dropdown menu
GetCurrentIcon
- finds the icon for the current button
Index
- the sequence number of the current button in the list of buttons
AllowAllUp
- if True, all buttons are allowed to be 'Up' at the same time. Default False
Is this button Down (ie has it been selected)? Default false
A DropDownMenu that appears when this button is selected

A DropDownMenu that appears when this button is selected

It uses the same code as a TPopupMenu, and offers a series of additional menu choices.

Is this button a member of a group? Default false

Is this button a member of a group?

This would mean behaviour similar to the radio buttons in a TRadioGroup, where only one button in the group can be selected, or the check boxes in a TCheckGroup where more than one item can be selected but the members of the group interact in some way.

ImageIndex
- the index value of the image from the imagelist to be used with this button
Indeterminate
- if True, this button is in an unspecified state. Default False
Is this button Marked (ie has it been selected)? Default false
The item on the Main Menu with which this tool button is associated

The item on the Main Menu with which this tool button is associated

Typically, the buttons on the toolbar would each point to an entry on the menu action list, which could also be accessed by using the Main Menu

Has this button been wrapped to the next row?
Determines the style of the tool button.
See TToolButtonStyle for the possible Style values.
TToolBarFlag
- enumerated type for flags denoting status of ToolBar
TToolBarFlags
- set of TToolBarFlag
CheckMenuDropdown
- returns True if there is a checked dropdown menu
ClickButton
- software emulation of the OnClick event
FindButtonFromAccel
- returns the Button corresponding to the specified accelerator key
RepositionButton
- method for re-positioning a button
RepositionButtons
- method for re-positioning several buttons
WrapButtons
- returns True if changing to NewHeight and NewWidth causes wrapping of buttons
Create
- constructor for TToolBar: calls inherited Create and sets many formatting and size defaults

Create - constructor for TToolBar: calls inherited Create and sets many formatting and size defaults

Among the variables initialised and defaults set are the list of buttons, button width and height, style, indentation, alignment, links for image change, the bounds and the edge borders

TComponent.Create
Destroy
- destructor for TToolBar: frees buttons and links then calls inherited Destroy
TComponent.Destroy TCustomControl.Destroy
BeginUpdate
- starts the update process
EndUpdate
- finishes the update process
SetButtonSize
- stores new values for height and width
ButtonCount
- the number of buttons on the ToolBar
Lists the tool buttons (TToolButton) in the toolbar.

Buttons maintains a list of TToolButton instances. All tool buttons that share a TToolBar parent have the same height and (except for separators and dividers) the same width. Other controls on a toolbar are held in place by invisible separators, which are automatically created and destroyed.

To add tool buttons to the toolbar at design time, select the toolbar, right-click, and choose New Button. To create a space (separator) between one button and the next, select New Separator. To create a divider between buttons, add a button and set its Style propery to tbsDivider. Other controls may be added to the toolbar directly from the Component palette.

ButtonList
- the list of Buttons (as a TList)
RowCount
- the number of Rows of Buttons
ButtonHeight
- the height of the buttons
ButtonWidth
- the width of the buttons
The Images on the Image List that are NOT selected for display
EdgeBorders
- which borders form th eedge
EdgeInner
- this toolbar has an inner edge
EdgeOuter
- this toolbar has an outer edge
Should the toolbuttons be displayed Flat (rather than in relief)? Default false
The Images on the Image list that are selected for display
The Images to be displayed on the buttons
Indent
- the amount by which the buttons should be indented Default is 1
Should the contents of the toolbar be displayed as a List? Default false
ShowCaptions
- should the captions be shown for the buttons? (Default False)
Is the ToolBar to be Transparent? Default False
Wrapable
- enables wrapping buttons to the next row if there are too many for the current row
TTrackBarOrientation
- enumerated type denoting horizontal or vertical orientation for TrackBar
TTickMark
- enumerated type denoting position of tick marks relative to the TrackBar
TTickStyle
- enumerated type denoting style of tick marks
TTrackBarScalePos
- enumerated type denoting position of the scale for a TrackBar
TCustomTrackBar
- the base class for TTrackBar

TCustomTrackBar defines many of the properties inherited by TTrackBar, a device that allows the user to determine the value of a variable using a quasi-analog slider

ApplyChanges
- implement any pending changes
DoChange
- system message to implement changes
Create
- constructor for TCustomTrackBar: calls inherited Create then initialises style, position, size and bounds
TComponent.Create TWinControl.Create
SetTick
- set the interval for ticks on the taskbar (integer)
Frequency
- how frequently the position of the slider is to be read and updated (currently unsupported)
Line-Size
- increment for slider position when an arrow key is pressed
Max
- the value corresponding to full movement of the slider. Default = 10
Min
- the value associated with the minimum slider position. Default = 0
OnChange
- action to be taken on change in the slider position
Orientation
- horizontal or vertical
PageSize
- increment for slider position when PageUp or PageDown key is pressed
Position
- the location of the slider along the track bar. Represents the Return value from the control
ScalePos
- whether scaling label appears at top, bottom, left or right
Tickmarks
- whether the ticks are above/left, below/right, or both
Tickmarks
- where the ticks appear relative to the bar: above/left, below/right, or both
TickStyle
- none, produced automatically, or calculated manually
TTrackBar
: a device which allows the user to determine the value of a variable using a quasi-analog slider

TTrackBar: a device which allows the user to determine the value of a variable using a quasi-analog slider

The device looks like a slider-potentiometer control on a hi-fi amplifier, and consists of a slider which can be moved along a bar using the mouse. Tick marks can be displayed along one or both edges, giving an indication of the proportion of the maximum value of the controlled variable that is being selected.

The Position property indicates the distance along the bar that the slider has been placed, either by the program or by mouse capture and movement

In the example, movement of the slider is detected and shown in the associated TProgressBar.

HowToUseStdCtrls
TNodeState
- enumerated type denoting the status of a TreeNode

Cut, DropHilited, Focused, Selected, MultiSelected, Expanded, HasChildren, InTree, Deleting, Bound

TNodeStates
- set of TNodeState
TNodeAttachMode
- enumerated type denoting mode of attachment of TreeNodes

TNodeAttachMode - enumerated type denoting mode of attachment of TreeNodes

    naAdd,           // add as last sibling of Destination
        naAddFirst,      // add as first sibling of Destination
        naAddChild,      // add as last child of Destination
        naAddChildFirst, // add as first child of Destination
        naInsert,        // insert in front of Destination
        naInsertBehind   // insert behind Destination

TAddMode
- enumerated type containing a series of constants to determine the place where a node should be placed in a tree.

This sets consist of three values:

taAdd: Adds the node as the last child.

taAddFirst: Adds the node as the first child.

taInsert: Adds the node in front another node.

This set is used in TTreeNode.InternalMove and TTreeNodes.InternalAddObject

TTreeNodeArray
- pointer to a TTreeNode
ETreeNodeError
- exception type for errors arising from the code of TTreeNode
ETreeViewError
- exception type for errors arising from the code of TTreeView
A array of strings containings names for NodeAttachModes
This is a constant array of string containing names for the modes to attach a node.
An array of strings to store the names for the different TAddModes.
Type TAddMode = (taAddFirst, taAdd, taInsert);

Const AddModeNames: array[TAddMode] of string = ('taAddFirst', 'taAdd', 'taInsert');
A constant for the identifier of a LCL stream
TTVChangingEvent
- a generic event handling method for changing a specified Tree Node if AllowChange is True
TTVChangedEvent
- generic event handling method for a changed Tree Node
TTVEditingEvent
- generic event handling method for editing a specified node, if AllowEdit is True
TTVEditedEvent
- generic event handling method for a node that has been edited
TTVExpandingEvent
- generic event handling method for expanding a tree node, if AllowExpansion is True
TTVCollapsingEvent
- generic event handling method for collapsing a Tree Node if AllowCollapse is True
TTVExpandedEvent
- generic event handling method for a Tree Node that has been expanded
TTVCompareEvent
- generic event handling method for comparing two Tree Nodes
TTVCustomDrawEvent
- generic event handling method for Tree View custom drawing
TTVCustomDrawItemEvent
- generic event handling method for Tree View Item custom drawing
TTVAdvancedCustomDrawEvent
- generic event handler method for Tree View advanced custom drawing
TTVAdvancedCustomDrawItemEvent
- generic event handler method for Tree View Item advanced custom drawing
TTVCustomCreateNodeEvent
- generic event handling method for Tree View node creation
TTreeNodeCompare
- generic function to compare Tree Nodes: returns -1 if Node1 is less than Node2, zero if equal, +1 if Node1 is greater
A pointer to TTreeNodeInfo
TTreeNodeInfo
- record structure for (new) Tree Node information
A pointer to TDelphiNodeInfo
TDelphiNodeInfo
- record structure for Tree Node information (for Delphi compatability)
TTreeNode
is a single item that holds data in TTreeView
A TTreeNode is part of a TTreeView and is used for storing data. This can be done by using the Caption property or for more complex data the Data property can be used. Each node can have sibling or child items associated with it.
Create
- constructor for TTreeNode:
calls inherited Create then itntialises indexes and sets subtree count to 1
TObject.Create
AlphaSort
- if True, sorted alphabetically
Assign
- if Source is of correct type, copies details directly, otherwise calls inherited Assign which probably raises an exception
TPersistent.Assign
Collapse
- method for collapsing tree view to show only the main stems. Apply recursively if Recurse is True
CustomSort
- if True, the customised sort method specified in SortProc is to be used
DefaultTreeViewSort
- returns result of string comparison between names of Node1 and Node2

DefaultTreeViewSort - returns result of string comparison between names of Node1 and Node2

DefaultTreeViewSort compares the text of two TreeNodes and returns the following result:

< 0
  if Node1.Text<Node2.Text.
0
  if Node1.Text=Node2.Text.
> 0
  if Node1.Text>Node2.Text.

The comparision takes into account Ansi characters, i.e. it takes care of strange accented characters. Contrary to AnsiCompareText, the comparision is case sensitive.

Delete
the curent TreeNode
DeleteChildren
- remove the descendent Nodes in the tree structure
Destroy
- destructor for TTreeNode: unbinds all references, frees data and calls inherited Destroy
TPersistent.Destroy
DisplayExpandSignLeft
- returns the position of the left edge of the expand sign
DisplayExpandSignRect
- returns the coordinates of the rectangle within which the expand sign are displayed
DisplayExpandSignRight
- returns the position of the right edge of the expand sign (ie takes into account the width of the icon etc)
DisplayIconLeft
- returns the position of the actual icon for the expand sign (usually 1 pixel greater than DisplayExpandSignLeft)
DisplayRect
- returns the coordinates of the rectangle containing the current entry; if TextOnly is True, returns the coordinates for the text
DisplayStateIconLeft
- returns the position of the State Icon
DisplayTextLeft
- returns the position of the left edge of the text
DisplayTextRight
- returns the position of the right edge of the text
EditText
(currently set False - to be implemented)
EndEdit
(to be implemented)
Expand
- method for expanding the current node. If Recurse is True, also expand all descendent nodes
ExpandParents
- apply expansion to the parents of the current node
Bottom
- returns the position of the displayed tree structure (whether or not it is expanded)
BottomExpanded
- returns the position of the bottom of the fully expanded tree structure
GetParentNodeOfAbsoluteLevel
- returns the parent of all nodes at this absolute level
GetFirstChild
- returns the first child node of this parent
GetHandle
- returns the operating system Handle for the current node
GetLastSibling
- returns the last node at the same level as the current node
GetLastChild
- returns the last child node of this parent
GetLastSubChild
- returns the last sub-child node of this parent
GetNext
- returns the next node in the list
GetNextChild
- returns the next child node of the parent specified by AValue
GetNextExpanded
- returns the next expanded node
GetNextMultiSelected
- returns the next node in a multiselection
GetNextSibling
- returns the next node in the same level as the current node
GetNextVisible
- returns the next visible (ie not hidden) node
GetPrev
- returns the previous node in the list
GetPrevChild
- returns the previous child node of the parent specified by AValue
GetPrevExpanded
- returns the previous expanded node
GetPrevMultiSelected
- returns the previous node in a multi-selection
GetPrevSibling
- returns the previous node in the same level as the current node
GetPrevVisible
- returns the previous visible (not hidden) node
HasAsParent
- returns True if the node specified by AValue has a parent
IndexOf
- returns the index of the node specified by AValue
IndexOfText
- returns the index of the node containing the specified Text string
FindNode
- returns the node containing the specified text string
MakeVisible
- method for rendering a node visible
MoveTo
- method for relocating a node to the specified Destination using the specified mode of attachment

MoveTo - method for relocating a node to the specified Destination using the specified mode of attachment

Definition of the modes of attachment:

        naAdd,           // add as last sibling of Destination
        naAddFirst,      // add as first sibling of Destination
        naAddChild,      // add as last child of Destination
        naAddChildFirst, // add as first child of Destination
        naInsert,        // insert in front of Destination
        naInsertBehind   // insert behind Destination

MultiSelectGroup
- method for multi-selecting a group of nodes
Update
the contents and appearance of the curent node
ConsistencyCheck
- makes sure all references to and from the node are consistent
WriteDebugReport
- for debugging. If Recurse is True, report for all descendants as well
AbsoluteIndex
- the absolute index of the current node, ie without taking into account the level of ancestry
Count
- the number of nodes
Cut
- whether the node has been Cut
Property of type pointer used to store custom data in a node.
Data
- pointer to th eNode's data
Deleting
- if True, the node is being deleted
Focused
- if True, the node has received focus
DropTarget
- if True, the current node is a target for a drop process
Expanded
- if True, the node has been expanded
Handle
- the operating system handle for this node
HasChildren
- if true, this node has descendent nodes
The Height of the current node
ImageIndex
- the index of the image associated with the current node. Default -1 if no image
The Index value of the current node
IsVisible
- if True, the current node is visible (not hidden)
IsFullHeightVisible
- if True, the full height of the TreeNode is visible within the display window
Items
- the index of the current node within the list of items
The Level of descendance of indentation of the current node
MultiSelected
- if True, several nodes have been selected simultaneously (eg using the Shift or Ctrl key while selecting)
OverlayIndex
- the index of the overlay
The Owner control of the current TreeNode
The Parent of the current node
Selected
- if True, the current node has been selected
SelectedIndex
- the index of the current node if selected: default - if not selected
SubTreeCount
- the number of sub-trees
StateIndex
the index of the state (within an enumerated type)

StateIndex the index of the state (within an enumerated type)

Definition of enumerated type NodeState:

nsCut, nsDropHilited, nsFocused, nsSelected, nsMultiSelected, nsExpanded, nsHasChildren, nsInTree, nsDeleting, nsBound

The Text string of the current node
the collection of TreeNodes to which this node belongs
The TreeView to which this node belongs
The position of the Top of the current node
PNodeCache
- pointer to TNodeCache
TNodeCache
- a cache (temporary storage record) for a TTreeNode and its index
A collection or list of TTreeNode
InternalAddObject
- method for adding text of data within the structure of the current node; returns the value of the new updated node
GetCount
- returns the number of nodes in the collection
SetItem
- method for recording details of specified node
SetUpdateState
- records status of update process
Create
- constructor for TTreeNodes: calls inherited Create
TObject.Create
Destroy
- destructor for TTreeNodes: calls inherited Destroy
TPersistent.Destroy
Add
- adds a sibling node with specified text string, and returns the new node
AddChild
- adds a child node with specified text to the parent node, and returns the new node
AddChildFirst
- adds a node with specified text as the first child of the parent node, and returns the new node
AddChildObject
- adds a child node with specified text and data-pointer to the parent node and returns the new node
AddChildObjectFirst
- adds a node with specified text and data as the first child of the parent node, and returns the new node
AddFirst
- adds a node with specified text as the first node in the same level as SiblingNode. and returns the new node
AddObject
- adds a node with specified text and data-pointer in the same level as SiblingNode. and returns the new node
AddObjectFirst
- adds a node with specified text and data-pointer as the first node in the same level as SiblingNode. and returns the new node
Assign
- if Source is of correct type, copies properties directly, otherwise calls inherited Assign which probably raises an exception
TPersistent.Assign
BeginUpdate
- start the update process
Clear
the current node
ClearMultiSelection
- clears a series of nodes in a multi-selection (provided the selection has not already been cleared)
IsMultiSelection
- returns True if this node is part if a multi-selection
Delete
this node
EndUpdate
- finish the update process
GetFirstNode
- returns the first node in the collection
GetLastNode
- last top level node
GetLastSubNode
- absolute last node
GetLastExpandedSubNode
- absolute last node
FindTopLvlNode
- returns a top level node containing the specified text string
Insert
a node with the specified text just before the specified Next node, and returns the new node
InsertObject
- inserts a new node with specified text and data just before the specified Next node, and returns the new node
InsertBehind
- inserts a new node with specified text just behind specified Previous node, and returns the new node
InsertObjectBehind
- inserts a new node with specified text and data-pointer just behind specified Previous node, and returns the new node
ConsistencyCheck
- makes sure all references to and from the nodes are consistent
WriteDebugReport
- for debugging
Count
- the number of nodes in the collection
KeepCollapsedNodes
- if True, preserves the nodes that have been collapsed
Owner
- the TTreeView that owns the collection of nodes
TopLvlCount
- the number of nodes at the top level of the tree structure
TopLvlItems
- the list of nodes at the top level of the tree structure
TTreeViewState
- enumerated type containing the permissible values for state of a TTreeView

TTreeViewState - enumerated type containing the permissible values for state of a TTreeView

    tvsScrollbarChanged,
        tvsMaxRightNeedsUpdate,
        tvsTopsNeedsUpdate,
        tvsMaxLvlNeedsUpdate,
        tvsTopItemNeedsUpdate,
        tvsBottomItemNeedsUpdate,
        tvsCanvasChanged,
        tvsDragged,
        tvsIsEditing,
        tvsStateChanging,
        tvsManualNotify,
        tvsUpdating,
        tvsPainting,
        tvsMouseCapture,
        tvsWaitForDragging,
        tvsDblClicked,
        tvsTripleClicked,
        tvsQuadClicked,
        tvsSelectionChanged

TTreeViewStates
- set of TTreeViewState
TTreeViewOption
- enumerated type containing the permissible values for Options in TreeViews

TTreeViewOption - enumerated type containing the permissible values for Options in TreeViews

    tvoAllowMultiselect,
        tvoAutoExpand,
        tvoAutoInsertMark,
        tvoAutoItemHeight,
        tvoHideSelection,
        tvoHotTrack,
        tvoKeepCollapsedNodes,
        tvoReadOnly,
        tvoRightClickSelect,
        tvoRowSelect,
        tvoShowButtons,
        tvoShowLines,
        tvoShowRoot,
        tvoShowSeparators,
        tvoToolTips,
        tvoNoDoubleClickExpand

TTreeViewOptions
- set of TTreeViewOption
A set of TreeViewOptions which are set be default.

A series of defaults used to set the options of a TreeView object when first placed on a form. This set consists of the following items:

    tvoShowRoot,
        tvoShowLines,
        tvoShowButtons,
        tvoHideSelection,
        tvoToolTips,
        tvoKeepCollapsedNodes,
        tvoAutoItemHeight

For the meaning of these options, see the documentation of TTreeView.

TTreeViewExpandSignType
- enumerated type for specifying the symbol type to appear in treeviews to denote whether or not the node is expanded: either a +- sign or an arrow
TCustomTreeView
- ancestor class for TTreeView

TCustomTreeView - ancestor class for TTreeView, which displays a collection of items in a hierarchical tree form. This class defines many properties which are inherited by children classes, including loading the data from files or streams, saving to files or streams, updating, sorting alphabetically, editing, making visible or invisible, expanding or collapsing the tree display, and many more.

Please note that Accessibility support in TCustomTreeView might make this control slower if there is a very large number of items, for example, 10.000+ items. If the performance impact is unacceptable it is possible to turn accessibility off for tree view items by setting TCustomTreeView.AccessibilityOn to false. The default value is true.

SetHotTrack
- specifies the status of HotTrack
FChangeTimer
- local variable to act as timer for changes
CanChange
- returns True if a given TreeNode can be changed
CanCollapse
returns True if a given TreeNode is able to be collapsed
CanEdit
- returns True if a Given TreeNode is allowed to be edited
CanExpand
- returns True if the specified TreeNode can be expanded
CreateNode
- creates a new node in a TreeView and returns its content
CustomDraw
- returns True if Custom Drawing is proceeding in the specified Rectangle

CustomDraw - returns True if Custom Drawing is proceeding in the specified Rectangle

Stage indicates whether PrePaint, PostPaint, PreErase or PostErase

Progress
CustomDrawItem
- returns True if Custom Image drawing is proceeding at the specified TreeNode

CustomDrawItem - returns True if Custom Image drawing is proceeding at the specified TreeNode

State denotes one of Selected, Grayed, Disabled, Checked, Focused, Default, Hot, Marked or Indeterminate

Stage indicates whether PrePaint, PostPaint, PreErase or PostErase

If PaintImages is True, Images should be painted as well as text

GetMaxLvl
- returns the maximum level of branching of the tree structure
GetMaxScrollLeft
- returns maximal extent of scrolling to the left
GetMaxScrollTop
- returns the maximal extent of scrolling upwards
GetNodeAtInternalY
- returns the node at the specified internal (ie relative) Y coordinate
GetNodeAtY
- returns the node at the specified (absolute) Y coordinate
GetNodeDrawAreaHeight
- returns the height for the area in which node is drawn
GetNodeDrawAreaWidth
- returns the width for the area in which node is drawn
IsCustomDrawn
- returns True if the specified target node is custom drawn
IsNodeVisible
- returns True if the specified node is visible
IsNodeHeightFullVisible
- returns True if the full height of the specified node is visible in the current view
IsInsertMarkVisible
- returns True if an Insert mark is visible
Change
- software emulation of the OnChange event
Collapse
- software emulation of the OnCollapsed event
Delete
- remove the specified node from the tree structure (software emulation of the OnDeletion event)
DoPaint
- perform the actual painting
DoPaintNode
- perform the actual painting of the specified node
EndEditing
- finish editing
EnsureNodeIsVisible
- method to make sure specified node is visible
Expand
the specified node
GetImageIndex
- returns the index of the image associated with the specified node
GetSelectedIndex
- returns the index of the selected node
SetOptions
- specifies the options for the TreeView
UpdateDefaultItemHeight
- brings the value of the default item height up-to-date
UpdateInsertMark
- see if there is an insert mark at X,Y and put one in if necessary
DoSelectionChanged
- perform the code required for a change in selection
WMHScroll
- LCL Message for horizontal scroll
WMVScroll
- LCL Message for Vertical scroll
Allows to turn accessibility off to speed up the control
This property is provided for the case when a tree view contains a huge amount of items, lets say 10.000+. In this case accessibility might slow the tree down, so turning this property off might make things faster.
AutoExpand
- if True, the tree structure is automatically expanded when a node is selected
HideSelection
- if True, the selected part of the tree is to be hidden
HotTrack
- the property whereby the item under the mouse pointer becomes emphasised
TCustomListView.HotTrack
Images
- the ImageList to be used in association with the list of TreeNodes
Indent
- the amount by which each successive level of branching is to be indented in the tree structure
Items
- the collection of TreeNodes that comprise the TreeView
OnAdvancedCustomDraw
- event handler for advanced custom drawing
OnAdvancedCustomDrawItem
- event handleer for advanced custom drawing item
OnChange
- specialised event handler for a change in the TreeView
OnChanging
- specialised event handler while TreeView is being changed
OnCollapsed
- specialised event handler when part of the tree is collapsed
OnCollapsing
- specialised event handler while part of the tree is being collapsed
OnCompare
- specialised event handler for comparisons within the TreeView
OnCustomCreateItem
- event handler for custom item creation
OnCustomDraw
- event handler for custom drawing
OnCustomDrawItem
- event handler for custom drawing item
OnDeletion
- specialised event handler for deletion of node(s) from the tree
OnEdited
- specialised event handler when the TreeView has been edited
OnEditing
- specialised event handler while a TreeView is being edited
OnExpanded
- specialised event handler when a TreeView has been expanded
OnExpanding
- specialised event handler while a TreeView is being expanded
OnGetImageIndex
- event handler for finding the index of an image
OnGetSelectedIndex
- event handler for finding index of selected item
OnSelectionChanged
- event handler for a change in the selection
ReadOnly
- if True, the TreeView can only be observed, and not Written to or changed. Default False
RightClickSelect
- if True, a Right Click selects an Item. Default False
RowSelect
- if True, a row is selected
ScrolledLeft
- the position of the tree when fully scrolled to the left
ScrolledTop
- th eposition of th etree when fully scrolled to the top
ShowButtons
- if True, buttons are displayed
ShowLines
- show the connecting lines of the tree structure
ShowRoot
- if True, the root of the tree structure is displayed
ShowSeparators
- if True, separators are shown between items
SortType
- the way the items are to be sorted: None, by Data, by Text or Both
StateImages
- the list of images to denote state of the tree (expanded, contracted etc)
ToolTips
- if True (default), pop-up tool tips are to be shown
Create
- constructor for TCustomTreeView: calls inherited Create then sets defaults for style, size, etc

Create - constructor for TCustomTreeView: calls inherited Create then sets defaults for style, size, etc

Among the variables initialised and defaults set are:

size, colour, the symbols for expansion etc, the border style and width, scroll bars, options, indentation, timers, action links

TComponent.Create TCustomControl.Create
Destroy
- destructor for TCustomTreeView: frees images, nodes and links, then calls inherited Destroy
TComponent.Destroy TCustomControl.Destroy
If True, sort alphabetically
ConsistencyCheck
- check that indexes of treenodes match those of images etc
CustomSort
- if True, an external sorting method specified by SortProc is to be used
GetHitTestInfoAt
- returns the result of a hit test at the point (X, Y)
GetNodeAt
- returns the TreeNode at position (X. Y)
GetInsertMarkAt
- find if there is an insert mark at the specified coordinates
SetInsertMark
- place an Insert mark at the specified node in the tree
SetInsertMarkAt
- place an insert mark at the specified coordinates
IsEditing
- returns True if editing is in progress
BeginUpdate
- start the update of the display
EndUpdate
finishes updating the display
FullCollapse
- method to collapse the treeview fully, ie show just the root
FullExpand
- method to expand the treeview fully, and show all the branches
LoadFromFile
- load the data from the specified file
LoadFromStream
- load data from the specified stream
SaveToFile
- saves the data to the specified file
SaveToStream
- save the data to the specified stream
WriteDebugReport
- used for debugging
LockSelectionChangeEvent
- if the selection has changed, lock its status
UnlockSelectionChangeEvent
- unlock a selection to allow it to be changed
GetFirstMultiSelected
- returns the first node from a multiple selection
SelectionVisible
- returns True if a selection is visible
MakeSelectionVisible
- method for making a selection visible
BackgroundColor
for the treeview
BottomItem
- the last item on the list
DefaultItemHeight
- default height for items on the list
DropTarget
- the target node for dropping a dragged item
ExpandSignType
- the symbols to denote whether a list is expanded or collapsed; default is plus or minus
InsertMarkNode
- place a marker on the specified node
InsertMarkType
- the type of marker to be inserted
KeepCollapsedNodes
- if True, the collapsed nodes are to be retained
The set of Options for displaying the tree view

The set of Options for displaying the tree view

List of available options:

    tvoAllowMultiselect,
        tvoAutoExpand,
        tvoAutoInsertMark,
        tvoAutoItemHeight,
        tvoHideSelection,
        tvoHotTrack,
        tvoKeepCollapsedNodes,
        tvoReadOnly,
        tvoRightClickSelect,
        tvoRowSelect,
        tvoShowButtons,
        tvoShowLines,
        tvoShowRoot,
        tvoShowSeparators,
        tvoToolTips,
        tvoNoDoubleClickExpand

ScrollBars
- the style of scroll bars for the treeview display
The Selected tree nodes
SelectionColor
- the colour to be used for the selected nodes, to distinguish them from the others
SeparatorColor
- the colour to be used for separators
TopItem
- the first visible node of the tree

Use TopItem to get the topmost visible node. It is usually needed when tree view contains many nodes and scroll bar is requred to display them all. If you need the first node of the tree regardless of visibility use Items[0]

Items GetNodeAtY
TreeLineColor
- the colour to be used for the lines showing the tree structure
ExpandSignColor
- the colour to be used for the expand/collapse symbols
TTreeView
is a control that displays a hierarchical list of items
Use a TTreeView to display a hierarchical list of items. Items are shown by their caption and an optional bitmap.
AutoExpand
- automatically expand the tree when an item is selected
HideSelection
- the selected items are to be hidden
HotTrack
- the property whereby the item under the mouse pointer becomes emphasised
TCustomListView.HotTrack
The Bitmap image associated with each item in the display
Indent
- the amount by which each successive branching level is to be indented
OnEditing
- event handler during the editing process
TTreeNodeExpandedState
- class to store and restore the expanded state of a TTreeView. The nodes are identified by their Text property.

TTreeNodeExpandedState - class to store and restore the expanded state of a TTreeView. The nodes are identified by their Text property.

Usage example:

    // save old expanded state
          OldExpanded:=TTreeNodeExpandedState.Create(ATreeView);
          ... change a lot of nodes ...
          // restore old expanded state
          OldExpanded.Apply(ATreeView);
          OldExpanded.Free;

NodeText
- the text in the current node
Children
- the children of the current node, as an AvgLvlTree
Create
- constructor for the rest of the tree structure
Clear
the nodes from the tree structure
CreateChildNodes
- constructor for the offspring nodes
Apply
- begin reconstructing the tree structure by inserting the first node
Apply
- continue reconstructing the tree structure by adding the remaining nodes in succession
Function to compare the node text of two nodes.

This function does an ANSICompare on the NodeText of two nodes. The parameters Data1 and Data2 are pointers to the nodes to be compared. The result is the same is the result from ANSICompareText.

-1: The nodetext from the first node is lower then the nodetext from the second.

0: The nodetext-s from both nodes are equal.

1: The nodetext from the first node is higher then the nodetext from the second.

Function to compare the given text with the nodetextof the specified node.

This function does an ANSICompare on the NodeText of two nodes. The parameters Data1 and Data2 are pointers to the nodes to be compared. The result is the same is the result from ANSICompareText.

-1: The given text is lower then the nodetext from the given node.

0: The given text is equal to the nodetext from the given node.

1: The given text is higher then the nodetext from the given node.

Function InitCommonControl
Implemented for Delphi compatibility, always returns true;
Procedure CheckCommonControl.
Implemented for Delphi compatibility. Procedure does not execute any code.
Procedure used to register the components.
TCustomHeaderControl
- base class for THeaderControl, a header strip of user-designed sections which allow selection of pages or actions

TCustomHeaderControl - base class for THeaderControl, a header strip of user-designed sections which allow selection of pages or actions

THeaderControl offers a widget that could be placed along the edge of a Panel or Form, allowing a highly customised mechanism for selection. However, there are no intrinsically associated display areas, and it is the developer's responsibility to supply an index associated with the selection from the THeaderControl and determining what action is to occur or what is to be displayed in any attached Panel or Form.

Multi-PageControls
THeaderControl
, a header strip of user-designed sections which allow selection of pages or actions

THeaderControl, a header strip of user-designed sections which allow selection of pages or actions

THeaderControl offers a widget that could be placed along the edge of a Panel or Form, allowing a highly customised mechanism for selection. However, there are no intrinsically associated display areas, and it is the developer's responsibility to supply an index associated with the selection from the THeaderControl and determine what action is to occur or what is to be displayed in any attached Panel or Form.

THeaderControl is used by selecting its icon from the Common Controls tab of the IDE Component Palette, and placing it on the Form in the desired position. It may be convenient to dock it with a Form or Panel whose properties it is to be used for controlling.

After size, position, docking, alignment, anchoring etc have been performed using the Object Inspector or Form Designer, the Sections of the Header can be created by selecting the control, right-clicking with the mouse and choosing 'Section Editor'. A Stringlist editor will pop up, with options to add, delete or move entries up or down the list. Each entry is given an Index which can be used in OnClick event handlers to determine the action to be taken when that section is selected at run-time.

Multi-PageControls
PaintSection
- method for painting the current section (specified by Index) of the Header
GetSectionAt
- find the index for the section located at point P
Destroy
- destructor for TCustomHeaderControl: frees sections then calls inherited Destroy
TComponent.Destroy TCustomControl.Destroy
Create
- constructor for TCustomHeaderControl: calls inherited Create, creates the sections and initialises style and bounds
TComponent.Create TCustomControl.Create
DragReorder
- find out if the sections are allowed to be re-ordered by dragging
Images
- the list of Images available for selection using this tool
Sections
- the short segments of the header, separated by vertical bars, that function as the elementary selection units of the header
OnSectionDrag
- event handler for dragging the section of header
OnSectionEndDrag
- event handler for ending the drag process for this section
OnSectionClick
- event handler for mouse click on this section of header
OnSectionResize
- event handler for re-sizing this section of the header
OnSectionTrack
- event handler for tracking this section
OnSectionSeparatorDblClick
- event handler for double-click on the separator between sections
IndexOfTabWithCaption
- returns the index value of the tab that has the specified Caption
THeaderSections
- a collection of Items ot type THeaderSection, the individual parts of a THeaderControl
AddItem
- adds a HeaderSection to the Header at the position specified by Index
Items
- the series of individual HeaderSections in the collection
THeaderSection
- the individual sections of a THeaderControl, each of which can be used to control its own option, selection etc
Create
- constructor for THeaderSection:
calls inherited Create then initialises state, visibility, alignment, size and Index
TCollectionItem.Create
Assign
- if Source is of correct type, copies properties directly, otherwise calls inherited Assign which probably raises an exception
TPersistent.Assign
The position of the left boundary of the section
The position of the right boundary of the section
State
- whether normal, hot (ie mouse hovers over it, ready to be selected) or pressed (selected)
Alignment
- whether text is to be left or right justified or centered
Index of the image in the imagelist
Maximum permissable width of a section
Minimum permissable width of a section (default = 0)
The text string that is to appear in the section
The Width of the section that appears on the THeaderControl
OriginalIndex
- index which doesn't change when the user reorders the sections
Update
checks if update is in fact required, then calls inherited method
TCollection.Update
OnCreateSectionClass
- event handler for creating a new section class
ToolTips
- whether Popup tool tips are to be shown
Clear
- the stringlist
FindCaption
- search for and return the list item that contains the nominated caption

FindCaption- search for and return the list item that contains the nominated caption

Starting from item with StartIndex

Looking for the string Value

Partial, Inclusive, Wrap, PartStart: Boolean arguments allowing matches with part of the string, permitting the string to wrap over a line, etc

GetItemAt
- find and return the list item at the specified coordinates
GetControlClassDefaultSize
returns its own defaults, overriding inherited values
TControl.GetControlClassDefaultSize
GetControlClassDefaultSize
returns its own defaults, overriding inherited values
TControl.GetControlClassDefaultSize
GetControlClassDefaultSize
- returns its own defaults, overriding the inherited values
TControl.GetControlClassDefaultSize
GetControlClassDefaultSize
returns its own defaults, overriding inherited values
TControl.GetControlClassDefaultSize
GetOwner
returns a HeaderControl, overriding inherited value
TPersistent.GetOwner
TSectionTrackState
- enumerated type for tracking the state of a header section
Checked
- if True, a check mark is present beside the item, implying it has been selected
The position of the Left side of the list item
The ListView in which this Item is fould
The coordinates of the position where the ListItem is located
The position of the Top of this ListItem
FindCaption
- returns the ListItem with the specified caption at the given starting place.
HideSelection
- render the selected items invisible
CalculatePreferredSize
calls inherited method then supplies its own values if any are missing
TControl.CalculatePreferredSize
CreatePanel
- returns a created Status Panel
CreatePanels
- returns a set of created panels
GetPanelClass
- returns a class of status panel
DoSetApplicationHint
- specifies a hint string and returns True if successful
DoHint
- shows the hint and returns True if successful (uses OnHint event handler)
ExecuteAction
: if required action is a Hint-related, sets the Hint in place, otherwise calls inherited method
TComponent.ExecuteAction
SizeGripEnabled
- returns True if the size-grip (an area at the bottom of the statusbar where a mouse can grip to change the size) is enabled
AutoHint
- if True, a hint is automatically shown when mouse hovers over status bar. Default False
SizeGrip
- an area at the bottom of the statusbar where a mouse can grip to change the size: True if this is working
Event handler for creating a StatusBar Panel class
Client cannot be added to TPageControl itself but new TabSheet should be added and client placed onto it
DoAddDockClient
creates a new TabSheet in the PageControl, places the client on it and aligns it
TWinControl.DoAddDockClient
DoRemoveDockClient
- frees the page which is being undocked
TWinControl.DoRemoveDockClient
PositionDockRect
converts client coordinates to screen coordinates, then places the docking rectangle at the calculated position
TControl.PositionDockRect
DisplayRect
- returns the coordinates of a rectangle for displaying the current item

DisplayRect - returns the coordinates of a rectangle for displaying the current item

Display codes can be: drBounds, drIcon, drLabel, drSelectBounds

DisplayRectSubItem
- returns the coordinates of a display rectangle for a specified sub-item

DisplayRectSubItem - returns the coordinates of a display rectangle for a specified sub-item

Display codes can be: drBounds, drIcon, drLabel, drSelectBounds

WSCreateItems
- instruction to the Widget Set to create Items
FinalizeWnd
stores the list origin then calls inherited method
TWinControl.FinalizeWnd
GetControlClassDefaultSize
returns its own defaults, overriding inherited values
TControl.GetControlClassDefaultSize
GetButtonDrawDetail
- find theme information for Windows XP inplementations
GetControlClassDefaultSize
- returns its own defaults, overriding the inherited values
Control.GetControlClassDefaultSize
FontChanged
- method to cope with change in font
ParentFontChanged
- method for coping with change in parent font
DefaultTreeViewSort
- returns result of string comparison between names of Node1 and Node2

DefaultTreeViewSort - returns result of string comparison between names of Node1 and Node2

DefaultTreeViewSort compares the text of two TreeNodes and returns the following result:

< 0
  if Node1.Text<Node2.Text.
0
  if Node1.Text=Node2.Text.
> 0
  if Node1.Text>Node2.Text.

The comparision takes into account Ansi characters, i.e. it takes care of strange accented characters. Contrary to AnsiCompareText, the comparision is case sensitive.

CreateSection
- method for creating a header section
CreateSections
- method for creating a collection of header sections
SectionClick
- method for emulating the OnSectionClick event
SectionResize
- method for emulating the OnSectionResize event
SectionTrack
- method for emulating the OnSectionTrack event
SectionSeparatorDblClick
- method for emulating the OnSectionSeparatorDblClick event
SectionEndDrag
- method for emulating the OnSectionEndDrag event
SectionDrag
- method to emulate the OnSectionDrag event
UpdateState
- bring the state of the control up-to-date
GetControlClassDefaultSize
- returns its own defaults, overriding inherited values
TControl.GetControlClassDefaultSize
GetTextPath
- returns a string containing the path to the current node delimited by slash
Select Only This Node
FindNodeWithText
- returns a node containing the specified text string
FindNodeWithData
- returns a node containing the specified data pointer
SortTopLevelNodes
- sorts the top level nodes, using the specified comparison method
Item
- finds the node corresponding to the given index
TStatusPanelClass
- set of TStatusPanel
TSBCreatePanelClassEvent
- generic event handling procedure for creating a Status Bar panel class
TCustomDrawResultFlag
- enumerated type, a series of flags to signify the result of a drawing process
TCustomDrawResult
- set of TCustomDrawResultFlag
TDisplayCode
- enumerated type denoting how items are displayed
GetCheckedInternal
- returns True if item is internally checked
BeginUpdate
- start the update process
EndUpdate
- finish the update process
IsCustomDrawn
- returns True if a target has been custom drawn
CustomDraw
- performs custom drawing in the given rectangle, and returns True if successful
CustomDrawItem
- custom draws the specified item, and returns True if successful
CustomDrawSubItem
- custom draws the specified subitem, returning True if successful
IntfCustomDraw
- uses the interface to perform custom drawing and returns a result of drawing
OnCustomDraw
- event handler for custom drawing
OnCustomDrawItem
- event handler for custom drawing an item
OnCustomDrawSubItem
- event handler for custom drawing a subitem
OnAdvancedCustomDraw
- event handler for advanced custom drawing
OnAdvancedCustomDrawItem
- event handler for advanced custom drawing item
OnAdvancedCustomDrawSubItem
- event handler for advanced custom drawing subitem
SelectOnlyThis
- method for selecting only the indicated node
TreeLinePenStyle
- the pen style for drawing lines on the tree
THeaderSectionState
- enumerated type containing possible selection states for header
Visible
if True
THeaderSectionClass
- class of THeaderSection
SectionFromOriginalIndex
- the section as defined by the original (unchanged) index
TLVCustomDrawEvent
- generic event handler method for List View custom drawing
TLVCustomDrawItemEvent
- generic event handling method for List View item drawing
TLVCustomDrawSubItemEvent
- generic event handling method for List View subitem drawing
TLVAdvancedCustomDrawEvent
- generic event handling method for List View custom drawing
TLVAdvancedCustomDrawSubItemEvent
- generic event handling method for List View custom subitem drawing
TListViewFlag
- enumerated type (currently containing only one value) for List View flag
TListViewFlags
- set of TListViewFlag
TOldTreeNodeInfo
- record type (old version) for Tree Node information
TCustomSectionTrackEvent
- generic event handling method for custom tracking a header section
TSectionDragEvent
- generic event handling method for dragging a header section
TCustomSectionNotifyEvent
- generic event notification method for header section
TCustomHCCreateSectionClassEvent
- generic event handler method for custom creation of header control
DrawPanel
calls the OnDrawPanel event handler if assigned
LMDrawItem
- LCL message handler for drawing the item on the current canvas
Show/Hide caption
The ToolBar.ShowCaptions has precendence. Hiding will only work if ToolBar.List is true.