/Doc/Slider.html

https://bitbucket.org/alsh/pygui-mirror · HTML · 52 lines · 52 code · 0 blank · 0 comment · 0 complexity · 06896540a0ee8ddf05b6ccea966ecb50 MD5 · raw file 

    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="content-type"><title>PyGUI - class Slider</title></head><body>
    3. 

  3. <h1>class Slider(<a href="Control.html">Control</a>)</h1>
    4. 

  4. A Slider is a control that allows a user to select a value by dragging
    5. 

  5. a knob along a scale. The range of values may be either discrete or
    6. 

  6. continuous, and an action may be specified to be invoked whenever the
    7. 

  7. user changes the value.<br>
    8. 

  8. <h2>Constructor</h2>
    9. 

  9. <div style="margin-left: 40px;">
    10. 

  10. <dl>
    11. 

  11.   <dt style="font-family: monospace;">Slider(orient)</dt>
    12. 

  12.   <dd>Constructs a Slide with the specified orientation, 'h' for horizontal and 'v' for vertical.<br>
    13. 

  13. Note: On some platforms, the orientation of the slider is determined by
    14. 

  14. its relative width and height; on such platforms, the orient parameter
    15. 

  15. is ignored. For maximum portability, ensure that the dimensions of the
    16. 

  16. control and the orient parameter are in agreement with each other.</dd>
    17. 

  17. </dl>
    18. 

  18. </div>
    19. 

  19. <h2>Properties</h2>
    20. 

  20. <div style="margin-left: 40px;">
    21. 

  21. <dl>
    22. 

  22.   <dt style="font-family: monospace;">value</dt>
    23. 

  23.   <dd>The current value of the slider.<br>
    24. 

  24.     <br>
    25. 

  25.   </dd>
    26. 

  26.   <dt><span style="font-family: monospace;">min_value</span><br>
    27. 

  27.     <span style="font-family: monospace;">max_value</span></dt>
    28. 

  28.   <dd>The minimum and maximum values to which the slider can be set. These default to 0.0 and 1.0.<br>
    29. 

  29.     <br>
    30. 

  30.   </dd>
    31. 

  31.   <dt style="font-family: monospace;">action</dt>
    32. 

  32.   <dd>Action to perform when the user changes the value of the slider. See <a href="actions.html">Actions</a>.<br>
    33. 

  33.     <br>
    34. 

  34.   </dd>
    35. 

  35.   <dt style="font-family: monospace;">ticks</dt>
    36. 

  36.   <dd>The number of tick marks to display beside the slider, including
    37. 

  37. the ones at each end. If this is set to 0, no tick marks will be
    38. 

  38. displayed. The default is not to show any tick marks.<br>
    39. 

  39.     <br>
    40. 

  40.   </dd>
    41. 

  41.   <dt style="font-family: monospace;">discrete</dt>
    42. 

  42.   <dd>If true, the value of the control is constrained to correspond to one of the tick marks specified with the <span style="font-family: monospace;">ticks</span> property. If false, the value may be set to anything between the <span style="font-family: monospace;">min_value</span> and <span style="font-family: monospace;">max_value</span>. The default is false.<br>
    43. 

  43.     <br>
    44. 

  44.   </dd>
    45. 

  45.   <dt style="font-family: monospace;">live</dt>
    46. 

  46.   <dd>If true, the slider's action will be invoked continuously while
    47. 

  47. the knob is being dragged. If false, the action will only be invoked
    48. 

  48. when the mouse is released. The default is true.</dd>
    49. 

  49. </dl>
    50. 

  50. </div>
    51. 

  51. ---<br>
    52. 

  52. </body></html>
    53.