TColorListBox class

In unit ColorBox

Implements a list box control used to display and select color names and values.

Declaration

pascal

TColorListBox = class(TCustomColorListBox)

Inheritance

Description

TColorListBox is a TCustomColorListBox descendant which implements a list box control used to display and select color names and values. 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 list 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.

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

Properties

`ColorRectWidth`	published	Width for the color sample (swatch) displayed for colors in the item list.
`ColorRectOffset`	published	Number of pixels between the color sample and the color name.
`DefaultColorColor`	published	TColor used for the clDefault color constant.
`NoneColorColor`	published	TColor used for the clNone color constant.
`Selected`	published	The TColor value for the selected item in the list box control.
`Style`	published	Settings which determine the colors available in the control and their display style.
`ColorDialog`	published	Dialog displayed to select a custom color for the control.
`Align`	published	Specifies the placement of the control on its Parent control.
`Anchors`	published	The set of anchor definitions for this control.
`BidiMode`	published	Indicates whether text controls use in bi-directional reading.
`BorderSpacing`	published	Determines the inner and outer border spacing for this control.
`BorderStyle`	published	Line style used for the border on the control.
`ClickOnSelChange`	published	Allows selection changes to generate a Click event.
`Color`	published	The background color for the control.
`Constraints`	published	Contains the minimum and maximum Width and Height for the control.
`DragCursor`	published	The cursor shape shown during a drag operation.
`DragKind`	published	Indicates the action performed for a drag operation: drag-and-drop or drag-and-dock.
`DragMode`	published	Determines how a drag operation is started for the control.
`ExtendedSelect`	published	True when a contiguous range of items can be selected using Shift+Click. The default value is True.
`Enabled`	published	Determines whether the control responds to mouse or keyboard input.
`Font`	published	The font to be used for text display in this control.
`IntegralHeight`	published	Not implemented: shrink the Height of the widget, so that it only shows fully visible rows.
`ItemHeight`	published	The default height for an item displayed in the list.
`ParentBidiMode`	published	Indicates whether the BiDiMode settings in the Parent control are used.
`ParentColor`	published	Use the Color from the Parent control, when enabled.
`ParentShowHint`	published	If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True.
`ParentFont`	published	Indicates if the Font from the Parent control is used in the control.
`PopupMenu`	published	A context-sensitive menu that pops up when the right mouse button is clicked over this control.
`ShowHint`	published	Enables Hint display for the control.
`TabOrder`	published	Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`TabStop`	published	Enables keyboard navigation using the Tab or Shift+Tab keys.
`TopIndex`	published	Index of the first visible (or top-most) item.
`Visible`	published	Allows the control, and all of its children, to be displayed or hidden.

Events

`OnGetColors`	published	OnGetColors - event handler for the instruction to get colors.
`OnChangeBounds`	published	Event handler signalled when the Bounds for the control have been changed.
`OnClick`	published	Notification handler for mouse clicks.
`OnContextPopup`	published	Invoked when a context-sensitive pop-up menu is requested.
`OnDblClick`	published	Event handler signalled when a mouse double click occurs in the control.
`OnDragDrop`	published	Event handler signalled when an object is dropped onto the control.
`OnDragOver`	published	Event handler signalled when a control is dragged over the control instance.
`OnEnter`	published	Event handler signalled when the control receives focus.
`OnEndDrag`	published	Event handler signalled for the end of a drag-drop operation.
`OnExit`	published	Event handler signalled when the control loses focus.
`OnKeyPress`	published	Event handler signalled for character data entered by the user.
`OnKeyDown`	published	Event handler signalled for key down keyboard events.
`OnKeyUp`	published	Event handler signalled when a key up event has occurred for the control.
`OnMouseDown`	published	Event handler signalled when a mouse down event is handled for the control.
`OnMouseEnter`	published	Event handler signalled when the mouse pointer has entered the control.
`OnMouseLeave`	published	Event handler signalled when the mouse pointer has left the control.
`OnMouseMove`	published	Event handler signalled when the mouse pointer is moved in the control.
`OnMouseUp`	published	Event handler signalled when a mouse up event is handled for the control.
`OnMouseWheel`	published	Event handler for mouse wheel turned.
`OnMouseWheelDown`	published	Event handler signalled for a downward movement of the mouse wheel.
`OnMouseWheelUp`	published	Event handler signalled for an upward movement of the mouse wheel.
`OnMouseWheelHorz`	published	Event handler signalled for a horizontal movement of the mouse wheel.
`OnMouseWheelLeft`	published	Event handler signalled for a leftward movement of the mouse wheel.
`OnMouseWheelRight`	published	Event handler signalled for a rightward movement of the mouse wheel.
`OnResize`	published	Notification handler for a resize of the control.
`OnSelectionChange`	published	Handler invoked when an item is selected in the control.
`OnShowHint`	published	Event handler signalled when a hint window is displayed for the control.
`OnStartDrag`	published	Event handler signalled for the start of a dragging operation.
`OnUTF8KeyPress`	published	Handler for a character entered by the user.