Sign in Join
FPDoc Onlineexperiment

TCustomCheckListBox.DrawItem procedure

Member of TCustomCheckListBoxprotectedIn unit CheckLst

Adjusts the drawing area for the specified item, and renders it on the control.

Declaration

pascal
procedure DrawItem(AIndex: Integer; ARect: TRect; 
 State: TOwnerDrawState); override

Arguments

AIndex

Ordinal position in Items for the entry drawn in the method.

ARect

TRectangle with the drawing area for the item.

State

TOwnerDrawState for Items in the control.

Description

DrawItem is an overridden procedure used to render the item specified in AIndex to the drawing area in ARect. DrawItem ensures that sufficient space is reserved for the check box drawn for an item on the list box.

The Header property determines whether a check box is required for the item, and GetCheckWidth is called to get the width for the check box when needed. ARect is updated to increase or decrease the horizontal boundary depending on the value in UseRightToLeftAlignment; The right boundary is decremented for RTL, and the left boundary is incremented for LTR.

DrawItem calls the inherited method to render the item on the list box for the control.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.