lasarus_compotents/ECC/docs/ecslider.xml

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