Add classes ref generated by makerst.py

classes/class_range.rst

@@ -0,0 +1,176 @@
+.. _class_Range:
+
+Range
+=====
+
+Inherits: :ref:`Control<class_control>`
+---------------------------------------
+
+Category: Core
+--------------
+
+Brief Description
+-----------------
+
+Abstract base class for range-based controls.
+
+Member Functions
+----------------
+
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| :ref:`float<class_float>`  | :ref:`get_val<class_Range_get_val>`  **(** **)** const                                                  |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| :ref:`float<class_float>`  | :ref:`get_value<class_Range_get_value>`  **(** **)** const                                              |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| :ref:`float<class_float>`  | :ref:`get_min<class_Range_get_min>`  **(** **)** const                                                  |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| :ref:`float<class_float>`  | :ref:`get_max<class_Range_get_max>`  **(** **)** const                                                  |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| :ref:`float<class_float>`  | :ref:`get_step<class_Range_get_step>`  **(** **)** const                                                |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| :ref:`float<class_float>`  | :ref:`get_page<class_Range_get_page>`  **(** **)** const                                                |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| :ref:`float<class_float>`  | :ref:`get_unit_value<class_Range_get_unit_value>`  **(** **)** const                                    |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| void                       | :ref:`set_val<class_Range_set_val>`  **(** :ref:`float<class_float>` value  **)**                       |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| void                       | :ref:`set_value<class_Range_set_value>`  **(** :ref:`float<class_float>` value  **)**                   |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| void                       | :ref:`set_min<class_Range_set_min>`  **(** :ref:`float<class_float>` minimum  **)**                     |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| void                       | :ref:`set_max<class_Range_set_max>`  **(** :ref:`float<class_float>` maximum  **)**                     |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| void                       | :ref:`set_step<class_Range_set_step>`  **(** :ref:`float<class_float>` step  **)**                      |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| void                       | :ref:`set_page<class_Range_set_page>`  **(** :ref:`float<class_float>` pagesize  **)**                  |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| void                       | :ref:`set_unit_value<class_Range_set_unit_value>`  **(** :ref:`float<class_float>` value  **)**         |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| void                       | :ref:`set_rounded_values<class_Range_set_rounded_values>`  **(** :ref:`bool<class_bool>` enabled  **)** |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| :ref:`bool<class_bool>`    | :ref:`is_rounded_values<class_Range_is_rounded_values>`  **(** **)** const                              |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| void                       | :ref:`set_exp_unit_value<class_Range_set_exp_unit_value>`  **(** :ref:`bool<class_bool>` enabled  **)** |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| :ref:`bool<class_bool>`    | :ref:`is_unit_value_exp<class_Range_is_unit_value_exp>`  **(** **)** const                              |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| void                       | :ref:`share<class_Range_share>`  **(** :ref:`Object<class_object>` with  **)**                          |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+| void                       | :ref:`unshare<class_Range_unshare>`  **(** **)**                                                        |
++----------------------------+---------------------------------------------------------------------------------------------------------+
+
+Signals
+-------
+
+-  **value_changed**  **(** :ref:`float<class_float>` value  **)**
+-  **changed**  **(** **)**
+
+Description
+-----------
+
+Range is a base class for :ref:`Control<class_control>` nodes that change a floating point *value* between a *minimum* and a *maximum*, using *step* and *page*, for example a :ref:`ScrollBar<class_scrollbar>`.
+
+Member Function Description
+---------------------------
+
+.. _class_Range_get_val:
+
+- :ref:`float<class_float>`  **get_val**  **(** **)** const
+
+Return the current value.
+
+.. _class_Range_get_value:
+
+- :ref:`float<class_float>`  **get_value**  **(** **)** const
+
+.. _class_Range_get_min:
+
+- :ref:`float<class_float>`  **get_min**  **(** **)** const
+
+Return the minimum value.
+
+.. _class_Range_get_max:
+
+- :ref:`float<class_float>`  **get_max**  **(** **)** const
+
+Return the maximum value.
+
+.. _class_Range_get_step:
+
+- :ref:`float<class_float>`  **get_step**  **(** **)** const
+
+Return the stepping, if step is 0, stepping is disabled.
+
+.. _class_Range_get_page:
+
+- :ref:`float<class_float>`  **get_page**  **(** **)** const
+
+Return the page size, if page is 0, paging is disabled.
+
+.. _class_Range_get_unit_value:
+
+- :ref:`float<class_float>`  **get_unit_value**  **(** **)** const
+
+Return value mapped to 0 to 1 (unit) range.
+
+.. _class_Range_set_val:
+
+- void  **set_val**  **(** :ref:`float<class_float>` value  **)**
+
+.. _class_Range_set_value:
+
+- void  **set_value**  **(** :ref:`float<class_float>` value  **)**
+
+.. _class_Range_set_min:
+
+- void  **set_min**  **(** :ref:`float<class_float>` minimum  **)**
+
+Set minimum value, clamped range value to it if it's less.
+
+.. _class_Range_set_max:
+
+- void  **set_max**  **(** :ref:`float<class_float>` maximum  **)**
+
+.. _class_Range_set_step:
+
+- void  **set_step**  **(** :ref:`float<class_float>` step  **)**
+
+Set step value. If step is 0, stepping will be disabled.
+
+.. _class_Range_set_page:
+
+- void  **set_page**  **(** :ref:`float<class_float>` pagesize  **)**
+
+Set page size. Page is mainly used for scrollbars or anything that controls text scrolling.
+
+.. _class_Range_set_unit_value:
+
+- void  **set_unit_value**  **(** :ref:`float<class_float>` value  **)**
+
+Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max.
+
+.. _class_Range_set_rounded_values:
+
+- void  **set_rounded_values**  **(** :ref:`bool<class_bool>` enabled  **)**
+
+.. _class_Range_is_rounded_values:
+
+- :ref:`bool<class_bool>`  **is_rounded_values**  **(** **)** const
+
+.. _class_Range_set_exp_unit_value:
+
+- void  **set_exp_unit_value**  **(** :ref:`bool<class_bool>` enabled  **)**
+
+.. _class_Range_is_unit_value_exp:
+
+- :ref:`bool<class_bool>`  **is_unit_value_exp**  **(** **)** const
+
+.. _class_Range_share:
+
+- void  **share**  **(** :ref:`Object<class_object>` with  **)**
+
+.. _class_Range_unshare:
+
+- void  **unshare**  **(** **)**
+
+