summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2024-09-26 18:45:35 +0200
committerRémi Verschelde <rverschelde@gmail.com>2024-09-26 18:45:35 +0200
commit01d567ba1b8d18e5a177d41b163c4c6aed5165e8 (patch)
tree8db1d3110119b92fb14edaf53378f30165bb80cc /doc
parent9a8dcc1eebaaab5223d2f39ac2509d3f130c45d4 (diff)
parent78801f61da872d3df03d21b36626af6cfb7f2c00 (diff)
downloadredot-engine-01d567ba1b8d18e5a177d41b163c4c6aed5165e8.tar.gz
Merge pull request #97406 from timothyqiu/tooltip-atm
Add auto translate mode for tooltips
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/Control.xml4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml
index 927ab9ae0e..9d36bc657b 100644
--- a/doc/classes/Control.xml
+++ b/doc/classes/Control.xml
@@ -1057,6 +1057,10 @@
[b]Note:[/b] To look up [Control]'s own items use various [code]get_theme_*[/code] methods without specifying [code]theme_type[/code].
[b]Note:[/b] Theme items are looked for in the tree order, from branch to root, where each [Control] node is checked for its [member theme] property. The earliest match against any type/class name is returned. The project-level Theme and the default Theme are checked last.
</member>
+ <member name="tooltip_auto_translate_mode" type="int" setter="set_tooltip_auto_translate_mode" getter="get_tooltip_auto_translate_mode" enum="Node.AutoTranslateMode" default="0">
+ Defines if tooltip text should automatically change to its translated version depending on the current locale. Uses the same auto translate mode as this control when set to [constant Node.AUTO_TRANSLATE_MODE_INHERIT].
+ [b]Note:[/b] When the tooltip is customized using [method _make_custom_tooltip], this auto translate mode is applied automatically to the returned control.
+ </member>
<member name="tooltip_text" type="String" setter="set_tooltip_text" getter="get_tooltip_text" default="&quot;&quot;">
The default tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments, provided that the [member mouse_filter] property is not [constant MOUSE_FILTER_IGNORE]. The time required for the tooltip to appear can be changed with the [member ProjectSettings.gui/timers/tooltip_delay_sec] option. See also [method get_tooltip].
The tooltip popup will use either a default implementation, or a custom one that you can provide by overriding [method _make_custom_tooltip]. The default tooltip includes a [PopupPanel] and [Label] whose theme properties can be customized using [Theme] methods with the [code]"TooltipPanel"[/code] and [code]"TooltipLabel"[/code] respectively. For example: