115 lines
3.2 KiB
XML
115 lines
3.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="AcceptDialog" inherits="WindowDialog" category="Core" version="3.0.alpha.custom_build">
|
|
<brief_description>
|
|
Base dialog for user notification.
|
|
</brief_description>
|
|
<description>
|
|
This dialog is useful for small notifications to the user about an event. It can only be accepted or closed, with the same result.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<demos>
|
|
</demos>
|
|
<methods>
|
|
<method name="add_button">
|
|
<return type="Button">
|
|
</return>
|
|
<argument index="0" name="text" type="String">
|
|
</argument>
|
|
<argument index="1" name="right" type="bool" default="false">
|
|
</argument>
|
|
<argument index="2" name="action" type="String" default="""">
|
|
</argument>
|
|
<description>
|
|
Add custom button to the dialog and return the created button.
|
|
The button titled with [i]text[/i] and the [i]action[/i] will be passed to [custom_action] signal when it is pressed.
|
|
</description>
|
|
</method>
|
|
<method name="add_cancel">
|
|
<return type="Button">
|
|
</return>
|
|
<argument index="0" name="name" type="String">
|
|
</argument>
|
|
<description>
|
|
Add custom cancel button to the dialog and return the created button.
|
|
</description>
|
|
</method>
|
|
<method name="get_hide_on_ok" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<description>
|
|
Return true if the dialog will be hidden when accepted (default true).
|
|
</description>
|
|
</method>
|
|
<method name="get_label">
|
|
<return type="Label">
|
|
</return>
|
|
<description>
|
|
Return the label used for built-in text.
|
|
</description>
|
|
</method>
|
|
<method name="get_ok">
|
|
<return type="Button">
|
|
</return>
|
|
<description>
|
|
Return the OK Button.
|
|
</description>
|
|
</method>
|
|
<method name="get_text" qualifiers="const">
|
|
<return type="String">
|
|
</return>
|
|
<description>
|
|
Return the built-in label text.
|
|
</description>
|
|
</method>
|
|
<method name="register_text_enter">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="line_edit" type="Node">
|
|
</argument>
|
|
<description>
|
|
Register a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted.
|
|
</description>
|
|
</method>
|
|
<method name="set_hide_on_ok">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="enabled" type="bool">
|
|
</argument>
|
|
<description>
|
|
Set whether the dialog is hidden when accepted (default true).
|
|
</description>
|
|
</method>
|
|
<method name="set_text">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="text" type="String">
|
|
</argument>
|
|
<description>
|
|
Set the built-in label text.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="dialog_hide_on_ok" type="bool" setter="set_hide_on_ok" getter="get_hide_on_ok">
|
|
</member>
|
|
<member name="dialog_text" type="String" setter="set_text" getter="get_text">
|
|
</member>
|
|
</members>
|
|
<signals>
|
|
<signal name="confirmed">
|
|
<description>
|
|
Emitted when accepted.
|
|
</description>
|
|
</signal>
|
|
<signal name="custom_action">
|
|
<argument index="0" name="action" type="String">
|
|
</argument>
|
|
<description>
|
|
Emitted with a custom button is added.
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
<constants>
|
|
</constants>
|
|
</class>
|