TfpgTreeView

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

Represents a window that displays a hierachy list of items

Declaration

Source position: fpg_tree.pas line 147

`type TfpgTreeView = class(TfpgWidget)`
`public`
`constructor Create(); override;`
`destructor Destroy; override;`
`procedure SetColumnWidth();`
`function GetColumnWidth();`
`function GetNodeAt();`
`procedure GotoNextNodeUp;`		Moves the selection to the previous node up the tree
`procedure GotoNextNodeDown;`		Moves the selection to the next node down the tree
`procedure FullCollapse;`		Collapses all the nodes within a tree view control
`procedure FullExpand;`		Expands all nodes within the tree view control
`function NextNode();`		Return the next node after ANode
`function PrevNode();`		Return the previous node starting from ANode
`function NextVisualNode();`		Return the next visible node starting from ANode
`function PrevVisualNode();`		Return the previous visible node starting from ANode
`procedure BeginUpdate;`
`procedure EndUpdate;`
`property Font: TfpgFont; [r]`		This gives you read access to the internal Font resource
`property RootNode: TfpgTreeNode; [r]`		Returns the first node of the tree where all other nodes branch from
`property Selection: TfpgTreeNode; [rw]`		Specifies the selected node in the tree view
`property ImageList: TfpgImageList; [rw]`		Refers to the image list associated with the tree view
`property StateImageList: TfpgImageList; [rw]`
`property PopupMenu: TfpgPopupMenu; [rw]`		Identifies the pop-up menu associated with the tree view
`published`
`property Align;`
`property BackgroundColor;`
`property DefaultColumnWidth: Word; [rw]`		Is the default with of columns displayed in the tree view
`property Enabled;`
`property FontDesc: ; [rw]`		Specifies the font used for the tree view
`property IndentNodeWithNoImage: Boolean; [rw]`
`property NoImageIndent: Integer; [rw]`
`property ParentShowHint;`
`property ScrollWheelDelta: Integer; [rw]`
`property ShowColumns: Boolean; [rw]`
`property Hint;`
`property ShowHint;`
`property ShowImages: Boolean; [rw]`
`property TabOrder;`
`property TextColor;`
`property TreeLineColor: TfpgColor; [rw]`
`property TreeLineStyle: TfpgLineStyle; [rw]`
`property OnChange: TNotifyEvent; [rw]`
`property OnExpand: TfpgTreeExpandEvent; [rw]`
`property OnDoubleClick;`
`property OnShowHint;`
`property OnStateImageClicked: TfpgStateImageClickedEvent; [rw]`
`end;`

Inheritance

`TfpgTreeView`		Represents a window that displays a hierachy list of items
\|
`TfpgWidget`		This forms the basis of any visual widget in fpGUI
\|
`TfpgWindow`		Encapsulates a top level or child window
\|
`TfpgWindowImpl`		Maps to a backend specific base class
\|
`TfpgX11Window`		Implements XLib specific windowing functionality
\|
`TfpgWindowBase`		Abstract class use for representing a Window or Widget
\|
`TfpgComponent`		A descendant of the FPC TComponent class
\|
`TComponent`
?
`TObject`

Description

Represents a window that displays a hierachy list of items. Examples of such hierachies can be the headings in a document, the entries in a index, or the files and directories on a disk.

Use TfpgTreeView to add an expanding and contracting outline to a form. Each node in a tree view control consists of a label and a number of optional bitmapped images. Each node can have a list of subnodes associated with it. By clicking on a node, the user can expand or collapse the associated list of subnodes.

Remark:

There is basic column support, but this is still very experimental.