mirror of
https://github.com/godotengine/godot.git
synced 2024-11-27 09:16:35 +08:00
d516aab8fa
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018 and fix the version tag in all files (not really stable yet, but it makes no sense to hardcode rc3 at this stage).
86 lines
2.7 KiB
XML
86 lines
2.7 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="AcceptDialog" inherits="WindowDialog" category="Core" version="3.0-stable">
|
|
<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>
|
|
Adds a button with label [i]text[/i] and a custom [i]action[/i] to the dialog and returns the created button. [i]action[/i] will be passed to the [custom_action] signal when pressed.
|
|
If [code]true[/code], [i]right[/i] will place the button to the right of any sibling buttons. Default value: [code]false[/code].
|
|
</description>
|
|
</method>
|
|
<method name="add_cancel">
|
|
<return type="Button">
|
|
</return>
|
|
<argument index="0" name="name" type="String">
|
|
</argument>
|
|
<description>
|
|
Adds a button with label [i]name[/i] and a cancel action to the dialog and returns the created button.
|
|
</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="register_text_enter">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="line_edit" type="Node">
|
|
</argument>
|
|
<description>
|
|
Registers a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="dialog_hide_on_ok" type="bool" setter="set_hide_on_ok" getter="get_hide_on_ok">
|
|
If [code]true[/code] the dialog is hidden when accepted. Default value: [code]true[/code].
|
|
</member>
|
|
<member name="dialog_text" type="String" setter="set_text" getter="get_text">
|
|
The text displayed by this dialog.
|
|
</member>
|
|
</members>
|
|
<signals>
|
|
<signal name="confirmed">
|
|
<description>
|
|
Emitted when the dialog is accepted.
|
|
</description>
|
|
</signal>
|
|
<signal name="custom_action">
|
|
<argument index="0" name="action" type="String">
|
|
</argument>
|
|
<description>
|
|
Emitted when a custom button is pressed. See [method add_button].
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
<constants>
|
|
</constants>
|
|
</class>
|