diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2019-06-29 11:41:14 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-06-29 11:41:14 +0200 |
| commit | 1bbad8c4690ac988932e3695a54f869ebd4c32a4 (patch) | |
| tree | 0fc359fb028455b15e386e7f62271941f01a7d65 /doc | |
| parent | 9adc158097b5bfdb14fbd283918183e19bd2b133 (diff) | |
| parent | f9cbd34fe04e41120e8d6413669c86a342267888 (diff) | |
Merge pull request #29923 from zaksnet/Document-Spinbox
Document SpinBox Node
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/SpinBox.xml | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/classes/SpinBox.xml b/doc/classes/SpinBox.xml index 8e2e2f1baa..3388af2dd0 100644 --- a/doc/classes/SpinBox.xml +++ b/doc/classes/SpinBox.xml @@ -5,6 +5,16 @@ </brief_description> <description> SpinBox is a numerical input text field. It allows entering integers and floats. + [b]Example:[/b] + [codeblock] + var spin_box = SpinBox.new() + add_child(spin_box) + var line_edit = spin_box.get_line_edit() + line_edit.context_menu_enabled = false + spin_box.align = LineEdit.ALIGN_RIGHT + [/codeblock] + The above code will create a [SpinBox], disable context menu on it and set the text alignment to right. + See [Range] class for more options over the [SpinBox]. </description> <tutorials> </tutorials> @@ -13,23 +23,29 @@ <return type="LineEdit"> </return> <description> + Returns the [LineEdit] instance from this [SpinBox]. You can use it to access properties and methods of [LineEdit]. </description> </method> </methods> <members> <member name="align" type="int" setter="set_align" getter="get_align" enum="LineEdit.Align"> + Sets the text alignment of the [SpinBox]. </member> <member name="editable" type="bool" setter="set_editable" getter="is_editable"> + If [code]true[/code], the [SpinBox] will be editable. Otherwise, it will be read only. </member> <member name="prefix" type="String" setter="set_prefix" getter="get_prefix"> + Adds the specified [code]prefix[/code] string before the numerical value of the [SpinBox]. </member> <member name="suffix" type="String" setter="set_suffix" getter="get_suffix"> + Adds the specified [code]prefix[/code] string after the numerical value of the [SpinBox]. </member> </members> <constants> </constants> <theme_items> <theme_item name="updown" type="Texture"> + Sets a custom [Texture] for up and down arrows of the [SpinBox]. </theme_item> </theme_items> </class> |