88 lines
9.0 KiB
XML
88 lines
9.0 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<fpdoc-descriptions><package name="eccontrols"><module name="ECEditBtns"><element name="TECCombo"><short>Visual component. Combo with associated button.</short>
|
|
</element><element name="TECColorBtn"><short>Visual component for selecting color. Line edit displays color code in various formats while associated button triggers color dialog.</short>
|
|
</element><element name="TCustomECColorBtn"><short>Base class for TECColorBtn. No <b>published</b> properties, no abstract methods.</short>
|
|
</element><element name="TECEditBtn"><short>Visual component. An alternative to TEditButton.</short>
|
|
</element><element name="TCustomECEditBtn"><short>Base class for TCustomECColorBtn and TECEditBtn. No <b>published</b> properties, no abstract methods.</short>
|
|
</element><element name="TECSpeedBtnPlus"><short>Visual component. A button designed to be associated to line-edit or combobox.</short>
|
|
</element><element name="TCustomECSpeedBtn"><short>Base class for TECSpeedBtn and TECSpeedBtnPlus. No <b>published</b> properties, no abstract methods.</short>
|
|
</element><element name="TECSpeedBtn"><short>Visual component - stand alone button with advanced features and built-in glyphs. An alternative to TSpeedButton.</short>
|
|
<descr>Features and differences from TSpeedButton:
|
|
|
|
TSpeedButton has property <i>Glyph: TBitmap</i>. TECSpeedBtn has properties <i>ImageIndex: Integer</i> and <i>Images: TImageList</i> instead.
|
|
|
|
TECSpeedBtn has property Delay and built-in timer. Therefore it can work as a delay-button (Delay>0) or toggle-box (Delay<0).
|
|
|
|
TECSpeedBtn has more than 80 built-in glyph (painted via TCanvas helper). Glyphs can be various for checked and unchecked state.
|
|
|
|
Similarly to TSpeedButton, TECSpeedBtn has properties GroupIndex, Checked and AllowAllUp so buttons can be grouped to radio-group.
|
|
|
|
TECSpeedBtn cannot obtain focus but can be pressed by acceleration key (Alt+ [underlined key]).
|
|
|
|
TECSpeedBtn can be linked with TAction too.
|
|
</descr><seealso><link id="TCustomECSpeedBtn.Delay"/><link id="TCustomECSpeedBtn.OnRelease"/>
|
|
</seealso>
|
|
</element><element name="TECSpeedBtnActionLink"><short>Class needed for linking with TAction.</short>
|
|
</element><element name="TColorString"><short>Enumerated type denoting format of color string.</short>
|
|
</element><element name="TColorString.ecsRGBColor"><short>Displays color in this order: Red, Green, Blue</short>
|
|
</element><element name="TColorString.ecsBGRColor"><short>Displays color in this order: Blue, Green, Red</short>
|
|
</element><element name="TColorString.ecsARGBColor"><short>Displays color in this order: Alpha, Red, Green, Blue</short>
|
|
</element><element name="TColorString.ecsABGRColor"><short>Displays color in this order: Alpha, Blue, Green, Red</short>
|
|
</element><element name="TColorString.ecsSystemBGR"><short>Displays names of known colors, like clBlue, clRed etc. Unknown color displys in this order: Blue, Green, Red.</short>
|
|
</element><element name="TEBOption"><short>Enumerated type. Options for TCustomECEditBtn (or descendants) and TECCombo.</short>
|
|
</element><element name="TEBOptions"><short>Set of TEBOption.</short>
|
|
</element><element name="TEBOption.eboClickAltEnter"><short>Alt+Enter executes click on associated button.</short>
|
|
</element><element name="TEBOption.eboClickCtrlEnter"><short>Ctrl+Enter executes click on associated button.</short>
|
|
</element><element name="TEBOption.eboClickShiftEnter"><short>Shift+Enter executes click on associated button.</short>
|
|
</element><element name="TCustomECSpeedBtn.Checked"><short>Denotes whether TECSpeedBtn is checked. This component has no State property and no state cbGrayed.</short><descr>Checked can be True only when Delay < 0 (button behaves like a TToggleBox) or Delay > 0 (button works with Delay).</descr>
|
|
</element><element name="TCustomECSpeedBtn.Delay"><short>Behaviour of button depends on value (negative, 0, positive).</short><descr>Delay = 0 (defalut): button behaves like TSpeedBtn<br/>
|
|
|
|
Delay < 0: button behaves like TToggleBox<br/>
|
|
|
|
Delay > 0: means value [miliseconds]. On click, button stays pushed. After this delay, it gets back to normal state.<br/><br/>
|
|
|
|
In all cases, it triggers OnRelease when changed form pushed to normal state.</descr>
|
|
</element><element name="TCustomECSpeedBtn.GlyphColor"><short>Color of built-in glyph.</short>
|
|
</element><element name="TCustomECSpeedBtn.OnRelease"><short>Triggered when button changes its state from pushed back to normal.</short>
|
|
</element><element name="TCustomECSpeedBtn.OnChange"><short>Triggered when <link id="TCustomECSpeedBtn.Checked">Checked</link> property is changed.</short><descr>Property Checked changes only when button is in delay-mode (Delay > 0) or as a togglebox (Delay < 0).</descr>
|
|
</element><element name="TCustomECSpeedBtn.OnDrawGlyph"><short>Event triggered before glyph is painted to internal image (bitmap) of button. This enables to draw user-defined glyph.</short><descr>The OnDrawGlyph has the highest precedence. The second is TCustomECSpeedBtn.ImageIndex (if image exists in Images). The last is built-in glyph.</descr>
|
|
</element><element name="TCustomECSpeedBtn.GlyphDesign"><short>Selects built-in glyph for Checked = False.</short><descr>This glyph is displayed when:<br/>
|
|
Normal button (Delay = 0) is in any state (normal, pushed, highlighted or disabled)<br/>
|
|
ToggleBox (Delay < 0) is unchecked (all states except pushed).<br/>
|
|
Delay button (Delay > 0) is unchecked (all states except pushed).</descr>
|
|
</element><element name="TCustomECSpeedBtn.GlyphDsgnChecked"><short>Selects built-in glyph for Checked = True.</short><descr>This glyph is displayed when:<br/>
|
|
Normal button (Delay = 0) - never<br/>
|
|
ToggleBox (Delay < 0) is checked (pushed state).<br/>
|
|
Delay button (Delay > 0) is checked (pushed state).</descr>
|
|
</element><element name="TCustomECSpeedBtn.Images"><short>Image list. ImageIndex and ImageIdxChecked properties points to this list.</short>
|
|
</element><element name="TCustomECSpeedBtn.Layout"><short>Alignment of the image.</short>
|
|
</element><element name="TCustomECSpeedBtn.Spacing"><short>Distance between glyph (or image) and Caption (if both exist). Spacing may mean horizontal or vertical, depends on Layout.</short>
|
|
</element><element name="TCustomECSpeedBtn.ImageIndex"><short>Index of image from list (Images) for Checked = False.</short><descr>This image is displayed when:<br/>
|
|
Normal button (Delay = 0) is in any state (normal, pushed, highlighted or disabled)<br/>
|
|
|
|
ToggleBox (Delay < 0) is unchecked (all states except pushed).<br/>
|
|
|
|
Delay button (Delay > 0) is unchecked (all states except pushed).</descr>
|
|
</element><element name="TCustomECSpeedBtn.ImageIdxChecked"><short>Index of image from list (Images) for Checked = True.</short><descr>This image is displayed when:<br/>
|
|
Normal button (Delay = 0) - never<br/>
|
|
ToggleBox (Delay < 0) is checked (pushed state).<br/>
|
|
Delay button (Delay > 0) is checked (pushed state).</descr>
|
|
</element><element name="TCustomECSpeedBtn.Margin"><short>Margin around image and Caption. Applies only when AutoSize = True.</short>
|
|
</element><element name="TCustomECEditBtn.Button"><short>Subclass. Button associated to line-edit.</short>
|
|
</element><element name="TCustomECEditBtn.Indent"><short>Indent [pixels] of buttons. Distance between line-edit and button.</short>
|
|
</element><element name="TCustomECEditBtn.WidthInclBtn"><short>Width including button width. Common property "Width" gives width of edit only. WidthInclBtns gives width including Button and Indent.</short>
|
|
</element><element name="TCustomECEditBtn.Options"><short>See <link id="TEBOption"/>.</short>
|
|
</element><element name="TCustomECColorBtn.CustomColor"><short>Selected color. User can select color via associated ColorDialog or type-in the color code to line-edit.</short>
|
|
</element><element name="TCustomECColorBtn.ColorString"><short>Format of <link id="TCustomECColorBtn.CustomColor">CustomColor</link>.</short>
|
|
</element><element name="TCustomECColorBtn.Prefix"><short>Prefix of the color code. Default is $. Can be #, nothing or anything else.</short>
|
|
</element><element name="TCustomECColorBtn.OnCustomColorChanged"><short>Triggered when CuctomColor is changed.</short>
|
|
</element><element name="TECCombo.Button"><short>Subclass. Button associated to combobox.</short>
|
|
</element><element name="TECCombo.Options"><short>See <link id="TEBOption"/>.</short>
|
|
</element><element name="TECCombo.Indent"><short>Indent [pixels] of buttons. Distance between combobox and button.</short>
|
|
</element><element name="TECCombo.WidthInclBtn"><short>Width including button width. Common property "Width" gives width of combobox only. WidthInclBtns gives width including Button and Indent.</short>
|
|
</element>
|
|
<short>Visual components TECSpeedBtn, TECEditBtn, TECColorBtn and TECCombo.</short>
|
|
</module>
|
|
</package>
|
|
</fpdoc-descriptions>
|