summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2019-02-13 20:31:53 +0100
committerGitHub <noreply@github.com>2019-02-13 20:31:53 +0100
commitb340b7e804cd6fc6ecc8c14d9645a89a17270281 (patch)
tree8f64e66cadbaf36c1758e599b59881fd3b58047f /doc/classes
parentf015bc8d2ba9e2caecd8eb627d414e4ea5f53ba4 (diff)
parent7051685a779f2b1fa4322d6f8fbfaba71deea73f (diff)
Merge pull request #25422 from azagaya/optionbutton
Fix docs about item_selected and item_focused . Fixes #25273
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/OptionButton.xml19
1 files changed, 14 insertions, 5 deletions
diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml
index c58c932b61..09b9167149 100644
--- a/doc/classes/OptionButton.xml
+++ b/doc/classes/OptionButton.xml
@@ -71,9 +71,18 @@
<argument index="0" name="idx" type="int">
</argument>
<description>
- Return the ID of the item at index "idx".
- </description>
- </method>
+ Return the ID of the item at index [code]idx[/code].
+ </description>
+ </method>
+ <method name="get_item_index" qualifiers="const">
+ <return type="int">
+ </return>
+ <argument index="0" name="id" type="int">
+ </argument>
+ <description>
+ Return the index of the item with the given [code]id[/code].
+ </description>
+ </method>
<method name="get_item_metadata" qualifiers="const">
<return type="Variant">
</return>
@@ -198,14 +207,14 @@
<argument index="0" name="ID" type="int">
</argument>
<description>
- This signal is emitted when user navigated to an item using [code]ui_up[/code] or [code]ui_down[/code] action. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index).
+ This signal is emitted when user navigated to an item using [code]ui_up[/code] or [code]ui_down[/code] action. ID of the item selected is passed as argument.
</description>
</signal>
<signal name="item_selected">
<argument index="0" name="ID" type="int">
</argument>
<description>
- This signal is emitted when the current item was changed by the user. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index).
+ This signal is emitted when the current item was changed by the user. Index of the item selected is passed as argument.
</description>
</signal>
</signals>