virtualx-engine/doc/classes/StatusIndicator.xml
Rémi Verschelde 85062e37ef
Merge pull request #89588 from bruvzg/status_ind_menu_direct
[StatusIndicator] Switch API to use Texture2D instead of Image, improve handling on macOS, add method to set native popup menu directly.
2024-05-01 09:54:44 +02:00

35 lines
1.5 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="StatusIndicator" inherits="Node" keywords="tray" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Application status indicator (aka notification area icon).
[b]Note:[/b] Status indicator is implemented on macOS and Windows.
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<members>
<member name="icon" type="Texture2D" setter="set_icon" getter="get_icon">
Status indicator icon.
</member>
<member name="menu" type="NodePath" setter="set_menu" getter="get_menu" default="NodePath(&quot;&quot;)">
Status indicator native popup menu. If this is set, the [signal pressed] signal is not emitted.
[b]Note:[/b] Native popup is only supported if [NativeMenu] supports [constant NativeMenu.FEATURE_POPUP_MENU] feature.
</member>
<member name="tooltip" type="String" setter="set_tooltip" getter="get_tooltip" default="&quot;&quot;">
Status indicator tooltip.
</member>
<member name="visible" type="bool" setter="set_visible" getter="is_visible" default="true">
If [code]true[/code], the status indicator is visible.
</member>
</members>
<signals>
<signal name="pressed">
<param index="0" name="mouse_button" type="int" />
<param index="1" name="mouse_position" type="Vector2i" />
<description>
Emitted when the status indicator is pressed.
</description>
</signal>
</signals>
</class>