TCustomColorListBox class

In unit ColorBox

Implements the base class for TColorListBox.

Declaration

pascal

TCustomColorListBox = class(TCustomListBox)

Inheritance

Descends from it: TColorListBox

Description

TCustomColorListBox is a TCustomListBox descendant which implements a list box control used to display and select color names and values. TCustomColorListBox is the base class for the TColorListBox control. Each item in the control has a small rectangle where the color is displayed (swatch) and the color name.

The Style property is used to configure the list of available colors and their display names. Style may also trigger use of the OnGetColors event handler to get the items displayed in the combo-box control.

The ColorRectWidth and ColorRectOffset properties can be used to control the size and spacing for the color swatch displayed for the list items.

Colors allows indexed access to the TColor values in the list of items. When included in the Style property, colors like clDefault and/or clNone may be included in the list of Colors. The DefaultColorColor and NoneColorColor properties can be used to specify the TColor values used for those color constants.

ColorNames allows indexed access to the names for the values in Colors.

Do not create instances of TCustomColorListBox; use the TColorL:istBox descendant instead.

Use TCustomColorBox / TColorBox to display color names and values in a combo-box control.

Properties

`ColorRectWidth`	public	Width for the color sample (swatch) displayed for colors in the item list.
`ColorRectOffset`	public	Number of pixels between the color sample and the color name.
`Style`	public	Settings which determine the colors available in the control and their display style.
`Colors`	public	Provides indexed access to the TColor value for items in the control.
`ColorNames`	public	Provides indexed access to the names for the Colors used in the control.
`Selected`	public	The TColor value for the selected item in the list box control.
`DefaultColorColor`	public	TColor used for the clDefault color constant.
`NoneColorColor`	public	TColor used for the clNone color constant.
`ColorDialog`	public	Dialog displayed to select a custom color for the control.

Methods

`ColorRectWidthStored`	protected	Implements the storage specifier for the ColorRectWidth property.
`DrawItem`	protected	Draws the color preview and name for an item in list box control.
`SetColorList`	protected	Loads the list of colors used in the control.
`Loaded`	protected	Performs actions needed when LCL component streaming has been completed.
`InitializeWnd`	protected	Performs actions needed when the window handle for the control is created.
`DoAutoAdjustLayout`	protected	Performs actions needed to auto-adjust the control using the specified layout policy.
`DoGetColors`	protected	Signals the OnGetColors event handler (when assigned).
`DoSelectionChange`	protected	Performs actions needed when the selection in the control is changed.
`PickCustomColor`	protected	Selects a custom color using a color dialog.
`Notification`	protected	Performs actions needed when the specified component is added to or removed from the control.
`Create`	public	Constructor for the class instance.