blob: 4529a473c6cec6ce14e595de8baf7b5048ca34c3 (
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
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorFileDialog" inherits="ConfirmationDialog" category="Core" version="3.0-beta">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="add_filter">
<return type="void">
</return>
<argument index="0" name="filter" type="String">
</argument>
<description>
Adds a comma-delimited file extension filter option to the [code]EditorFileDialog[/code] with an optional semi-colon-delimited label.
Example: "*.tscn, *.scn; Scenes", results in filter text "Scenes (*.tscn, *.scn)".
</description>
</method>
<method name="clear_filters">
<return type="void">
</return>
<description>
Removes all filters except for "All Files (*)".
</description>
</method>
<method name="get_access" qualifiers="const">
<return type="int" enum="EditorFileDialog.Access">
</return>
<description>
</description>
</method>
<method name="get_current_dir" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_current_file" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_current_path" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_display_mode" qualifiers="const">
<return type="int" enum="EditorFileDialog.DisplayMode">
</return>
<description>
</description>
</method>
<method name="get_mode" qualifiers="const">
<return type="int" enum="EditorFileDialog.Mode">
</return>
<description>
</description>
</method>
<method name="get_vbox">
<return type="VBoxContainer">
</return>
<description>
Returns the [code]VBoxContainer[/code] used to display the file system.
</description>
</method>
<method name="invalidate">
<return type="void">
</return>
<description>
Notify the [code]EditorFileDialog[/code] that its view of the data is no longer accurate. Updates the view contents on next view update.
</description>
</method>
<method name="is_overwrite_warning_disabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_showing_hidden_files" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_access">
<return type="void">
</return>
<argument index="0" name="access" type="int" enum="EditorFileDialog.Access">
</argument>
<description>
</description>
</method>
<method name="set_current_dir">
<return type="void">
</return>
<argument index="0" name="dir" type="String">
</argument>
<description>
</description>
</method>
<method name="set_current_file">
<return type="void">
</return>
<argument index="0" name="file" type="String">
</argument>
<description>
</description>
</method>
<method name="set_current_path">
<return type="void">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
</description>
</method>
<method name="set_disable_overwrite_warning">
<return type="void">
</return>
<argument index="0" name="disable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_display_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="EditorFileDialog.DisplayMode">
</argument>
<description>
</description>
</method>
<method name="set_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="EditorFileDialog.Mode">
</argument>
<description>
</description>
</method>
<method name="set_show_hidden_files">
<return type="void">
</return>
<argument index="0" name="show" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="access" type="int" enum="EditorFileDialog.Access" setter="set_access" getter="get_access">
The location from which the user may select a file, including [code]res://[/code], [code]user://[/code], and the local file system.
</member>
<member name="display_mode" type="int" enum="EditorFileDialog.DisplayMode" setter="set_display_mode" getter="get_display_mode">
The view format in which the [code]EditorFileDialog[/code] displays resources to the user.
</member>
<member name="mode" type="int" enum="EditorFileDialog.Mode" setter="set_mode" getter="get_mode">
The purpose of the [code]EditorFileDialog[/code]. Changes allowed behaviors.
</member>
<member name="current_dir" type="String" setter="set_current_dir" getter="get_current_dir">
The currently occupied directory.
</member>
<member name="current_file" type="String" setter="set_current_file" getter="get_current_file">
The currently selected file.
</member>
<member name="current_path" type="String" setter="set_current_path" getter="get_current_path">
The file system path in the address bar.
</member>
<member name="show_hidden_files" type="bool" setter="set_show_hidden_files" getter="is_showing_hidden_files">
If [code]true[/code] hidden files and directories will be visible in the [code]EditorFileDialog[/code].
</member>
<member name="disable_overwrite_warning" type="bool" setter="set_disable_overwrite_warning" getter="is_overwrite_warning_disabled">
If [code]true[/code] the [code]EditorFileDialog[/code] will not warn the user before overwriting files.
</member>
</members>
<signals>
<signal name="dir_selected">
<argument index="0" name="dir" type="String">
</argument>
<description>
Emitted when a directory is selected.
</description>
</signal>
<signal name="file_selected">
<argument index="0" name="path" type="String">
</argument>
<description>
Emitted when a file is selected.
</description>
</signal>
<signal name="files_selected">
<argument index="0" name="paths" type="PoolStringArray">
</argument>
<description>
Emitted when multiple files are selected.
</description>
</signal>
</signals>
<constants>
<constant name="MODE_OPEN_FILE" value="0" enum="Mode">
The [code]EditorFileDialog[/code] can select only one file. Accepting the window will open the file.
</constant>
<constant name="MODE_OPEN_FILES" value="1" enum="Mode">
The [code]EditorFileDialog[/code] can select multiple files. Accepting the window will open all files.
</constant>
<constant name="MODE_OPEN_DIR" value="2" enum="Mode">
The [code]EditorFileDialog[/code] can select only one directory. Accepting the window will open the directory.
</constant>
<constant name="MODE_OPEN_ANY" value="3" enum="Mode">
The [code]EditorFileDialog[/code] can select a file or directory. Accepting the window will open it.
</constant>
<constant name="MODE_SAVE_FILE" value="4" enum="Mode">
The [code]EditorFileDialog[/code] can select only one file. Accepting the window will save the file.
</constant>
<constant name="ACCESS_RESOURCES" value="0" enum="Access">
The [code]EditorFileDialog[/code] can only view [code]res://[/code] directory contents.
</constant>
<constant name="ACCESS_USERDATA" value="1" enum="Access">
The [code]EditorFileDialog[/code] can only view [code]user://[/code] directory contents.
</constant>
<constant name="ACCESS_FILESYSTEM" value="2" enum="Access">
The [code]EditorFileDialog[/code] can view the entire local file system.
</constant>
<constant name="DISPLAY_THUMBNAILS" value="0" enum="DisplayMode">
The [code]EditorFileDialog[/code] displays resources as thumbnails.
</constant>
<constant name="DISPLAY_LIST" value="1" enum="DisplayMode">
The [code]EditorFileDialog[/code] displays resources as a list of filenames.
</constant>
</constants>
</class>
|