[Overview][Constants][Types][Classes][Procedures and functions][Index] |
[Properties (by Name)] [Methods (by Name)] [Events (by Name)]
TCustomTreeView - ancestor class for TTreeView
Source position: comctrls.pp line 2154
type TCustomTreeView = class(TCustomControl) |
||
protected |
||
|
||
procedure BeginAutoDrag; override; |
|
Start the AutoDrag process |
function DoDragMsg(); override; |
|
DoDragMsg generates system message to indicate object and position for dragging and returns Result of action |
function CanChange(); dynamic; |
|
CanChange - returns True if a given TreeNode can be changed |
function CanCollapse(); dynamic; |
|
CanCollapse returns True if a given TreeNode is able to be collapsed |
function CanEdit(); dynamic; |
|
CanEdit - returns True if a Given TreeNode is allowed to be edited |
function CanExpand(); dynamic; |
|
CanExpand - returns True if the specified TreeNode can be expanded |
function CreateNode; virtual; |
|
CreateNode - creates a new node in a TreeView and returns its content |
function CustomDraw(); virtual; |
|
CustomDraw - returns True if Custom Drawing is proceeding in the specified Rectangle |
function CustomDrawItem(); virtual; |
|
CustomDrawItem - returns True if Custom Image drawing is proceeding at the specified TreeNode |
function GetDragImages; override; |
|
Get the list of Images to be dragged - returned as a list |
function GetMaxLvl; |
|
GetMaxLvl - returns the maximum level of branching of the tree structure |
function GetMaxScrollLeft; |
|
|
function GetMaxScrollTop; |
|
|
function GetNodeAtInternalY(); |
|
|
function GetNodeAtY(); |
|
|
function GetNodeDrawAreaHeight; |
|
|
function GetNodeDrawAreaWidth; |
|
|
function IsCustomDrawn(); |
|
|
function IsNodeVisible(); |
|
|
function IsNodeHeightFullVisible(); |
|
|
function IsInsertMarkVisible; virtual; |
|
|
procedure Change(); dynamic; |
|
Change - software emulation of the OnChange event |
procedure Collapse(); dynamic; |
|
Collapse - software emulation of the OnCollapsed event |
procedure CreateParams(); override; |
|
CreateParams - create parameters for this windowed class |
procedure CreateWnd; override; |
|
Creates the Window |
procedure Delete(); dynamic; |
|
Delete - remove the specified node from the tree structure (software emulation of the OnDeletion event) |
procedure DestroyWnd; override; |
|
DestroyWnd - destroy the window for this control |
procedure DoEndDrag(); override; |
|
End the dragging process |
procedure DragOver(); override; |
|
Drag the control over the source; Accept determines if the dragged object will be accepted |
procedure DoPaint; virtual; |
|
DoPaint - perform the actual painting |
procedure DoPaintNode(); virtual; |
|
DoPaintNode - perform the actual painting of the specified node |
procedure DoStartDrag(); override; |
|
|
procedure EndEditing; |
|
|
procedure EnsureNodeIsVisible(); |
|
|
procedure Expand(); dynamic; |
|
|
procedure GetImageIndex(); virtual; |
|
|
procedure GetSelectedIndex(); virtual; |
|
|
procedure InitializeWnd; override; |
|
InitializeWnd - initialise the window for this control |
procedure Invalidate; override; |
|
Render this control non-valid |
procedure EraseBackground(); override; |
|
EraseBackground - remove all material from the background |
procedure KeyDown(); override; |
|
KeyDown - emulate the action of pressing the specified key (makes OnKeyDown respond) |
procedure Loaded; override; |
|
|
procedure MouseDown(); override; |
|
MouseDown - a procedure that allows the programmer to simulate a mouse button being down over the control, and initiates the same Action as that associated with the OnMouseDown event |
procedure MouseMove(); override; |
|
MouseMove - a procedure that allows the programmer to simulate a mouse being moved over the control, and initiates the same Action as that associated with the OnMouseMove event |
procedure MouseUp(); override; |
|
MouseUp - a procedure that allows the programmer to simulate a mouse button being Up over the control, and initiates the same Action as that associated with the OnMouseUp event |
procedure Notification(); override; |
|
|
procedure Paint; override; |
|
The default paint handler for the class |
procedure SetDragMode(); override; |
|
|
procedure SetOptions(); |
|
|
procedure UpdateDefaultItemHeight; virtual; |
|
|
procedure WndProc(); override; |
|
WndProc - message handler for the procedure of this window |
procedure UpdateInsertMark(); virtual; |
|
|
procedure DoSelectionChanged; virtual; |
|
|
procedure WMHScroll(); message; |
|
|
procedure WMVScroll(); message; |
|
|
procedure WMLButtonDown(); message; |
|
|
procedure WMNotify(); message; |
|
|
procedure Resize; override; |
|
Checks for changes and calls DoOnResize |
property AutoExpand: Boolean; [rw] |
|
AutoExpand - if True, the tree structure is automatically expanded when a node is selected |
property BorderStyle; |
||
property HideSelection: Boolean; [rw] |
|
HideSelection - if True, the selected part of the tree is to be hidden |
property HotTrack: Boolean; [rw] |
|
|
property Images: TCustomImageList; [rw] |
|
Images - the ImageList to be used in association with the list of TreeNodes |
property Indent: Integer; [rw] |
|
Indent - the amount by which each successive level of branching is to be indented in the tree structure |
property Items: TTreeNodes; [rw] |
|
Items - the collection of TreeNodes that comprise the TreeView |
property OnAdvancedCustomDraw: TTVAdvancedCustomDrawEvent; [rw] |
|
|
property OnAdvancedCustomDrawItem: TTVAdvancedCustomDrawItemEvent; [rw] |
|
|
property OnChange: TTVChangedEvent; [rw] |
|
OnChange - specialised event handler for a change in the TreeView |
property OnChanging: TTVChangingEvent; [rw] |
|
OnChanging - specialised event handler while TreeView is being changed |
property OnCollapsed: TTVExpandedEvent; [rw] |
|
OnCollapsed - specialised event handler when part of the tree is collapsed |
property OnCollapsing: TTVCollapsingEvent; [rw] |
|
OnCollapsing - specialised event handler while part of the tree is being collapsed |
property OnCompare: TTVCompareEvent; [rw] |
|
OnCompare - specialised event handler for comparisons within the TreeView |
property OnCustomCreateItem: TTVCustomCreateNodeEvent; [rw] |
|
|
property OnCustomDraw: TTVCustomDrawEvent; [rw] |
|
|
property OnCustomDrawItem: TTVCustomDrawItemEvent; [rw] |
|
|
property OnDeletion: TTVExpandedEvent; [rw] |
|
OnDeletion - specialised event handler for deletion of node(s) from the tree |
property OnEdited: TTVEditedEvent; [rw] |
|
OnEdited - specialised event handler when the TreeView has been edited |
property OnEditing: TTVEditingEvent; [rw] |
|
OnEditing - specialised event handler while a TreeView is being edited |
property OnExpanded: TTVExpandedEvent; [rw] |
|
OnExpanded - specialised event handler when a TreeView has been expanded |
property OnExpanding: TTVExpandingEvent; [rw] |
|
OnExpanding - specialised event handler while a TreeView is being expanded |
property OnGetImageIndex: TTVExpandedEvent; [rw] |
|
|
property OnGetSelectedIndex: TTVExpandedEvent; [rw] |
|
|
property OnSelectionChanged: TNotifyEvent; [rw] |
|
|
property ReadOnly: Boolean; [rw] |
|
ReadOnly - if True, the TreeView can only be observed, and not Written to or changed. Default False |
property RightClickSelect: Boolean; [rw] |
|
RightClickSelect - if True, a Right Click selects an Item. Default False |
property RowSelect: Boolean; [rw] |
|
|
property ScrolledLeft: Integer; [rw] |
|
|
property ScrolledTop: Integer; [rw] |
|
|
property ShowButtons: Boolean; [rw] |
|
|
property ShowLines: Boolean; [rw] |
|
|
property ShowRoot: Boolean; [rw] |
|
|
property ShowSeparators: Boolean; [rw] |
|
|
|
SortType - the way the items are to be sorted: None, by Data, by Text or Both |
|
property StateImages: TCustomImageList; [rw] |
|
|
property ToolTips: Boolean; [rw] |
|
ToolTips - if True (default), pop-up tool tips are to be shown |
public |
||
constructor Create(); override; |
|
|
destructor Destroy; override; |
|
|
function AlphaSort; |
|
If True, sort alphabetically |
procedure ConsistencyCheck; |
|
|
function CustomSort(); |
|
CustomSort - if True, an external sorting method specified by SortProc is to be used |
function DefaultTreeViewSort(); |
|
DefaultTreeViewSort - returns result of string comparison between names of Node1 and Node2 |
function GetHitTestInfoAt(); |
|
GetHitTestInfoAt - returns the result of a hit test at the point (X, Y) |
function GetNodeAt(); |
|
GetNodeAt - returns the TreeNode at position (X. Y) |
procedure GetInsertMarkAt(); |
|
|
procedure SetInsertMark(); |
|
|
procedure SetInsertMarkAt(); virtual; |
|
|
function IsEditing; |
|
IsEditing - returns True if editing is in progress |
procedure BeginUpdate; |
|
BeginUpdate - start the update of the display |
procedure EndUpdate; |
|
EndUpdate finishes updating the display |
procedure FullCollapse; |
|
FullCollapse - method to collapse the treeview fully, ie show just the root |
procedure FullExpand; |
|
FullExpand - method to expand the treeview fully, and show all the branches |
procedure LoadFromFile(); |
|
LoadFromFile - load the data from the specified file |
procedure LoadFromStream(); |
|
LoadFromStream - load data from the specified stream |
procedure SaveToFile(); |
|
SaveToFile - saves the data to the specified file |
procedure SaveToStream(); |
|
SaveToStream - save the data to the specified stream |
procedure WriteDebugReport(); |
|
WriteDebugReport - used for debugging |
procedure LockSelectionChangeEvent; |
|
LockSelectionChangeEvent - if the selection has changed, lock its status |
procedure UnlockSelectionChangeEvent; |
|
UnlockSelectionChangeEvent - unlock a selection to allow it to be changed |
function GetFirstMultiSelected; |
|
GetFirstMultiSelected - returns the first node from a multiple selection |
function SelectionVisible; |
|
SelectionVisible - returns True if a selection is visible |
procedure MakeSelectionVisible; |
|
MakeSelectionVisible - method for making a selection visible |
property BackgroundColor: TColor; [rw] |
|
BackgroundColor for the treeview |
property BorderWidth; |
|
Property to determine width of the window's border |
property BottomItem: TTreeNode; [rw] |
|
BottomItem - the last item on the list |
property DefaultItemHeight: Integer; [rw] |
|
DefaultItemHeight - default height for items on the list |
property DropTarget: TTreeNode; [rw] |
|
|
property ExpandSignType: TTreeViewExpandSignType; [rw] |
|
ExpandSignType - the symbols to denote whether a list is expanded or collapsed; default is plus or minus |
property InsertMarkNode: TTreeNode; [rw] |
|
InsertMarkNode - place a marker on the specified node |
property InsertMarkType: TTreeViewInsertMarkType; [rw] |
|
InsertMarkType - the type of marker to be inserted |
property KeepCollapsedNodes: Boolean; [rw] |
|
KeepCollapsedNodes - if True, the collapsed nodes are to be retained |
property Options: TTreeViewOptions; [rw] |
|
The set of Options for displaying the tree view |
property ScrollBars: TScrollStyle; [rw] |
|
ScrollBars - the style of scroll bars for the treeview display |
|
The Selected tree nodes |
|
property SelectionColor: TColor; [rw] |
|
SelectionColor - the colour to be used for the selected nodes, to distinguish them from the others |
property SeparatorColor: TColor; [rw] |
|
SeparatorColor - the colour to be used for separators |
|
TopItem - the first node on the list |
|
property TreeLineColor: TColor; [rw] |
|
TreeLineColor - the colour to be used for the lines showing the tree structure |
property ExpandSignColor: TColor; [rw] |
|
ExpandSignColor - the colour to be used for the expand/collapse symbols |
published |
||
property TabStop; |
|
Is the control in the sequence of controls accessed by successive presses of the Tab key? |
end; |
|
TCustomTreeView - ancestor class for TTreeView |
|
| | ||
TCustomControl |
||
? | ||
TObject |
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.
lazarus-ccr.sourceforge.net |