summaryrefslogtreecommitdiff
path: root/doc/classes/TabContainer.xml
blob: ad02064862e46bfd4bf8c38cdfc2e7ede28ded12 (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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
<?xml version="1.0" encoding="UTF-8" ?>
<class name="TabContainer" inherits="Control" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		Tabbed Container.
	</brief_description>
	<description>
		Tabbed Container. Contains several children controls, but shows only one at the same time. Clicking on the top tabs allows to change the currently visible one.
		Children controls of this one automatically.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="are_tabs_visible" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns [code]true[/code] if the tabs are visible.
			</description>
		</method>
		<method name="get_current_tab" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the current tab index that is being shown.
			</description>
		</method>
		<method name="get_current_tab_control" qualifiers="const">
			<return type="Control">
			</return>
			<description>
			</description>
		</method>
		<method name="get_popup" qualifiers="const">
			<return type="Popup">
			</return>
			<description>
			</description>
		</method>
		<method name="get_previous_tab" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the previous tab index that was being shown.
			</description>
		</method>
		<method name="get_tab_align" qualifiers="const">
			<return type="int" enum="TabContainer.TabAlign">
			</return>
			<description>
				Returns the tab alignment.See the ALIGN_* constants.
			</description>
		</method>
		<method name="get_tab_control" qualifiers="const">
			<return type="Control">
			</return>
			<argument index="0" name="idx" type="int">
			</argument>
			<description>
				Returns the current tab control that is being shown.
			</description>
		</method>
		<method name="get_tab_count" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the amount of tabs.
			</description>
		</method>
		<method name="get_tab_disabled" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="tab_idx" type="int">
			</argument>
			<description>
				Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is disabled.
			</description>
		</method>
		<method name="get_tab_icon" qualifiers="const">
			<return type="Texture">
			</return>
			<argument index="0" name="tab_idx" type="int">
			</argument>
			<description>
				Returns the [Texture] for the tab at index [code]tab_idx[/code] or null if the tab has no [Texture].
			</description>
		</method>
		<method name="get_tab_title" qualifiers="const">
			<return type="String">
			</return>
			<argument index="0" name="tab_idx" type="int">
			</argument>
			<description>
				Returns the title for the tab at index [code]tab_idx[/code]. Tab titles are by default the children node name, but this can be overridden.
			</description>
		</method>
		<method name="set_current_tab">
			<return type="void">
			</return>
			<argument index="0" name="tab_idx" type="int">
			</argument>
			<description>
				Bring a tab (and the Control it represents) to the front, and hide the rest.
			</description>
		</method>
		<method name="set_popup">
			<return type="void">
			</return>
			<argument index="0" name="popup" type="Node">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_tab_align">
			<return type="void">
			</return>
			<argument index="0" name="align" type="int" enum="TabContainer.TabAlign">
			</argument>
			<description>
				Set tab alignment, from the ALIGN_* enum. Moves tabs to the left, right or center.
			</description>
		</method>
		<method name="set_tab_disabled">
			<return type="void">
			</return>
			<argument index="0" name="tab_idx" type="int">
			</argument>
			<argument index="1" name="disabled" type="bool">
			</argument>
			<description>
				Set tab at index [code]tab_idx[/code] disabled.
			</description>
		</method>
		<method name="set_tab_icon">
			<return type="void">
			</return>
			<argument index="0" name="tab_idx" type="int">
			</argument>
			<argument index="1" name="icon" type="Texture">
			</argument>
			<description>
				Set an icon for a tab at index [code]tab_idx[/code].
			</description>
		</method>
		<method name="set_tab_title">
			<return type="void">
			</return>
			<argument index="0" name="tab_idx" type="int">
			</argument>
			<argument index="1" name="title" type="String">
			</argument>
			<description>
				Set a title for the tab at index [code]tab_idx[/code]. Tab titles are by default the children node name, but this can be overridden.
			</description>
		</method>
		<method name="set_tabs_visible">
			<return type="void">
			</return>
			<argument index="0" name="visible" type="bool">
			</argument>
			<description>
				If [code]true[/code] all the tabs will be visible.
			</description>
		</method>
	</methods>
	<members>
		<member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab">
			The current tab.
		</member>
		<member name="tab_align" type="int" setter="set_tab_align" getter="get_tab_align" enum="TabContainer.TabAlign">
			The alignment of all the tabs of the tab container. See the [code]ALIGN_*[/code] constants.
		</member>
		<member name="tabs_visible" type="bool" setter="set_tabs_visible" getter="are_tabs_visible">
			If [code]true[/code] all tabs that are children of the TabContainer will be visible.
		</member>
	</members>
	<signals>
		<signal name="pre_popup_pressed">
			<description>
			</description>
		</signal>
		<signal name="tab_changed">
			<argument index="0" name="tab" type="int">
			</argument>
			<description>
				Emitted only when the current tab changes.
			</description>
		</signal>
		<signal name="tab_selected">
			<argument index="0" name="tab" type="int">
			</argument>
			<description>
				Emitted when a tab is being selected, even if it is the same tab.
			</description>
		</signal>
	</signals>
	<constants>
		<constant name="ALIGN_LEFT" value="0">
		</constant>
		<constant name="ALIGN_CENTER" value="1">
		</constant>
		<constant name="ALIGN_RIGHT" value="2">
		</constant>
	</constants>
	<theme_items>
		<theme_item name="decrement" type="Texture">
		</theme_item>
		<theme_item name="decrement_highlight" type="Texture">
		</theme_item>
		<theme_item name="font" type="Font">
		</theme_item>
		<theme_item name="font_color_bg" type="Color">
		</theme_item>
		<theme_item name="font_color_disabled" type="Color">
		</theme_item>
		<theme_item name="font_color_fg" type="Color">
		</theme_item>
		<theme_item name="hseparation" type="int">
		</theme_item>
		<theme_item name="increment" type="Texture">
		</theme_item>
		<theme_item name="increment_highlight" type="Texture">
		</theme_item>
		<theme_item name="label_valign_bg" type="int">
		</theme_item>
		<theme_item name="label_valign_fg" type="int">
		</theme_item>
		<theme_item name="menu" type="Texture">
		</theme_item>
		<theme_item name="menu_highlight" type="Texture">
		</theme_item>
		<theme_item name="panel" type="StyleBox">
		</theme_item>
		<theme_item name="side_margin" type="int">
		</theme_item>
		<theme_item name="tab_bg" type="StyleBox">
		</theme_item>
		<theme_item name="tab_fg" type="StyleBox">
		</theme_item>
		<theme_item name="top_margin" type="int">
		</theme_item>
	</theme_items>
</class>