asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #11312 from deliciousfudge/acceptdialog-docs

Browse source 
Rewrite the documentation of AcceptDialog class
This commit is contained in:
Poommetee Ketson 2017-09-17 08:33:04 +07:00 committed by GitHub
commit d30682ad2e
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/classes/AcceptDialog.xml
View file

@ -21,8 +21,8 @@
<argument index="2" name="action" type="String" default="&quot;&quot;"> <argument index="2" name="action" type="String" default="&quot;&quot;">
</argument> </argument>
<description> <description>
Add custom button to the dialog and return the created button. 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.
The button titled with [i]text[/i] and the [i]action[/i] will be passed to [custom_action] signal when it is 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> </description>
</method> </method>
<method name="add_cancel"> <method name="add_cancel">
@ -31,7 +31,7 @@
<argument index="0" name="name" type="String"> <argument index="0" name="name" type="String">
</argument> </argument>
<description> <description>
Add custom cancel button to the dialog and return the created button. Adds a button with label [i]name[/i] and a cancel action to the dialog and returns the created button.
</description> </description>
</method> </method>
<method name="get_hide_on_ok" qualifiers="const"> <method name="get_hide_on_ok" qualifiers="const">
@ -68,7 +68,7 @@
<argument index="0" name="line_edit" type="Node"> <argument index="0" name="line_edit" type="Node">
</argument> </argument>
<description> <description>
Register a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted. Registers a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted.
</description> </description>
</method> </method>
<method name="set_hide_on_ok"> <method name="set_hide_on_ok">
@ -99,14 +99,14 @@
<signals> <signals>
<signal name="confirmed"> <signal name="confirmed">
<description> <description>
Emitted when accepted. Emitted when the dialog is accepted.
</description> </description>
</signal> </signal>
<signal name="custom_action"> <signal name="custom_action">
<argument index="0" name="action" type="String"> <argument index="0" name="action" type="String">
</argument> </argument>
<description> <description>
Emitted with a custom button is added. Emitted when a custom button is pressed. See [method add_button].
</description> </description>
</signal> </signal>
</signals> </signals>