Clase wxFileDialog

Esta clase representa el cuadro de diálogo del selector de archivos.

Jerarquía:

La ruta y el nombre de fichero son elementos distintos de una ruta de fichero completa. Si path es wxEmptyString, se utilizará el directorio actual. Si filename es wxEmptyString, no se proporcionará ningún nombre de archivo por defecto. El comodín determina qué archivos se muestran en el selector de archivos, y la extensión de archivo proporciona una extensión de tipo para el nombre de archivo requerido.

El uso típico para el diálogo de abrir fichero es:

void MyFrame::OnOpen(wxCommandEvent& WXUNUSED(event))
{
    if (...current content has not been saved...)
    {
        if (wxMessageBox(_("Current content has not been saved! Proceed?"), _("Please confirm"),
                         wxICON_QUESTION | wxYES_NO, this) == wxNO )
            return;
        //else: proceed asking to the user the new file to open
    }
 
    wxFileDialog
        openFileDialog(this, _("Open XYZ file"), "", "",
                       "XYZ files (*.xyz)|*.xyz", wxFD_OPEN|wxFD_FILE_MUST_EXIST);
 
    if (openFileDialog.ShowModal() == wxID_CANCEL)
        return;     // the user changed idea...
 
    // proceed loading the file chosen by the user;
    // this can be done with e.g. wxWidgets input streams:
    wxFileInputStream input_stream(openFileDialog.GetPath());
    if (!input_stream.IsOk())
    {
        wxLogError("Cannot open file '%s'.", openFileDialog.GetPath());
        return;
    }
 
    ...
}

En cambio, el uso típico del cuadro de diálogo de guardar archivo es algo más sencillo:

void MyFrame::OnSaveAs(wxCommandEvent& WXUNUSED(event))
{
    wxFileDialog
        saveFileDialog(this, _("Save XYZ file"), "", "",
                       "XYZ files (*.xyz)|*.xyz", wxFD_SAVE|wxFD_OVERWRITE_PROMPT);
 
    if (saveFileDialog.ShowModal() == wxID_CANCEL)
        return;     // the user changed idea...
 
    // save the current contents in the file;
    // this can be done with e.g. wxWidgets output streams:
    wxFileOutputStream output_stream(saveFileDialog.GetPath());
    if (!output_stream.IsOk())
    {
        wxLogError("Cannot save current contents in file '%s'.", saveFileDialog.GetPath());
        return;
    }
 
    ...
}

Filtros comodín

Todas las implementaciones de wxFileDialog proporcionan un filtro comodín. Si se escribe un nombre de archivo que contenga comodines (*, ?) en el elemento de texto del nombre de archivo y se pulsa Aceptar, solo se mostrarán los archivos que coincidan con el patrón. El comodín puede ser una especificación para múltiples tipos de archivo con una descripción para cada uno, como por ejemplo:

"BMP and GIF files (*.bmp;*.gif)|*.bmp;*.gif|PNG files (*.png)|*.png"

En Mac macOS en el diálogo de abrir archivo la caja de elección de filtro no se muestra por defecto. En su lugar, todos los comodines dados se aplican al mismo tiempo: Así, en el ejemplo anterior se muestran todos los archivos bmp, gif y png. Para forzar la visualización de la opción de filtro, configurar las wxSystemOptions correspondientes antes de llamar al diálogo de apertura de archivos:

wxSystemOptions::SetOption(wxOSX_FILEDIALOG_ALWAYS_SHOW_TYPES, 1)

Pero a diferencia de Windows y Unix, donde la elección del tipo de archivo filtra solo los archivos seleccionados, en Mac macOS incluso en este caso el diálogo muestra todos los archivos que coinciden con todos los tipos de archivo. Los archivos que no coinciden con el tipo de archivo seleccionado actualmente aparecen en gris y no se pueden seleccionar.

Personalización de diálogos

De forma única entre los otros diálogos estándar, wxFileDialog puede personalizarse añadiéndole controles extra. Además, hay dos formas de hacerlo: la primera es definir una función callback y usar para decirle al diálogo que la llame, mientras que la segunda requiere definir una clase que herede de wxFileDialogCustomizeHook e implementar sus funciones virtuales, en particular wxFileDialogCustomizeHook::AddCustomControls() donde se tienen que crear los controles extra, y finalmente llamar aSetCustomizeHook() con este objeto hook personalizado.

El primer enfoque es algo más simple y flexible, ya que permite crear cualquier tipo de controles personalizados, pero no está soportado por el "nuevo estilo" (donde "nuevo" significa usado desde Windows Vista, es decir, alrededor de 2007) de diálogos de archivo bajo MSW. Debido a esto, llamar a SetExtraControlCreator() en wxMSW fuerza el uso de diálogos de estilo antiguo (Windows XP), que pueden parecer fuera de lugar. El segundo enfoque es implementado por los diálogos MSW de forma nativa y no sufre esta limitación, por lo que se recomienda su uso, especialmente si los pocos tipos de control simples soportados por él (ver wxFileDialogCustomize para más información sobre los controles soportados) son suficientes para sus necesidades.

Ambas aproximaciones a la personalización de diálogos están demostradas en el Ejemplo de Diálogos, comprobarlo para más detalles.

Nota: Los diálogos de archivo del nuevo estilo sólo se pueden utilizar en wxMSW cuando se utiliza el modelo de subprocesamiento COM. Este es el caso por defecto, pero si la aplicación inicializa COM por sí misma utilizando el modelo multihilo, se utilizan los diálogos de estilo antiguo, al menos cuando deben tener un padre, ya que el nuevo estilo de diálogo no soporta este modelo de subprocesamiento.

Estilos

Esta clase admite los siguientes estilos:

wxFD_DEFAULT_STYLE

Equivalente a wxFD_OPEN.

wxFD_OPEN

Es un diálogo de apertura; normalmente esto significa que la etiqueta del botón por defecto del diálogo es "Abrir". No puede combinarse con wxFD_SAVE.

wxFD_SAVE

Este es un diálogo de guardar; normalmente significa que la etiqueta del botón por defecto del diálogo es "Guardar". No puede combinarse con wxFD_OPEN.

wxFD_OVERWRITE_PROMPT

Solo para diálogos de guardado: pide confirmación si se va a sobrescribir un fichero. Este estilo está siempre activado en wxOSX y no puede ser desactivado.

wxFD_NO_FOLLOW

Indica al diálogo que devuelva la ruta y el nombre del fichero de acceso directo seleccionado, no su destino como hace por defecto. Actualmente esta opción solo está implementada en wxMSW y wxOSX (donde impide que se resuelvan los alias). La ruta de enlace no desreferenciada siempre se devuelve, incluso sin esta bandera, en Unix, por lo que usarla allí no hace nada. Esta opción se añadió en wxWidgets 3.1.0.

wxFD_FILE_MUST_EXIST

Solo para el diálogo de apertura: el usuario solo puede seleccionar ficheros que existan realmente. Hay que tener en cuenta que en macOS el diálogo de archivo con estilo wxFD_OPEN siempre se comporta como si se hubiera especificado este estilo, porque es imposible elegir un archivo que no existe desde un diálogo de archivo estándar de macOS.

wxFD_MULTIPLE

Solo para el diálogo de apertura: permite seleccionar múltiples ficheros.

wxFD_CHANGE_DIR

Cambia el directorio de trabajo actual (cuando se cierra el diálogo) al directorio donde está el fichero o ficheros elegidos por el usuario.

wxFD_PREVIEW

Mostrar la vista previa de los archivos seleccionados (actualmente solo soportado por wxGTK).

wxFD_SHOW_HIDDEN

Muestra los ficheros ocultos. Esta bandera fue añadida en wxWidgets 3.1.3

Tipos

ExtraControlCreatorFunction()

Funciones miembro públicas

wxFileDialog()

~wxFileDialog()

AddShortcut()

GetCurrentlySelectedFilename()

GetCurrentlySelectedFilterIndex()

GetDirectory()

GetExtraControl()

GetFilename()

GetFilenames()

GetFilterIndex()

GetMessage()

GetPath()

GetPaths()

GetWildcard()

SetCustomizeHook()

SetDirectory()

SetExtraControlCreator()

SetFilename()

SetFilterIndex()

SetMessage()

SetPath()

SetWildcard()

ShowModal()

Métodos y datos heredados

Esta clase hereda los métodos y datos miembro públicos y protegidos de wxObject, wxEvtHandler, wxWindow, wxDialog, wxTopLevelWindow y wxNonOwnedWindow.