summaryrefslogtreecommitdiff
path: root/doc/classes/AcceptDialog.xml
blob: 8821a450e5dd7fe0eb2506dc5d8701de8c481e58 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
<?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="&quot;&quot;">
			</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>