lasarus_compotents/ECC/docs/ecprogressbar.xml

27 lines
3.4 KiB
XML

<?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>