summaryrefslogtreecommitdiff
path: root/doc/classes/Range.xml
diff options
context:
space:
mode:
authorJuan Linietsky <reduzio@gmail.com>2017-09-12 17:42:36 -0300
committerJuan Linietsky <reduzio@gmail.com>2017-09-12 17:45:41 -0300
commit4f929a0fdfae24b1ca5acf0b732219119090ee43 (patch)
tree730471182cae00f2e47c7430db441d057383d29b /doc/classes/Range.xml
parent175777596ec3521731665dd750fd7087793b10fc (diff)
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
recognize them.
Diffstat (limited to 'doc/classes/Range.xml')
-rw-r--r--doc/classes/Range.xml182
1 files changed, 182 insertions, 0 deletions
diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml
new file mode 100644
index 0000000000..0543cdd111
--- /dev/null
+++ b/doc/classes/Range.xml
@@ -0,0 +1,182 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="Range" inherits="Control" category="Core" version="3.0.alpha.custom_build">
+ <brief_description>
+ Abstract base class for range-based controls.
+ </brief_description>
+ <description>
+ Range is a base class for [Control] nodes that change a floating point [i]value[/i] between a [i]minimum[/i] and a [i]maximum[/i], using [i]step[/i] and [i]page[/i], for example a [ScrollBar].
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="get_as_ratio" qualifiers="const">
+ <return type="float">
+ </return>
+ <description>
+ Return value mapped to 0 to 1 range.
+ </description>
+ </method>
+ <method name="get_max" qualifiers="const">
+ <return type="float">
+ </return>
+ <description>
+ Return the maximum value.
+ </description>
+ </method>
+ <method name="get_min" qualifiers="const">
+ <return type="float">
+ </return>
+ <description>
+ Return the minimum value.
+ </description>
+ </method>
+ <method name="get_page" qualifiers="const">
+ <return type="float">
+ </return>
+ <description>
+ Return the page size, if page is 0, paging is disabled.
+ </description>
+ </method>
+ <method name="get_step" qualifiers="const">
+ <return type="float">
+ </return>
+ <description>
+ Return the stepping, if step is 0, stepping is disabled.
+ </description>
+ </method>
+ <method name="get_value" qualifiers="const">
+ <return type="float">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="is_ratio_exp" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="is_using_rounded_values" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="set_as_ratio">
+ <return type="void">
+ </return>
+ <argument index="0" name="value" type="float">
+ </argument>
+ <description>
+ Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max.
+ </description>
+ </method>
+ <method name="set_exp_ratio">
+ <return type="void">
+ </return>
+ <argument index="0" name="enabled" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_max">
+ <return type="void">
+ </return>
+ <argument index="0" name="maximum" type="float">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_min">
+ <return type="void">
+ </return>
+ <argument index="0" name="minimum" type="float">
+ </argument>
+ <description>
+ Set minimum value, clamped range value to it if it's less.
+ </description>
+ </method>
+ <method name="set_page">
+ <return type="void">
+ </return>
+ <argument index="0" name="pagesize" type="float">
+ </argument>
+ <description>
+ Set page size. Page is mainly used for scrollbars or anything that controls text scrolling.
+ </description>
+ </method>
+ <method name="set_step">
+ <return type="void">
+ </return>
+ <argument index="0" name="step" type="float">
+ </argument>
+ <description>
+ Set step value. If step is 0, stepping will be disabled.
+ </description>
+ </method>
+ <method name="set_use_rounded_values">
+ <return type="void">
+ </return>
+ <argument index="0" name="enabled" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_value">
+ <return type="void">
+ </return>
+ <argument index="0" name="value" type="float">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="share">
+ <return type="void">
+ </return>
+ <argument index="0" name="with" type="Node">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="unshare">
+ <return type="void">
+ </return>
+ <description>
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="exp_edit" type="bool" setter="set_exp_ratio" getter="is_ratio_exp" brief="">
+ </member>
+ <member name="max_value" type="float" setter="set_max" getter="get_max" brief="">
+ </member>
+ <member name="min_value" type="float" setter="set_min" getter="get_min" brief="">
+ </member>
+ <member name="page" type="float" setter="set_page" getter="get_page" brief="">
+ </member>
+ <member name="rounded" type="bool" setter="set_use_rounded_values" getter="is_using_rounded_values" brief="">
+ </member>
+ <member name="step" type="float" setter="set_step" getter="get_step" brief="">
+ </member>
+ <member name="value" type="float" setter="set_value" getter="get_value" brief="">
+ </member>
+ </members>
+ <signals>
+ <signal name="changed">
+ <description>
+ This signal is emitted when min, max, range or step change.
+ </description>
+ </signal>
+ <signal name="value_changed">
+ <argument index="0" name="value" type="float">
+ </argument>
+ <description>
+ This signal is emitted when value changes.
+ </description>
+ </signal>
+ </signals>
+ <constants>
+ </constants>
+</class>