From 61f7145f4367d6fe6b7868706bdf90d41af52e68 Mon Sep 17 00:00:00 2001
From: bruvzg <7645683+bruvzg@users.noreply.github.com>
Date: Thu, 21 Mar 2024 10:42:38 +0200
Subject: [Native File Dialog] Add support for using native dialogs in the
editor.
---
doc/classes/EditorFileDialog.xml | 64 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 64 insertions(+)
(limited to 'doc/classes/EditorFileDialog.xml')
diff --git a/doc/classes/EditorFileDialog.xml b/doc/classes/EditorFileDialog.xml
index b51341dc24..4befcf5e69 100644
--- a/doc/classes/EditorFileDialog.xml
+++ b/doc/classes/EditorFileDialog.xml
@@ -19,6 +19,16 @@
For example, a [param filter] of [code]"*.tscn, *.scn"[/code] and a [param description] of [code]"Scenes"[/code] results in filter text "Scenes (*.tscn, *.scn)".
+
+
+
+
+
+
+ Adds an additional [OptionButton] to the file dialog. If [param values] is empty, a [CheckBox] is added instead.
+ [param default_value_index] should be an index of the value in the [param values]. If [param values] is empty it should be either [code]1[/code] (checked), or [code]0[/code] (unchecked).
+
+
@@ -40,6 +50,33 @@
[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property.
+
+
+
+
+ Returns the default value index of the [OptionButton] or [CheckBox] with index [param option].
+
+
+
+
+
+
+ Returns the name of the [OptionButton] or [CheckBox] with index [param option].
+
+
+
+
+
+
+ Returns an array of values of the [OptionButton] with index [param option].
+
+
+
+
+
+ Returns a [Dictionary] with the selected values of the additional [OptionButton]s and/or [CheckBox]es. [Dictionary] keys are names and values are selected value indices.
+
+
@@ -53,6 +90,30 @@
Notify the [EditorFileDialog] that its view of the data is no longer accurate. Updates the view contents on next view update.
+
+
+
+
+
+ Sets the default value index of the [OptionButton] or [CheckBox] with index [param option].
+
+
+
+
+
+
+
+ Sets the name of the [OptionButton] or [CheckBox] with index [param option].
+
+
+
+
+
+
+
+ Sets the option values of the [OptionButton] with index [param option].
+
+
@@ -80,6 +141,9 @@
The available file type filters. For example, this shows only [code].png[/code] and [code].gd[/code] files: [code]set_filters(PackedStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))[/code]. Multiple file types can also be specified in a single filter. [code]"*.png, *.jpg, *.jpeg ; Supported Images"[/code] will show both PNG and JPEG files when selected.
+
+ The number of additional [OptionButton]s and [CheckBox]es in the dialog.
+
If [code]true[/code], hidden files and directories will be visible in the [EditorFileDialog]. This property is synchronized with [member EditorSettings.filesystem/file_dialog/show_hidden_files].
--
cgit v1.2.3