ShellCtrls unit

shellctrls.pas contains tree view and list view controls used to access files and directories on the local file system. The following components are added to the Lazarus IDE component palette:

Misc Tab

• TShellTreeView
• TShellListView

ShellCtrls.pas is part of the Lazarus Component Library (LCL).

Classes and records

EInvalidPath	class	Exception raised for an invalid path in shell controls.
EShellCtrl	class	Exception raised for errors occurring in shell controls.
TCustomShellListView	class	The base class that defines a list view control to display files or directories found on the local file system.
TCustomShellTreeView	class	The base class for a tree view control used to display files, directories and other objects (such as devices) from the local file system.
TFileItem	class	Provides information about a file or directory on the local file system for use in file sort comparison routines.
TShellListColumn	class	Defines a column displayed on a shell list view control.
TShellListColumns	class	Collection type used to store column definitions in a shell list view control.
TShellListItem	class	Implements the class used for list items maintained in TShelllListView.
TShellListView	class	Implements a list view control to display files or directories found on the local file system.
TShellTreeNode	class	Represents tree nodes in TCustomShellTreeView / TShellTreeView.
TShellTreeView	class	Implements a tree view control to display the files, directories and other objects (such as devices) from the local file system.

Procedures and functions

DbgS	function	Provides strings values with details about classes used in shell controls for the debugger.
Register	procedure	Registers components for use in the Lazarus IDE.

Types

TAddItemEvent	procedure type	Specifies an event handler signalled when an item is added to a shell control.
TCSLVFileAddedEvent	procedure type	Deprecated. Specifies an event handler signalled when an item is added to TCustomShellListView.
TExpandCollapseMode	enumeration	Indicates actions performed for child nodes when a shell tree node is expanded or collapsed.
TFileItemCompareEvent	procedure type	Implements a handler routine used to compare values in a custom file sort for TCustomShellTreeView.
TFileSortType	enumeration	Represents sorting options for the items in a shell control.
TMaskCaseSensitivity	enumeration	Represents case sensitivity options for file masks.
TObjectType	enumeration	Indicates which objects should be visible in a Shell control.
TObjectTypes	set	Set type with values that indicate the visible objects in a Shell control.
TSLVColumnID	enumeration	Column identifiers used for column data displayed on a shell list view control.
TSLVFileAddedEvent	procedure type	Specifies an object procedure used to implement the OnFileAdded event handler in TCustomShellListView.
TSLVGetCellTextEvent	procedure type	Specifies an object procedure used to implement an OnGetCellText event handler in TCustomShellListView.
TSLVSizeFunc	procedure type	String function used to format size information for a file displayed in a column on a shell list view control.
TSLVSizeUnits	enumeration	Represents size units available for file size information displayed for a column on a shell list view control.

Uses

• Classes
• SysUtils
• Types
• Math
• AVL_Tree
• Forms
• Graphics
• Controls
• ComCtrls
• LCLStrConsts
• LCLProc
• LazFileUtils
• LazUTF8
• LazLoggerBase
• Masks