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

TShellListView

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

Implements a list view control to display the files, directories and other objects (such as devices) on the local file system.

Declaration

Source position: shellctrls.pas line 254

type TShellListView = class(TCustomShellListView)

public

  property Columns: TListColumns;

  

Collection with the column definitions for the list view control (size, alignment, image index, etc.).

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 BorderSpacing: TControlBorderSpacing;

  

Determines the inner and outer border spacing for this control.

  property BorderStyle: TBorderStyle;

  

Line style drawn as a border around the control.

  property BorderWidth: TBorderWidth;

  

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

  property Color: TColor;

  

The background color for the control.

  property Constraints: TSizeConstraints;

  

The minimum and maximum Width and Height for the control.

  property DragCursor: TCursor;

  

The cursor shape shown while the control is dragged.

  property DragMode: TDragMode;

  

Allows the user to drag the control.

  property Enabled: Boolean;

  

Determines whether the control reacts on mouse or keyboard input.

  property Font: TFont;

  

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

  property HideSelection: Boolean;

  

If control looses focus, don't paint selection background for selected item(s).

  property LargeImages: TCustomImageList;

  

ImageList object, which contains "big" icons for one if ListView layouts.

  property LargeImagesWidth: Integer;

  

Contains the Width for the large images used in the list view.

  property Mask: string;

  

File mask used to select items displayed in the shell control.

  property MaskCaseSensitivity: TMaskCaseSensitivity;

  

Case Sensitivity option enabled for file masks in the shell control.

  property MultiSelect: Boolean;

  

Allows simultaneous selection of one or more list items using Ctrl+Click, Shift+Click, Ctrl+Shift+Click, or using program code.

  property ParentColor: Boolean;

  

Uses the Color from the Parent control, when enabled.

  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;

  

Disables editing of list items on the control when set to True.

  property RowSelect: Boolean;

  

In Report view, this highlights the entire selected row to the right edge of the list view control.

  property ScrollBars: TScrollStyle;

  

Specifies the scroll bars visible for the control.

  property ShowColumnHeaders: Boolean;

  

Show header area in ListView, which shows captions of columns.

  property ShowHint: Boolean;

  

Enables the Hint display.

  property SmallImages: TCustomImageList;

  

ImageList object, which contains "small" icons for one if ListView layouts.

  property SmallImagesWidth: Integer;

  

Width for the images in the SmallImages property.

  property SortColumn: Integer;

  

Ordinal position for the column used to sort the list items, or -1 when not assigned.

  property SortType: TSortType;

  

Specifies the sorting mechanism used for the current SortColumn.

  property StateImages: TCustomImageList;

  

Image list with the state images for the items on the control.

  property TabStop: Boolean;

  

Allows the user to navigate to the control by pressing the Tab or Shift_Tab keys.

  property TabOrder: TTabOrder;

  

Determines the sequence of control navigation when the user presses the Tab key.

  property ToolTips: Boolean;

  

Indicates if a hint (tool tip) is automatically displayed for an item under the mouse cursor.

  property Visible: Boolean;

  

Allows the control, and all of its children, to be displayed or hidden.

  property ViewStyle: TViewStyle;

  

Sets one of ListView layouts: List (simple column), Report (few columns with full width), Icon (big icons), Small Icon (small icons, 16x16).

  property OnChange: TLVChangeEvent;

  

Event handler signalled when the content for a list item is changed.

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  property OnColumnClick: TLVColumnClickEvent;

  

Event handler signalled when a column header for the control is clicked.

  property OnCompare: TLVCompareEvent;

  

Event handler signalled to compare list items in the CustomSort method.

  property OnContextPopup: TContextPopupEvent;

  

Invoked when a context-sensitive pop-up menu is requested.

  property OnDblClick: TNotifyEvent;

  

Event Handler for double mouse clicks.

  property OnDeletion: TLVDeletedEvent;

  

Event handler signalled when a list item is deleted from the Items container.

  property OnDragDrop: TDragDropEvent;

  

This handler determines the action on an drop onto this control, in a drag-drop operation.

  property OnDragOver: TDragOverEvent;

  

Event handler for a control being dragged over this control.

  property OnEdited: TLVEditedEvent;

  

Event handler signalled when editing has been completed for a list item in the control.

  property OnEditing: TLVEditingEvent;

  

Event handler signalled to determine if editing can be started for a list item in the control.

  property OnEndDrag: TEndDragEvent;

  

Notification handler for the end of a dragging operation.

  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;

  

Event handler for mouse entering the area of the control.

  property OnMouseLeave: TNotifyEvent;

  

Event handler for mouse leaving the area of the control.

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler for mouse button going up.

  property OnMouseWheel: TMouseWheelEvent;

  

Event handler for mouse wheel turned.

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  

Event handler for downward movement of mouse wheel.

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  

Event handler for upward movement of the mouse wheel.

  property OnMouseWheelHorz: TMouseWheelEvent;

  

Event handler for horizontal movements of the mouse wheel.

  property OnMouseWheelLeft: TMouseWheelUpDownEvent;

  

Event handler for left movements of the mouse wheel.

  property OnMouseWheelRight: TMouseWheelUpDownEvent;

  

Event handler for right movements of the mouse wheel.

  property OnResize: TNotifyEvent;

  

Notification handler for a resize of the control.

  property OnSelectItem: TLVSelectItemEvent;

  

Event handler signalled when the selected list item for the control is changed.

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

  property OnUTF8KeyPress: TUTF8KeyPressEvent;

  

Handler for a character entered by the user.

  property OnAddItem: TAddItemEvent;

  

Event handler signalled to determine if the specified file information can be added to the Items for the list view.

  property OnFileAdded: TCSLVFileAddedEvent;

  

Event handler signalled when a file is added to the Items in the control.

  property ObjectTypes: TObjectTypes;

  

Indicates which objects are visible in the control (files and/or directories, hidden files, etc.).

  property Root: string;

  

Indicates the initial directory path whose objects are displayed in the control.

  property ShellTreeView: TCustomShellTreeView;

  

Used to connect the ShellListView to a ShellTreeView.

end;

Inheritance

TShellListView

  

Implements a list view control to display the files, directories and other objects (such as devices) on the local file system.

|

TCustomShellListView

  

The base class that defines a list view control to display the files, directories and other objects (such as devices) from the local file system.

|

TCustomListView

  

TCustomListView is the base class for TListView.

|

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 which have an associated widget.

|

TComponent

?

TObject

Description

TShellListView is a TCustomShellListView descendant which implements a list view control for file system objects on the local file system. TShellListView contains properties, methods, and events needed to access and maintain items in the control including:

See also

TCustomShellListView

  

The base class that defines a list view control to display the files, directories and other objects (such as devices) from the local file system.

TCustomShellListView.Mask

  

File mask used to select items displayed in the shell control.

TCustomShellListView.MaskCaseSensitivity

  

Case Sensitivity option enabled for file masks in the shell control.

TCustomShellListView.ObjectTypes

  

Indicates which objects are visible in the control (files and/or directories, hidden files, etc.).

TCustomShellListView.Root

  

Indicates the initial directory path whose objects are displayed in the control.

TCustomShellListView.ShellTreeView

  

Used to connect the ShellListView to a ShellTreeView.

TCustomShellListView.Items

  

Collection of list items displayed on the list view control.

TCustomShellListView.GetPathFromItem

  

Gets the path on the local file system for the specified item.

TCustomShellListView.OnAddItem

  

Event handler signalled to determine if the specified file information can be added to the Items for the list view.

TCustomShellListView.OnFileAdded

  

Event handler signalled when a file is added to the Items in the control.

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