Стартовый пул
This commit is contained in:
87
ECC/docs/eceditbtns.xml
Normal file
87
ECC/docs/eceditbtns.xml
Normal file
@@ -0,0 +1,87 @@
|
||||
<?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>
|
51
ECC/docs/ecgroupctrls.xml
Normal file
51
ECC/docs/ecgroupctrls.xml
Normal file
@@ -0,0 +1,51 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions><package name="eccontrols"><module name="ECGroupCtrls"><element name="TCustomECGroupCtrl"><short>Base abstract class for TECRadioGroup and TECCheckGroup. No <b>published</b> properties.</short>
|
||||
</element><element name="TCustomECRadioGroup"><short>Base class for TECRadioGroup. No abstract classes, no <b>published</b> properties.</short>
|
||||
</element><element name="TCustomECCheckGroup"><short>Base class for TECCheckGroup. No abstract classes, no <b>published</b> properties.</short>
|
||||
</element><element name="TECRadioGroup"><short>Visual component. An alternative to TRadioGroup.</short>
|
||||
</element><short>Visual components TECRadioGroup and TECCheckGroup.</short><element name="TECItemState"><short>Enumerated type denoting state of items of TECRadioGroup and TECCheckGroup.</short>
|
||||
</element><element name="TECGCOption"><short>Enumerated type. Options for TECRadioGroup and TECCheckGroup.</short>
|
||||
</element><element name="TECGCOption.egoAllowAllUp"><short>Allow all items to be unchecked. <i>False</i> means that one item of TECRadioGroup and at least one item of TECCheckGroup is always selected.</short>
|
||||
</element><element name="TECGCOption.egoCaptionBy"><short>Caption is displayed by the box, i.e. on the left or on the right - depends on the BiDiMode.</short>
|
||||
</element><element name="TECGCOption.egoCentered"><short>Glyphs, images and texts of items are horizontally centered.</short>
|
||||
</element><element name="TECGCOption.egoColumnThenRow"><short>Determines order of items. Default is left to right, next row and again left to right (assumes horizonal orientation and left-to-right language).</short>
|
||||
</element><element name="TECGCOption.egoNativeGlyphs"><short>Items have native glyph, i.e. empty or full small circle (TECRadioGroup) and empty or checked square (TECCheckGroup).</short>
|
||||
</element><element name="TECGCOption.egoSplitted"><short>Items are separated with vertical and vertical spliters (beveled lines).</short>
|
||||
</element><element name="TECGCOptions"><short>Set of TECGCOption.</short>
|
||||
</element>
|
||||
<element name="TGroupCtrlItem"><short>Group Control item. RadioGroup or CheckGroup is collection of these items.</short>
|
||||
</element><element name="TGroupCtrlItems"><short>Collection of items. Subclass for TCustomECGroupCtrl and descendants.</short>
|
||||
</element>
|
||||
<element name="TGroupCtrlItem.Caption"><short>Caption of the item. Display depends on properties Font, (Un)CheckedFontColor and (Un)CheckedFontStyles of TCustomECGroupCtrl.</short>
|
||||
</element><element name="TGroupCtrlItem.Checked"><short>Determines whether the item (radiobutton or checkbox) is checked (selected) or not. Can be set via code to True or False, regardless on egoAllowAllUp option.</short>
|
||||
</element><element name="TGroupCtrlItem.ImageIndex"><short>Index of image. Parent (TCustomECGroupCtrl) contains link to ImageList (property Images).</short>
|
||||
</element><element name="TGroupCtrlItems.Add"><short>Adds new item to collection.</short>
|
||||
</element><element name="TGroupCtrlItems.Items"><short>Collection of items.</short>
|
||||
</element><element name="TGroupCtrlItems.Reset"><short>Set all items to unchecked (Checked=False), regardless on egoAllowAllUp option.</short>
|
||||
</element><element name="TGroupCtrlItems.Click"><short>This method is called on item click (i.e. mouse click or key-up event). Method respects egoAllowAllUp option.</short>
|
||||
</element><element name="TCustomECGroupCtrl.BlockColor"><short>Color of the component. Applies only when Style = eosPanel.</short>
|
||||
</element><element name="TCustomECGroupCtrl.CheckedFontColor"><short>Font color of checked items.</short>
|
||||
</element><element name="TCustomECGroupCtrl.CheckedFontStyles"><short>Font styles (bold, italic, underline) of checked items.</short>
|
||||
</element><element name="TCustomECGroupCtrl.UncheckedFontStyles"><short>Font styles (bold, italic, underline) of unchecked items.</short>
|
||||
</element><element name="TCustomECGroupCtrl.UncheckedFontColor"><short>Font color of unchecked items.</short>
|
||||
</element><element name="TCustomECGroupCtrl.Images"><short>Item images are taken from this image list.</short>
|
||||
</element><element name="TCustomECGroupCtrl.Indent"><short>Distance between caption and block with items. Applies only when Caption is not empty string.</short>
|
||||
</element><element name="TCustomECGroupCtrl.Items"><short>Subclass containing items.</short>
|
||||
</element><element name="TCustomECGroupCtrl.Spacing"><short>Distance between glyph, image and text of item. Also distance between border and content (when egoCentered is not in Options).</short>
|
||||
</element><element name="TCustomECGroupCtrl.Options"><short>See <link id="TECGCOption"/>.</short>
|
||||
</element><element name="TCustomECGroupCtrl.RowCount"><short>Number of rows.</short>
|
||||
</element><element name="TCustomECRadioGroup.ItemIndex"><short>Index of item that is currently selected. -1 or any other negative value means that no items is selected.</short>
|
||||
</element><element name="TCustomECRadioGroup.OnSelectionChange"><short>Triggered when ItemIndex changes. Changes from negative to other negative value are not allowed.</short>
|
||||
</element><element name="TCustomECCheckGroup.OnItemClick"><short>Triggered when any item changed its state (property Checked). Both True=>False and False=>True are valid.</short>
|
||||
</element><element name="TCustomECCheckGroup.Checked"><short>Maps property Checked of items. This property was added for compatibility with TCheckGroup.</short><seealso><link id="TGroupCtrlItem.Checked"/>
|
||||
</seealso>
|
||||
</element><element name="TECCheckGroup"><short>Visual component. An alternative to TCheckGroup.</short>
|
||||
</element>
|
||||
<element name="TECRadioGroup.Orientation"><short>Denotes orientation of the group control.</short>
|
||||
<example file="examples/tecgroupctrls_ori.txt"/>
|
||||
</element>
|
||||
<element name="TECCheckGroup.Orientation"><short>Denotes orientation of the group control.</short><example file="examples/tecgroupctrls_ori.txt"/>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
27
ECC/docs/ecimagemenu.xml
Normal file
27
ECC/docs/ecimagemenu.xml
Normal file
@@ -0,0 +1,27 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions><package name="eccontrols"><module name="ECImageMenu"><element name="TCaptionAlignment"><short>Enumerated type denoting alingment of the caption.</short>
|
||||
</element><element name="TCaptionAlignment.ecaImageSide"><short>Caption is aligned to image.</short>
|
||||
</element><element name="TCaptionAlignment.ecaOpposite"><short>Caption is aligned to the opposite side of the image.</short>
|
||||
</element><element name="TCaptionAlignment.ecaCentered"><short>Caption is centered in the space by the image.</short>
|
||||
</element><element name="TECImageMenu"><short>Visual component. Vertical menu with images. Similar component is frequently used in KDE4 applications.</short>
|
||||
</element><element name="TCustomECImageMenu"><short>Base class for TECImageMenu. No <b>published</b> properties, no abstract classes.</short>
|
||||
</element><element name="TImageMenuItem"><short>Menu item. Menu is collection of these items.</short>
|
||||
</element><element name="TImageMenuItem.Caption"><short>Caption of menu item. Usually displayed with larger, bold font.</short>
|
||||
</element><element name="TImageMenuItem.Description"><short>Description of menu item. Usually displayed with smaller font.</short>
|
||||
</element><element name="TImageMenuItem.ImageIndex"><short>Index of image. Owner (TCustomECImageMenu) contains link to ImageList (property Images).</short>
|
||||
</element><element name="TImageMenuItems"><short>Collection of menu items. Subclass for TECImageMenu.</short>
|
||||
</element><element name="TCustomECImageMenu.Alternate"><short>Determines whether odd and even menu items are drawn with different (lighter and darker) background.</short>
|
||||
</element><element name="TCustomECImageMenu.CaptionAlign"><short>Alignment of the menu captions.</short><descr>Applies only when Layout = eopLeft or eopRight.
|
||||
Caption is always centered when Layout = eopTop or eopBottom.</descr>
|
||||
</element><element name="TCustomECImageMenu.CaptionFontOptions"><short>Font options of menu captions. Captions are usually displayed with larger, bold font while descriptions are displayed with small font.</short>
|
||||
</element><element name="TCustomECImageMenu.Images"><short>Menu images are taken from this image list.</short>
|
||||
</element><element name="TCustomECImageMenu.Layout"><short>Alignment of the image.</short>
|
||||
</element><element name="TCustomECImageMenu.MenuItems"><short>Subclass containing menu items.</short>
|
||||
</element><element name="TCustomECImageMenu.Spacing"><short>Spacing around images and captions.</short>
|
||||
</element>
|
||||
<short>Visual component TECImageMenu.</short><element name="TImageMenuItems.Items"><short>Collection of menu items.</short>
|
||||
</element><element name="TImageMenuItems.Add"><short>Adds new menu item to collection.</short>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
26
ECC/docs/ecprogressbar.xml
Normal file
26
ECC/docs/ecprogressbar.xml
Normal file
@@ -0,0 +1,26 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions><package name="eccontrols"><module name="ECProgressBar"><element name="TECProgressBar"><short>Visual component. An advanced alternative to TProgressBar.</short>
|
||||
</element><element name="TCustomECProgressBar.CaptionInline"><short>Determines whether caption is drawn on the progress bar, together with Position and Units.</short>
|
||||
</element><element name="TCustomECProgressBar.ProgressDigits"><short>Number of digits or decimal places (formating). Depends on Scale.ValueFormat.</short>
|
||||
</element><element name="TCustomECProgressBar.ProgressFontOptions"><short>Font options of the progress text. Determines font-size, color and font-styles (bold, italic) of the text written inside progress bar.</short>
|
||||
</element><element name="TCustomECProgressBar.ProgressTextAlign"><short>Aligning of the text inside the progress bar.</short><descr>0: Progress text is centered.<br/>
|
||||
Negative values orientation [pixels]: Progress text is aligned to the left (horizontal orientation) or to the bottom (vertical orientation).<br/>
|
||||
Positive values [pixels]: Progress text is aligned to the right (horizontal orientation) or to the top (vertical orientation).</descr>
|
||||
</element><element name="TProgressTextStyle"><short>Enumerated type denoting style of the progress text.</short>
|
||||
</element><element name="TProgressTextStyle.eptNone"><short>No text displayed.</short>
|
||||
</element><element name="TProgressTextStyle.eptSolid"><short>Text is rendered with a solid color.</short>
|
||||
</element><element name="TProgressTextStyle.eptInverted"><short>Text is displayed inverted.</short>
|
||||
</element><element name="TCustomECProgressBar.ProgressTextStyle"><short>Style of the progress text.</short><descr>eptSolid: Text color is ProgressFontOptions.FontColor.
|
||||
eptInverted: Text color is ProgressColor (out of progress) or background color (over progress) - usually clBtnFace. </descr>
|
||||
</element><element name="TCustomECProgressBar.Units"><short>Units are displayed by the value as a part of the progress text. Usually %.</short>
|
||||
</element><element name="TCustomECProgressBar"><short>Base class for TECProgressBar. No abstract classes, no <b>published</b> properties.</short>
|
||||
</element><element name="TCustomECPositionBar"><short>Base class for TECPositionBar. No abstract classes, no <b>published</b> properties.</short>
|
||||
</element><element name="TCustomECPositionBar.ProgressSign"><short>A sign (mark) showing actual position of the progress.</short>
|
||||
</element><element name="TECPositionBar"><short>Visual component. An alternative to TTrackBar or TScrollBar. Similar components are used in Blender (3D graphics software).</short>
|
||||
</element><element name="TCustomECPositionBar.MouseDragPixels"><short>Mouse drag parameter. Number of pixels that is needed to drag to increment or decrement progress position by one pixel.</short><descr>Default is 1, i.e. dragging and progress are 1:1.</descr>
|
||||
</element><element name="TCustomECPositionBar.MouseDragPixelsFine"><short>Mouse drag parameter. CTRL is pressed. Number of pixels that is needed to drag to increment or decrement progress position by one pixel.</short><descr>Default is 10, i.e. dragging and progress are 10:1. Used for fine adjusting.</descr>
|
||||
</element>
|
||||
<short>Visual components TECProgressBar and TECPositionBar.</short>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
33
ECC/docs/ecruler.xml
Normal file
33
ECC/docs/ecruler.xml
Normal file
@@ -0,0 +1,33 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions><package name="eccontrols"><module name="ECRuler"><element name="TECRulerScale"><short>Class is used as a subclass of TECRuler.</short>
|
||||
</element><element name="TPointerStyle"><short>Style of the ruler pointer.</short>
|
||||
</element><element name="TPointerMode"><short>Mode of the ruler pointer. epmMovable means that pointer moves on mouse hovering.</short>
|
||||
</element><element name="TCaptionAlign"><short>Aligning of the Caption on the ruler.</short>
|
||||
</element><element name="TCaptionAlign.ecaBorder"><short>Caption is aligned to the border (bevel) of the ruler.</short>
|
||||
</element><element name="TCaptionAlign.ecaScale"><short>Caption is aligned to the scale.</short>
|
||||
</element><element name="TCaptionAlign.ecaCenter"><short>Caption is centered between border and scale.</short>
|
||||
</element><element name="TECRuler"><short>Visual component - advanced ruler.</short>
|
||||
</element><element name="TCustomECRuler"><short>Base class for TECRuler. No abstract classes, no <b>published</b> properties.</short>
|
||||
</element><element name="TCustomECRuler.SetCaptionPos"/><element name="TCustomECRuler.SetCaptionAlign"/><element name="TCustomECRuler.CaptionAlign"><short>Aligning of the Caption. </short>
|
||||
</element><element name="TCustomECRuler.CaptionPos"><short>Position of the Caption. Left or right for horizontal rulers, top or bottom for vertical rulers.</short>
|
||||
</element><element name="TCustomECRuler.IndentBottomRight"><short>Indentation of the scale from the right/bottom side of the border of the ruler.</short>
|
||||
</element><element name="TCustomECRuler.IndentTopLeft"><short>Indentation of the scale from the left/top side of the border of the ruler.</short>
|
||||
</element><element name="TCustomECRuler.Max"><short>Maximum.</short>
|
||||
</element><element name="TCustomECRuler.Min"><short>Minimum.</short>
|
||||
</element><element name="TCustomECRuler.PointerColor"><short>Color of the pointer.</short>
|
||||
</element><element name="TCustomECRuler.PointerMode"><short>Mode of the pointer. epmMovable moves pointer on mouse hovering.</short>
|
||||
</element><element name="TCustomECRuler.PointerStyle"><short>Style of the pointer (solid, dotted or dashed).</short>
|
||||
</element><element name="TCustomECRuler.PointerWidth"><short>Width of the pointer.</short>
|
||||
</element><element name="TCustomECRuler.Position"><short>Actual position of the pointer on the ruler.</short>
|
||||
</element><element name="TCustomECRuler.PositionToHint"><short>Denotes that current position is displayed in the Hint component.</short>
|
||||
</element><element name="TCustomECRuler.Reversed"><short>Reversed slider, i.e. from Max to Min.</short>
|
||||
</element><element name="TCustomECRuler.Scale"><short>Subclass.</short>
|
||||
</element><element name="TCustomECRuler.ScaleFontOptions"><short>Font options of the scale. Determines font-size, color and font-styles (bold, italic) of the values.</short>
|
||||
</element><element name="TCustomECRuler.ScalePos"><short>Position of the scale on the component. Scale can be aligned to the top/bottom (horizontal ruler) or to the left/right (vertical ruler).</short>
|
||||
</element><element name="TCustomECRuler.OnChangePosition"><short>Triggered when Position is changed.</short>
|
||||
</element><element name="TCustomECRuler.Transparent"><short>Transparent ruler.</short>
|
||||
</element>
|
||||
<short>Visual component TECRuler.</short>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
89
ECC/docs/ecscale.xml
Normal file
89
ECC/docs/ecscale.xml
Normal file
@@ -0,0 +1,89 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions><package name="eccontrols"><module name="ECScale"><element name="TCustomECScale"><descr>You can use this class as a subclass for your own visual components.</descr>
|
||||
<short>Base class for TECScale and TECRulerScale. No abstract classes, no <b>published</b> properties.</short>
|
||||
</element><element name="TCustomECScale.Correction">
|
||||
</element><element name="TCustomECScale.DateTimeFormat"><short>Format of values. For ValueFormat = esvfDate or esvfTime only.</short>
|
||||
</element><element name="TCustomECScale.Digits"><short>Number of digits. Depends on <b>ValueFormat</b>.</short><descr>case <var>ValueFormat</var> of
|
||||
<i>esvfAutoRound</i>: numbers of decimal places (i.e. 10,000 for <var>Digits</var> = 3)
|
||||
<i>esvfFixedRound</i>: numbers of decimal places (i.e. 10,000 for <var>Digits</var> = 3)
|
||||
<i>esvfSmartRound</i>: numbers of decimal places (i.e. 10,50 for <var>Digits</var> = 3)
|
||||
<i>esvfExponential</i>: number of digits of exponent (i.e. 1,00E+001 for <var>Digits</var> = 3)
|
||||
<i>esvfHexadecimal</i>: numbers of digits (i.e. 00A for <var>Digits</var> = 3)
|
||||
<i>esvfMarkHexadec</i>: numbers of digits (i.e. $00A for <var>Digits</var> = 3)
|
||||
<i>esvfOctal</i>: numbers of digits (i.e. 036 for <var>Digits</var> = 3)
|
||||
<i>esvfBinary</i>: numbers of digits (i.e. 1100100 for <var>Digits</var> = 7)
|
||||
<i>esvfDate</i>: does not affect
|
||||
<i>esvfTime</i>: does not affect
|
||||
<i>esvfText</i>: does not affect</descr>
|
||||
</element><element name="TCustomECScale.FontOrientation"><short>Orientation of values (0-3600, 900 ~ 90 degrees)</short>
|
||||
</element><element name="TCustomECScale.LogarithmBase"><short>Only for ScaleType = estLogarithmic.</short>
|
||||
</element><element name="TCustomECScale.ScaleType"><short>Scale can be <i>estLinear</i> or <i>estLogarithmic</i>
|
||||
</short>
|
||||
</element><element name="TCustomECScale.Text"><short>Text can be used instead of values. Values are then indexes of TStringList.</short>
|
||||
</element><element name="TCustomECScale.TickAlign"><short>Alignment of the ticks. Can be <i>etaOuter</i>, <i>etaInner</i>, <i>etaCenter</i>
|
||||
</short>
|
||||
</element><element name="TCustomECScale.TickColor"><short>Color of the ticks. clDefault is clBtnText. Only for TickDesing = etdSimple or etdThick.</short>
|
||||
</element><element name="TCustomECScale.TickDesign"><short>Design of ticks. Can be: <i>etdSimple</i>, <i>etdThick</i>, <i>etd3DLowered</i>, <i>etd3DRaised</i>
|
||||
</short>
|
||||
</element><element name="TCustomECScale.TickIndent"><short>Indent of ticks. Distance of ticks from the edge of component or from the groove of ECSlider.</short>
|
||||
</element><element name="TCustomECScale.TickLength"><short>Length of the long ticks. Medium ticks are 0.7 of this value. Short ticks are 0.5 of this value.</short>
|
||||
</element><element name="TCustomECScale.TickLongValue"><short>Common divisor for long ticks. Only long ticks can have value. Default is 10. For range 0..100 will exist long ticks 0, 10, 20, ... 90, 100.</short>
|
||||
</element><element name="TCustomECScale.TickMiddleValue"><short>Common divisor for middle ticks. Default is 5.</short>
|
||||
</element><element name="TCustomECScale.TickShortValue"><short>Common divisor for short ticks. Default is 1.</short>
|
||||
</element><element name="TCustomECScale.TickVisible"><short>Visibility of ticks (short, middle, long).</short>
|
||||
</element><element name="TCustomECScale.ValueDisplay"><short>Displaying of the values.</short>
|
||||
<seealso><link id="TValueDisplay"/>, <link id="TCustomECScale.ValueIndent"/>, <link id="TCustomECScale.ValueShift"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TValueDisplay.evdNormal"><short>Value is centered to tick (horizontaly in case of horizontal scale).</short>
|
||||
</element><element name="TValueDisplay.evdTopLeft"><short>Values are aligned to the left from tick (in case of horizontal scale).</short>
|
||||
</element><element name="TValueDisplay.evdBottomRight"><short>Values are aligned to the right from tick (in case of horizontal scale).</short>
|
||||
</element><element name="TValueDisplay.evdTopLeftInside"><short>Values are aligned to the left from tick (in case of horizontal scale).</short>
|
||||
</element><element name="TValueDisplay.evdBttmRightInside"><short>Values are aligned to the right from tick (in case of horizontal scale).</short>
|
||||
</element><element name="TValueDisplay.evdCompactTopLeft"><short>Behaves like evdTopLeftInside in case of horizontal scale. In case of vertical scale are values separated to digits and diplayed as a column.</short>
|
||||
</element><element name="TValueDisplay.evdCompactBttmRight"><short>Behaves like evdBttmRightInside in case of horizontal scale. In case of vertical scale are values separated to digits and diplayed as a column.</short>
|
||||
</element><element name="TValueDisplay"><short>Enumeration denoting displaying values of the scale.</short><descr>Position of the values also influe:<br/>
|
||||
|
||||
ValueIndent: distance form tick (vertical in case of horizontal scale)<br/>
|
||||
|
||||
ValueShift: distance ( -/+) from centered position (horizontal in case of horizontal scale)</descr><seealso><link id="TCustomECScale.ValueIndent"/><link id="TCustomECScale.ValueShift"/>
|
||||
</seealso><example file="examples/tvaluedisplay.txt"/>
|
||||
</element>
|
||||
<element name="TCustomECScale.ValueIndent"><short>Distance between ticks and values.</short><seealso><link id="TCustomECScale.ValueDisplay"/>, <link id="TCustomECScale.ValueShift"/>
|
||||
</seealso>
|
||||
</element><element name="TCustomECScale.ValueShift"><short>Shift (in pixels) from the acccurate position.</short><seealso><link id="TCustomECScale.ValueDisplay"/>, <link id="TCustomECScale.ValueIndent"/>
|
||||
</seealso>
|
||||
</element><element name="TScaleType"><short>Enumeration denoting type of a scale.</short>
|
||||
</element><element name="TECScale"><short>Class is used as a subclass of TECSlider, TECProgressBar and TECPositionBar or third party visual components.</short>
|
||||
</element><element name="TTickAlign"><short>Enumeration denoting aligning of the ticks. etaInner means aligning to the groove of a slider or to the edge of a ruler.</short>
|
||||
</element><element name="TTickSize"><short>Enumeration denoting length of the tick. Private type.</short>
|
||||
</element><element name="TTickMetrics"><short>Record containing position and size of the tick. Private type.</short>
|
||||
</element><element name="TTicksVisible"><short>Enumeration denoting visibility of the ticks (short, middle, long).</short>
|
||||
</element><element name="TScaleValueFormat"><short>Enumeration denoting format of the values.</short>
|
||||
</element><element name="TScaleValueFormat.esvfAutoRound"><short>Automatic round.</short>
|
||||
</element><element name="TScaleValueFormat.esvfFixedRound"><short>Fixed number of decimal places.</short>
|
||||
</element><element name="TScaleValueFormat.esvfSmartRound"><short>Advanced rounding.</short>
|
||||
</element><element name="TScaleValueFormat.esvfMarkHexadec"><short>Hexadecimal numbers with $ prefix.</short>
|
||||
</element><element name="TScaleValueFormat.esvfOctal"><short>Octal numbers.</short>
|
||||
</element><element name="TScaleValueFormat.esvfBinary"><short>Binary numbers.</short>
|
||||
</element><element name="TScaleValueFormat.esvfDate"><short>Date.</short>
|
||||
</element><element name="TScaleValueFormat.esvfTime"><short>Time.</short>
|
||||
</element><element name="TScaleValueFormat.esvfHexadecimal"><short>Hexadecimal numbers.</short>
|
||||
</element><element name="TScaleValueFormat.esvfExponential"><short>Decimal numbers with exponent.</short>
|
||||
</element><element name="TCustomECScale.OnPrepareValue"><short>Triggered before the value is painted. Enables user-defined formating.</short><seealso><link id="TCustomECScale.ValueFormat"/>
|
||||
</seealso>
|
||||
</element><element name="TCustomECScale.ValueVisible"><short>Visibility of values (none, bound, regular, all).</short>
|
||||
</element><element name="TCustomECScale.ValueFormat"><short>Format of values (round, hexadecimal, date, time, ... ).</short><seealso><link id="TCustomECScale.OnPrepareValue"/>
|
||||
</seealso>
|
||||
</element><element name="TCustomECScale.GetStringMax"><short>Returns string representation of maximum (Max). Applies correct formatting.</short>
|
||||
</element><element name="TCustomECScale.GetStringMin"><short>Returns string representation of minimum (Min). Applies correct formatting.</short>
|
||||
</element><element name="TCustomECScale.GetPreferredWidth"><short>Returns preferred width (or height) needed to draw a scale. Width for vertical scales, height for horizontal.</short>
|
||||
</element><element name="TCustomECScale.GetStringPosition"><short>Returns string representation of current position. Applies correct formatting.</short>
|
||||
</element><element name="TCustomECScale.SetScaleBounds"><short>Sets bounds of the scale.</short><descr>This method must be called before GetPreferredWidth(), CalcTickPosAndValues() and Draw().</descr>
|
||||
</element><element name="TCustomECScale.CalcTickPosAndValues"><short>Calculates positions of ticks and values. Must be called before Draw().</short>
|
||||
</element><element name="TCustomECScale.Draw"><short>Draws the scale on canvas. CalcTickPosAndValues() must be called before.</short>
|
||||
</element>
|
||||
<short>Class TECScale. Not a component but can draw itself to any canvas.</short>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
57
ECC/docs/ecslider.xml
Normal file
57
ECC/docs/ecslider.xml
Normal file
@@ -0,0 +1,57 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions><package name="eccontrols"><module name="ECSlider"><element name="TProgressStyle"><short>Enumerated type denoting style of the progress.</short>
|
||||
</element><element name="TBaseECSlider"><short>Base class for TCustomECSlider, TCustomECProgressBar and TCustomECPositionBar</short>
|
||||
<descr>This class contains abstract classes. Do not instantiate.</descr>
|
||||
</element><element name="TECSlider"><short>Visual component. An advanced alternative to TTrackBar.</short>
|
||||
</element>
|
||||
<element name="TBaseECSlider.CaptionPos"><short>Position of the Caption.</short>
|
||||
</element><element name="TBaseECSlider.GrooveBevelWidth"><short>Width of the groove bevel. Applies only when GrooveStyle = eosPanel.</short>
|
||||
</element><element name="TBaseECSlider.GrooveColor"><short>Groove color. Applies only when <link id="TBaseECSlider.GrooveTransparent">GrooveTransparent</link> = False. clDefault is clBtnText.</short>
|
||||
</element><element name="TBaseECSlider.GrooveStyle"><short>Denotes the style (button-like, panel-like) of the groove.</short>
|
||||
</element><element name="TBaseECSlider.GrooveTransparent"><short>Deotes whether the groove is transparent or opaque (filled with <link id="TBaseECSlider.GrooveColor">GrooveColor</link>).</short>
|
||||
</element><element name="TBaseECSlider.GrooveWidth"><short>Width of the groove.</short>
|
||||
</element><element name="TBaseECSlider.ImageIndex"><short>Index of the image in ImageList.</short>
|
||||
</element><element name="TBaseECSlider.ImagePos"><short>Position of the image.</short><descr>May depend on <link id="TBaseECSlider.CaptionPos">CaptionPos</link> and Orientation.</descr>
|
||||
</element><element name="TBaseECSlider.Images"><short>Link to associated TImageList.</short>
|
||||
</element><element name="TBaseECSlider.LogarithmicPosition"><short>Logarithmic position. Useful when Scale.ScaleType is estLogarithmic.</short>
|
||||
</element><element name="TBaseECSlider.Indent"><short>Indent of Caption, Scale, Groove, Image etc.</short>
|
||||
</element><element name="TBaseECSlider.Max"><short>Maximal value of the Slider/ProgressBar/PositionBar.</short>
|
||||
</element><element name="TBaseECSlider.Min"><short>Minimal value of the Slider/ProgressBar/PositionBar.</short>
|
||||
</element><element name="TBaseECSlider.Position"><short>Current position.</short>
|
||||
</element><element name="TBaseECSlider.PositionToHint"><short>Denotes that current position is displayed in the Hint component.</short>
|
||||
</element><element name="TBaseECSlider.ProgressColor"><short>Color of the progress.</short>
|
||||
</element><element name="TProgressMark"><short>Enumerated type denoting position of progress mark(s) by the groove.</short><descr>Progress mark(s) can be visible only when GrooveFromMiddle = True.</descr>
|
||||
</element><element name="TProgressVisibility"><short>Enumerated type denoting visibility of the progress.</short>
|
||||
</element><element name="TTickMark"><short>Enumerated type denoting position of the scale (ticks and values) by the groove.</short>
|
||||
</element><element name="TBaseECSlider.ProgressColor2"><short>The second color of the progress.</short>
|
||||
</element><element name="TBaseECSlider.ProgressFromMiddle"><short>Determines the behaviour of the slider.</short><descr>False: Common slider. Progress is painted from Min to Position.<br/>
|
||||
|
||||
True: Slider has defined ProgressMiddlePos. Progress is painted from ProgressMiddlePos to Position.</descr>
|
||||
</element><element name="TBaseECSlider.ProgressMark"><short>Small marks denoting the middle position. Applies only when ProgressFromMiddle = True.</short>
|
||||
</element><element name="TBaseECSlider.ProgressMarkSize"><short>Size of the small marks denoting the middle position. Applies only when ProgressFromMiddle = True.</short>
|
||||
</element><element name="TBaseECSlider.ProgressMiddlePos"><short>The middle position. Should be between Min and Max. Applies only when ProgressFromMiddle = True.</short>
|
||||
</element><element name="TBaseECSlider.ProgressParameter"><short>Design parameter. Applies only when progress is visible and ProgressStyle = epsAesthetic.</short>
|
||||
</element><element name="TBaseECSlider.ProgressVisible"><short>Visibility of the progress.</short><descr>Default is epvProgress. Progress can be also invisible or always fully visible. The second is useful in combination with OnDrawProgressBMP where user can define own progress (for example rainbow gradient for selecting color).</descr>
|
||||
</element><element name="TBaseECSlider.Reversed"><short>Reversed slider, i.e. from Max to Min.</short>
|
||||
</element><element name="TBaseECSlider.Scale"><short>Subclass.</short>
|
||||
</element><element name="TBaseECSlider.ScaleFontOptions"><short>Font options of the scale. Determines font-size, color and font-styles (bold, italic) of the values.</short>
|
||||
</element><element name="TBaseECSlider.ScaleTickPos"><short>Determines whether the ticks of the scale will be on the left, on the right or on both sides of the groove (in case of vertical slider).</short>
|
||||
</element><element name="TBaseECSlider.ScaleValuePos"><short>Determines whether the values of the scale will be on the left, on the right or on both sides of the groove (in case of vertical slider).</short>
|
||||
</element><element name="TBaseECSlider.OnChange"><short>Triggered when <link id="TBaseECSlider.Position">Position</link> is changed.</short>
|
||||
</element><element name="TBaseECSlider.OnDrawProgressBMP"><short>Triggered when internal bitmap of the progress is painted. This enables to draw user-defined progress.</short>
|
||||
</element><element name="TCustomECSlider"><short>Base class for TECSlider. No abstract classes, no <b>published</b> properties.</short>
|
||||
</element><element name="TCustomECSlider.Knob"><short>Subclass.</short>
|
||||
</element><element name="TCustomECSlider.PageSize"><short>The value that increments to Position when user presses PageUp/PageDown or single clicks the left-mouse button on the groove.</short>
|
||||
</element><element name="TCustomECSlider.Increment"><short>The value that increments to Position when user presses arrow keys, [+] or [-].</short><descr>Note: Some widgetsets (like GTK2) uses arrow keys for changing focus of visual components.</descr>
|
||||
</element><element name="TCustomECSlider.DiscreteChange"><short>Applies when Mode = eimDiscrete. Position of the slider can be integer multiple of the DiscreteChange only.</short>
|
||||
</element><element name="TCustomECSlider.Mode"><short>Denoting whether the slider is in eimContinuous (normal, default) or eimDiscrete mode. In discrete mode. Position of the slider can be integer multiple of the DiscreteChange only.</short>
|
||||
</element><element name="TCustomECSlider.RelativeScaleLength"><short>Relative length of the scale. Applies only when Orientation = eooHorizontal and CaptionPos = eopLeft or eopRight.</short><descr>Negative value (default) fits the scale and caption within the component.<br/>
|
||||
Positive value (percents) is the relative scale length.<br/>
|
||||
Useful when more sliders with different captions (like Red, Green, Blue) need to be aligned.</descr>
|
||||
</element><element name="TCustomECSlider.ScaleIndent"><short>Indent of the scale from the groove. Groove length = Scale length + 2 * ScaleIndent.</short>
|
||||
</element><element name="TECSliderKnob"><short>Visual subclass. Knob of the TECSlider.</short>
|
||||
</element>
|
||||
<short>Visual component TECSlider and base classes for TECProgressBar and TECPositionBar.</short>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
158
ECC/docs/ecspinctrls.xml
Normal file
158
ECC/docs/ecspinctrls.xml
Normal file
@@ -0,0 +1,158 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions><package name="eccontrols"><module name="ECSpinCtrls"><element name="TButtonStyle"><short>Enumerated type denoting style of the spin buttons.</short>
|
||||
</element><element name="TButtonStyle.ebsSeparated"><short>Each glyph is drawn on its own button (using ThemeServices).</short>
|
||||
</element><element name="TButtonStyle.ebsClearBlock"><short>All glyphs are drawn on one big button without any separtor.</short>
|
||||
</element><element name="TButtonStyle.ebsSplittedBlock"><short>All glyphs are drawn on one big button (using ThemeServices). They are separated with 3D lowered bevel.</short>
|
||||
</element><element name="TBtnKind"><short>Enumerated type denoting kind of the button.</short>
|
||||
</element><element name="TBtnKind.ebkMin"><short>Sets minumal value.</short>
|
||||
</element><element name="TBtnKind.ebkBigDec"><short>Big decrement.</short>
|
||||
</element><element name="TBtnKind.ebkDec"><short>Small decrement.</short>
|
||||
</element><element name="TBtnKind.ebkMiddle"><short>Sets middle value.</short>
|
||||
</element><element name="TBtnKind.ebkMax"><short>Sets maximal value.</short>
|
||||
</element><element name="TBtnKind.ebkBigInc"><short>Big increment.</short>
|
||||
</element><element name="TBtnKind.ebkInc"><short>Small increment.</short>
|
||||
</element><element name="TBtnKind.ebkMenu"><short>Menu button. Can invoke menu.</short>
|
||||
</element><element name="TBtnKind.ebkDrag"><short>Sets value by mouse dragging.</short>
|
||||
</element><element name="TDragOrientation"><short>Enumerated type denoting direction of mouse dragging.</short>
|
||||
</element><element name="TDragOrientation.edoBoth"><short>Both directions. Vertical dragging for approximate and horizontal dragging for fine setting (or reversely).</short>
|
||||
</element><element name="TDrawGlyphEvent"><short>Method type. Enables user-defined glyphs of buttons.</short>
|
||||
</element><element name="TESOption"><short>Enumerated type. Options for TECSpinEdit.</short>
|
||||
</element><element name="TESOption.esoArrowKeysExceed"><short>Arrow keys, Home/End and PageUp/PageDown can exceed Min and Max values and reach MaxInEdit and MinInEdit.</short>
|
||||
</element><element name="TESOption.esoEditingChangesValue"><short>Editing immediately changes value, it does not wait for EditingDone.</short>
|
||||
</element><element name="TESOption.esoGridMode"><short>Key is reseted if used in KeyDown (Key := #0;).</short>
|
||||
</element><element name="TESOption.esoHomeEndAlt"><short>Alt key is a modifier. Alt + Home/End can reach Max/Min.</short>
|
||||
</element><element name="TESOption.esoHomeEndCtrl"><short>Ctrl key is a modifier. Ctrl + Home/End can reach Max/Min.</short>
|
||||
</element><element name="TESOption.esoUpDownAlt"><short>Alt key is a modifier. Alt + arrow keys can reach spin.</short>
|
||||
</element><element name="TESOption.esoUpDownCtrl"><short>Ctrl key is a modifier. Ctrl + arrow keys can reach spin.</short>
|
||||
</element><element name="TESOption.esoUpDownShift"><short>Shiftt key is a modifier. Shift + arrow keys can reach spin.</short>
|
||||
</element><element name="TESOption.esoUpDownOnly"><short>No modifier. Arrow keys can reach spin.</short>
|
||||
</element><element name="TESOption.esoSpaceClicksMiddle"><short>Modifiers + Space clicks Middle, otherwise it opens Menu.</short>
|
||||
</element><element name="TESOptions"><short>Set of TESOption.</short>
|
||||
</element><element name="TGlyphStyle"><short>Style of built-in glyphs.</short>
|
||||
</element><element name="TModifierEnter"><short>Enumerated type denoting behaviour of modifier (alt, ctrl, meta, shift) + enter key.</short>
|
||||
</element><element name="TValueFormat"><short>Enumerated type denoting format of values.</short>
|
||||
</element>
|
||||
<element name="TCustomControlTimer"><short>Base class for TControlTimer. No <b>published</b> properties, no abstract classes.</short>
|
||||
</element><element name="TControlTimer"><short>Non visual component - advanced timer.</short>
|
||||
</element><element name="TCustomControlTimer.Delay"><short>The very first interval [miliseconds].</short>
|
||||
</element><element name="TCustomControlTimer.Repeating"><short>All the next intervals after the very first (2-nd, 3-rd, 4-th ...) [miliseconds].</short>
|
||||
</element><element name="TCustomControlTimer.Count"/><element name="TCustomControlTimer.MaxCount"><short>Count of intervals. 0 (default) or negative value means infinite count. After reaching this value is timer automatically disabled and OnTimerStop event is triggered.</short>
|
||||
</element><element name="TCustomControlTimer.Counter"><short>Count of intervals.</short>
|
||||
</element>
|
||||
<element name="TSingleSpinBtn"><short>Subclass. <link id="TCustomSpinBtns">TCustomSpinBtns</link> (or descendants) contain nine TSingleSpinBtn instances (one for each small button).</short>
|
||||
</element><element name="TECSpinBtns"><short>Visual component. Advanced alternative to TUpDown.</short>
|
||||
</element><element name="TECSpinBtnsPlus"><short>Visual component. Subclass designed for TECSpinEdit.</short>
|
||||
</element><element name="TECSpinEdit"><short>Visual component. Alternative to TSpinEdit and TFloatSpinEdit.</short>
|
||||
</element><element name="TECSpinController"><short>Non visual component. Designed for controlling properties of multiple <link id="TECSpinBtns">TECSpinBtns</link> and <link id="TECSpinEdit">TECSpinEdit</link>.</short>
|
||||
</element><element name="TECSpinController.ClientList"><short>Generic list of clients (TECSpinBtns and TECSpinEdits).</short>
|
||||
</element><element name="TECSpinController.ActionAltEnter"><short>Controls ActionAltEnter property of all TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.ActionCtrlEnter"><short>Controls ActionCtrlEnter property of all TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.ActionShiftEnter"><short>Controls ActionShiftEnter property of all TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.BtnBigDecWidth"><short>Controls BtnBigDecWidth property of all TECSpinBtns and TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.BtnBigIncWidth"><short>Controls BtnBigIncWidth property of all TECSpinBtns and TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.BtnDecWidth"><short>Controls BtnDecWidth property of all TECSpinBtns and TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.BtnDragWidth"><short>Controls BtnDragWidth property of all TECSpinBtns and TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.BtnIncWidth"><short>Controls BtnIncWidth property of all TECSpinBtns and TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.BtnMaxWidth"><short>Controls BtnMaxWidth property of all TECSpinBtns and TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.BtnMenuWidth"><short>Controls BtnMenuWidth property of all TECSpinBtns and TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.BtnMiddleWidth"><short>Controls BtnMiddleWidth property of all TECSpinBtns and TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.BtnMinWidth"><short>Controls BtnMinWidth property of all TECSpinBtns and TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.GlyphStyle"><short>Controls GlyphStyle property of all TECSpinBtns and TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.Indent"><short>Controls Indent property of all TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.Reversed"><short>Controls Reversed property of all TECSpinBtns and TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.Spacing"><short>Controls Spacing property of all TECSpinBtns and TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.Style"><short>Controls Style property of all TECSpinBtns and TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.TimerDelay"><short>Controls TimerDelay property of all TECSpinBtns and TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.TimerRepeating"><short>Controls TimerRepeating property of all TECSpinBtns and TECSpinEdit clients.</short>
|
||||
</element><element name="TECSpinController.Options"><short>Controls Options property of all TECSpinEdit clients.</short>
|
||||
</element><element name="TCustomSpinBtns"><short>Base class for <link id="TECSpinBtns">TECSpinBtns</link> and <link id="TECSpinBtnsPlus">TECSpinBtnsPlus</link>. No <b>published</b> properties, no abstract classes.</short>
|
||||
</element><element name="TSingleSpinBtn.BtnOrder"><short>Order for button. Buttons can be arranged to any order.</short>
|
||||
</element><element name="TSingleSpinBtn.Caption"><short>Caption. Only short captions (one or two letters) are recommended.</short>
|
||||
</element><element name="TSingleSpinBtn.GlyphColor"><short>Glyph color. Also font color of Caption.</short>
|
||||
</element><element name="TSingleSpinBtn.ImageIndex"><short>Image index. Image is taken from Parent's ImageList (property Images).</short>
|
||||
</element><element name="TSingleSpinBtn.Left"><short>Position of the button (0 is the most left etc.).</short>
|
||||
</element><element name="TSingleSpinBtn.Visible"><short>Visibility. Usually nine buttons are not needed. <link id="TCustomSpinBtns">TCustomSpinBtns</link> (or descendants) can consist from 1-9 buttons.</short>
|
||||
</element><element name="TSingleSpinBtn.Width"><short>Width of button. Each of buttons can have different width.</short>
|
||||
</element><element name="TSingleSpinBtn.Parent"><short>Determines Parent which this button belongs to.</short>
|
||||
</element><element name="TSingleSpinBtn.FEnabled"/><element name="TSingleSpinBtn.Enabled"><short>Buttons ebkMin, ebkMax, ebkDec, ebkInc, ebkBigDec and ebkBigInc are disabled when TECSpinBtns reaches minimum (Min) or maximum (Max).</short>
|
||||
</element><element name="TSingleSpinBtn.Kind"><short>Kind of button.</short>
|
||||
</element><element name="TCustomSpinBtns.BtnBigDec"><short>Subclass. Button designed for big decrease.</short>
|
||||
</element><element name="TCustomSpinBtns.BtnBigInc"><short>Subclass. Button designed for big increase.</short>
|
||||
</element><element name="TCustomSpinBtns.BtnDec"><short>Subclass. Button designed for small decrease.</short>
|
||||
</element><element name="TCustomSpinBtns.BtnInc"><short>Subclass. Button designed for small increase.</short>
|
||||
</element><element name="TCustomSpinBtns.BtnDrag"><short>Subclass. Button designed for mouse dragging, i.e. changing value by mouse move while left mouse button is held.</short>
|
||||
</element><element name="TCustomSpinBtns.BtnMax"><short>Subclass. Button designed for setting maximal possible value.</short>
|
||||
</element><element name="TCustomSpinBtns.BtnMin"><short>Subclass. Button designed for setting minimal possible value.</short>
|
||||
</element><element name="TCustomSpinBtns.BtnMiddle"><short>Subclass. Button designed for setting middle value. It can be 0 or any other user-defined value.</short>
|
||||
</element><element name="TCustomSpinBtns.BtnMenu"><short>Subclass. Button designed for executing menu or other user-defined action.</short>
|
||||
</element><element name="TCustomSpinBtns.OnMenuClick"><short>Event triggered on BtnMenu click.</short>
|
||||
</element><element name="TCustomSpinBtns.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 TSingleSpinBtn.Caption. The third is image from Images. The last is built-in glyph.</descr>
|
||||
</element><element name="TCustomSpinBtns.OnChange"><short>Event triggered on change of Value property.</short>
|
||||
</element><element name="TCustomSpinBtns.Value"><short>Actual value. TECSpinBtns is designed in floating point arithmetic. If you need integer value, use trunc() or round() functions.</short>
|
||||
</element><element name="TCustomSpinBtns.TimerRepeating"><short>The next Intervals [miliseconds], i.e. 2-nd, 3-rd, 4-th and all following intervals. </short>
|
||||
</element><element name="TCustomSpinBtns.TimerDelay"><short>The very fisrt interval [miliseconds].</short>
|
||||
</element><element name="TCustomSpinBtns.Style"><short>Style of button glyphs.</short>
|
||||
</element><element name="TCustomSpinBtns.Spacing"><short>Spacing [pixels]. Distance between buttons.</short>
|
||||
</element><element name="TCustomSpinBtns.Reversed"><short>Determines whether button spinning is reversed.</short><descr>Reversed = False: UP - increases value; DOWN - decrases value (default)<br/>
|
||||
|
||||
Reversed = True: UP - decreases value; DOWN - increases value</descr>
|
||||
</element><element name="TCustomSpinBtns.PageSize"><short>Big increment or decrement. Used by BtnBigInc and BtnBigDec.</short>
|
||||
</element><element name="TCustomSpinBtns.DragControl"><short>Determines which mouse buttons can be used for dragging besides the drag button (BtnDrag). User can always use BtnDrag and left mouse button.</short><descr>This enables mouse dragging even if BtnDrag is not visible.<br/>
|
||||
Example: DragControl = [mbMiddle] captures mouse and enables dragging when any button of TECSpinBtns (including disabled ones and BtnDrag) is clicked by middle mouse button.</descr>
|
||||
</element><element name="TCustomSpinBtns.MenuControl"><short>Determines which mouse buttons can be used for executing menu besides the menu button (BtnMenu). User can always use BtnMenu and left mouse button.</short><descr>This enables executing of menu or user defined action even if BtnMenu is not visible.<br/>
|
||||
|
||||
Example: MenuControl = [mbMiddle] executes menu or user defined action when any button of TECSpinBtns (including disabled ones and BtnMenu) is clicked by middle mouse button.</descr>
|
||||
</element><element name="TCustomSpinBtns.Min"><short>Minimal possible value.</short>
|
||||
</element><element name="TCustomSpinBtns.Max"><short>Maximal possible value.</short>
|
||||
</element><element name="TCustomSpinBtns.Increment"><short>Small increment or decrement. Used by BtnInc and BtnDec.</short>
|
||||
</element><element name="TCustomSpinBtns.DragOrientation"><short>Orientation of mouse dragging. Possible directions: vertical (edoVertical, default), horizontal (edoHorizontal) and both (edoBoth).</short>
|
||||
</element><element name="TCustomSpinBtns.GlyphStyle"><short>Style of glyphs.</short>
|
||||
</element><element name="TCustomSpinBtns.Images"><short>Image list. Single buttons can take images from here. They have ImageIndex property for this purpose.</short>
|
||||
</element><element name="TCustomSpinBtns.Middle"><short>Middle (0) or any other user-defined value.</short>
|
||||
</element><element name="TCustomSpinBtns.MouseFromMiddle"><short>Determines whether mouse dragging starts at actual value (False, default) or at Middle value (True).</short>
|
||||
</element><element name="TCustomSpinBtns.Mode"><short>Denoting whether the spin control is in eimContinuous (normal, default) or eimDiscrete mode. In discrete mode. <link id="TCustomSpinBtns.Value">Value</link> of the spin control can be integer multiple of the DiscreteChange only.</short>
|
||||
</element><element name="TCustomSpinBtns.DiscreteChange"><short>Applies only when Mode = eimDiscrete. <link id="TCustomSpinBtns.Value">Value</link>can hold only integer multiples of DiscreteChange.</short>
|
||||
</element><element name="TCustomSpinBtns.MouseStepPixelsX"><short>Mouse sensitivity in horizontal direction.</short>
|
||||
</element><element name="TCustomSpinBtns.MouseStepPixelsY"><short>Mouse sensitivity in vertical direction.</short>
|
||||
</element><element name="TCustomSpinBtns.MouseIncrementX"><short>Increment for horizontal mouse dragging.</short>
|
||||
</element><element name="TCustomSpinBtns.MouseIncrementY"><short>Increment for vertical mouse dragging.</short>
|
||||
</element><element name="TECSpinBtnsPlus.MaxInEdit"><short>Designed specially for TECSpinEdit. Value edited by keyboard can exceed Max.</short><descr>Feature for experienced users. Usually, Max = MaxInEdit.</descr>
|
||||
</element><element name="TECSpinBtnsPlus.MinInEdit"><short>Designed specially for TECSpinEdit. Value edited by keyboard can exceed Min.</short><descr>Feature for experienced users. Usually, Min = MinInEdit.</descr>
|
||||
</element><element name="TECSpinEdit.ActionAltEnter"><short>Determines what action will happen when user presses Alt+Enter.</short><descr>Possibilities: No action (default), menu button click, middle button click.</descr>
|
||||
</element><element name="TECSpinEdit.ActionCtrlEnter"><short>Determines what action will happen when user presses Ctrl+Enter.</short><descr>Possibilities: No action, menu button click (default), middle button click.</descr>
|
||||
</element><element name="TECSpinEdit.ActionShiftEnter"><short>Determines what action will happen when user presses Shift+Enter.</short><descr>Possibilities: No action (default), menu button click, middle button click.</descr>
|
||||
</element><element name="TECSpinEdit.Buttons"><short>Subclass. Spin-buttons associated to line-edit.</short>
|
||||
</element><element name="TECSpinEdit.Indent"><short>Indent [pixels] of buttons. Distance between line-edit and buttons.</short>
|
||||
</element><element name="TECSpinEdit.BiDiMode"><short>Bi-directional mode. Inherited property.</short><descr>Buttons are sticked to the right for left-to-right languages and to the left for right-to-left languages.</descr>
|
||||
</element><element name="TECSpinBtns.Controller"><short>Link to <link id="TECSpinController">TECSpinController</link>. Controller will control set selected properties.</short>
|
||||
</element><element name="TECSpinEdit.Controller"><short>Link to <link id="TECSpinController">TECSpinController</link>. Controller will control selected set of properties.</short>
|
||||
</element><element name="TECSpinEdit.WidthInclBtns"><short>Width including button width. Common property "Width" gives width of edit only. WidthInclBtns gives width including Buttons and Indent.</short>
|
||||
</element><element name="TECSpinEdit.Value"><short>Actual value. This property reads and writes value from Buttons.Value.</short>
|
||||
</element><element name="TECSpinEdit.ValueFormat"><short>Format of value in line-edit.</short>
|
||||
</element><element name="TECSpinEdit.Items"><short>Applies only for ValueFormat = evfText or evfCombined. Value is index of this string list.</short>
|
||||
</element><element name="TECSpinEdit.MantissaExp"><short>Applies only for ValueFormat = evfExponent or evfMantissa.</short><descr>evfExponent: Value is exponent, MantissaExp is mantissa.<br/>
|
||||
|
||||
evfMantissa: Value is mantissa, MantissaExp is exponent.<br/><br/>
|
||||
|
||||
Example:<br/>
|
||||
|
||||
MantissaExp = 2<br/>
|
||||
|
||||
evfExponent: 1, 2, 4, 8, 16, 32, 64, ...<br/>
|
||||
evfMantissa: 1, 4, 9, 16, 25, 36, 49, 64, ...</descr>
|
||||
</element><element name="TECSpinEdit.DateTimeFormat"><short>Applies only for ValueFormat = evfDate or evfTime.</short>
|
||||
</element><element name="TECSpinEdit.Options"><short>See <link id="TESOption"/>.</short>
|
||||
</element><element name="TECSpinEdit.Digits"><short>Number of digits. Applies to several ValueFormats.</short><descr>evfRound: number of decimal places.<br/>
|
||||
evfExponent: number of decimal places.<br/>
|
||||
evfExponential: number of decimal places and digits of exponent.<br/>
|
||||
evfMantissa: number of decimal places.<br/>
|
||||
evfHexadecimal: number of digits.<br/>
|
||||
evfMarkHexadec: number of digits after $.<br/>
|
||||
evfOctal: number of digits.<br/>
|
||||
evfBinary: number of digits.<br/>
|
||||
</descr>
|
||||
</element>
|
||||
<short>Visual components TECSpinBtns and TECSpinEdit. Non visual components TControlTimer and TECSpinController.</short>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
26
ECC/docs/ecswitch.xml
Normal file
26
ECC/docs/ecswitch.xml
Normal file
@@ -0,0 +1,26 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions><package name="eccontrols"><module name="ECSwitch"><element name="TECSwitchKnob"><short>Visual subclass. Knob of the TECSwitch.</short>
|
||||
</element><element name="TGlyphStyle"><short>Enumerated type denoting style of the glyphs on the groove of TECSwitch.</short>
|
||||
</element><element name="TECSwitchActionLink"><short>Class needed for linking with TAction.</short>
|
||||
</element><element name="TECSwitchActionLinkClass"><short>Class needed for linking with TAction.</short>
|
||||
</element><element name="TCustomECSwitch"><short>Base class for TECSwitch. No abstract classes, no <b>published</b> properties.</short>
|
||||
</element><element name="TECSwitch"><short>Visual component. An advanced alternative to TCheckBox.</short>
|
||||
</element><element name="TCustomECSwitch.AllowGrayed"><short>Denotes whether TCustomECSwitch/TECSwitch can be grayed, i.e. not checked nor unchecked.</short>
|
||||
</element><element name="TCustomECSwitch.CaptionPos"><short>Position of the Caption.</short>
|
||||
</element><element name="TCustomECSwitch.Checked"><short>Denotes whether TECSwitch is On or Off. When State = cbGrayed, Checked is False.</short>
|
||||
</element><element name="TCustomECSwitch.GlyphStyle"><short>Selects style of small glyphs on the groove. Glyphs are built-in, they are stored in resources.</short>
|
||||
</element><element name="TCustomECSwitch.GrooveCheckedClr"><short>Color of the groove of checked switch. clDefault is clActiveCaption.</short>
|
||||
</element><element name="TCustomECSwitch.GrooveUncheckedClr"><short>Color of the groove of unchecked switch. clDefault is cl3DDkShadow.</short>
|
||||
</element><element name="TCustomECSwitch.GrooveIndent"><short>Space (pixels) around groove.</short>
|
||||
</element><element name="TCustomECSwitch.Knob"><short>Subclass.</short>
|
||||
</element><element name="TCustomECSwitch.KnobIndent"><short>Space (pixels) around Knob.</short>
|
||||
</element><element name="TCustomECSwitch.State"><short>State of the switch. Just like TCheckBox, it can be cbUnchecked, cbChecked and cbGrayed.</short>
|
||||
</element><element name="TCustomECSwitch.SwitchColor"><short>Color of the component. Applies only when Style = eosPanel.</short>
|
||||
</element><element name="TCustomECSwitch.SwitchHeight"><short>Height of the switch (does NOT include Caption).</short>
|
||||
</element><element name="TCustomECSwitch.SwitchWidth"><short>Width of the switch (does NOT include Caption).</short>
|
||||
</element><element name="TCustomECSwitch.OnChange"><short>Triggered when State property is changed.</short>
|
||||
</element>
|
||||
<short>Visual component TECSwitch.</short>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
157
ECC/docs/ectypes.xml
Normal file
157
ECC/docs/ectypes.xml
Normal file
@@ -0,0 +1,157 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions><package name="eccontrols"><module name="ECTypes"><element name="TECCustomKnob"><short>Base class for TECSliderKnob and TECSwitchKnob.</short>
|
||||
</element>
|
||||
<element name="TECBaseControl"><short>Base abstract class for TBaseECSlider, TCustomECRuler, TCustomECSwitch.</short>
|
||||
<descr>This class contains many abstract classes. Do not instantiate.</descr>
|
||||
</element>
|
||||
<element name="TItemState"><short>Enumerated type denoting state of TECSpeedBtn, TECSpinBtns or TECGroupCtrls.</short>
|
||||
</element><element name="TItemState.eisPushedDisabled"><short>Item or Button is pushed but not enabled.</short>
|
||||
</element><element name="TGlyphDesign"><short>Enumerated type selecting the built-in glyph of canvas helper class.</short>
|
||||
</element><element name="TGlyphDesign.egdNone"><short>No built-in glyph selected.</short>
|
||||
</element><element name="TGlyphDesign.egdRectBeveled"><short>Color rectangle, frame is 3D lowered.</short>
|
||||
</element><element name="TGlyphDesign.egdRectFramed"><short>Color rectangle, frame is drawn with clBtnText.</short>
|
||||
</element><element name="TIncrementalMode"><short>Enumerated type denoting mode of TECSlider or TECSpinBtns.</short>
|
||||
<descr>Control in mode eimContinuous can hold any floating point value between Min and Max.
|
||||
|
||||
Control in mode eimDiscret can hold only integer multipliers of DiscreteChange (i.e. 0.1, 0.2, 0.3 ... for DiscreteChange = 0.1; it can never be 0.05, 0.15, 0.25).</descr>
|
||||
</element><element name="TIncrementalMode.eimContinuous"><short>TECSlider or TECSpinBtns can hold any floating-point value between Min and Max.</short>
|
||||
</element><element name="TIncrementalMode.eimDiscrete"><short>TECSlider or TECSpinBtns can only hold integer multiples of DiscreteChange.</short>
|
||||
</element><element name="TObjectOrientation"><short>Enumerated type denoting horizontal or vertical orientation of visual component.</short>
|
||||
</element><element name="TObjectPos"><short>Enumerated type denoting position of the element (Caption, Image) within the visual component.</short>
|
||||
</element><element name="TObjectStyle"><short>Enumerated type denoting the style of visual component.</short>
|
||||
</element><element name="TObjectStyle.eosButton"><short>Component is drawn as a PushButton using ThemeServices.</short>
|
||||
</element><element name="TObjectStyle.eosPanel"><short>Component is drawn as a panel using 3D-lowered or 3D-raised frames.</short>
|
||||
</element><element name="TRedrawMode"><short>Enumerated type designed for efficient repainting of complex visual components.</short><descr>For higher efficiency, TBaseECSlider derived components are drawn to bitmaps and these bitmaps (or their parts) are copied to component's Canvas on Paint method.</descr>
|
||||
</element><element name="TRedrawMode.ermHoverKnob"><short>Only Knob of ECSlider is repainted.</short>
|
||||
</element><element name="TRedrawMode.ermMoveKnob"><short>Knob is moved from A to B. Rectangle determined by A, B and space between them is repainted.</short>
|
||||
</element><element name="TRedrawMode.ermFreeRedraw"><short>The most common value. Whole component is repainted. Value can fall to lower state (ermHoverKnob or ermMoveKnob).</short>
|
||||
</element><element name="TRedrawMode.ermRedrawBkgnd"><short>Internal bitmaps are repainted. Whole component is repainted. Value cannot fall to lower states.</short>
|
||||
</element><element name="TRedrawMode.ermRecalcRedraw"><short>Component is recalculated. Internal bitmaps are repainted. Whole component is repainted. Value cannot fall to lower states.</short>
|
||||
</element><element name="TTickDesign"><short>Enumerated type denoting design of ticks (ticks of TECScale or ticks on Knob of TECSlider or TECSwitch).</short>
|
||||
</element><element name="TBasicPos"><short>Enumerated type denoting position of the element (Caption, Scale) within the visual component.</short>
|
||||
<descr>This type is simpilfied. Depends on orientation of object.</descr>
|
||||
</element><element name="TBasicPos.etpTopLeft"><short>Position is <i>Top</i> (in case of horizontal component) or <i>Left</i> (in case of vertical component).</short>
|
||||
</element><element name="TBasicPos.etpBottomRight"><short>Position is <i>Bottom</i> (in case of horizontal component) or <i>Right</i> (in case of vertical component).</short>
|
||||
</element><element name="TTickStyle"><short>Enumerated type denoting style of ticks on the Knob of TECSlider or TECSwitch.</short>
|
||||
</element><element name="TValuesVisibility"><short>Enumerated type denoting visibility of values (numbers) of TECScale.</short>
|
||||
</element><element name="TValuesVisibility.evvNone"><short>No values are displayed.</short>
|
||||
</element><element name="TValuesVisibility.evvBounds"><short>Only bound values are displayed.</short>
|
||||
</element><element name="TValuesVisibility.evvValues"><short>Only regular values are displayed.</short>
|
||||
</element><element name="TValuesVisibility.evvAll"><short>Regular and bound values are displayed (useful when bound values are not regular).</short>
|
||||
</element><element name="TCanvasHelper"><short>Helper class; it can paint built-in glyphs of TECpeedBtn or backgrounds for many EC controls.</short>
|
||||
</element><element name="TCanvasHelper.DrawButtonBackground"><short>Draws Button like background on the canvas. Uses ThemeServices.</short>
|
||||
</element><element name="TCanvasHelper.DrawGlyph"><short>Draws built-in glyphs on the canvas.</short>
|
||||
</element><element name="TCanvasHelper.DrawPanelBackground"><short>Draws panel-like background on the canvas.</short>
|
||||
</element><element name="TCanvasHelper.GlyphExtent"><short>Returns size of glyph.</short>
|
||||
</element><element name="TCanvasHelper.SetRealGlyphColor"><short>Set glyph color. clDefault is clBtnText for Enabled = True. For Enabled = False is color merged: 67% glyph color and 33% background.</short>
|
||||
</element>
|
||||
<element name="TBitmapHelper.TransparentClear"><short>Fills bitmap with transparent color.</short>
|
||||
</element><element name="TFontOptions"><short>Class is used as a subclass for visual components.</short><descr>Visual component has sometimes more text elements which need to have different font parameters. Implementing new TFont instance is exaggerating (memory consuming). TFontOptions is used instead.</descr>
|
||||
</element><element name="TFontOptions.FontColor"><short>Alternative color of parent's font.</short>
|
||||
</element><element name="TFontOptions.FontSize"><short>Alternative font-size of parent's font.</short>
|
||||
</element><element name="TFontOptions.FontStyles"><short>Alternative font-styles of parent's font.</short>
|
||||
</element><element name="TECBaseControl.BeginUpdate"><short>Increases UpdateCount. It reduces number of internal redraws when more than one visual property (color, bevel ...) is changed at a time.</short>
|
||||
</element><element name="TECBaseControl.EndUpdate"><short>Decreases UpdateCount.</short><descr>When UpdateCount is decreased to 0 then depends on Recalculate:<br/>
|
||||
True: calls <link id="TECBaseControl.RecalcRedraw"/><br/>
|
||||
False: calls <link id="TECBaseControl.Redraw"/>
|
||||
</descr>
|
||||
</element><element name="TECBaseControl.RecalcRedraw"><short>Recalculates and redraws internal bitmaps. Abstract method.</short>
|
||||
</element><element name="TECBaseControl.Redraw"><short>Redraws internal bitmaps. Abstract method.</short>
|
||||
</element><element name="TECBaseControl.Redraw_Invalidate"><short>Only calls Invalidate (if UpdateCount = 0). This method does not Redraw internal bitmaps.</short>
|
||||
</element><element name="TECBaseControl.BevelInner"><short>Style of inner bevel. Applies only when Style = eosPanel.</short>
|
||||
<seealso><link id="TECBaseControl.BevelOuter"/><link id="TECBaseControl.BevelSpace"/><link id="TECBaseControl.BevelWidth"/><link id="TECBaseControl.Color3DDark"/><link id="TECBaseControl.Color3DLight"/><link id="TECBaseControl.Redraw3DColorAreas"/>
|
||||
</seealso>
|
||||
</element><element name="TECBaseControl.BevelOuter"><short>Style of outer bevel. Applies only when Style = eosPanel.</short>
|
||||
<seealso><link id="TECBaseControl.BevelInner"/><link id="TECBaseControl.BevelSpace"/><link id="TECBaseControl.BevelWidth"/><link id="TECBaseControl.Color3DDark"/><link id="TECBaseControl.Color3DLight"/><link id="TECBaseControl.Redraw3DColorAreas"/>
|
||||
</seealso>
|
||||
</element><element name="TECBaseControl.BevelSpace"><short>Space between inner and outer bevel. Applies only when Style = eosPanel.</short>
|
||||
<seealso><link id="TECBaseControl.BevelInner"/><link id="TECBaseControl.BevelOuter"/><link id="TECBaseControl.BevelWidth"/><link id="TECBaseControl.Color3DDark"/><link id="TECBaseControl.Color3DLight"/><link id="TECBaseControl.Redraw3DColorAreas"/>
|
||||
</seealso>
|
||||
</element><element name="TECBaseControl.BevelWidth"><short>Width of inner and outer bevel. Inner and outer bevel cannot have different width. Applies only when Style = eosPanel.</short>
|
||||
<seealso><link id="TECBaseControl.BevelInner"/><link id="TECBaseControl.BevelOuter"/><link id="TECBaseControl.BevelSpace"/><link id="TECBaseControl.Color3DDark"/><link id="TECBaseControl.Color3DLight"/><link id="TECBaseControl.Redraw3DColorAreas"/>
|
||||
</seealso>
|
||||
</element><element name="TECBaseControl.Color3DDark"><short>Color of shadowed patrs of the bevel. Applies only when Style = eosPanel.</short>
|
||||
<seealso><link id="TECBaseControl.BevelInner"/><link id="TECBaseControl.BevelOuter"/><link id="TECBaseControl.BevelSpace"/><link id="TECBaseControl.BevelWidth"/><link id="TECBaseControl.Color3DLight"/><link id="TECBaseControl.Redraw3DColorAreas"/>
|
||||
</seealso>
|
||||
</element><element name="TECBaseControl.Color3DLight"><short>Color of enlighted parts of the bevel. Applies only when Style = eosPanel.</short>
|
||||
<seealso><link id="TECBaseControl.BevelInner"/><link id="TECBaseControl.BevelOuter"/><link id="TECBaseControl.BevelSpace"/><link id="TECBaseControl.BevelWidth"/><link id="TECBaseControl.Color3DDark"/><link id="TECBaseControl.Redraw3DColorAreas"/>
|
||||
</seealso>
|
||||
</element><element name="TECBaseControl.Orientation"><short>Denotes whether the visual component is oriented vertically or horizontally.</short>
|
||||
<seealso><link id="TECBaseControl.OrientationChanged"/>
|
||||
</seealso>
|
||||
</element><element name="TECBaseControl.Style"><short>Denotes the style (button-like, panel-like) of the visual component.</short>
|
||||
<seealso><link id="TECBaseControl.StyleChanged"/>
|
||||
</seealso>
|
||||
</element><element name="TECBaseControl.UpdateCount"><short>Counter of updates. UpdateCount > 0 means that component is being updated.</short>
|
||||
</element><element name="TECBaseControl.Redraw3DColorAreas"><short>Redraws those parts of internal bitmaps, which are drawn by Color3DDark or Color3DLight. Abstract method.</short>
|
||||
<seealso><link id="TECBaseControl.BevelInner"/><link id="TECBaseControl.BevelOuter"/><link id="TECBaseControl.BevelSpace"/><link id="TECBaseControl.BevelWidth"/><link id="TECBaseControl.Color3DDark"/><link id="TECBaseControl.Color3DLight"/>
|
||||
</seealso>
|
||||
</element><element name="TECBaseControl.HasCaption"><short>Returns True when visual component has any caption.</short>
|
||||
</element><element name="TECBaseControl.GetBorderWidth"><short>Returns width of border, i.e. inner bevel width + bevel space + outer bevel width.</short>
|
||||
</element><element name="TECBaseControl.OrientationChanged"><short>Triggered when <link id="TECBaseControl.Orientation">Orientation</link> changed.</short>
|
||||
<seealso><link id="TECBaseControl.Orientation"/>
|
||||
</seealso>
|
||||
</element><element name="TECBaseControl.StyleChanged"><short>Triggered when <link id="TECBaseControl.Style">Style</link> changed.</short>
|
||||
<seealso><link id="TECBaseControl.Style"/>
|
||||
</seealso>
|
||||
</element><element name="TECBaseControl.SetAutoSize"/><element name="TECBaseControl.InvalidateGrooveKnobRect"><short>Abstract method.</short>
|
||||
</element><element name="TECCustomKnob.BevelWidth"><short>Bevel width. Applies only when Style = eosPanel.</short>
|
||||
</element><element name="TECCustomKnob.Color"><short>Color of the knob. </short><descr>clDefault is:<br/>
|
||||
clBtnFace when Style = eosButton.<br/>
|
||||
Parent's color when Style = eosPanel.
|
||||
</descr>
|
||||
</element><element name="TECCustomKnob.Style"><short>Denotes the style (button-like, panel-like) of the knob.</short>
|
||||
</element><element name="TECCustomKnob.Height"><short>Height of the knob.</short>
|
||||
</element><element name="TECCustomKnob.Width"><short>Width of the knob.</short>
|
||||
</element><element name="TECCustomKnob.Cursor"><short>TECSlider changes cursor (crHandPoint is default) when knob is hovered. TECSwitch doesn't.</short>
|
||||
</element><element name="TECCustomKnob.TickMarkCount"><short>Number of ticks on the knob.</short>
|
||||
</element><element name="TECCustomKnob.TickMarkDesign"><short>Design of the ticks (etdSimple, etdThick, etd3DLowered or etd3DRaised).</short>
|
||||
</element><element name="TECCustomKnob.TickMarkStyle"><short>Style of the ticks (solid or dotted lines).</short>
|
||||
</element><element name="TECCustomKnob.TickMarkSpacing"><short>Spacing (number of pixels) around ticks.</short>
|
||||
</element><element name="TECCustomKnob.BackgroundColor"><short>Sets unique transparent color for internal bitmaps.</short>
|
||||
</element><element name="TECCustomKnob.DrawKnobs"><short>Draws normal, disabled and highlighted knobs to internal bitmaps.</short>
|
||||
</element><element name="TECCustomKnob.SetSize"><short>Changes size of internal bitmaps and redraws them.</short>
|
||||
</element><element name="TECCustomKnob.RecalcRedraw"><short>Triggers parent's <link id="TECBaseControl.RecalcRedraw">RecalcRedraw</link> method.</short>
|
||||
</element><element name="ARGBToColor"><short>Converts separate 8-bit alpha, red, green and blue values to 32-bit TColor.</short>
|
||||
</element><element name="ColorToRGBA"><short>Splits 32-bit TColor to separate 8-bit alpha, red, green and blue values.</short>
|
||||
</element><element name="GetColorResolvingDefault"><short>Returns color but avoids clDefault because it is a system constant.</short><descr>Returns ASourceColor if it is not <i>clDefault</i>. If yes, returns ADefColor.</descr>
|
||||
</element><element name="GetColorResolvingDefAndEnabled"><short>Returns color but avoids clDefault because it is a system constant. Color is monochromatic when AEnabled = False.</short><descr>Returns ASourceColor if it is not <i>clDefault</i>. If yes, returns ADefColor.
|
||||
If AEnabled = <i>False</i>, returned color is monochromatic.</descr>
|
||||
</element><element name="GetMonochromaticColor"><short>Returns monochromatic color with the same intensity as AColor.</short>
|
||||
</element><element name="GetMergedColor"><short>Merges two colors with defined proportion.</short><descr>AProportion should be between 0 and 1.<br/>
|
||||
Proportion 1 returns AColor.<br/>
|
||||
Proportion 0 returns BColor.</descr>
|
||||
</element><element name="IsInRange"><short>Returns True if AValue is in interval (including endpoint).</short><descr>Regardless the order of endpoints, i.e IsInRange(2, 1, 3) and IsInRange (2, 3, 1) gives the same result (<i>True</i>).</descr>
|
||||
</element><element name="LinearToLogarithmic"><short>Converts linear position on the logarithmic scale to the logarithmic value.</short>
|
||||
<example file="examples/lineartologarithmic.txt"/><descr>Note: Negative bounds are set to 0.</descr>
|
||||
</element>
|
||||
<short>Base types and classes for Eye Candy Controls (EC-C).</short>
|
||||
<element name="TObjectMethod"><short>Alias for the simpliest method without any parmeters.</short>
|
||||
</element>
|
||||
<element name="TItemState.eisDisabled"><short>Item or Button is not enabled and not pushed.</short>
|
||||
</element><element name="TItemState.eisHighlighted"><short>Item or Button is enabled and is hovered by mouse.</short>
|
||||
</element><element name="TItemState.eisEnabled"><short>Item or Button is enabled and not hovered by mouse.</short>
|
||||
</element><element name="TItemState.eisPushed"><short>Item or Button is enabled, pushed and not hovered by mouse.</short>
|
||||
</element><element name="TItemState.eisPushedHihlighted"><short>Item or Button is enabled, pushed and hovered by mouse.</short>
|
||||
</element><element name="TItemStates"><short>Set of TItemState.</short><descr>Images of TECSpeedBtn and TECGroupCtrls are stored in internal bitmaps. This type denotes which states are actually needed (i.e. [eisHighlighted, eisEnabled, eisPushed, eisPushedHihlighted] when Enabled = True and [eisDisabled, eisPushedDisabled] when Enabled = False). This type was introduced for optimalization. It reduces overhead these controls stores 4 or 2 bitmaps instead of 6.</descr>
|
||||
</element>
|
||||
<element name="TTickDesign.etdSimple"><short>Simple line 1 pixel wide.</short>
|
||||
</element><element name="TTickDesign.etdThick"><short>Simple line 2 pixels wide.</short>
|
||||
</element><element name="TTickDesign.etd3DLowered"><short>Two lines with different colors simulate lowered bevel.</short>
|
||||
</element><element name="TTickDesign.etd3DRaised"><short>Two lines with different colors simulate raised bevel.</short>
|
||||
</element><element name="TMouseMethod"><short>Method used for grouped controls. Parameters are mouse-button and shift-state.</short>
|
||||
</element><element name="TOnPrepareValue"><short>Event. Can be used for modify values of TECScale for custom-drawn scales.</short>
|
||||
</element><element name="TBitmapHelper.SetProperties"><short>Sets basic properties for bitmaps used in many EC-Controls.</short>
|
||||
</element><element name="TFontOptions.Parent"><short>Parent of the class. Is responsible for freeing.</short>
|
||||
</element><element name="TFontOptions.OnRecalcRedraw"><short>Method that is called when parent component needs to be recalculated (when font-size is changed).</short>
|
||||
</element><element name="TFontOptions.OnRedraw"><short>Method that is called when parent component needs to be redrawn (when font-color is changed).</short>
|
||||
</element>
|
||||
<element name="TECBaseControl.InvalidateNonUpdated"><short>Invalidates component only when UpdateCount = 0.</short>
|
||||
</element><element name="TECBaseControl.InvalidateCustomRect"><short>Invalidates custom rectangle, i.e. when knob of slider is moved.</short>
|
||||
</element><element name="TECBaseControl.WMPaint"><short>This message method resolves difference between Paints invoked by InvalidateRect and by system. It prevents controls from unwanted vanishing.</short>
|
||||
</element><element name="TECBaseControl.RedrawMode"><short>Redraw mode of TECBaseControl.</short><seealso><link id="TRedrawMode"/>
|
||||
</seealso>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
18
ECC/docs/examples/lineartologarithmic.txt
Normal file
18
ECC/docs/examples/lineartologarithmic.txt
Normal file
@@ -0,0 +1,18 @@
|
||||
{Assume the logathmic scale from 10 to 1000.
|
||||
|
||||
We are in the middle, i.e. "linear" 505.}
|
||||
|
||||
//See the code
|
||||
|
||||
aProportion := (505-10)/(1000-10) = 495/990 = 0.5
|
||||
|
||||
AMin := logn(10, 10) = 1
|
||||
|
||||
AMax := logn(10, 1000) = 3
|
||||
|
||||
Result := 10^(1+(3+1)*0.5) = 10^2 = 100
|
||||
|
||||
{... which is correct since 100 is in the middle of logarithmic scale 10 .. 1000.}
|
||||
|
||||
| | | | | | | ||| | | | | | | ||
|
||||
10 100 (505) 1000
|
80
ECC/docs/examples/tecgroupctrls_ori.txt
Normal file
80
ECC/docs/examples/tecgroupctrls_ori.txt
Normal file
@@ -0,0 +1,80 @@
|
||||
{ Orientation = eooHorizontal, BiDiMode = bdLeftToRight, [] in Options }
|
||||
|
||||
1 2 3
|
||||
|
||||
{ or }
|
||||
|
||||
1 2
|
||||
3 4
|
||||
|
||||
{ Orientation = eooHorizontal, BiDiMode = bdLeftToRight, [egoColumnThenRow] in Options }
|
||||
|
||||
1 2 3
|
||||
|
||||
{ or }
|
||||
|
||||
1 3
|
||||
2 4
|
||||
|
||||
{ Orientation = eooHorizontal, BiDiMode = bdRightToLeft, [] in Options }
|
||||
|
||||
3 2 1
|
||||
|
||||
{ or }
|
||||
|
||||
2 1
|
||||
4 3
|
||||
|
||||
{ Orientation = eooHorizontal, BiDiMode = bdRightToLeft, [egoColumnThenRow] in Options }
|
||||
|
||||
3 2 1
|
||||
|
||||
{ or }
|
||||
|
||||
3 1
|
||||
4 2
|
||||
|
||||
{ Orientation = eooVertical, BiDiMode = bdLeftToRight, [] in Options }
|
||||
|
||||
3
|
||||
2
|
||||
1
|
||||
|
||||
{ or }
|
||||
|
||||
2 4
|
||||
1 3
|
||||
|
||||
{ Orientation = eooVertical, BiDiMode = bdLeftToRight, [egoColumnThenRow] in Options }
|
||||
|
||||
3
|
||||
2
|
||||
1
|
||||
|
||||
{ or }
|
||||
|
||||
3 4
|
||||
1 2
|
||||
|
||||
{ Orientation = eooVertical, BiDiMode = bdRightToLeft, [] in Options }
|
||||
|
||||
1
|
||||
2
|
||||
3
|
||||
|
||||
{ or }
|
||||
|
||||
1 3
|
||||
2 4
|
||||
|
||||
{ Orientation = eooVertical, BiDiMode = bdRightToLeft, [egoColumnThenRow] in Options }
|
||||
|
||||
1
|
||||
2
|
||||
3
|
||||
|
||||
{ or }
|
||||
|
||||
1 2
|
||||
3 4
|
||||
|
122
ECC/docs/examples/tvaluedisplay.txt
Normal file
122
ECC/docs/examples/tvaluedisplay.txt
Normal file
@@ -0,0 +1,122 @@
|
||||
Horizontal Scales:
|
||||
|
||||
evdNormal:
|
||||
| | | | | | | | | | |
|
||||
| | |
|
||||
|
|
||||
|
||||
125
|
||||
|
||||
evdTopLeft:
|
||||
| | | | | | | | | | |
|
||||
| | |
|
||||
|
|
||||
|
||||
125
|
||||
|
||||
evdBottomRight:
|
||||
| | | | | | | | | | |
|
||||
| | |
|
||||
|
|
||||
|
||||
125
|
||||
|
||||
evdTopLeftInside, evdCompactTopLeft:
|
||||
| | | | | | | | | | |
|
||||
| | |
|
||||
125|
|
||||
|
||||
|
||||
evdBttmRightInside, evdCompactBttmRight:
|
||||
| | | | | | | | | | |
|
||||
| | |
|
||||
|125
|
||||
|
||||
|
||||
|
||||
Vertical Scales:
|
||||
|
||||
evdNormal:
|
||||
--
|
||||
--
|
||||
125 -----
|
||||
--
|
||||
--
|
||||
|
||||
evdTopLeft:
|
||||
___
|
||||
__
|
||||
__
|
||||
__
|
||||
125 __
|
||||
_____
|
||||
__
|
||||
__
|
||||
__
|
||||
__
|
||||
___
|
||||
|
||||
evdBottomRight:
|
||||
___
|
||||
__
|
||||
__
|
||||
__
|
||||
__
|
||||
_____
|
||||
125 __
|
||||
__
|
||||
__
|
||||
__
|
||||
___
|
||||
|
||||
evdTopLeftInside:
|
||||
___
|
||||
__
|
||||
__
|
||||
__
|
||||
125 __
|
||||
_____
|
||||
__
|
||||
__
|
||||
__
|
||||
__
|
||||
___
|
||||
|
||||
evdBttmRightInside:
|
||||
___
|
||||
__
|
||||
__
|
||||
__
|
||||
__
|
||||
_____
|
||||
125 __
|
||||
__
|
||||
__
|
||||
__
|
||||
___
|
||||
|
||||
evdCompactTopLeft:
|
||||
_____ (130)
|
||||
__
|
||||
__
|
||||
__
|
||||
__
|
||||
___
|
||||
__
|
||||
1 __
|
||||
2 __
|
||||
5 __
|
||||
_____ (125)
|
||||
|
||||
evdCompactBttmRight:
|
||||
_____ (125)
|
||||
1 __
|
||||
2 __
|
||||
5 __
|
||||
__
|
||||
___
|
||||
__
|
||||
__
|
||||
__
|
||||
__
|
||||
_____ (120)
|
Reference in New Issue
Block a user