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

TCheckListBox

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

TCheckListBox implements a list box with check boxes for its items.

Declaration

Source position: checklst.pas line 88

type TCheckListBox = class(TCustomCheckListBox)

published

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property AllowGrayed: Boolean;

  

Indicates if the item can use the "grayed" (or unselectable) check box state.

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property BidiMode: TBiDiMode;

  

Customization (of text controls) in bidirectional reading environments.

  property BorderSpacing: TControlBorderSpacing;

  

Determines the inner and outer border spacing for this control.

  property BorderStyle: TBorderStyle;

  

Indicates if borders are displayed around the control.

  property Color: TColor;

  

The background color of the control.

  property Columns: Integer;

  

The number of visible vertical columns displayed in 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 ExtendedSelect: Boolean;

  

True when a contiguous range of items can be selected by a Shift+Click. Default is True.

  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 IntegralHeight: Boolean;

  

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

  property Items: TStrings;

  

The list of all items defined in the control.

  property ItemHeight: Integer;

  

The default height for an item displayed in the list.

  property ItemIndex: Integer;

  

Ordinal position for the currently selected item, -1 if none.

  property MultiSelect: Boolean;

  

Allows selection of more than one item from the list.

  property OnChangeBounds: TNotifyEvent;

  

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

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  property OnClickCheck: TNotifyEvent;

  

Event handler signalled when a check box in the control has been changed.

  property OnContextPopup: TContextPopupEvent;

  

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

  property OnDblClick: TNotifyEvent;

  

Event Handler for double mouse clicks.

  property OnDrawItem: TDrawItemEvent;

  

Handler for painting of a list item in owner-draw mode.

  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 OnEndDrag: TEndDragEvent;

  

Notification handler for the end of a dragging operation.

  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 OnItemClick: TCheckListClicked;

  

Event handler signalled when the check box state for a specific item has been changed.

  property OnKeyPress: TKeyPressEvent;

  

Handler for a character entered by the user.

  property OnKeyDown: TKeyEvent;

  

Handler for keyboard key pressed.

  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 OnSelectionChange: TSelectionChangeEvent;

  

Handler invoked when an item is selected in the control.

  property OnShowHint: TControlShowHintEvent;

  

Event handler signalled when a hint window is displayed for the control.

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

  property OnUTF8KeyPress: TUTF8KeyPressEvent;

  

Handler for a character entered by the user.

  property ParentBidiMode: Boolean;

  

Allows to use the BiDiMode settings in the Parent control. Default is true.

  property ParentColor: Boolean;

  

Use 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 ShowHint: Boolean;

  

Enables the Hint display.

  property Sorted: Boolean;

  

Determines whether the list entries are sorted in alphanumeric order.

  property Style: TListBoxStyle;

  

Appearance of the list box (normal, owner-draw fixed, or owner-draw variable).

  property TabOrder: TTabOrder;

  

Determines the sequence of control navigation 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;

  

Index of the first visible (or top-most) item.

  property Visible: Boolean;

  

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

end;

Inheritance

TCheckListBox

  

TCheckListBox implements a list box with check boxes for its items.

|

TCustomCheckListBox

  

The base class for TCheckListBox, a list box with check box items.

|

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

|

TComponent

?

TObject

Description

TCheckListBox is a TCustomCheckListBox descendant which implements a scrollable list box which displays check boxes for each of its items.

Use the Items property to define the caption for entries that appear in the control. Each of the Items can have a state of checked or unchecked (or "grayed" when AllowGrayed is set). Use the properties and methods such as Toggle, CheckAll, Checked, ItemEnabled, and State to maintain the items in the control.

It provides the scrolling, selection, and drawing styles inherited from the ancestor class. It also includes the ability to render its items as a check box, and to respond to mouse or keyboard events when an item is toggled.

Use the event handlers in the class to perform actions needed when one or more items are clicked or change their state value. Use OnItemClick to process item changes individually.

TCheckListBox sets the visibility for properties defined in the ancestor class.

See also

TCustomCheckListBox

  

The base class for TCheckListBox, a list box with check box items.

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