[Overview][Types][Classes][Procedures and functions][Index] Reference for unit 'ShellCtrls' (#lcl)

TShellTreeView

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

The main class for tree view control to display the files, directories and other objects (such as devices) from the file system structure

Declaration

Source position: shellctrls.pas line 106

type TShellTreeView = class(TCustomShellTreeView) end;

published

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property AutoExpand: Boolean;

  

Unfold a tree-item when user clicks it or an item activated by code.

  property BorderSpacing: TControlBorderSpacing;

  

Determines the inner and outer border spacing for this control.

  property BackgroundColor: TColor;

  

Color of background area of control.

  property BorderStyle: TBorderStyle;

  

Allows to show a border (line) around the control,

  property BorderWidth: TBorderWidth;

  

Width of the Border around the control; default is zero.

  property Color: TColor;

  

The background color of the control.

  property Constraints: TSizeConstraints;

  

The minimal and maximal Width and Height of this control.

  property Enabled: Boolean;

  

Determines whether the control reacts on mouse or keyboard input.

  property ExpandSignType: TTreeViewExpandSignType;

  

Sets shape of expand/collapse (fold/unfold) symbol: plus/minus, empty arrows, filled arrows etc.

  property Font: TFont;

  

The font to be used for text display in this control.

  property FileSortType: TFileSortType;

  property HideSelection: Boolean;

  property HotTrack: Boolean;

  property Images: TCustomImageList;

  property Indent: Integer;

  property ParentColor: Boolean;

  

If true, the Color of the control will be the same as the one from the Parent. Default is true.

  property ParentFont: Boolean;

  

If true, the Font of the control will be the same as the one from the Parent. Default is true.

  property ParentShowHint: Boolean;

  

If true, the value of ShowHint for the control will be the same as the one from the Parent. Default is true.

  property PopupMenu: TPopupMenu;

  

A context-sensitive menu that pops up when the right mouse button is clicked over this control

  property ReadOnly: Boolean;

  

Don't allow to change item captions by mouse click with a delay.

  property RightClickSelect: Boolean;

  

Right-click also selects tree-item. Else it only calls PopupMenu.

  property Root: string;

  property RowSelect: Boolean;

  

When a tree-item is selected, paint selection background with full width.

  property ScrollBars: TScrollStyle;

  

Kind of scrollbars: horizontal, vertical, or both. Auto* mean that scrollbars hide automatically.

  property SelectionColor: TColor;

  

Color used to paint background of item selection.

  property ShowButtons: Boolean;

  

Show expand/collapse (fold/unfold) icons at left side for nodes with sub-nodes.

  property ShowHint: Boolean;

  

Enables the Hint display.

  property ShowLines: Boolean;

  

Show vertical lines at left side. They paint the tree structure for nested nodes.

  property ShowRoot: Boolean;

  

Show the root tree-item which is always present in code but may be hidden for user.

  property StateImages: TCustomImageList;

  property TabOrder: TTabOrder;

  

Determines the sequence of controls, reachable when the user presses the Tab key.

  property TabStop: Boolean;

  

Allows the user to navigate to this control, by pressing the Tab key.

  property Tag;

  property ToolTips: Boolean;

  

Show tooltip (hint) for a tree-item when the item is too long to fit by width and mouse is over it.

  property Visible: Boolean;

  

Allows to show or hide the control, and all of its children.

  property OnAdvancedCustomDraw: TTVAdvancedCustomDrawEvent;

  property OnAdvancedCustomDrawItem: TTVAdvancedCustomDrawItemEvent;

  property OnChange: TTVChangedEvent;

  

OnChange - specialised event handler for a change in the TreeView

  property OnChanging: TTVChangingEvent;

  

OnChanging - specialised event handler while TreeView is being changed

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  property OnCollapsed: TTVExpandedEvent;

  property OnCollapsing: TTVCollapsingEvent;

  property OnCustomDraw: TTVCustomDrawEvent;

  property OnCustomDrawItem: TTVCustomDrawItemEvent;

  property OnDblClick: TNotifyEvent;

  property OnEdited: TTVEditedEvent;

  property OnEditing: TTVEditingEvent;

  property OnEnter: TNotifyEvent;

  property OnExit: TNotifyEvent;

  property OnExpanded: TTVExpandedEvent;

  property OnExpanding: TTVExpandingEvent;

  property OnGetImageIndex: TTVExpandedEvent;

  property OnGetSelectedIndex: TTVExpandedEvent;

  property OnKeyDown: TKeyEvent;

  

Handler for keyboard key pressed.

  property OnKeyPress: TKeyPressEvent;

  

Handler for a character entered by the user.

  property OnKeyUp: TKeyEvent;

  

Handler for keyboard key released.

  property OnMouseDown: TMouseEvent;

  

Event handler for mouse button going down.

  property OnMouseEnter: TNotifyEvent;

  property OnMouseLeave: TNotifyEvent;

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler for mouse button going up.

  property OnMouseWheel: TMouseWheelEvent;

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  property OnSelectionChanged: TNotifyEvent;

  

OnSelectionChanged - event handler for a change in the selection

  property OnShowHint: TControlShowHintEvent;

  

Event Handler when a hint shall be shown.

  property OnUTF8KeyPress: TUTF8KeyPressEvent;

  

Handler for a character entered by the user.

  property Options: TTreeViewOptions;

  

Set of additional option flags for treeview.

  property TreeLineColor: TColor;

  

Color used to paint vertical lines at left side.

  property TreeLinePenStyle: TPenStyle;

  

Style of TPen, used to paint vertical lines at left side.

  property ExpandSignColor: TColor;

  

Color used to paint expand/collapse (fold/unfold) symbol (i.e. plus/minus symbol).

  property ObjectTypes: TObjectTypes;

  

Indicates which objects should be shown in this control (for example if it should show files and directories or only directories)

  property ShellListView: TCustomShellListView;

  

Can be utilized to connect this ShellTreeView to a ShellListView

Inheritance

TShellTreeView

  

The main class for tree view control to display the files, directories and other objects (such as devices) from the file system structure

|

TCustomShellTreeView

  

The base class for tree view control to display the files, directories and other objects (such as devices) from the file system structure

|

TCustomTreeView

  

TCustomTreeView - ancestor class for TTreeView

|

TCustomControl

  

The base class for windowed controls which paint themselves.

|

TWinControl

  

The base class for controls which can contain other (child) controls.

|

TControl

  

The base class for visible controls.

|

TLCLComponent

  

The base class for LCL components associated with widgets.

|

TComponent

?

TObject

The latest version of this document can be found at lazarus-ccr.sourceforge.net.