..
  This file was automatically converted from MediaWiki syntax.
  If some markup is wrong, looks weird or doesn't make sense, feel free
  to fix it.

  Please remove this comment once this file was manually checked
  and no "strange ReST" artifacts remain.

.. _directslider:

DirectSlider
============

Use a DirectSlider to make a slider, a widget that allows the user to select a
value between a bounded interval. DirectSlider is available beginning in
Panda3D 1.1.

A DirectSlider consists of a long bar, by default horizontal, along with a
"thumb", which is a special button that the user may move left or right along
the bar. The normal DirectGui parameters such as frameSize, geom, and relief
control the look of the bar; to control the look of the thumb, prefix each of
these parameters with the prefix "thumb\_", e.g.
``thumb_frameSize``.

If you want to get (or modify) the current value of the slider (by default,
the range is between 0 and 1), use
``mySlider['value']``.

+-------------------------------------------------------------------+---------------------------------------------------------------------------------+----------------------------------------------+
| **Keyword**                                                       | **Definition**                                                                  | **Value**                                    |
+-------------------------------------------------------------------+---------------------------------------------------------------------------------+----------------------------------------------+
| value                                                             | Initial value of the slider                                                     | Default is 0                                 |
+-------------------------------------------------------------------+---------------------------------------------------------------------------------+----------------------------------------------+
| range                                                             | The (min, max) range of the slider                                              | Default is (0, 1)                            |
+-------------------------------------------------------------------+---------------------------------------------------------------------------------+----------------------------------------------+
| pageSize                                                          | The amount to jump the slider when the user clicks left or right of the thumb   | Default is 0.1                               |
+-------------------------------------------------------------------+---------------------------------------------------------------------------------+----------------------------------------------+
| orientation                                                       | The orientation of the slider                                                   | HORIZONTAL or VERTICAL                       |
+-------------------------------------------------------------------+---------------------------------------------------------------------------------+----------------------------------------------+
| command                                                           | Function called when the value of the slider changes (takes no arguments)       | Function                                     |
+-------------------------------------------------------------------+---------------------------------------------------------------------------------+----------------------------------------------+
| extraArgs                                                         | Extra arguments to the function specified in command                            | [Extra Arguments]                            |
+-------------------------------------------------------------------+---------------------------------------------------------------------------------+----------------------------------------------+
| thumb\_geom, thumb\_relief, thumb\_text, thumb\_frameSize, etc.   | Parameters to control the look of the thumb                                     | Any parameters appropriate to DirectButton   |
+-------------------------------------------------------------------+---------------------------------------------------------------------------------+----------------------------------------------+


Example
=======




.. code-block:: python
    
    import direct.directbase.DirectStart
    from direct.gui.DirectGui import *
    
    def showValue():
        print slider['value']
    
    slider = DirectSlider(range=(0,100), value=50, pageSize=3, command=showValue)
    
    run()



"range" sets values between 0 and 100 "value" sets initial value to 50
"pageSize" sets the step between mouseclicks to 3 (approximately) "command"
calls the showValue-function implemented above