Files
godot-docs-l10n/classes/es/class_filedialog.rst
Rémi Verschelde cf78697eea Add localized class reference as pre-generated RST files
Currently including `zh_CN` and `es` which both have very high completion
ratios. Others will be added once they reach a significant percentage too.

These RST files will be used by godot-docs in place of its `classes` folder
after we sync with https://github.com/godotengine/godot-docs/pull/5458.

The update workflow is manual for now (example for `zh_CN`):

- Build `godotengine/godot` in the branch we currently track (now `3.x`)
- Run `godot --doctool -l zh_CN`
- Run `cd doc && make rst LANGARG=zh_CN`
- Copy `doc/_build/rst/*` to `classes/zh_CN/` here
- Make sure to have `classes/zh_CN/index.rst` copied from `docs/classes`
2021-12-21 16:07:55 +01:00

418 lines
20 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the FileDialog.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_FileDialog:
FileDialog
==========
**Inherits:** :ref:`ConfirmationDialog<class_ConfirmationDialog>` **<** :ref:`AcceptDialog<class_AcceptDialog>` **<** :ref:`WindowDialog<class_WindowDialog>` **<** :ref:`Popup<class_Popup>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
Diálogo para seleccionar archivos o directorios en el sistema de archivos.
Descripción
----------------------
FileDialog is a preset dialog used to choose files and directories in the filesystem. It supports filter masks. The FileDialog automatically sets its window title according to the :ref:`mode<class_FileDialog_property_mode>`. If you want to use a custom title, disable this by setting :ref:`mode_overrides_title<class_FileDialog_property_mode_overrides_title>` to ``false``.
Propiedades
----------------------
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`Access<enum_FileDialog_Access>` | :ref:`access<class_FileDialog_property_access>` | ``0`` |
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`current_dir<class_FileDialog_property_current_dir>` | ``"res://"`` |
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`current_file<class_FileDialog_property_current_file>` | ``""`` |
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`current_path<class_FileDialog_property_current_path>` | ``"res://"`` |
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | dialog_hide_on_ok | ``false`` (overrides :ref:`AcceptDialog<class_AcceptDialog_property_dialog_hide_on_ok>`) |
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`filters<class_FileDialog_property_filters>` | ``PoolStringArray( )`` |
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`Mode<enum_FileDialog_Mode>` | :ref:`mode<class_FileDialog_property_mode>` | ``4`` |
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`mode_overrides_title<class_FileDialog_property_mode_overrides_title>` | ``true`` |
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`show_hidden_files<class_FileDialog_property_show_hidden_files>` | ``false`` |
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | window_title | ``"Save a File"`` (overrides :ref:`WindowDialog<class_WindowDialog_property_window_title>`) |
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
Métodos
--------------
+-------------------------------------------+------------------------------------------------------------------------------------------------------+
| void | :ref:`add_filter<class_FileDialog_method_add_filter>` **(** :ref:`String<class_String>` filter **)** |
+-------------------------------------------+------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_filters<class_FileDialog_method_clear_filters>` **(** **)** |
+-------------------------------------------+------------------------------------------------------------------------------------------------------+
| void | :ref:`deselect_items<class_FileDialog_method_deselect_items>` **(** **)** |
+-------------------------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`LineEdit<class_LineEdit>` | :ref:`get_line_edit<class_FileDialog_method_get_line_edit>` **(** **)** |
+-------------------------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`VBoxContainer<class_VBoxContainer>` | :ref:`get_vbox<class_FileDialog_method_get_vbox>` **(** **)** |
+-------------------------------------------+------------------------------------------------------------------------------------------------------+
| void | :ref:`invalidate<class_FileDialog_method_invalidate>` **(** **)** |
+-------------------------------------------+------------------------------------------------------------------------------------------------------+
Propiedades del Theme
------------------------------------------
+-------------------------------+--------------------------------------------------------------------------------+---------------------------+
| :ref:`Color<class_Color>` | :ref:`file_icon_modulate<class_FileDialog_theme_color_file_icon_modulate>` | ``Color( 1, 1, 1, 1 )`` |
+-------------------------------+--------------------------------------------------------------------------------+---------------------------+
| :ref:`Color<class_Color>` | :ref:`files_disabled<class_FileDialog_theme_color_files_disabled>` | ``Color( 0, 0, 0, 0.7 )`` |
+-------------------------------+--------------------------------------------------------------------------------+---------------------------+
| :ref:`Color<class_Color>` | :ref:`folder_icon_modulate<class_FileDialog_theme_color_folder_icon_modulate>` | ``Color( 1, 1, 1, 1 )`` |
+-------------------------------+--------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture<class_Texture>` | :ref:`file<class_FileDialog_theme_icon_file>` | |
+-------------------------------+--------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture<class_Texture>` | :ref:`folder<class_FileDialog_theme_icon_folder>` | |
+-------------------------------+--------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture<class_Texture>` | :ref:`parent_folder<class_FileDialog_theme_icon_parent_folder>` | |
+-------------------------------+--------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture<class_Texture>` | :ref:`reload<class_FileDialog_theme_icon_reload>` | |
+-------------------------------+--------------------------------------------------------------------------------+---------------------------+
| :ref:`Texture<class_Texture>` | :ref:`toggle_hidden<class_FileDialog_theme_icon_toggle_hidden>` | |
+-------------------------------+--------------------------------------------------------------------------------+---------------------------+
Señales
--------------
.. _class_FileDialog_signal_dir_selected:
- **dir_selected** **(** :ref:`String<class_String>` dir **)**
Emitido cuando el usuario selecciona un directorio.
----
.. _class_FileDialog_signal_file_selected:
- **file_selected** **(** :ref:`String<class_String>` path **)**
Se emite cuando el usuario selecciona un archivo haciendo doble clic en él o pulsando el botón **OK**.
----
.. _class_FileDialog_signal_files_selected:
- **files_selected** **(** :ref:`PoolStringArray<class_PoolStringArray>` paths **)**
Emitido cuando el usuario selecciona varios archivos.
Enumeraciones
--------------------------
.. _enum_FileDialog_Mode:
.. _class_FileDialog_constant_MODE_OPEN_FILE:
.. _class_FileDialog_constant_MODE_OPEN_FILES:
.. _class_FileDialog_constant_MODE_OPEN_DIR:
.. _class_FileDialog_constant_MODE_OPEN_ANY:
.. _class_FileDialog_constant_MODE_SAVE_FILE:
enum **Mode**:
- **MODE_OPEN_FILE** = **0** --- El diálogo permite seleccionar uno, y sólo un archivo.
- **MODE_OPEN_FILES** = **1** --- El diálogo permite seleccionar varios archivos.
- **MODE_OPEN_DIR** = **2** --- El diálogo sólo permite seleccionar un directorio, no permitiendo la selección de ningún archivo.
- **MODE_OPEN_ANY** = **3** --- El diálogo permite seleccionar un archivo o directorio.
- **MODE_SAVE_FILE** = **4** --- El diálogo avisará cuando exista un archivo.
----
.. _enum_FileDialog_Access:
.. _class_FileDialog_constant_ACCESS_RESOURCES:
.. _class_FileDialog_constant_ACCESS_USERDATA:
.. _class_FileDialog_constant_ACCESS_FILESYSTEM:
enum **Access**:
- **ACCESS_RESOURCES** = **0** --- El diálogo sólo permite acceder a los archivos bajo la ruta :ref:`Resource<class_Resource>` (``res://``).
- **ACCESS_USERDATA** = **1** --- El diálogo sólo permite acceder a los archivos bajo la ruta de datos del usuario (``user://``).
- **ACCESS_FILESYSTEM** = **2** --- El diálogo permite acceder a los archivos de todo el sistema de archivos.
Descripciones de Propiedades
--------------------------------------------------------
.. _class_FileDialog_property_access:
- :ref:`Access<enum_FileDialog_Access>` **access**
+-----------+-------------------+
| *Default* | ``0`` |
+-----------+-------------------+
| *Setter* | set_access(value) |
+-----------+-------------------+
| *Getter* | get_access() |
+-----------+-------------------+
The file system access scope. See enum ``Access`` constants.
\ **Warning:** Currently, in sandboxed environments such as HTML5 builds or sandboxed macOS apps, FileDialog cannot access the host file system. See `godot-proposals#1123 <https://github.com/godotengine/godot-proposals/issues/1123>`__.
----
.. _class_FileDialog_property_current_dir:
- :ref:`String<class_String>` **current_dir**
+-----------+------------------------+
| *Default* | ``"res://"`` |
+-----------+------------------------+
| *Setter* | set_current_dir(value) |
+-----------+------------------------+
| *Getter* | get_current_dir() |
+-----------+------------------------+
El directorio de trabajo actual del diálogo de archivos.
----
.. _class_FileDialog_property_current_file:
- :ref:`String<class_String>` **current_file**
+-----------+-------------------------+
| *Default* | ``""`` |
+-----------+-------------------------+
| *Setter* | set_current_file(value) |
+-----------+-------------------------+
| *Getter* | get_current_file() |
+-----------+-------------------------+
El archivo actualmente seleccionado del diálogo de archivos.
----
.. _class_FileDialog_property_current_path:
- :ref:`String<class_String>` **current_path**
+-----------+-------------------------+
| *Default* | ``"res://"`` |
+-----------+-------------------------+
| *Setter* | set_current_path(value) |
+-----------+-------------------------+
| *Getter* | get_current_path() |
+-----------+-------------------------+
La ruta de archivo actualmente seleccionada del diálogo de archivo.
----
.. _class_FileDialog_property_filters:
- :ref:`PoolStringArray<class_PoolStringArray>` **filters**
+-----------+-------------------------+
| *Default* | ``PoolStringArray( )`` |
+-----------+-------------------------+
| *Setter* | set_filters(value) |
+-----------+-------------------------+
| *Getter* | get_filters() |
+-----------+-------------------------+
The available file type filters. For example, this shows only ``.png`` and ``.gd`` files: ``set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))``.
----
.. _class_FileDialog_property_mode:
- :ref:`Mode<enum_FileDialog_Mode>` **mode**
+-----------+-----------------+
| *Default* | ``4`` |
+-----------+-----------------+
| *Setter* | set_mode(value) |
+-----------+-----------------+
| *Getter* | get_mode() |
+-----------+-----------------+
The dialog's open or save mode, which affects the selection behavior. See enum ``Mode`` constants.
----
.. _class_FileDialog_property_mode_overrides_title:
- :ref:`bool<class_bool>` **mode_overrides_title**
+-----------+---------------------------------+
| *Default* | ``true`` |
+-----------+---------------------------------+
| *Setter* | set_mode_overrides_title(value) |
+-----------+---------------------------------+
| *Getter* | is_mode_overriding_title() |
+-----------+---------------------------------+
If ``true``, changing the ``Mode`` property will set the window title accordingly (e.g. setting mode to :ref:`MODE_OPEN_FILE<class_FileDialog_constant_MODE_OPEN_FILE>` will change the window title to "Open a File").
----
.. _class_FileDialog_property_show_hidden_files:
- :ref:`bool<class_bool>` **show_hidden_files**
+-----------+------------------------------+
| *Default* | ``false`` |
+-----------+------------------------------+
| *Setter* | set_show_hidden_files(value) |
+-----------+------------------------------+
| *Getter* | is_showing_hidden_files() |
+-----------+------------------------------+
Si ``true``, el diálogo mostrará los archivos ocultos.
Descripciones de Métodos
------------------------------------------------
.. _class_FileDialog_method_add_filter:
- void **add_filter** **(** :ref:`String<class_String>` filter **)**
Añade ``filter`` como filtro personalizado; ``filter`` debe tener la forma ``"filename.extension ; Description"``. Por ejemplo, ``"*.png ; Imágenes PNG"``.
----
.. _class_FileDialog_method_clear_filters:
- void **clear_filters** **(** **)**
Borra todos los filtros añadidos en el diálogo.
----
.. _class_FileDialog_method_deselect_items:
- void **deselect_items** **(** **)**
Borra los elementos actualmente seleccionados en el diálogo.
----
.. _class_FileDialog_method_get_line_edit:
- :ref:`LineEdit<class_LineEdit>` **get_line_edit** **(** **)**
Returns the LineEdit for the selected file.
\ **Warning:** 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 :ref:`CanvasItem.visible<class_CanvasItem_property_visible>` property.
----
.. _class_FileDialog_method_get_vbox:
- :ref:`VBoxContainer<class_VBoxContainer>` **get_vbox** **(** **)**
Returns the vertical box container of the dialog, custom controls can be added to it.
\ **Warning:** 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 :ref:`CanvasItem.visible<class_CanvasItem_property_visible>` property.
----
.. _class_FileDialog_method_invalidate:
- void **invalidate** **(** **)**
Invalida y actualiza la lista de contenido del diálogo actual.
Theme Property Descriptions
---------------------------
.. _class_FileDialog_theme_color_file_icon_modulate:
- :ref:`Color<class_Color>` **file_icon_modulate**
+-----------+-------------------------+
| *Default* | ``Color( 1, 1, 1, 1 )`` |
+-----------+-------------------------+
La modulación del color aplicada al icono del archivo.
----
.. _class_FileDialog_theme_color_files_disabled:
- :ref:`Color<class_Color>` **files_disabled**
+-----------+---------------------------+
| *Default* | ``Color( 0, 0, 0, 0.7 )`` |
+-----------+---------------------------+
El tinte de color para los archivos desactivados (cuando se utiliza ``FileDialog`` en el modo de carpeta abierta).
----
.. _class_FileDialog_theme_color_folder_icon_modulate:
- :ref:`Color<class_Color>` **folder_icon_modulate**
+-----------+-------------------------+
| *Default* | ``Color( 1, 1, 1, 1 )`` |
+-----------+-------------------------+
La modulación del color aplicada al icono de la carpeta.
----
.. _class_FileDialog_theme_icon_file:
- :ref:`Texture<class_Texture>` **file**
Icono personalizado para los archivos.
----
.. _class_FileDialog_theme_icon_folder:
- :ref:`Texture<class_Texture>` **folder**
Icono personalizado para las carpetas.
----
.. _class_FileDialog_theme_icon_parent_folder:
- :ref:`Texture<class_Texture>` **parent_folder**
Icono personalizado para la flecha de la carpeta principal.
----
.. _class_FileDialog_theme_icon_reload:
- :ref:`Texture<class_Texture>` **reload**
Icono personalizado para el botón de recarga.
----
.. _class_FileDialog_theme_icon_toggle_hidden:
- :ref:`Texture<class_Texture>` **toggle_hidden**
Icono personalizado para el botón oculto de commutación.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`