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

TCustomListBox

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

The base class for TListBox.

Declaration

Source position: stdctrls.pp line 497

type TCustomListBox = class(TWinControl) end;

protected

  class procedure WSRegisterClass; override;

  

Registers this component class with the current WidgetSet.

  procedure AssignItemDataToCache(); virtual;

  

Copy selection state into the cache.

  procedure AssignCacheToItemData(); virtual;

  

Sends the cached selection state to the widget.

  procedure BeforeDragStart; override;

  procedure BeginAutoDrag; override;

  

For internal use: user has started dragging the control.

  function CalculateStandardItemHeight;

  

Determine the standard Height of the items, when no widget has yet been created.

  procedure CreateParams(); override;

  procedure InitializeWnd; override;

  

Copies the Items into the widget.

  procedure FinalizeWnd; override;

  

Caches the Items stored in the widget.

  class function GetControlClassDefaultSize; override;

  procedure CheckIndex();

  

Assures that the index is inside the Items list bounds.

  function GetItemHeight;

  function GetItemIndex; virtual;

  function GetSelCount;

  function GetSelected();

  function GetCachedDataSize; virtual;

  

Returns the size of a cached item.

  function GetCachedData();

  

Returns an pointer to the cached item data.

  procedure SetExtendedSelect(); virtual;

  procedure SetItemIndex(); virtual;

  procedure SetItems(); virtual;

  procedure SetItemHeight();

  procedure SetMultiSelect(); virtual;

  procedure SetSelected();

  procedure SetSorted(); virtual;

  procedure SetStyle(); virtual;

  procedure DrawItem(); virtual;

  

Paints an item in owner-draw mode.

  procedure DoAutoAdjustLayout(); override;

  procedure DoSelectionChange(); virtual;

  

Invokes the OnSelectionChange handler.

  procedure SendItemIndex;

  

Sends the ItemIndex to the widget.

public

  constructor Create(); override;

  destructor Destroy; override;

  procedure AddItem();

  

Adds an item to the list.

  procedure Click; override;

  

Invokes the OnClick and ActionLink.Execute handlers.

  procedure Clear; virtual;

  

Removes all items from the list.

  procedure ClearSelection;

  

Unselects all items.

  function GetIndexAtXY();

  

Find the item at the given client coordinates.

  function GetIndexAtY();

  function GetSelectedText;

  

Get the text of all selected items in one string.

  function ItemAtPos();

  

Get the item index for the given client coordinates.

  function ItemRect();

  

Returns the client area of an item (including scrolling).

  function ItemVisible();

  

Returns True if the item is at least partially visible in the scrolled list.

  function ItemFullyVisible();

  

Returns True if the item is fully visible in the scrolled list.

  procedure LockSelectionChange;

  

Blocks selection changes during update of the widget.

  procedure MakeCurrentVisible;

  

Makes the item at ItemIndex visible, possibly scrolling the list.

  procedure MeasureItem(); virtual;

  

Request the Height of a list item, using the OnMeasureItem handler.

  procedure SelectAll; virtual;

  

Selects all items in the list (in ExtendedSelect mode).

  procedure DeleteSelected; virtual;

  procedure UnlockSelectionChange;

  

Unlocks previously locked selection changes.

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property BorderStyle: TBorderStyle;

  

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

  property Canvas: TCanvas; [r]

  property ClickOnSelChange: Boolean; [rw]

  

Allows selection changes to generate a Click event.

  property Columns: Integer; [rw]

  

The number of visible vertical columns.

  property Constraints: TSizeConstraints;

  

The minimal and maximal Width and Height of this control.

  property Count: Integer; [r]

  

The number of items in the list.

  property ExtendedSelect: Boolean; [rw]

  

True when a contiguous range of items can be selected by a SHIFT-click. Default True.

  property Font: TFont;

  

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

  property IntegralHeight: Boolean; [rw]

  

Not implemented: shrink the Height of the widget, so that it only shows fully visible rows.

  property ItemHeight: Integer; [rw]

  

The default height of all items.

  property ItemIndex: Integer; [rw]

  

The currently selected item, -1 if none.

  property Items: TStrings; [rw]

  

The list of all items in the control.

  property MultiSelect: Boolean; [rw]

  

Allows to select more than one Item from the list, using CTRL-click.

  property OnChangeBounds: TNotifyEvent;

  

Event handler for a change of the Bounds of the control.

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  property OnDblClick: TNotifyEvent;

  

Event Handler for double mouse clicks.

  property OnDrawItem: TDrawItemEvent; [rw]

  

Handler for special painting of an item (in owner-draw mode).

  property OnEnter: TNotifyEvent;

  

Handler for control receiving the focus.

  property OnExit: TNotifyEvent;

  

Handler for control loosing the focus. This is a good place for checking the finished user input.

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

  

Handler invoked when the height of an item is required.

  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;

  

Notification handler for downward movement of mouse wheel.

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  

Notification handler for upward movement of mouse wheel.

  property OnResize: TNotifyEvent;

  

Notification handler for a resize of the control.

  property OnSelectionChange: TSelectionChangeEvent; [rw]

  

Handler invoked when an item is selected.

  property OnUTF8KeyPress: TUTF8KeyPressEvent;

  

Handler for a character entered by the user.

  property Options: TListBoxOptions; [rw]

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

  

The virtual width of the ListBox, in pixels.

  property SelCount: Integer; [r]

  

The number of selected iems in the list.

  property Selected []: Boolean; [rw]

  

Get or set the Selected state of an item.

  property ShowHint: Boolean;

  

Enables the Hint display.

  property Sorted: Boolean; [rw]

  

Determines whether the list entries are sorted.

  property Style: TListBoxStyle; [rw]

  

Appearance of the ListBox - normal, owner-draw fixed, or owner-draw variable.

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

  

Index of the first visible (topmost) item.

  property Visible: Boolean;

  

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

Inheritance

TCustomListBox

  

The base class for TListBox.

|

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.