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

TCustomListView

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

TCustomListView - the base class for TListView

Declaration

Source position: comctrls.pp line 893

type TCustomListView = class(TWinControl)

protected

  procedure ItemDeleted();

  

ItemDeleted - the specified listitem is removed from the list

  procedure ItemInserted();

  

ItemInserted - the specified item is inserted into the list

  procedure InitializeWnd; override;

  

InitializeWnd - initialise the window for this control

  procedure FinalizeWnd; override;

  

FinalizeWnd - getting ready to remove window (gets called before the Handle is destroyed)

  procedure DestroyWnd; override;

  

DestroyWnd - destroy the window for this control

  procedure BeginAutoDrag; override;

  

Start the AutoDrag process

  procedure Change(); dynamic;

  

Change - Internal procedure to simulate the OnChange event

  procedure ColClick(); dynamic;

  

ColClick - procedure to simulate the OnColumnClick event.

  procedure Delete();

  

Delete an Item from the List

  procedure DoDeletion(); dynamic;

  

Performs the actual deletion

  procedure DoInsert(); dynamic;

  

Performs the insertion

  procedure DoSelectItem(); dynamic;

  

DoSelectItem - perform item selection

  procedure InsertItem();

  

Insert an Item into the List

  procedure ImageChanged();

  

ImageChanged - procedure to signal that an image has chnaged

  procedure Loaded; override;

  function IsCustomDrawn(); virtual;

  function CustomDraw(); virtual;

  function CustomDrawItem(); virtual;

  function CustomDrawSubItem(); virtual;

  function IntfCustomDraw();

  property AllocBy: Integer; [rw]

  property BorderStyle;

  

BorderStyle - none, or single

  property Columns: TListColumns; [rw]

  

Columns - define and change the columns of a ListView

  property ColumnClick: Boolean;

  

ColumnClick - determines if the OnColumnClick event will be executed.

  property DefaultItemHeight: Integer; [rw]

  

DefaultItemHeight - sets or reads the default height for an item on the list

  property HideSelection: Boolean;

  

HideSelection - if True, the selected item is to be hidden

  property HoverTime: Integer; [rw]

  

HoverTime - the time for which the mouse must hover over the item before its help message is displayed

  property Items: TListItems; [rw]

  

Items - the list of entries in the list. Held as a linked list with a cached index of the last accessed item

  property LargeImages: TCustomImageList;

  

LargeImages - an ImageList to be used in association with the list of Items

  property MultiSelect: Boolean;

  

MultiSelect - enables the selection of more than one entry from Items - by pressing SHIFT or CTRL keys while selecting

  property OwnerData: Boolean; [rw]

  

OwnerData - if True, the Owner's data are to be displayed

  property OwnerDraw: Boolean;

  

OwnerDraw - if True, the Owner's Draw method is to be used

  property ReadOnly: Boolean;

  

ReadOnly - determines if the list can only be read, and not written or deleted.

  property ScrollBars: TScrollStyle; [rw]

  

ScrollBars - the kind of scrollbars to be used: none, auto, horizontal or vertical

  property ShowColumnHeaders: Boolean;

  

ShowColumnHeaders - whether headers for columns are to be displayed

  property ShowWorkAreas: Boolean;

  

ShowWorkAreas - if True, the work areas are to be displayed

  property SmallImages: TCustomImageList;

  

SmallImages - an ImageList of small images (icons) to be used in association with the list of Items

  property SortType: TSortType; [rw]

  

SortType - whether to sort by text, by data, both or not at all

  property SortColumn: Integer; [rw]

  

SortColumn - the column that is being sorted

  property StateImages: TCustomImageList;

  

StateImages - an imagelist of icons to demonstrate the state of a process or event

  property ToolTips: Boolean;

  

ToolTips - whether Popup tool tips are to be shown

  property ViewStyle: TViewStyle; [rw]

  

ViewStyle - whether to view as a simple list, a list with large or small icons, or as a report

  property OnChange: TLVChangeEvent; [rw]

  

OnChange - event handler for a change in the list

  property OnColumnClick: TLVColumnClickEvent; [rw]

  

OnColumnClick - event handler for clicking on a coulmn

  property OnCompare: TLVCompareEvent; [rw]

  

OnCompare - event handler for comparing list items

  property OnDeletion: TLVDeletedEvent; [rw]

  

OnDeletion - event handler for deleting a list item

  property OnInsert: TLVInsertEvent; [rw]

  

OnInsert - event handler for inserting list item

  property OnSelectItem: TLVSelectItemEvent; [rw]

  

OnSelectItem - event handler for list item selection

  property OnCustomDraw: TLVCustomDrawEvent; [rw]

  property OnCustomDrawItem: TLVCustomDrawItemEvent; [rw]

  property OnCustomDrawSubItem: TLVCustomDrawSubItemEvent; [rw]

  property OnAdvancedCustomDraw: TLVAdvancedCustomDrawEvent; [rw]

  property OnAdvancedCustomDrawItem: TLVAdvancedCustomDrawItemEvent; [rw]

  property OnAdvancedCustomDrawSubItem: TLVAdvancedCustomDrawSubItemEvent; [rw]

public

  constructor Create(); override;

  destructor Destroy; override;

  

  procedure BeginUpdate;

  

BeginUpdate - start updating the list view

  procedure Clear;

  

Clear - the stringlist

  procedure EndUpdate;

  

EndUpdate - finish updating the list view

  function FindCaption();

  

FindCaption- search for and return the list item that contains the nominated caption

  function GetItemAt();

  

GetItemAt - find and return the list item at the specified coordinates

  property BoundingRect: TRect; [r]

  

BoundingRect - the coordinates of the rectangle containing the ListView

  property Canvas: TCanvas; [r]

  

Canvas - defines the area on which all graphic material is drawn (Read-only)

  property Checkboxes: Boolean;

  

CheckBoxes - determines if the ListView shows checkboxes beside the items on the list

  property Column: TListColumn; [r]

  

Column - reads the column information of the listview.

  property DropTarget: TListItem; [rw]

  

DropTarget - location where an item from the list is to be dropped

  property FlatScrollBars: Boolean;

  

FlatScrollBars - whether the scroll bars are to be displayed flat (default False)

  property FullDrag: Boolean;

  

  property GridLines: Boolean;

  

Whether GridLines are to be shown

  property HotTrack: Boolean;

  

  property HotTrackStyles: TListHotTrackStyles; [rw]

  

  property ItemFocused: TListItem; [rw]

  

ItemFocused - the item currently receiving focus

  property RowSelect: Boolean;

  

RowSelect - whether the user can select rows of items (across columns). Default false

  property SelCount: Integer; [r]

  

SelCount - the number of items selected

  property Selected: TListItem; [rw]

  

Selected - the current list item that has been selected

  property TabStop;

  

Is the control in the sequence of controls accessed by successive presses of the Tab key?

  property TopItem: TListItem; [r]

  

TopItem - the first item on the list

  property ViewOrigin: TPoint; [rw]

  

ViewOrigin - the top left coordinate for the current view

  property VisibleRowCount: Integer; [r]

  

VisibleRowCount - the number of rows visible in the current view (some items might have scrolled outside the window)

end;

Inheritance

TCustomListView

  

TCustomListView - the base class for TListView

|

TWinControl

?

TObject

Description

TCustomListView is the base class for TListView. If you want to define your own ListView class, you should derive it from this class.

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