mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-12-02 21:07:35 +01:00
1132 lines
41 KiB
XML
1132 lines
41 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<fpdoc-descriptions>
|
|
<package name="lcl">
|
|
<!--
|
|
====================================================================
|
|
ColorBox
|
|
====================================================================
|
|
-->
|
|
<module name="ColorBox">
|
|
<short>Defines Classes for selecting color from a list or ComboBox</short>
|
|
<descr/>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="LResources">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="SysUtils">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="Classes">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="Graphics">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="Controls">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="Forms">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="Dialogs">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- unresolved type reference Visibility: default -->
|
|
<element name="StdCtrls">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- enumeration type Visibility: default -->
|
|
<element name="TColorPalette">
|
|
<short>
|
|
<var>TColorPalette</var> - enumerated type: whether default or full palette is to be used</short>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TColorPalette.cpDefault">
|
|
<short/>
|
|
</element>
|
|
<!-- enumeration value Visibility: default -->
|
|
<element name="TColorPalette.cpFull">
|
|
<short/>
|
|
</element>
|
|
<!-- object Visibility: default -->
|
|
<element name="TColorBox">
|
|
<short>
|
|
<var>TColorBox</var> - presents the user with a ComboBox with a drop-down list from which to select a color</short>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TColorBox.FPalette">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TColorBox.GetSelection">
|
|
<short>Read specifier for selection property</short>
|
|
<descr>Use GetSelection to convert the item selected into a system color.</descr>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TColorBox.GetSelection.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TColorBox.SetSelection">
|
|
<short>Write specifier for selection property</short>
|
|
<descr>Use SetSelection to set the item in the ColorBox when appointed a color from code.</descr>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorBox.SetSelection.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TColorBox.GetColor">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TColorBox.GetColor.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorBox.GetColor.Index">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TColorBox.GetSelected">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TColorBox.GetSelected.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TColorBox.SetSelected">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorBox.SetSelected.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TColorBox.SetPalette">
|
|
<short>Write specifier for the Palette property</short>
|
|
<descr>Use SetPalette to determine whether to reset the colorlist in the ColorBox based on the type of palette.</descr>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorBox.SetPalette.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TColorBox.SetStyle" link="#LCL.StdCtrls.TCustomComboBox.SetStyle">
|
|
<descr>Use SetStyle to prevent the style to be changed to anything else than csOwnerDrawFixed.
|
|
</descr>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorBox.SetStyle.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TColorBox.DrawItem" link="#LCL.StdCtrls.TCustomComboBox.DrawItem">
|
|
<descr>Use DrawItem to customdraw an item in the ColorBox. A color preview is drawn and the item rectangle is made smaller and given to the inherited method to draw the corresponding text. The Brush color and Pen color where changed and reset to their original values.
|
|
</descr>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorBox.DrawItem.Index">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorBox.DrawItem.Rect">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorBox.DrawItem.State">
|
|
<short/>
|
|
</element>
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TColorBox.Create" link="#rtl.Classes.TComponent.Create">
|
|
<descr>Use Create to create an instance of TColorBox and initialize all properties and variables.
|
|
</descr>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorBox.Create.AOwner">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TColorBox.SetColorList">
|
|
<short>Write specifier for the ColorList property</short>
|
|
<descr>Use SetColorList to fill the itemlist in the ColorBox with the right color entries. Based on the value of the Palette property.</descr>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TColorBox.Selection">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TColorBox.Palette">
|
|
<short>The <var>Palette</var> of colors to be used for the drop-down list</short>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TColorBox.Colors">
|
|
<short>
|
|
<var>Colors</var> - the indexed color values available for the list</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorBox.Colors.Index">
|
|
<short/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.Align" link="#LCL.Controls.TControl.Align">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.Anchors" link="#LCL.Controls.TControl.Anchors">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.ArrowKeysTraverseList" link="#LCL.StdCtrls.TCustomComboBox.ArrowKeysTraverseList">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.AutoComplete" link="#LCL.StdCtrls.TCustomComboBox.AutoComplete">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.AutoCompleteText" link="#LCL.StdCtrls.TCustomComboBox.AutoCompleteText">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.AutoDropDown" link="#LCL.StdCtrls.TCustomComboBox.AutoDropDown">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.AutoSize" link="#LCL.Controls.TControl.AutoSize">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.Color" link="#LCL.Controls.TControl.Color">
|
|
<short>
|
|
<var>Color</var> - this is the color for the display of the actual control, not the color selected from the list</short>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.Ctl3D" link="#LCL.Controls.TControl.Ctl3D">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.DragMode" link="#LCL.Controls.TControl.DragMode">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.DragCursor" link="#LCL.Controls.TControl.DragCursor">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.DropDownCount" link="#LCL.StdCtrls.TCustomComboBox.DropDownCount">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.Enabled" link="#LCL.Controls.TControl.Enabled">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.Font" link="#LCL.Controls.TControl.Font">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.ItemHeight" link="#LCL.StdCtrls.TCustomComboBox.ItemHeight">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.ItemIndex" link="#LCL.StdCtrls.TCustomComboBox.ItemIndex">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.Items" link="#LCL.StdCtrls.TCustomComboBox.Items">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.ItemWidth" link="#LCL.StdCtrls.TCustomComboBox.ItemWidth">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.MaxLength" link="#LCL.StdCtrls.TCustomComboBox.MaxLength">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.Palette">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.ParentColor" link="#LCL.Controls.TControl.ParentColor">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.ParentCtl3D" link="#LCL.Controls.TWinControl.ParentCtl3D">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.ParentFont" link="#LCL.Controls.TControl.ParentFont">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.ReadOnly" link="#LCL.StdCtrls.TCustomComboBox.ReadOnly">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.Selected" link="#LCL.ColorBox.TCustomColorBox.Selected"/>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.ShowHint" link="#LCL.Controls.TControl.ShowHint">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.Sorted" link="#LCL.StdCtrls.TCustomComboBox.Sorted">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.TabStop" link="#LCL.Controls.TWinControl.TabStop">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.Text" link="#LCL.StdCtrls.TCustomComboBox.Text">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.Visible" link="#LCL.Controls.TControl.Visible">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnChange" link="#LCL.StdCtrls.TCustomComboBox.OnChange">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnClick" link="#LCL.Controls.TControl.OnClick">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnCloseUp" link="#LCL.StdCtrls.TCustomComboBox.OnCloseUp">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnDblClick" link="#LCL.Controls.TControl.OnDblClick">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnDragOver" link="#LCL.Controls.TControl.OnDragOver">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnDrawItem" link="#LCL.StdCtrls.TCustomComboBox.OnDrawItem">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnDropDown" link="#LCL.StdCtrls.TCustomComboBox.OnDropDown">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnEditingDone" link="#LCL.Controls.TControl.OnEditingDone">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnExit" link="#LCL.Controls.TWinControl.OnExit">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnMeasureItem" link="#LCL.StdCtrls.TCustomComboBox.OnMeasureItem">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorBox.OnSelect" link="#LCL.StdCtrls.TCustomComboBox.OnSelect">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- class Visibility: default -->
|
|
<element name="TColorListBox">
|
|
<short>
|
|
<var>TColorListBox</var> - a box containing a simple list of colors from which to select</short>
|
|
</element>
|
|
<!-- variable Visibility: private -->
|
|
<element name="TColorListBox.FPalette">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TColorListBox.GetColor">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TColorListBox.GetColor.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorListBox.GetColor.Index">
|
|
<short/>
|
|
</element>
|
|
<!-- function Visibility: private -->
|
|
<element name="TColorListBox.GetSelected">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- function result Visibility: default -->
|
|
<element name="TColorListBox.GetSelected.Result">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TColorListBox.SetSelected">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorListBox.SetSelected.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: private -->
|
|
<element name="TColorListBox.SetPalette">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorListBox.SetPalette.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TColorListBox.SetStyle">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorListBox.SetStyle.Value">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: protected -->
|
|
<element name="TColorListBox.DrawItem">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorListBox.DrawItem.Index">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorListBox.DrawItem.Rect">
|
|
<short/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorListBox.DrawItem.State">
|
|
<short/>
|
|
</element>
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TColorListBox.Create" link="#rtl.Classes.TComponent.Create">
|
|
<short/>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorListBox.Create.AOwner">
|
|
<short/>
|
|
</element>
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TColorListBox.SetColorList">
|
|
<short>
|
|
<var>SetColorList</var> - stores the list of colors</short>
|
|
<descr/>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TColorListBox.Colors">
|
|
<short>
|
|
<var>Colors</var> - the indexed color values available for the list</short>
|
|
</element>
|
|
<!-- argument Visibility: default -->
|
|
<element name="TColorListBox.Colors.Index">
|
|
<short/>
|
|
</element>
|
|
<!-- property Visibility: public -->
|
|
<element name="TColorListBox.Selected">
|
|
<short>The color that has been <var>Selected</var> from the list</short>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.Align" link="#LCL.Controls.TControl.Align">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.Anchors" link="#LCL.Controls.TControl.Anchors">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.BorderStyle" link="#LCL.Controls.TWinControl.BorderStyle">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.ClickOnSelChange" link="#LCL.StdCtrls.TCustomListBox.ClickOnSelChange">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.Color" link="#LCL.Controls.TControl.Color">
|
|
<short>
|
|
<var>Color</var> - Determine the color for the display of the actual control, not the color selected from the list</short>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.Constraints" link="#LCL.Controls.TControl.Constraints">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.DragCursor" link="#LCL.Controls.TControl.DragCursor">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.DragMode" link="#LCL.Controls.TControl.DragMode">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.Enabled" link="#LCL.Controls.TControl.Enabled">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.ExtendedSelect" link="#LCL.StdCtrls.TCustomListBox.ExtendedSelect">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.Font" link="#LCL.Controls.TControl.Font">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.IntegralHeight" link="#LCL.StdCtrls.TCustomListBox.IntegralHeight">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.ItemHeight" link="#LCL.StdCtrls.TCustomListBox.ItemHeight">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.Items" link="#LCL.StdCtrls.TCustomListBox.Items">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.MultiSelect" link="#LCL.StdCtrls.TCustomListBox.MultiSelect">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.Palette">
|
|
<short>The <var>Palette</var> of colors from which selection is to be made</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.ParentColor" link="#LCL.Controls.TControl.ParentColor">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.ParentFont" link="#LCL.Controls.TControl.ParentFont">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.ShowHint" link="#LCL.Controls.TControl.ShowHint">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.Sorted" link="#LCL.StdCtrls.TCustomListBox.Sorted">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.TabStop" link="#LCL.Controls.TWinControl.TabStop">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.TopIndex">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.Visible" link="#LCL.Controls.TControl.Visible">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnClick" link="#LCL.Controls.TControl.OnClick">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnDblClick" link="#LCL.Controls.TControl.OnDblClick">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnDragOver" link="#LCL.Controls.TControl.OnDragOver">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnDrawItem" link="#LCL.StdCtrls.TCustomListBox.OnDrawItem">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnExit" link="#LCL.Controls.TWinControl.OnExit">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnMouseEnter" link="#LCL.Controls.TControl.OnMouseEnter">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnMouseLeave" link="#LCL.Controls.TControl.OnMouseLeave">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnMouseWheel" link="#LCL.Controls.TControl.OnMouseWheel">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnMouseWheelDown" link="#LCL.Controls.TControl.OnMouseWheelDown">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnMouseWheelUp" link="#LCL.Controls.TControl.OnMouseWheelUp">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnResize" link="#LCL.Controls.TControl.OnResize">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnSelectionChange" link="#LCL.StdCtrls.TCustomListBox.OnSelectionChange">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnShowHint" link="#LCL.Controls.TControl.OnShowHint">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- property Visibility: published -->
|
|
<element name="TColorListBox.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag">
|
|
<short/>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<!-- procedure Visibility: default -->
|
|
<element name="Register">
|
|
<short>Register procedure for colorbox</short>
|
|
<descr>This procedure registers the component to the Additional menu</descr>
|
|
<errors/>
|
|
<seealso/>
|
|
</element>
|
|
<element name="TColorBox.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
|
|
<element name="TColorListBox.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
|
|
<element name="TCustomColorBox">
|
|
<short>
|
|
<var>TCustomColorBox</var> - base class for <var>TColorBox</var>
|
|
</short>
|
|
</element>
|
|
<element name="TCustomColorBox.SetStyle" link="#LCL.StdCtrls.TCustomComboBox.SetStyle"/>
|
|
<element name="TCustomColorBox.DrawItem" link="#LCL.StdCtrls.TCustomComboBox.DrawItem"/>
|
|
<element name="TCustomColorBox.Create">
|
|
<short>
|
|
<var>Create</var> - constructor for TCustomColorBox: calls inherited <var>Create</var>, sets style, default colors and color list, ReadOnly and Selected properties</short>
|
|
<seealso>
|
|
<link id="#LCL.StdCtrls.TCustomCombobox.Create">TCustomCombobox.Create</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomColorBox.SetColorList">
|
|
<short>
|
|
<var>SetColorList</var> - specifies the list of colors to be presented in the drop-down</short>
|
|
</element>
|
|
<element name="TCustomColorBox.Colors">
|
|
<short>
|
|
<var>Colors</var> the color specified by the Index</short>
|
|
</element>
|
|
<element name="TCustomColorBox.Palette">
|
|
<short>The <var>Palette</var> of colors to be included</short>
|
|
</element>
|
|
<element name="TCustomColorBox.Selected">
|
|
<short>The color that has been <var>Selected</var> from the ComboBox</short>
|
|
</element>
|
|
<element name="TCustomColorListBox">
|
|
<short>
|
|
<var>TCustomColorListBox</var> - base class for <var>TColorListBox</var>
|
|
</short>
|
|
</element>
|
|
<element name="TCustomColorListBox.SetStyle">
|
|
<short>
|
|
<var>SetStyle</var> - specify the Style</short>
|
|
</element>
|
|
<element name="TCustomColorListBox.DrawItem" link="#LCL.StdCtrls.TCustomListBox.DrawItem"/>
|
|
<element name="TCustomColorListBox.Create">
|
|
<short>
|
|
<var>Create</var> - constructor for <var>TCustomColorListBox</var>: calls inherited <var>Create</var>, initializes style, default colors and sets color list</short>
|
|
<seealso>
|
|
<link id="#LCL.StdCtrls.TCustomListBox.Create">TCustomListBox.Create</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomColorListBox.SetColorList">
|
|
<short>
|
|
<var>SetColorList</var> - specifies the list of colors</short>
|
|
</element>
|
|
<element name="TCustomColorListBox.Colors">
|
|
<short>The <var>Colors</var> specified by <var>Index</var>
|
|
</short>
|
|
</element>
|
|
<element name="TCustomColorListBox.Selected" link="#LCL.StdCtrls.TCustomListBox.Selected"/>
|
|
<element name="TCustomColorListBox.Palette">
|
|
<short>The <var>Palette</var> to be used to supply the colors</short>
|
|
</element>
|
|
<element name="TColorBoxStyle">
|
|
<short>
|
|
<var>TColorBoxStyle</var> - set of <var>TColorBoxStyles</var>
|
|
</short>
|
|
</element>
|
|
<element name="TCustomColorBox.Loaded" link="#rtl.Classes.TComponent.Loaded"/>
|
|
<element name="TCustomColorBox.InitializeWnd" link="#LCL.Controls.TWinControl.InitializeWnd"/>
|
|
<element name="TCustomColorBox.DoGetColors">
|
|
<short>
|
|
<var>DoGetColors</var> - perform the code for getting colors</short>
|
|
</element>
|
|
<element name="TCustomColorBox.Change" link="#LCL.StdCtrls.TCustomComboBox.Change"/>
|
|
<element name="TCustomColorBox.PickCustomColor">
|
|
<short>
|
|
<var>PickCustomColor</var> - if True, a custom color is picked rather than one of the standard list</short>
|
|
</element>
|
|
<element name="TCustomColorBox.Style" link="#LCL.StdCtrls.TCustomComboBox.Style"/>
|
|
<element name="TCustomColorBox.ColorNames">
|
|
<short>
|
|
<var>ColorNames</var> - the name of the specified (indexed) color, stored as a string</short>
|
|
</element>
|
|
<element name="TCustomColorBox.DefaultColorColor">
|
|
<short>
|
|
<var>DefaultColorColor</var> - the default color, expressed as a Color value</short>
|
|
<descr>
|
|
<p>
|
|
<var>DefaultColorColor</var> - the default color, expressed as a Color value</p>
|
|
<p>The use of the construct <var>..ColorColor</var> denotes the value of a color as a TColor, as opposed to an index value</p>
|
|
</descr>
|
|
</element>
|
|
<element name="TCustomColorBox.NoneColorColor">
|
|
<short>
|
|
<var>NoneColorColor</var> - the color to be used when no selection has been made, or when <var>None</var> is selected, stored as a <var>TColor</var>
|
|
</short>
|
|
</element>
|
|
<element name="TCustomColorBox.OnGetColors">
|
|
<short>
|
|
<var>OnGetColors</var> - event handler for the instruction to get colors</short>
|
|
</element>
|
|
<element name="TColorBox.DefaultColorColor" link="#LCL.ColorBox.TCustomColorBox.DefaultColorColor"/>
|
|
<element name="TColorBox.NoneColorColor" link="#LCL.ColorBox.TCustomColorBox.NoneColorColor"/>
|
|
<element name="TColorBox.Style" link="#LCL.StdCtrls.TCustomComboBox.Style"/>
|
|
<element name="TColorBox.OnGetColors" link="#LCL.ColorBox.TCustomColorBox.OnGetColors"/>
|
|
<element name="TCustomColorListBox.Loaded" link="#rtl.Classes.TComponent.Loaded"/>
|
|
<element name="TCustomColorListBox.InitializeWnd" link="#LCL.Controls.TWinControl.InitializeWnd"/>
|
|
<element name="TCustomColorListBox.DoGetColors">
|
|
<short>
|
|
<var>DoGetColors</var> - perform the code for getting the colors</short>
|
|
</element>
|
|
<element name="TCustomColorListBox.DoSelectionChange" link="#LCL.StdCtrls.TCustomListBox.DoSelectionChange"/>
|
|
<element name="TCustomColorListBox.PickCustomColor">
|
|
<short>
|
|
<var>PickCustomColor</var> - if True, a custom color is picked rather than one from the standard list</short>
|
|
</element>
|
|
<element name="TCustomColorListBox.Style" link="#LCL.StdCtrls.TCustomListBox.Style"/>
|
|
<element name="TCustomColorListBox.ColorNames">
|
|
<short>
|
|
<var>ColorNames</var> - the name of the indexed color, stored as a string</short>
|
|
</element>
|
|
<element name="TCustomColorListBox.DefaultColorColor">
|
|
<short>
|
|
<var>DefaultColorColor</var> - the default color, expressed as a Color value</short>
|
|
<descr>
|
|
<p>
|
|
<var>DefaultColorColor</var> - the default color, expressed as a Color value</p>
|
|
<p>The use of the construct <var>..ColorColor</var> denotes the value of a color as a TColor, as opposed to an index value</p>
|
|
</descr>
|
|
</element>
|
|
<element name="TCustomColorListBox.NoneColorColor">
|
|
<short>
|
|
<var>NoneColorColor</var> - the color to be used when no selection has been made, or when <var>None</var> is selected, stored as a <var>TColor</var>
|
|
</short>
|
|
</element>
|
|
<element name="TCustomColorListBox.OnGetColors">
|
|
<short>
|
|
<var>OnGetColors</var> - event handler for the instruction to get colors</short>
|
|
</element>
|
|
<element name="TColorListBox.DefaultColorColor" link="#LCL.ColorBox.TCustomColorListBox.DefaultColorColor"/>
|
|
<element name="TColorListBox.NoneColorColor" link="#LCL.ColorBox.TCustomColorListBox.NoneColorColor"/>
|
|
<element name="TColorListBox.Style" link="#LCL.StdCtrls.TCustomListBox.Style"/>
|
|
<element name="TColorListBox.OnGetColors" link="#LCL.ColorBox.TCustomColorListBox.OnGetColors"/>
|
|
<element name="TColorListBox.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup"/>
|
|
<element name="TColorListBox.ParentBidiMode" link="#LCL.Controls.TControl.ParentBiDiMode"/>
|
|
<element name="TColorListBox.BidiMode" link="#LCL.Controls.TControl.BiDiMode"/>
|
|
</module>
|
|
<!-- ColorBox -->
|
|
</package>
|
|
</fpdoc-descriptions>
|