summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorEric M <itsjusteza@gmail.com>2020-11-30 00:11:40 +1000
committerEric M <itsjusteza@gmail.com>2020-11-30 00:11:40 +1000
commit12ded391f5fd720fff0c30d41d72600a29cb7937 (patch)
tree11d7ecf9dc3f4e5b0b6c628c18e56f21950b0c7d /doc
parentd1943f6a77c9a1832795c6e095d61d8d5b63a371 (diff)
Exposed shortcut_context property to scripting and added documentation.
I didn't expose this as a property or add documentation in the original PR #42109.
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/BaseButton.xml3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml
index 378df1ce65..45ef4cb14c 100644
--- a/doc/classes/BaseButton.xml
+++ b/doc/classes/BaseButton.xml
@@ -65,6 +65,9 @@
<member name="shortcut" type="Shortcut" setter="set_shortcut" getter="get_shortcut">
[Shortcut] associated to the button.
</member>
+ <member name="shortcut_context" type="Node" setter="set_shortcut_context" getter="get_shortcut_context">
+ The [Node] which must be a parent of the focused GUI [Control] for the shortcut to be activated. If [code]null[/code], the shortcut can be activated when any control is focused (a global shortcut). This allows shortcuts to be accepted only when the user has a certain area of the GUI focused.
+ </member>
<member name="shortcut_in_tooltip" type="bool" setter="set_shortcut_in_tooltip" getter="is_shortcut_in_tooltip_enabled" default="true">
If [code]true[/code], the button will add information about its shortcut in the tooltip.
</member>