2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2017-11-24 09:16:52 +01:00
<class name= "FileDialog" inherits= "ConfirmationDialog" category= "Core" version= "3.0-beta" >
2017-09-12 22:42:36 +02:00
<brief_description >
Dialog for selecting files or directories in the filesystem.
</brief_description>
<description >
FileDialog is a preset dialog used to choose files and directories in the filesystem. It supports filter masks.
</description>
<tutorials >
</tutorials>
<demos >
</demos>
<methods >
<method name= "add_filter" >
<return type= "void" >
</return>
<argument index= "0" name= "filter" type= "String" >
</argument>
<description >
Add a custom filter. Filter format is: "mask ; description", example (C++): dialog-> add_filter("*.png ; PNG Images");
</description>
</method>
<method name= "clear_filters" >
<return type= "void" >
</return>
<description >
Clear all the added filters in the dialog.
</description>
</method>
2017-11-27 23:37:47 +01:00
<method name= "deselect_items" >
<return type= "void" >
</return>
<description >
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "get_current_dir" qualifiers= "const" >
<return type= "String" >
</return>
<description >
Get the current working directory of the file dialog.
</description>
</method>
<method name= "get_current_file" qualifiers= "const" >
<return type= "String" >
</return>
<description >
Get the current selected file of the file dialog (empty if none).
</description>
</method>
<method name= "get_current_path" qualifiers= "const" >
<return type= "String" >
</return>
<description >
Get the current selected path (directory and file) of the file dialog (empty if none).
</description>
</method>
<method name= "get_vbox" >
<return type= "VBoxContainer" >
</return>
<description >
Return the vertical box container of the dialog, custom controls can be added to it.
</description>
</method>
<method name= "invalidate" >
<return type= "void" >
</return>
<description >
Invalidate and update the current dialog content list.
</description>
</method>
<method name= "set_current_dir" >
<return type= "void" >
</return>
<argument index= "0" name= "dir" type= "String" >
</argument>
<description >
Set the current working directory of the file dialog.
</description>
</method>
<method name= "set_current_file" >
<return type= "void" >
</return>
<argument index= "0" name= "file" type= "String" >
</argument>
<description >
Set the current selected file name of the file dialog.
</description>
</method>
<method name= "set_current_path" >
<return type= "void" >
</return>
<argument index= "0" name= "path" type= "String" >
</argument>
<description >
Set the current selected file path of the file dialog.
</description>
</method>
</methods>
<members >
2017-09-13 08:49:40 +02:00
<member name= "access" type= "int" setter= "set_access" getter= "get_access" enum= "FileDialog.Access" >
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "filters" type= "PoolStringArray" setter= "set_filters" getter= "get_filters" >
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "mode" type= "int" setter= "set_mode" getter= "get_mode" enum= "FileDialog.Mode" >
2017-09-12 22:42:36 +02:00
</member>
2017-12-03 02:54:06 +01:00
<member name= "mode_overrides_title" type= "bool" setter= "set_mode_overrides_title" getter= "is_mode_overriding_title" >
If [code]true[/code], changing the [code]mode[/code] property will set the window title accordingly (e. g. setting mode to [code]MODE_OPEN_FILE[/code] will change the window title to "Open a File").
</member>
2017-09-13 08:49:40 +02:00
<member name= "show_hidden_files" type= "bool" setter= "set_show_hidden_files" getter= "is_showing_hidden_files" >
2017-09-12 22:42:36 +02:00
</member>
</members>
<signals >
<signal name= "dir_selected" >
<argument index= "0" name= "dir" type= "String" >
</argument>
<description >
Event emitted when the user selects a directory.
</description>
</signal>
<signal name= "file_selected" >
<argument index= "0" name= "path" type= "String" >
</argument>
<description >
Event emitted when the user selects a file (double clicks it or presses the OK button).
</description>
</signal>
<signal name= "files_selected" >
<argument index= "0" name= "paths" type= "PoolStringArray" >
</argument>
<description >
Event emitted when the user selects multiple files.
</description>
</signal>
</signals>
<constants >
2017-11-24 23:16:30 +01:00
<constant name= "MODE_OPEN_FILE" value= "0" enum= "Mode" >
2017-09-12 22:42:36 +02:00
The dialog allows the selection of one, and only one file.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MODE_OPEN_FILES" value= "1" enum= "Mode" >
2017-09-12 22:42:36 +02:00
The dialog allows the selection of multiple files.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MODE_OPEN_DIR" value= "2" enum= "Mode" >
2017-09-12 22:42:36 +02:00
The dialog functions as a folder selector, disallowing the selection of any file.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MODE_OPEN_ANY" value= "3" enum= "Mode" >
2017-09-12 22:42:36 +02:00
The dialog allows the selection of a file or a directory.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MODE_SAVE_FILE" value= "4" enum= "Mode" >
2017-09-12 22:42:36 +02:00
The dialog will warn when a file exists.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ACCESS_RESOURCES" value= "0" enum= "Access" >
2017-09-12 22:42:36 +02:00
The dialog allows the selection of file and directory.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ACCESS_USERDATA" value= "1" enum= "Access" >
2017-10-14 12:45:26 +02:00
The dialog allows access files under [Resource] path(res://) .
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ACCESS_FILESYSTEM" value= "2" enum= "Access" >
2017-10-14 12:45:26 +02:00
The dialog allows access files in whole file system.
2017-09-12 22:42:36 +02:00
</constant>
</constants>
<theme_items >
<theme_item name= "files_disabled" type= "Color" >
</theme_item>
<theme_item name= "folder" type= "Texture" >
</theme_item>
2017-12-07 08:23:08 +01:00
<theme_item name= "parent_folder" type= "Texture" >
</theme_item>
2017-09-12 22:42:36 +02:00
<theme_item name= "reload" type= "Texture" >
</theme_item>
</theme_items>
</class>