| Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions | |
The QFileDialog class provides dialogs that allow users to select files or directories. More...
#include <qfiledialog.h>
Inherits QDialog.
The QFileDialog class enables a user to traverse their file system in order to select one or many files or a directory.
The easiest way to create a QFileDialog is to use the static functions. On Windows, these static functions will call the native Windows file dialog and on Mac OS X, these static function will call the native Mac OS X file dialog.
QString s = QFileDialog::getOpenFileName(
"/home",
"Images (*.png *.xpm *.jpg)",
this,
"open file dialog"
"Choose a file" );
In the above example, a modal QFileDialog is created using a static function. The startup directory is set to "/home". The file filter is set to "Images (*.png *.xpm *.jpg)". The parent of the file dialog is set to this and it is given the identification name - "open file dialog". The caption at the top of file dialog is set to "Choose a file". If you want to use multiple filters, separate each one with two semi-colons, e.g.
"Images (*.png *.xpm *.jpg);;Text files (*.txt);;XML files (*.xml)"
You can create your own QFileDialog without using the static functions. By calling setMode(), you can set what can be returned by the QFileDialog.
QFileDialog* fd = new QFileDialog( this, "file dialog", TRUE );
fd->setMode( QFileDialog::AnyFile );
In the above example, the mode of the file dialog is set to AnyFile, meaning that the user can select any file, or even specify a file that doesn't exist. This mode is useful for creating a "File Save As" file dialog. Use ExistingFile if the user must select an existing file or Directory if only a directory may be selected. (See the QFileDialog::Mode enum for the complete list of modes.)
You can retrieve the dialog's mode with mode(). Use setFilter() to set the dialog's file filter, e.g.
fd->setFilter( "Images (*.png *.xpm *.jpg)" );
In the above example, the filter is set to "Images (*.png *.xpm *.jpg)", this means that only files with the extension png, xpm or jpg will be shown in the QFileDialog. You can apply several filters by using setFilters() and add additional filters with addFilter(). Use setSelectedFilter() to select one of the filters you've given as the file dialog's default filter. Whenever the user changes the filter the filterSelected() signal is emitted.
The file dialog has two view modes, QFileDialog::List which simply lists file and directory names and QFileDialog::Detail which displays additional information alongside each name, e.g. file size, modification date, etc. Set the mode with setViewMode().
fd->setViewMode( QFileDialog::Detail );
The last important function you will need to use when creating your own file dialog is selectedFile().
QString fileName;
if ( fd->exec() == QDialog::Accepted )
fileName = fd->selectedFile();
In the above example, a modal file dialog is created and shown. If the user clicked OK, then the file they selected is put in fileName.
If you are using the ExistingFiles mode then you will need to use selectedFiles() which will return the selected files in a QStringList.
The dialog's working directory can be set with setDir(). The display of hidden files is controlled with setShowHiddenFiles(). The dialog can be forced to re-read the directory with rereadDir() and re-sort the directory with resortDir(). All the files in the current directory can be selected with selectAll().
There are two kinds of preview widgets that can be used with QFileDialogs: content preview widgets and information preview widgets. They are created and used in the same way except that the function names differ, e.g. setContentsPreview() and setInfoPreview().
A preview widget is a widget that is placed inside a QFileDialog so that the user can see either the contents of the file, or information about the file.
class Preview : public QLabel, public QFilePreview
{
public:
Preview( QWidget *parent=0 ) : QLabel( parent ) {}
void previewUrl( const QUrl &u )
{
QString path = u.path();
QPixmap pix( path );
if ( pix.isNull() )
setText( "This is not a pixmap" );
else
setPixmap( pix );
}
};
In the above snippet, we create a preview widget which inherits from QLabel and QFilePreview. File preview widgets must inherit from QFilePreview.
Inside the class we reimplement QFilePreview::previewUrl(), this is where we determine what happens when a file is selected. In the above example we only show a preview of the file if it is a valid pixmap. Here's how to make a file dialog use a preview widget:
Preview* p = new Preview;
QFileDialog* fd = new QFileDialog( this );
fd->setContentsPreviewEnabled( TRUE );
fd->setContentsPreview( p, p );
fd->setPreviewMode( QFileDialog::Contents );
fd->show();
The first line creates an instance of our preview widget. We then create our file dialog and call setContentsPreviewEnabled( TRUE ), this tell the file dialog to preview the contents of the currently selected file. We then call setContentsPreview() -- note that we pass the same preview widget twice. Finally, before showing the file dialog, we call setPreviewMode() setting the mode to Contents which will show the contents preview of the file that the user has selected.
If you create another preview widget that is used for displaying information about a file, create it in the same way as the contents preview widget and call setInfoPreviewEnabled(), and setInfoPreview(). Then the user will be able to switch between the two preview modes.
For more information about creating a QFilePreview widget see QFilePreview.
See also Dialog Classes.
This enum is used to indicate what the user may select in the file dialog, i.e. what the dialog will return if the user clicks OK.
See setMode().
This enum describes the preview mode of the file dialog.
See setPreviewMode(), setContentsPreview() and setInfoPreview().
This enum describes the view mode of the file dialog, i.e. what information about each file will be displayed.
See setViewMode().
If dirName is specified then it will be used as the dialog's working directory, i.e. it will be the directory that is shown when the dialog appears. If filter is specified it will be used as the dialog's file filter.
QFileDialog* fd = new QFileDialog( this );
fd->addFilter( "Images (*.png *.jpg *.xpm)" );
fd->show();
In the above example, a file dialog is created, and the file filter "Images (*.png *.jpg *.xpm)" is added and is set as the current filter. The original filter, "All Files (*)", is still available.
See also setFilter() and setFilters().
See also addRightWidget(), addWidgets(), and addToolButton().
See also addLeftWidget(), addWidgets(), and addToolButton().
See also addWidgets(), addLeftWidget(), and addRightWidget().
MyFileDialog::MyFileDialog( QWidget* parent, const char* name ) :
QFileDialog( parent, name )
{
QLabel* label = new QLabel( "Added widgets", this );
QLineEdit* lineedit = new QLineEdit( this );
QToolButton* toolbutton = new QToolButton( this );
addWidgets( label, lineedit, toolbutton );
}
If you don't want to have one of the widgets added, pass 0 in that widget's position.
Every time you call this function, a new row of widgets will be added to the bottom of the file dialog.
See also addToolButton(), addLeftWidget(), and addRightWidget().
The ownership of the QDir pointer is transferred to the caller, so it must be deleted by the caller when no longer required.
See also setDir().
This signal is emitted when the user enters a directory.
See also dir().
Returns the file dialog's working directory. See the "dirPath" property for details.
This signal is emitted when the user highlights a file.
See also fileSelected() and filesSelected().
This signal is emitted when the user selects a file.
See also filesSelected(), fileHighlighted(), and selectedFile.
This signal is emitted when the user selects one or more files in ExistingFiles mode.
See also fileSelected(), fileHighlighted(), and selectedFiles.
This signal is emitted when the user selects a filter.
See also selectedFilter.
QString s = QFileDialog::getExistingDirectory(
"/home",
this,
"get existing directory"
"Choose a directory",
TRUE );
This function creates a modal file dialog called name, with parent, parent. If parent is not 0, the dialog will be shown centered over the parent.
The dialog's working directory is set to dir, and the caption is set to caption. Either of these may be QString::null in which case the current directory and a default caption will be used respectively.
If dirOnly is TRUE, then only directories will be shown in the file dialog; otherwise both directories and files will be shown.
Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If resolveSymlinks is FALSE, the file dialog will treat symlinks as regular directories.
Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any QTimers.
See also getOpenFileName(), getOpenFileNames(), and getSaveFileName().
QString s = QFileDialog::getOpenFileName(
"/home",
"Images (*.png *.xpm *.jpg)",
this,
"open file dialog",
"Choose a file to open" );
The function creates a modal file dialog called name, with parent, parent. If a parent is not 0, the dialog will be shown centered over the parent.
The file dialog's working directory will be set to startWith. If startWith includes a file name, the file will be selected. The filter is set to filter so that only those files which match the filter are shown. The filter selected is set to selectedFilter. The parameters startWith, selectedFilter and filter may be QString::null.
The dialog's caption is set to caption. If caption is not specified then a default caption will be used.
Under Windows and Mac OS X, this static function will use the native file dialog and not a QFileDialog, unless the style of the application is set to something other than the native style (Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any QTimers).
Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If resolveSymlinks is FALSE, the file dialog will treat symlinks as regular directories.
See also getOpenFileNames(), getSaveFileName(), and getExistingDirectory().
Examples: action/application.cpp, addressbook/mainwindow.cpp, application/application.cpp, chart/chartform.cpp, network/ftpclient/ftpmainwindow.ui.h, qwerty/qwerty.cpp, and showimg/showimg.cpp.
QStringList files = QFileDialog::getOpenFileNames(
"Images (*.png *.xpm *.jpg)",
"/home",
this,
"open files dialog"
"Select one or more files to open" );
This function creates a modal file dialog called name, with parent parent. If parent is not 0, the dialog will be shown centered over the parent.
The file dialog's working directory will be set to dir. If dir includes a file name, the file will be selected. The filter is set to filter so that only those files which match the filter are shown. The filter selected is set to selectedFilter. The parameters dir, selectedFilter and filter may be QString::null.
The dialog's caption is set to caption. If caption is not specified then a default caption will be used.
Under Windows and Mac OS X, this static function will use the native file dialog and not a QFileDialog, unless the style of the application is set to something other than the native style. (Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any QTimers).
Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If resolveSymlinks is FALSE, the file dialog will treat symlinks as regular directories.
Note that if you want to iterate over the list of files, you should iterate over a copy, e.g.
QStringList list = files;
QStringList::Iterator it = list.begin();
while( it != list.end() ) {
myProcessing( *it );
++it;
}
See also getOpenFileName(), getSaveFileName(), and getExistingDirectory().
It creates a modal file dialog called name, with parent, parent. If a parent is not 0, the dialog will be shown centered over the parent.
QString s = QFileDialog::getSaveFileName(
"/home",
"Images (*.png *.xpm *.jpg)",
this,
"save file dialog"
"Choose a filename to save under" );
The file dialog's working directory will be set to startWith. If startWith includes a file name, the file will be selected. The filter is set to filter so that only those files which match the filter are shown. The filter selected is set to selectedFilter. The parameters startWith, selectedFilter and filter may be QString::null.
The dialog's caption is set to caption. If caption is not specified then a default caption will be used.
Under Windows and Mac OS X, this static function will use the native file dialog and not a QFileDialog, unless the style of the application is set to something other than the native style. (Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any QTimers).
Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If resolveSymlinks is FALSE, the file dialog will treat symlinks as regular directories.
See also getOpenFileName(), getOpenFileNames(), and getExistingDirectory().
Examples: action/application.cpp, addressbook/mainwindow.cpp, application/application.cpp, network/ftpclient/ftpmainwindow.ui.h, qmag/qmag.cpp, qwerty/qwerty.cpp, and showimg/showimg.cpp.
See also setIconProvider() and QFileIconProvider.
Returns TRUE if the file dialog can provide a contents preview of the currently selected file; otherwise returns FALSE. See the "contentsPreview" property for details.
Returns TRUE if the file dialog can provide preview information about the currently selected file; otherwise returns FALSE. See the "infoPreview" property for details.
Returns the file dialog's mode. See the "mode" property for details.
Returns the preview mode for the file dialog. See the "previewMode" property for details.
The only time you will need to call this function is if the contents of the directory change and you wish to refresh the file dialog to reflect the change.
See also resortDir().
See also rereadDir().
Returns the name of the selected file. See the "selectedFile" property for details.
Returns the list of selected files. See the "selectedFiles" property for details.
Returns the filter which the user has selected in the file dialog. See the "selectedFilter" property for details.
Normally you would create a preview widget that derives from both QWidget and QFilePreview, so you should pass the same widget twice.
class Preview : public QLabel, public QFilePreview
{
public:
Preview( QWidget *parent=0 ) : QLabel( parent ) {}
void previewUrl( const QUrl &u )
{
QString path = u.path();
QPixmap pix( path );
if ( pix.isNull() )
setText( "This is not a pixmap" );
else
setPixmap( pix );
}
};
//...
int main( int argc, char** argv )
{
Preview* p = new Preview;
QFileDialog* fd = new QFileDialog( this );
fd->setContentsPreviewEnabled( TRUE );
fd->setContentsPreview( p, p );
fd->setPreviewMode( QFileDialog::Contents );
fd->show();
}
See also contentsPreview, setInfoPreview(), and previewMode.
Example: qdir/qdir.cpp.
Sets whether the file dialog can provide a contents preview of the currently selected file. See the "contentsPreview" property for details.
See also dir().
Sets the file dialog's working directory to pathstr.
See also dir().
Sets the filter used in the file dialog to newFilter.
If newFilter contains a pair of parentheses containing one or more of anything*something separated by spaces or by semi-colons then only the text contained in the parentheses is used as the filter. This means that these calls are all equivalent:
fd->setFilter( "All C++ files (*.cpp *.cc *.C *.cxx *.c++)" );
fd->setFilter( "*.cpp *.cc *.C *.cxx *.c++" );
fd->setFilter( "All C++ files (*.cpp;*.cc;*.C;*.cxx;*.c++)" );
fd->setFilter( "*.cpp;*.cc;*.C;*.cxx;*.c++" );
See also setFilters().
QString types("Image files (*.png *.xpm *.jpg);;"
"Text files (*.txt);;"
"Any files (*)");
QFileDialog fd = new QFileDialog( this );
fd->setFilters( types );
fd->show();
types must be a null-terminated list of strings.
The default is that there is no QFileIconProvider and QFileDialog just draws a folder icon next to each directory and nothing next to files.
See also QFileIconProvider and iconProvider().
Example: showimg/main.cpp.
Normally you would create a preview widget that derives from both QWidget and QFilePreview, so you should pass the same widget twice.
class Preview : public QLabel, public QFilePreview
{
public:
Preview( QWidget *parent=0 ) : QLabel( parent ) {}
void previewUrl( const QUrl &u )
{
QString path = u.path();
QPixmap pix( path );
if ( pix.isNull() )
setText( "This is not a pixmap" );
else
setText( "This is a pixmap" );
}
};
//...
int main( int argc, char** argv )
{
Preview* p = new Preview;
QFileDialog* fd = new QFileDialog( this );
fd->setInfoPreviewEnabled( TRUE );
fd->setInfoPreview( p, p );
fd->setPreviewMode( QFileDialog::Info );
fd->show();
}
See also setContentsPreview(), infoPreview, and previewMode.
Sets whether the file dialog can provide preview information about the currently selected file. See the "infoPreview" property for details.
Sets the file dialog's mode. See the "mode" property for details.
Sets the preview mode for the file dialog to m. See the "previewMode" property for details.
Sets the current filter selected in the file dialog to the n-th filter in the filter list.
See also filterSelected(), selectedFilter, selectedFiles, and selectedFile.
Example: qdir/qdir.cpp.
Sets whether hidden files are shown in the file dialog to s. See the "showHiddenFiles" property for details.
See also url().
Sets the file dialog's view mode to m. See the "viewMode" property for details.
Returns TRUE if hidden files are shown in the file dialog; otherwise returns FALSE. See the "showHiddenFiles" property for details.
See also setUrl().
Example: network/networkprotocol/view.cpp.
Returns the file dialog's view mode. See the "viewMode" property for details.
This property holds whether the file dialog can provide a contents preview of the currently selected file.
The default is FALSE.
See also setContentsPreview() and infoPreview.
Set this property's value with setContentsPreviewEnabled() and get this property's value with isContentsPreviewEnabled().
This property holds the file dialog's working directory.
Get this property's value with dirPath().
This property holds whether the file dialog can provide preview information about the currently selected file.
The default is FALSE.
Set this property's value with setInfoPreviewEnabled() and get this property's value with isInfoPreviewEnabled().
This property holds the file dialog's mode.
The default mode is ExistingFile.
Set this property's value with setMode() and get this property's value with mode().
This property holds the preview mode for the file dialog.
If you set the mode to be a mode other than NoPreview, you must use setInfoPreview() or setContentsPreview() to set the dialog's preview widget to your preview widget and enable the preview widget(s) with setInfoPreviewEnabled() or setContentsPreviewEnabled().
See also infoPreview, contentsPreview, and viewMode.
Set this property's value with setPreviewMode() and get this property's value with previewMode().
This property holds the name of the selected file.
If a file was selected selectedFile contains the file's name including its absolute path; otherwise selectedFile is empty.
See also QString::isEmpty(), selectedFiles, and selectedFilter.
Get this property's value with selectedFile().
This property holds the list of selected files.
If one or more files are selected, selectedFiles contains their names including their absolute paths. If no files are selected or the mode isn't ExistingFiles selectedFiles is an empty list.
It is more convenient to use selectedFile() if the mode is ExistingFile, Directory or DirectoryOnly.
Note that if you want to iterate over the list, you should iterate over a copy, e.g.
QStringList list = myFileDialog.selectedFiles();
QStringList::Iterator it = list.begin();
while( it != list.end() ) {
myProcessing( *it );
++it;
}
See also selectedFile, selectedFilter, and QValueList::empty().
Get this property's value with selectedFiles().
This property holds the filter which the user has selected in the file dialog.
Get this property's value with selectedFilter().
See also filterSelected(), selectedFiles, and selectedFile.
This property holds whether hidden files are shown in the file dialog.
The default is FALSE, i.e. don't show hidden files.
Set this property's value with setShowHiddenFiles() and get this property's value with showHiddenFiles().
This property holds the file dialog's view mode.
If you set the view mode to be Detail (the default), then you will see the file's details, such as the size of the file and the date the file was last modified in addition to the file's name.
If you set the view mode to be List, then you will just see a list of the files and folders.
Set this property's value with setViewMode() and get this property's value with viewMode().
This file is part of the Qt toolkit. Copyright © 1995-2003 Trolltech. All Rights Reserved.
| Copyright © 2003 Trolltech | Trademarks | Qt version 3.1.2
|