[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 1364

type TCustomListView = class(TWinControl) end;

protected

  procedure ItemDeleted();

  

ItemDeleted - the specified listitem is removed from the list

  procedure ItemInserted();

  

ItemInserted - the specified item is inserted into the list

  class procedure WSRegisterClass; override;

  

Registers this component class with the current WidgetSet.

  class function GetControlClassDefaultSize; override;

  procedure InitializeWnd; override;

  

InitializeWnd - calls inherited method, then sets various local properties

  procedure FinalizeWnd; override;

  

FinalizeWnd stores the list origin then calls inherited method

  procedure DestroyWnd; override;

  

Destroys the interface object (widget).

  procedure BeginAutoDrag; override;

  

For internal use: user has started dragging the control.

  function CreateListItem; virtual;

  function CreateListItems; virtual;

  function CanEdit(); virtual;

  procedure Change(); virtual;

  

Change - Internal procedure to simulate the OnChange event

  procedure ColClick(); virtual;

  

ColClick - procedure to simulate the OnColumnClick event.

  procedure Delete();

  

Delete an Item from the List

  procedure DoDeletion(); virtual;

  

DoDeletion - performs the actual deletion

  procedure DoInsert(); virtual;

  

Performs the insertion

  procedure DoItemChecked();

  procedure DoSelectItem(); virtual;

  

DoSelectItem - perform item selection

  procedure DoAutoAdjustLayout(); override;

  procedure DoSetBounds(); override;

  procedure DoEndEdit(); virtual;

  procedure InsertItem();

  

Insert an Item into the List

  procedure ImageChanged();

  

ImageChanged - procedure to signal that an image has chnaged

  procedure Loaded; override;

  

Called when the control has been loaded from a resource, transfers the loaded property values to the widget.

  procedure Notification(); override;

  function IsCustomDrawn(); virtual;

  

IsCustomDrawn - returns True if a target has been custom drawn

  function CustomDraw(); virtual;

  

CustomDraw - performs custom drawing in the given rectangle and returns True if successful

  function CustomDrawItem(); virtual;

  

CustomDrawItem - custom draws the specified item and returns True if successful

  function CustomDrawSubItem(); virtual;

  

CustomDrawSubItem - custom draws the specified subitem returning True if successful

  function IntfCustomDraw();

  

IntfCustomDraw - uses the interface to perform custom drawing and returns a result of drawing

  function GetUpdateCount;

  procedure DrawItem();

  procedure DoGetOwnerData(); virtual;

  function DoOwnerDataHint(); virtual;

  function DoOwnerDataStateChange(); virtual;

  procedure DblClick; override;

  procedure KeyDown(); override;

  property AllocBy: Integer; [rw]

  

When new items add to list, increase internal buffer capacity by this amount. Needed to not add to internal buffer by one.

  property AutoSort: Boolean; [rw]

  

When user clicks ListView header's column, sort ListView by this column. After next click, sort in other order.

  property AutoWidthLastColumn: Boolean; [rw]

  

For Report view. Resize last column, to fill entire ListView width.

  property ColumnClick: Boolean; [rw]

  

Enable to react to clicks on ListView header columns. And to call OnColumnClick event.

  property Columns: TListColumns; [rw]

  

Collection of items, which have properties of ListView columns (size, alignment, image index, etc).

  property DefaultItemHeight: Integer; [rw]

  

Default height of lines in ListView.

  property HideSelection: Boolean; [rw]

  

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

  property HoverTime: Integer; [rw]

  

Time (in msec) for which the mouse cursor must hover over an item, before item's tooltip is shown.

  property LargeImages: TCustomImageList; [rw]

  

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

  property OwnerDraw: Boolean; [rw]

  

Use owner-draw mode. It means that program must paint ListView items, using OnCustomDraw*, OnAdvancedCustomDraw* events.

  property ScrollBars: TScrollStyle; [rw]

  

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

  property ShowColumnHeaders: Boolean; [rw]

  

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

  property ShowWorkAreas: Boolean; [rw]

  

Property WorkAreas sets work areas in ListView. This property allows to highlight each work area with its own color and show with own caption.

  property SmallImages: TCustomImageList; [rw]

  

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

  property SortType: TSortType; [rw]

  

Sets sorting order for current sorting column: by text, by Data of items, both or none.

  property SortColumn: Integer; [rw]

  

Index of column, by which ListView was last sorted. -1 for none.

  property SortDirection: TSortDirection; [rw]

  

Sets sorting direction for current sorting column.

  property StateImages: TCustomImageList; [rw]

  

ImageList object, which contains "state" icons, for item states: selected, normal, etc.

  property ToolTips: Boolean; [rw]

  

Automatically show hints (tooltips) for ListView items, when mouse is over items.

  property ViewStyle: TViewStyle; [rw]

  

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; [rw]

  

Called when content of list collection changes.

  property OnColumnClick: TLVColumnClickEvent; [rw]

  

Called when user clicks on column's header area.

  property OnCompare: TLVCompareEvent; [rw]

  

Called during sorting of list, by one of columns, to compare items.

  property OnCreateItemClass: TLVCreateItemClassEvent; [rw]

  property OnData: TLVDataEvent; [rw]

  

Called for owner-data mode.

  property OnDataFind: TLVDataFindEvent; [rw]

  

Called for owner-data mode.

  property OnDataHint: TLVDataHintEvent; [rw]

  

Called for owner-data mode.

  property OnDataStateChange: TLVDataStateChangeEvent; [rw]

  

Called for owner-data mode.

  property OnDeletion: TLVDeletedEvent; [rw]

  

Called when items are deleted by code.

  property OnEdited: TLVEditedEvent; [rw]

  property OnEditing: TLVEditingEvent; [rw]

  property OnInsert: TLVInsertEvent; [rw]

  

Called when items are inserted by code.

  property OnItemChecked: TLVCheckedItemEvent; [rw]

  property OnSelectItem: TLVSelectItemEvent; [rw]

  

Called when items are selected or selection changes.

  property OnCustomDraw: TLVCustomDrawEvent; [rw]

  

Called for owner-draw mode.

  property OnCustomDrawItem: TLVCustomDrawItemEvent; [rw]

  

Called for owner-draw mode.

  property OnCustomDrawSubItem: TLVCustomDrawSubItemEvent; [rw]

  

Called for owner-draw mode.

  property OnDrawItem: TLVDrawItemEvent; [rw]

  property OnAdvancedCustomDraw: TLVAdvancedCustomDrawEvent; [rw]

  

Called for owner-draw mode.

  property OnAdvancedCustomDrawItem: TLVAdvancedCustomDrawItemEvent; [rw]

  

Called for owner-draw mode.

  property OnAdvancedCustomDrawSubItem: TLVAdvancedCustomDrawSubItemEvent; [rw]

  

Called for owner-draw mode.

public

  constructor Create(); override;

  

Create - constructor for TCustomListView: calls inherited Create then initialises columns, the list of items, the canvas and properties and some formats and styles

  destructor Destroy; override;

  

Destroy - destructor for TCustomListView: frees Canvas, calls inherited Destroy and frees columns, links and list items

  procedure AddItem();

  function AlphaSort;

  procedure Sort;

  

  procedure BeginUpdate;

  

BeginUpdate - start updating the list view

  procedure Clear;

  

Clear - the stringlist

  procedure EndUpdate;

  

EndUpdate - finish updating the list view

  procedure Repaint; override;

  function FindCaption();

  

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

  function FindData();

  function GetHitTestInfoAt();

  function GetItemAt();

  

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

  function GetNearestItem();

  function GetNextItem();

  procedure ClearSelection;

  procedure SelectAll;

  function IsEditing;

  property BoundingRect: TRect; [r]

  

Coordinates of the rectangle containing the ListView.

  property BorderStyle: TBorderStyle;

  

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

  property Canvas: TCanvas; [r]

  

TCanvas object, defines the area on which all graphic is drawn.

  property Checkboxes: Boolean; [rw]

  

Show the check-boxes column, at the side of usual lines. Allows to check/uncheck items.

  property Column []: TListColumn; [r]

  

Property of ListView columns.

  property ColumnCount: Integer; [r]

  property DropTarget: TListItem; [rw]

  property FlatScrollBars: Boolean; [rw]

  

Show ListView scrollbars in "flat" style (default off, not for all widgetsets).

  property FullDrag: Boolean; [rw]

  property GridLines: Boolean; [rw]

  

Show 1-pixel lines, as a grid, between rows and columns.

  property HotTrack: Boolean; [rw]

  

Allow to highlight/underline current ListView item, which is under mouse cursor.

  property HotTrackStyles: TListHotTrackStyles; [rw]

  

More options for HotTrack property.

  property IconOptions: TIconOptions; [rw]

  

Options for layouts, which show icons. Sets arrangement of icons, text-wrapping state.

  property ItemFocused: TListItem; [rw]

  

ListView item, which is shown as focused.

  property ItemIndex: Integer; [rw]

  property Items: TListItems; [rw]

  

Collection of items in ListView.

  property MultiSelect: Boolean; [rw]

  

Allow to select several Listview items at a time, using Ctrl+click (select one item more).

  property OwnerData: Boolean; [rw]

  

Use owner-data mode for ListView. It means, that ListView don't contain items, you must supply them using OnData* events.

  property ReadOnly: Boolean; [rw]

  

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

  property RowSelect: Boolean; [rw]

  

In Report view, this allows to highlight entire selected row, until right edge of ListView.

  property SelCount: Integer; [r]

  

Number of currently selected items.

  property Selected: TListItem; [rw]

  

Listview item, which is 1st selected.

  property LastSelected: TListItem; [r]

  

Listview item, which is last selected, in MultiSelect mode.

  property TabStop: Boolean;

  

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

  property TopItem: TListItem; [r]

  

Listview item, which is shown at the top edge of ListView.

  property ViewOrigin: TPoint; [rw]

  

Coordinate of the left/top visible point in ListView, updates when Listview scrolls.

  property VisibleRowCount: Integer; [r]

  

Number of rows, which is currenly shown with current Listview position/size/layout.

Inheritance

TCustomListView

  

TCustomListView - 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 associated with widgets.

|

TComponent

?

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.