Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QFileDialog Class Reference

The QFileDialog class provides a dialog that allows users to select files or directories. More...

#include <qfiledialog.h>

+ Inheritance diagram for QFileDialog:
+ Collaboration diagram for QFileDialog:

Public Types

enum  ViewMode { Detail , List }
 This enum describes the view mode of the file dialog; that is, what information about each file is displayed. More...
 
enum  FileMode { AnyFile , ExistingFile , Directory , ExistingFiles }
 This enum is used to indicate what the user may select in the file dialog; that is, what the dialog returns if the user clicks OK. More...
 
enum  AcceptMode { AcceptOpen , AcceptSave }
 \value AcceptOpen \value AcceptSave More...
 
enum  DialogLabel {
  LookIn , FileName , FileType , Accept ,
  Reject
}
 \value LookIn \value FileName \value FileType \value Accept \value Reject More...
 
enum  Option {
  ShowDirsOnly = 0x00000001 , DontResolveSymlinks = 0x00000002 , DontConfirmOverwrite = 0x00000004 , DontUseNativeDialog = 0x00000008 ,
  ReadOnly = 0x00000010 , HideNameFilterDetails = 0x00000020 , DontUseCustomDirectoryIcons = 0x00000040
}
 Options that influence the behavior of the dialog. More...
 
- Public Types inherited from QDialog
enum  DialogCode { Rejected , Accepted }
 The value returned by a modal dialog. More...
 
- Public Types inherited from QWidget
enum  RenderFlag { DrawWindowBackground = 0x1 , DrawChildren = 0x2 , IgnoreMask = 0x4 }
 This enum describes how to render the widget when calling QWidget::render(). More...
 
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric {
  PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM ,
  PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY ,
  PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled
}
 

Public Slots

virtual void open ()
 
- Public Slots inherited from QDialog
virtual void open ()
 
virtual int exec ()
 Shows the dialog as a \l{QDialog::Modal Dialogs}{modal dialog}, blocking until the user closes it.
 
virtual void reject ()
 Hides the modal dialog and sets the result code to Rejected.
 
- Public Slots inherited from QWidget
void setEnabled (bool)
 
void setDisabled (bool)
 Disables widget input events if disable is true; otherwise enables input events.
 
void setWindowModified (bool)
 
void setWindowTitle (const QString &)
 
void setStyleSheet (const QString &styleSheet)
 
void setFocus ()
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.
 
void update ()
 Updates the widget unless updates are disabled or the widget is hidden.
 
void repaint ()
 Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden.
 
void setHidden (bool hidden)
 Convenience function, equivalent to setVisible(!hidden).
 
void show ()
 Shows the widget and its child widgets.
 
void hide ()
 Hides the widget.
 
void showMinimized ()
 Shows the widget minimized, as an icon.
 
void showMaximized ()
 Shows the widget maximized.
 
void showFullScreen ()
 Shows the widget in full-screen mode.
 
void showNormal ()
 Restores the widget after it has been maximized or minimized.
 
bool close ()
 Closes this widget.
 
void raise ()
 Raises this widget to the top of the parent widget's stack.
 
void lower ()
 Lowers the widget to the bottom of the parent widget's stack.
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void fileSelected (const QString &file)
 When the selection changes for local operations and the dialog is accepted, this signal is emitted with the (possibly empty) selected file.
 
void filesSelected (const QStringList &files)
 When the selection changes for local operations and the dialog is accepted, this signal is emitted with the (possibly empty) list of selected files.
 
void currentChanged (const QString &path)
 When the current file changes for local operations, this signal is emitted with the new file name as the path parameter.
 
void directoryEntered (const QString &directory)
 
void urlSelected (const QUrl &url)
 When the selection changes and the dialog is accepted, this signal is emitted with the (possibly empty) selected url.
 
void urlsSelected (const QList< QUrl > &urls)
 When the selection changes and the dialog is accepted, this signal is emitted with the (possibly empty) list of selected urls.
 
void currentUrlChanged (const QUrl &url)
 When the current file changes, this signal is emitted with the new file URL as the url parameter.
 
void directoryUrlEntered (const QUrl &directory)
 This signal is emitted when the user enters a directory.
 
void filterSelected (const QString &filter)
 
- Signals inherited from QDialog
void finished (int result)
 
void accepted ()
 
void rejected ()
 
- Signals inherited from QWidget
void windowTitleChanged (const QString &title)
 This signal is emitted when the window's title has changed, with the new title as an argument.
 
void windowIconChanged (const QIcon &icon)
 This signal is emitted when the window's icon has changed, with the new icon as an argument.
 
void windowIconTextChanged (const QString &iconText)
 This signal is emitted when the window's icon text has changed, with the new iconText as an argument.
 
void customContextMenuRequested (const QPoint &pos)
 This signal is emitted when the widget's \l contextMenuPolicy is Qt::CustomContextMenu, and the user has requested a context menu on the widget.
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QFileDialog (QWidget *parent, Qt::WindowFlags f)
 
 QFileDialog (QWidget *parent=nullptr, const QString &caption=QString(), const QString &directory=QString(), const QString &filter=QString())
 Constructs a file dialog with the given parent and caption that initially displays the contents of the specified directory.
 
 ~QFileDialog ()
 Destroys the file dialog.
 
void setDirectory (const QString &directory)
 Sets the file dialog's current directory.
 
void setDirectory (const QDir &directory)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QDir directory () const
 Returns the directory currently being displayed in the dialog.
 
void setDirectoryUrl (const QUrl &directory)
 Sets the file dialog's current directory url.
 
QUrl directoryUrl () const
 Returns the url of the directory currently being displayed in the dialog.
 
void selectFile (const QString &filename)
 Selects the given filename in the file dialog.
 
QStringList selectedFiles () const
 Returns a list of strings containing the absolute paths of the selected files in the dialog.
 
void selectUrl (const QUrl &url)
 Selects the given url in the file dialog.
 
QList< QUrlselectedUrls () const
 Returns a list of urls containing the selected files in the dialog.
 
void setNameFilter (const QString &filter)
 
void setNameFilters (const QStringList &filters)
 
QStringList nameFilters () const
 
void selectNameFilter (const QString &filter)
 
QString selectedMimeTypeFilter () const
 
QString selectedNameFilter () const
 
QDir::Filters filter () const
 
void setFilter (QDir::Filters filters)
 
void setViewMode (ViewMode mode)
 
ViewMode viewMode () const
 
void setFileMode (FileMode mode)
 
FileMode fileMode () const
 
void setAcceptMode (AcceptMode mode)
 
AcceptMode acceptMode () const
 
void setSidebarUrls (const QList< QUrl > &urls)
 
QList< QUrlsidebarUrls () const
 
QByteArray saveState () const
 
bool restoreState (const QByteArray &state)
 
void setDefaultSuffix (const QString &suffix)
 
QString defaultSuffix () const
 
void setHistory (const QStringList &paths)
 Sets the browsing history of the filedialog to contain the given paths.
 
QStringList history () const
 Returns the browsing history of the filedialog as a list of paths.
 
void setItemDelegate (QAbstractItemDelegate *delegate)
 Sets the item delegate used to render items in the views in the file dialog to the given delegate.
 
QAbstractItemDelegateitemDelegate () const
 Returns the item delegate used to render the items in the views in the filedialog.
 
void setIconProvider (QAbstractFileIconProvider *provider)
 Sets the icon provider used by the filedialog to the specified provider.
 
QAbstractFileIconProvidericonProvider () const
 Returns the icon provider used by the filedialog.
 
void setLabelText (DialogLabel label, const QString &text)
 Sets the text shown in the filedialog in the specified label.
 
QString labelText (DialogLabel label) const
 Returns the text shown in the filedialog in the specified label.
 
void setSupportedSchemes (const QStringList &schemes)
 
QStringList supportedSchemes () const
 
void setOption (Option option, bool on=true)
 
bool testOption (Option option) const
 
void setOptions (Options options)
 
Options options () const
 
void open (QObject *receiver, const char *member)
 
void setVisible (bool visible) override
 \reimp
 
- Public Member Functions inherited from QDialog
 QDialog (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
 Constructs a dialog with parent parent.
 
 ~QDialog ()
 Destroys the QDialog, deleting all its children.
 
int result () const
 In general returns the modal dialog's result code, Accepted or Rejected.
 
QSize sizeHint () const override
 \reimp
 
QSize minimumSizeHint () const override
 \reimp
 
void setSizeGripEnabled (bool)
 
bool isSizeGripEnabled () const
 
void setModal (bool modal)
 
void setResult (int r)
 Sets the modal dialog's result code to i.
 
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
 Constructs a widget which is a child of parent, with widget flags set to f.
 
 ~QWidget ()
 Destroys the widget.
 
int devType () const override
 
WId winId () const
 Returns the window system identifier of the widget.
 
void createWinId ()
 
WId internalWinId () const
 
WId effectiveWinId () const
 
QStylestyle () const
 
void setStyle (QStyle *)
 Sets the widget's GUI style to style.
 
bool isWindow () const
 Returns true if the widget is an independent window, otherwise returns false.
 
bool isModal () const
 
Qt::WindowModality windowModality () const
 
void setWindowModality (Qt::WindowModality windowModality)
 
bool isEnabled () const
 
bool isEnabledTo (const QWidget *) const
 Returns true if this widget would become enabled if ancestor is enabled; otherwise returns false.
 
QRect frameGeometry () const
 
const QRectgeometry () const
 
QRect normalGeometry () const
 
int x () const
 
int y () const
 
QPoint pos () const
 
QSize frameSize () const
 
QSize size () const
 
int width () const
 
int height () const
 
QRect rect () const
 
QRect childrenRect () const
 
QRegion childrenRegion () const
 
QSize minimumSize () const
 
QSize maximumSize () const
 
int minimumWidth () const
 
int minimumHeight () const
 
int maximumWidth () const
 
int maximumHeight () const
 
void setMinimumSize (const QSize &)
 
void setMinimumSize (int minw, int minh)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMinimumSize(QSize(minw, minh)).
 
void setMaximumSize (const QSize &)
 
void setMaximumSize (int maxw, int maxh)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMaximumSize(QSize(maxw, maxh)).
 
void setMinimumWidth (int minw)
 
void setMinimumHeight (int minh)
 
void setMaximumWidth (int maxw)
 
void setMaximumHeight (int maxh)
 
QSize sizeIncrement () const
 
void setSizeIncrement (const QSize &)
 
void setSizeIncrement (int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the x (width) size increment to w and the y (height) size increment to h.
 
QSize baseSize () const
 
void setBaseSize (const QSize &)
 
void setBaseSize (int basew, int baseh)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setBaseSize(QSize(basew, baseh)).
 
void setFixedSize (const QSize &)
 Sets both the minimum and maximum sizes of the widget to s, thereby preventing it from ever growing or shrinking.
 
void setFixedSize (int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the width of the widget to w and the height to h.
 
void setFixedWidth (int w)
 Sets both the minimum and maximum width of the widget to w without changing the heights.
 
void setFixedHeight (int h)
 Sets both the minimum and maximum heights of the widget to h without changing the widths.
 
QPointF mapToGlobal (const QPointF &) const
 Translates the widget coordinate pos to global screen coordinates.
 
QPoint mapToGlobal (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapFromGlobal (const QPointF &) const
 Translates the global screen coordinate pos to widget coordinates.
 
QPoint mapFromGlobal (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapToParent (const QPointF &) const
 Translates the widget coordinate pos to a coordinate in the parent widget.
 
QPoint mapToParent (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapFromParent (const QPointF &) const
 Translates the parent widget coordinate pos to widget coordinates.
 
QPoint mapFromParent (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapTo (const QWidget *, const QPointF &) const
 Translates the widget coordinate pos to the coordinate system of parent.
 
QPoint mapTo (const QWidget *, const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapFrom (const QWidget *, const QPointF &) const
 Translates the widget coordinate pos from the coordinate system of parent to this widget's coordinate system.
 
QPoint mapFrom (const QWidget *, const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QWidgetwindow () const
 Returns the window for this widget, i.e.
 
QWidgetnativeParentWidget () const
 
QWidgettopLevelWidget () const
 
const QPalettepalette () const
 
void setPalette (const QPalette &)
 
void setBackgroundRole (QPalette::ColorRole)
 Sets the background role of the widget to role.
 
QPalette::ColorRole backgroundRole () const
 Returns the background role of the widget.
 
void setForegroundRole (QPalette::ColorRole)
 Sets the foreground role of the widget to role.
 
QPalette::ColorRole foregroundRole () const
 Returns the foreground role.
 
const QFontfont () const
 
void setFont (const QFont &)
 
QFontMetrics fontMetrics () const
 Returns the font metrics for the widget's current font.
 
QFontInfo fontInfo () const
 Returns the font info for the widget's current font.
 
QCursor cursor () const
 
void setCursor (const QCursor &)
 
void unsetCursor ()
 
void setMouseTracking (bool enable)
 
bool hasMouseTracking () const
 
bool underMouse () const
 Returns true if the widget is under the mouse cursor; otherwise returns false.
 
void setTabletTracking (bool enable)
 
bool hasTabletTracking () const
 
void setMask (const QBitmap &)
 Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible.
 
void setMask (const QRegion &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Causes only the parts of the widget which overlap region to be visible.
 
QRegion mask () const
 Returns the mask currently set on a widget.
 
void clearMask ()
 Removes any mask set by setMask().
 
void render (QPaintDevice *target, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground|DrawChildren))
 
void render (QPainter *painter, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground|DrawChildren))
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Renders the widget into the painter's QPainter::device().
 
Q_INVOKABLE QPixmap grab (const QRect &rectangle=QRect(QPoint(0, 0), QSize(-1, -1)))
 
void grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags())
 Subscribes the widget to a given gesture with specific flags.
 
void ungrabGesture (Qt::GestureType type)
 Unsubscribes the widget from a given gesture type.
 
QString styleSheet () const
 
QString windowTitle () const
 
void setWindowIcon (const QIcon &icon)
 
QIcon windowIcon () const
 
void setWindowIconText (const QString &)
 
QString windowIconText () const
 
void setWindowRole (const QString &)
 Sets the window's role to role.
 
QString windowRole () const
 Returns the window's role, or an empty string.
 
void setWindowFilePath (const QString &filePath)
 
QString windowFilePath () const
 
void setWindowOpacity (qreal level)
 
qreal windowOpacity () const
 
bool isWindowModified () const
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
Qt::LayoutDirection layoutDirection () const
 
void unsetLayoutDirection ()
 
void setLocale (const QLocale &locale)
 
QLocale locale () const
 
void unsetLocale ()
 
bool isRightToLeft () const
 
bool isLeftToRight () const
 
bool isActiveWindow () const
 
void activateWindow ()
 Sets the top-level widget containing this widget to be the active window.
 
void clearFocus ()
 Takes keyboard input focus from the widget.
 
void setFocus (Qt::FocusReason reason)
 Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.
 
Qt::FocusPolicy focusPolicy () const
 
void setFocusPolicy (Qt::FocusPolicy policy)
 
bool hasFocus () const
 
void setFocusProxy (QWidget *)
 Sets the widget's focus proxy to widget w.
 
QWidgetfocusProxy () const
 Returns the focus proxy, or \nullptr if there is no focus proxy.
 
Qt::ContextMenuPolicy contextMenuPolicy () const
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void grabMouse ()
 Grabs the mouse input.
 
void grabMouse (const QCursor &)
 
void releaseMouse ()
 Releases the mouse grab.
 
void grabKeyboard ()
 Grabs the keyboard input.
 
void releaseKeyboard ()
 Releases the keyboard grab.
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)
 Adds a shortcut to Qt's shortcut system that watches for the given key sequence in the given context.
 
void releaseShortcut (int id)
 Removes the shortcut with the given id from Qt's shortcut system.
 
void setShortcutEnabled (int id, bool enable=true)
 If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled.
 
void setShortcutAutoRepeat (int id, bool enable=true)
 
bool updatesEnabled () const
 
void setUpdatesEnabled (bool enable)
 
void update (int x, int y, int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle (x, y, w, h) inside the widget.
 
void update (const QRect &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle rect inside the widget.
 
void update (const QRegion &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.
 
void repaint (int x, int y, int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle (x, y, w, h) inside the widget.
 
void repaint (const QRect &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle rect inside the widget.
 
void repaint (const QRegion &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.
 
void stackUnder (QWidget *)
 Places the widget under w in the parent widget's stack.
 
void move (int x, int y)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to move(QPoint(x, y)).
 
void move (const QPoint &)
 
void resize (int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to resize(QSize(w, h)).
 
void resize (const QSize &)
 
void setGeometry (int x, int y, int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setGeometry(QRect(x, y, w, h)).
 
void setGeometry (const QRect &)
 
QByteArray saveGeometry () const
 
bool restoreGeometry (const QByteArray &geometry)
 
void adjustSize ()
 Adjusts the size of the widget to fit its contents.
 
bool isVisible () const
 
bool isVisibleTo (const QWidget *) const
 Returns true if this widget would become visible if ancestor is shown; otherwise returns false.
 
bool isHidden () const
 Returns true if the widget is hidden, otherwise returns false.
 
bool isMinimized () const
 
bool isMaximized () const
 
bool isFullScreen () const
 
Qt::WindowStates windowState () const
 Returns the current window state.
 
void setWindowState (Qt::WindowStates state)
 Sets the window state to windowState.
 
void overrideWindowState (Qt::WindowStates state)
 
QSizePolicy sizePolicy () const
 
void setSizePolicy (QSizePolicy)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the size policy of the widget to horizontal and vertical, with standard stretch and no height-for-width.
 
virtual int heightForWidth (int) const
 Returns the preferred height for this widget, given the width w.
 
virtual bool hasHeightForWidth () const
 
QRegion visibleRegion () const
 Returns the unobscured region where paint events can occur.
 
void setContentsMargins (int left, int top, int right, int bottom)
 Sets the margins around the contents of the widget to have the sizes left, top, right, and bottom.
 
void setContentsMargins (const QMargins &margins)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QMargins contentsMargins () const
 The contentsMargins function returns the widget's contents margins.
 
QRect contentsRect () const
 Returns the area inside the widget's margins.
 
QLayoutlayout () const
 Returns the layout manager that is installed on this widget, or \nullptr if no layout manager is installed.
 
void setLayout (QLayout *)
 Sets the layout manager for this widget to layout.
 
void updateGeometry ()
 Notifies the layout system that this widget has changed and may need to change geometry.
 
void setParent (QWidget *parent)
 Sets the parent of the widget to parent, and resets the window flags.
 
void setParent (QWidget *parent, Qt::WindowFlags f)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function also takes widget flags, f as an argument.
 
void scroll (int dx, int dy)
 Scrolls the widget including its children dx pixels to the right and dy downward.
 
void scroll (int dx, int dy, const QRect &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version only scrolls r and does not move the children of the widget.
 
QWidgetfocusWidget () const
 Returns the last child of this widget that setFocus had been called on.
 
QWidgetnextInFocusChain () const
 Returns the next widget in this widget's focus chain.
 
QWidgetpreviousInFocusChain () const
 The previousInFocusChain function returns the previous widget in this widget's focus chain.
 
bool acceptDrops () const
 
void setAcceptDrops (bool on)
 
void addAction (QAction *action)
 Appends the action action to this widget's list of actions.
 
void addActions (const QList< QAction * > &actions)
 Appends the actions actions to this widget's list of actions.
 
void insertActions (QAction *before, const QList< QAction * > &actions)
 Inserts the actions actions to this widget's list of actions, before the action before.
 
void insertAction (QAction *before, QAction *action)
 Inserts the action action to this widget's list of actions, before the action before.
 
void removeAction (QAction *action)
 Removes the action action from this widget's list of actions.
 
QList< QAction * > actions () const
 Returns the (possibly empty) list of this widget's actions.
 
QActionaddAction (const QString &text)
 
QActionaddAction (const QIcon &icon, const QString &text)
 
QActionaddAction (const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type=Qt::AutoConnection)
 
QActionaddAction (const QIcon &icon, const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename... Args, typename = compatible_action_slot_args<Args...>>
QActionaddAction (const QString &text, Args &&...args)
 
template<typename... Args, typename = compatible_action_slot_args<Args...>>
QActionaddAction (const QIcon &icon, const QString &text, Args &&...args)
 
QWidgetparentWidget () const
 Returns the parent of this widget, or \nullptr if it does not have any parent widget.
 
void setWindowFlags (Qt::WindowFlags type)
 
Qt::WindowFlags windowFlags () const
 Window flags are a combination of a type (e.g.
 
void setWindowFlag (Qt::WindowType, bool on=true)
 
void overrideWindowFlags (Qt::WindowFlags type)
 Sets the window flags for the widget to flags, without telling the window system.
 
Qt::WindowType windowType () const
 Returns the window type of this widget.
 
QWidgetchildAt (int x, int y) const
 Returns the visible child widget at the position ({x}, {y}) in the widget's coordinate system.
 
QWidgetchildAt (const QPoint &p) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the visible child widget at point p in the widget's own coordinate system.
 
void setAttribute (Qt::WidgetAttribute, bool on=true)
 Sets the attribute attribute on this widget if on is true; otherwise clears the attribute.
 
bool testAttribute (Qt::WidgetAttribute) const
 Returns true if attribute attribute is set on this widget; otherwise returns false.
 
QPaintEnginepaintEngine () const override
 Returns the widget's paint engine.
 
void ensurePolished () const
 Ensures that the widget and its children have been polished by QStyle (i.e., have a proper font and palette).
 
bool isAncestorOf (const QWidget *child) const
 Returns true if this widget is a parent, (or grandparent and so on to any level), of the given child, and both widgets are within the same window; otherwise returns false.
 
bool autoFillBackground () const
 
void setAutoFillBackground (bool enabled)
 
QBackingStorebackingStore () const
 
QWindowwindowHandle () const
 If this is a native widget, return the associated QWindow.
 
QScreenscreen () const
 Returns the screen the widget is on.
 
void setScreen (QScreen *)
 Sets the screen on which the widget should be shown to screen.
 
virtual QVariant inputMethodQuery (Qt::InputMethodQuery) const
 This method is only relevant for input widgets.
 
Qt::InputMethodHints inputMethodHints () const
 
void setInputMethodHints (Qt::InputMethodHints hints)
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 
- Public Member Functions inherited from QPaintDevice
virtual ~QPaintDevice ()
 
bool paintingActive () const
 
int width () const
 
int height () const
 
int widthMM () const
 
int heightMM () const
 
int logicalDpiX () const
 
int logicalDpiY () const
 
int physicalDpiX () const
 
int physicalDpiY () const
 
qreal devicePixelRatio () const
 
qreal devicePixelRatioF () const
 
int colorCount () const
 
int depth () const
 

Static Public Member Functions

static QString getOpenFileName (QWidget *parent=nullptr, const QString &caption=QString(), const QString &dir=QString(), const QString &filter=QString(), QString *selectedFilter=nullptr, Options options=Options())
 This is a convenience static function that returns an existing file selected by the user.
 
static QUrl getOpenFileUrl (QWidget *parent=nullptr, const QString &caption=QString(), const QUrl &dir=QUrl(), const QString &filter=QString(), QString *selectedFilter=nullptr, Options options=Options(), const QStringList &supportedSchemes=QStringList())
 This is a convenience static function that returns an existing file selected by the user.
 
static QString getSaveFileName (QWidget *parent=nullptr, const QString &caption=QString(), const QString &dir=QString(), const QString &filter=QString(), QString *selectedFilter=nullptr, Options options=Options())
 This is a convenience static function that returns a file name selected by the user.
 
static QUrl getSaveFileUrl (QWidget *parent=nullptr, const QString &caption=QString(), const QUrl &dir=QUrl(), const QString &filter=QString(), QString *selectedFilter=nullptr, Options options=Options(), const QStringList &supportedSchemes=QStringList())
 This is a convenience static function that returns a file selected by the user.
 
static QString getExistingDirectory (QWidget *parent=nullptr, const QString &caption=QString(), const QString &dir=QString(), Options options=ShowDirsOnly)
 This is a convenience static function that returns an existing directory selected by the user.
 
static QUrl getExistingDirectoryUrl (QWidget *parent=nullptr, const QString &caption=QString(), const QUrl &dir=QUrl(), Options options=ShowDirsOnly, const QStringList &supportedSchemes=QStringList())
 This is a convenience static function that returns an existing directory selected by the user.
 
static QStringList getOpenFileNames (QWidget *parent=nullptr, const QString &caption=QString(), const QString &dir=QString(), const QString &filter=QString(), QString *selectedFilter=nullptr, Options options=Options())
 This is a convenience static function that returns one or more existing files selected by the user.
 
static QList< QUrlgetOpenFileUrls (QWidget *parent=nullptr, const QString &caption=QString(), const QUrl &dir=QUrl(), const QString &filter=QString(), QString *selectedFilter=nullptr, Options options=Options(), const QStringList &supportedSchemes=QStringList())
 This is a convenience static function that returns one or more existing files selected by the user.
 
static void getOpenFileContent (const QString &nameFilter, const std::function< void(const QString &, const QByteArray &)> &fileContentsReady, QWidget *parent=nullptr)
 This is a convenience static function that returns the content of a file selected by the user.
 
static void saveFileContent (const QByteArray &fileContent, const QString &fileNameHint, QWidget *parent=nullptr)
 This is a convenience static function that saves fileContent to a file, using a file name and location chosen by the user.
 
- Static Public Member Functions inherited from QWidget
static void setTabOrder (QWidget *, QWidget *)
 Puts the second widget after the first widget in the focus order.
 
static void setTabOrder (std::initializer_list< QWidget * > widgets)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
static QWidgetmouseGrabber ()
 Returns the widget that is currently grabbing the mouse input.
 
static QWidgetkeyboardGrabber ()
 Returns the widget that is currently grabbing the keyboard input.
 
static QWidgetfind (WId)
 Returns a pointer to the widget with window identifier/handle id.
 
static QWidgetcreateWindowContainer (QWindow *window, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
 Creates a QWidget that makes it possible to embed window into a QWidget-based application.
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Static Public Member Functions inherited from QPaintDevice
static qreal devicePixelRatioFScale ()
 

Protected Member Functions

 QFileDialog (const QFileDialogArgs &args)
 
void done (int result) override
 \reimp
 
void accept () override
 \reimp
 
void changeEvent (QEvent *e) override
 \reimp
 
- Protected Member Functions inherited from QDialog
 QDialog (QDialogPrivate &, QWidget *parent, Qt::WindowFlags f=Qt::WindowFlags())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
void keyPressEvent (QKeyEvent *) override
 \reimp
 
void closeEvent (QCloseEvent *) override
 \reimp
 
void showEvent (QShowEvent *) override
 \reimp
 
void resizeEvent (QResizeEvent *) override
 \reimp
 
void contextMenuEvent (QContextMenuEvent *) override
 \reimp
 
bool eventFilter (QObject *, QEvent *) override
 \reimp
 
void adjustPosition (QWidget *)
 
- Protected Member Functions inherited from QWidget
bool event (QEvent *event) override
 This is the main event handler; it handles event event.
 
virtual void mousePressEvent (QMouseEvent *event)
 This event handler, for event event, can be reimplemented in a subclass to receive mouse press events for the widget.
 
virtual void mouseReleaseEvent (QMouseEvent *event)
 This event handler, for event event, can be reimplemented in a subclass to receive mouse release events for the widget.
 
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 This event handler, for event event, can be reimplemented in a subclass to receive mouse double click events for the widget.
 
virtual void mouseMoveEvent (QMouseEvent *event)
 This event handler, for event event, can be reimplemented in a subclass to receive mouse move events for the widget.
 
virtual void keyReleaseEvent (QKeyEvent *event)
 This event handler, for event event, can be reimplemented in a subclass to receive key release events for the widget.
 
virtual void focusInEvent (QFocusEvent *event)
 This event handler can be reimplemented in a subclass to receive keyboard focus events (focus received) for the widget.
 
virtual void focusOutEvent (QFocusEvent *event)
 This event handler can be reimplemented in a subclass to receive keyboard focus events (focus lost) for the widget.
 
virtual void enterEvent (QEnterEvent *event)
 This event handler can be reimplemented in a subclass to receive widget enter events which are passed in the event parameter.
 
virtual void leaveEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive widget leave events which are passed in the event parameter.
 
virtual void paintEvent (QPaintEvent *event)
 This event handler can be reimplemented in a subclass to receive paint events passed in event.
 
virtual void moveEvent (QMoveEvent *event)
 This event handler can be reimplemented in a subclass to receive widget move events which are passed in the event parameter.
 
virtual void actionEvent (QActionEvent *event)
 This event handler is called with the given event whenever the widget's actions are changed.
 
virtual void hideEvent (QHideEvent *event)
 This event handler can be reimplemented in a subclass to receive widget hide events.
 
virtual bool nativeEvent (const QByteArray &eventType, void *message, qintptr *result)
 This special event handler can be reimplemented in a subclass to receive native platform events identified by eventType which are passed in the message parameter.
 
int metric (PaintDeviceMetric) const override
 Internal implementation of the virtual QPaintDevice::metric() function.
 
void initPainter (QPainter *painter) const override
 Initializes the painter pen, background and font to the same as the given widget's.
 
QPaintDeviceredirected (QPoint *offset) const override
 
QPaintersharedPainter () const override
 
virtual void inputMethodEvent (QInputMethodEvent *)
 This event handler, for event event, can be reimplemented in a subclass to receive Input Method composition events.
 
void create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)
 Creates a new widget window.
 
void destroy (bool destroyWindow=true, bool destroySubWindows=true)
 Frees up window system resources.
 
virtual bool focusNextPrevChild (bool next)
 Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns true if it can find a new widget, or false if it can't.
 
bool focusNextChild ()
 Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Tab, and returns true if it can find a new widget, or false if it can't.
 
bool focusPreviousChild ()
 Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Shift+Tab, and returns true if it can find a new widget, or false if it can't.
 
 QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Member Functions inherited from QPaintDevice
 QPaintDevice () noexcept
 

Properties

ViewMode viewMode
 The way files and directories are displayed in the dialog.
 
FileMode fileMode
 The file mode of the dialog.
 
AcceptMode acceptMode
 The accept mode of the dialog.
 
QString defaultSuffix
 Suffix added to the filename if no other suffix was specified.
 
Options options
 The various options that affect the look and feel of the dialog.
 
QStringList supportedSchemes
 The URL schemes that the file dialog should allow navigating to.
 
- Properties inherited from QDialog
bool sizeGripEnabled
 whether the size grip is enabled
 
bool modal
 whether show() should pop up the dialog as modal or modeless
 
- Properties inherited from QWidget
bool modal
 whether the widget is a modal widget
 
Qt::WindowModality windowModality
 which windows are blocked by the modal widget
 
bool enabled
 whether the widget is enabled
 
QRect geometry
 the geometry of the widget relative to its parent and excluding the window frame
 
QRect frameGeometry
 geometry of the widget relative to its parent including any window frame
 
QRect normalGeometry
 the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget
 
int x
 the x coordinate of the widget relative to its parent including any window frame
 
int y
 the y coordinate of the widget relative to its parent and including any window frame
 
QPoint pos
 the position of the widget within its parent widget
 
QSize frameSize
 the size of the widget including any window frame
 
QSize size
 the size of the widget excluding any window frame
 
int width
 the width of the widget excluding any window frame
 
int height
 the height of the widget excluding any window frame
 
QRect rect
 the internal geometry of the widget excluding any window frame
 
QRect childrenRect
 the bounding rectangle of the widget's children
 
QRegion childrenRegion
 the combined region occupied by the widget's children
 
QSizePolicy sizePolicy
 the default layout behavior of the widget
 
QSize minimumSize
 the widget's minimum size
 
QSize maximumSize
 the widget's maximum size in pixels
 
int minimumWidth
 the widget's minimum width in pixels
 
int minimumHeight
 the widget's minimum height in pixels
 
int maximumWidth
 the widget's maximum width in pixels
 
int maximumHeight
 the widget's maximum height in pixels
 
QSize sizeIncrement
 the size increment of the widget
 
QSize baseSize
 the base size of the widget
 
QPalette palette
 the widget's palette
 
QFont font
 the font currently set for the widget
 
QCursor cursor
 the cursor shape for this widget
 
bool mouseTracking
 whether mouse tracking is enabled for the widget
 
bool tabletTracking
 whether tablet tracking is enabled for the widget
 
bool isActiveWindow
 whether this widget's window is the active window
 
Qt::FocusPolicy focusPolicy
 the way the widget accepts keyboard focus
 
bool focus
 whether this widget (or its focus proxy) has the keyboard input focus
 
Qt::ContextMenuPolicy contextMenuPolicy
 how the widget shows a context menu
 
bool updatesEnabled
 whether updates are enabled
 
bool visible
 whether the widget is visible
 
bool minimized
 whether this widget is minimized (iconified)
 
bool maximized
 whether this widget is maximized
 
bool fullScreen
 whether the widget is shown in full screen mode
 
QSize sizeHint
 the recommended size for the widget
 
QSize minimumSizeHint
 the recommended minimum size for the widget
 
bool acceptDrops
 whether drop events are enabled for this widget
 
QString windowTitle
 the window title (caption)
 
QIcon windowIcon
 the widget's icon
 
QString windowIconText
 the text to be displayed on the icon of a minimized window
 
double windowOpacity
 The level of opacity for the window.
 
bool windowModified
 whether the document shown in the window has unsaved changes
 
Qt::LayoutDirection layoutDirection
 the layout direction for this widget.
 
bool autoFillBackground
 whether the widget background is filled automatically
 
QString styleSheet
 the widget's style sheet
 
QLocale locale
 the widget's locale
 
QString windowFilePath
 the file path associated with a widget
 
Qt::InputMethodHints inputMethodHints
 What input method specific hints the widget has.
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Friends

class QPlatformDialogHelper
 

Additional Inherited Members

- Protected Slots inherited from QWidget
void updateMicroFocus (Qt::InputMethodQuery query=Qt::ImQueryAll)
 Updates the widget's micro focus and informs input methods that the state specified by query has changed.
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Protected Attributes inherited from QPaintDevice
ushort painters
 

Detailed Description

The QFileDialog class provides a dialog that allows users to select files or directories.

\inmodule QtWidgets

The QFileDialog class enables a user to traverse the file system to select one or many files or a directory.

The easiest way to create a QFileDialog is to use the static functions, such as \l getOpenFileName().

tr("Open Image"), "/home/jana", tr("Image Files (*.png *.jpg *.bmp)"));

In the above example, a modal QFileDialog is created using a static function. The dialog initially displays the contents of the "/home/jana" directory, and displays files matching the patterns given in the string "Image Files (*.png *.jpg *.bmp)". The parent of the file dialog is set to this, and the window title is set to "Open Image".

If you want to use multiple filters, separate each one with two semicolons. For example:

You can create your own QFileDialog without using the static functions. By calling setFileMode(), you can specify what the user must select in the dialog:

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 "Save As" file dialog. Use ExistingFile if the user must select an existing file, or \l Directory if only a directory can be selected. See the \l QFileDialog::FileMode enum for the complete list of modes.

The fileMode property contains the mode of operation for the dialog; this indicates what types of objects the user is expected to select. Use setNameFilter() to set the dialog's file filter. For example:

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 are shown in the QFileDialog. You can apply several filters by using setNameFilters(). Use selectNameFilter() to select one of the filters you've given as the file dialog's default filter.

The file dialog has two view modes: \l{QFileDialog::}{List} and \l{QFileDialog::}{Detail}. \l{QFileDialog::}{List} presents the contents of the current directory as a list of file and directory names. \l{QFileDialog::}{Detail} also displays a list of file and directory names, but provides additional information alongside each name, such as the file size and modification date. Set the mode with setViewMode():

The last important function you need to use when creating your own file dialog is selectedFiles().

In the above example, a modal file dialog is created and shown. If the user clicked OK, the file they selected is put in fileName.

The dialog's working directory can be set with setDirectory(). Each file in the current directory can be selected using the selectFile() function.

The \l{dialogs/standarddialogs}{Standard Dialogs} example shows how to use QFileDialog as well as other built-in Qt dialogs.

By default, a platform-native file dialog is used if the platform has one. In that case, the widgets that would otherwise be used to construct the dialog are not instantiated, so related accessors such as layout() and itemDelegate() return null. Also, not all platforms show file dialogs with a title bar, so be aware that the caption text might not be visible to the user. You can set the \l DontUseNativeDialog option or set the \l{Qt::AA_DontUseNativeDialogs}{AA_DontUseNativeDialogs} application attribute to ensure that the widget-based implementation is used instead of the native dialog.

See also
QDir, QFileInfo, QFile, QColorDialog, QFontDialog, {Standard Dialogs Example}

Definition at line 27 of file qfiledialog.h.

Member Enumeration Documentation

◆ AcceptMode

\value AcceptOpen \value AcceptSave

Enumerator
AcceptOpen 
AcceptSave 

Definition at line 42 of file qfiledialog.h.

◆ DialogLabel

\value LookIn \value FileName \value FileType \value Accept \value Reject

Enumerator
LookIn 
FileName 
FileType 
Accept 
Reject 

Definition at line 44 of file qfiledialog.h.

◆ FileMode

This enum is used to indicate what the user may select in the file dialog; that is, what the dialog returns if the user clicks OK.

\value AnyFile The name of a file, whether it exists or not. \value ExistingFile The name of a single existing file. \value Directory The name of a directory. Both files and directories are displayed. However, the native Windows file dialog does not support displaying files in the directory chooser. \value ExistingFiles The names of zero or more existing files.

See also
setFileMode()
Enumerator
AnyFile 
ExistingFile 
Directory 
ExistingFiles 

Definition at line 40 of file qfiledialog.h.

◆ Option

Options that influence the behavior of the dialog.

\value ShowDirsOnly Only show directories. By default, both files and directories are shown.\br This option is only effective in the \l Directory file mode.

\value DontResolveSymlinks Don't resolve symlinks. By default, symlinks are resolved.

\value DontConfirmOverwrite Don't ask for confirmation if an existing file is selected. By default, confirmation is requested.\br This option is only effective if \l acceptMode is \l {QFileDialog::}{AcceptSave}). It is furthermore not used on macOS for native file dialogs.

\value DontUseNativeDialog Don't use a platform-native file dialog, but the widget-based one provided by Qt.\br By default, a native file dialog is shown unless you use a subclass of QFileDialog that contains the Q_OBJECT macro, the global \l{Qt::}{AA_DontUseNativeDialogs} application attribute is set, or the platform does not have a native dialog of the type that you require.\br For the option to be effective, you must set it before changing other properties of the dialog, or showing the dialog.

\value ReadOnly Indicates that the model is read-only.

\value HideNameFilterDetails Indicates if the file name filter details are hidden or not.

\value DontUseCustomDirectoryIcons Always use the default directory icon.\br Some platforms allow the user to set a different icon, but custom icon lookup might cause significant performance issues over network or removable drives.\br Setting this will enable the \l{QAbstractFileIconProvider::}{DontUseCustomDirectoryIcons} option in \l{iconProvider()}.\br This enum value was added in Qt 5.2.

See also
options, testOption
Enumerator
ShowDirsOnly 
DontResolveSymlinks 
DontConfirmOverwrite 
DontUseNativeDialog 
ReadOnly 
HideNameFilterDetails 
DontUseCustomDirectoryIcons 

Definition at line 47 of file qfiledialog.h.

◆ ViewMode

This enum describes the view mode of the file dialog; that is, what information about each file is displayed.

\value Detail Displays an icon, a name, and details for each item in the directory. \value List Displays only an icon and a name for each item in the directory.

See also
setViewMode()
Enumerator
Detail 
List 

Definition at line 38 of file qfiledialog.h.

Constructor & Destructor Documentation

◆ QFileDialog() [1/3]

QFileDialog::QFileDialog ( QWidget * parent,
Qt::WindowFlags f )

Definition at line 332 of file qfiledialog.cpp.

References args, and d.

Referenced by getOpenFileContent(), and saveFileContent().

+ Here is the caller graph for this function:

◆ QFileDialog() [2/3]

QFileDialog::QFileDialog ( QWidget * parent = nullptr,
const QString & caption = QString(),
const QString & directory = QString(),
const QString & filter = QString() )
explicit

Constructs a file dialog with the given parent and caption that initially displays the contents of the specified directory.

The contents of the directory are filtered before being shown in the dialog, using a semicolon-separated list of filters specified by filter.

Definition at line 347 of file qfiledialog.cpp.

◆ ~QFileDialog()

QFileDialog::~QFileDialog ( )

Destroys the file dialog.

Definition at line 376 of file qfiledialog.cpp.

References d.

◆ QFileDialog() [3/3]

QFileDialog::QFileDialog ( const QFileDialogArgs & args)
protected

Definition at line 363 of file qfiledialog.cpp.

Member Function Documentation

◆ accept()

void QFileDialog::accept ( )
overrideprotectedvirtual

\reimp

Reimplemented from QDialog.

Definition at line 2722 of file qfiledialog.cpp.

References QDialog::accept(), acceptMode, AcceptOpen, AnyFile, d, Directory, DontConfirmOverwrite, ExistingFile, ExistingFiles, file, fileMode, files, info, selectedFiles(), selectedUrls(), setDirectory(), and testOption().

Referenced by QFileDialogPrivate::createWidgets().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ acceptMode()

QFileDialog::AcceptMode QFileDialog::acceptMode ( ) const

Definition at line 1849 of file qfiledialog.cpp.

References d.

◆ changeEvent()

void QFileDialog::changeEvent ( QEvent * e)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 504 of file qfiledialog.cpp.

References QWidget::changeEvent(), d, QEvent::LanguageChange, and QEvent::type().

+ Here is the call graph for this function:

◆ currentChanged

void QFileDialog::currentChanged ( const QString & path)
signal

When the current file changes for local operations, this signal is emitted with the new file name as the path parameter.

See also
filesSelected()

Referenced by QWidgetPlatformFileDialog::QWidgetPlatformFileDialog().

+ Here is the caller graph for this function:

◆ currentUrlChanged

void QFileDialog::currentUrlChanged ( const QUrl & url)
signal

When the current file changes, this signal is emitted with the new file URL as the url parameter.

See also
urlsSelected()
Since
5.2

◆ defaultSuffix()

QString QFileDialog::defaultSuffix ( ) const

Definition at line 1872 of file qfiledialog.cpp.

References d.

◆ directory()

QDir QFileDialog::directory ( ) const

Returns the directory currently being displayed in the dialog.

Definition at line 969 of file qfiledialog.cpp.

References d, dir, QString::isEmpty(), and QDir::rootPath().

Referenced by directoryUrl(), setDirectory(), and setDirectoryUrl().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ directoryEntered

void QFileDialog::directoryEntered ( const QString & directory)
signal
Since
4.3

This signal is emitted for local operations when the user enters a directory.

Referenced by QWidgetPlatformFileDialog::QWidgetPlatformFileDialog().

+ Here is the caller graph for this function:

◆ directoryUrl()

QUrl QFileDialog::directoryUrl ( ) const

Returns the url of the directory currently being displayed in the dialog.

Since
5.2

Definition at line 1018 of file qfiledialog.cpp.

References absolutePath(), d, directory(), and QUrl::fromLocalFile().

Referenced by QWidgetPlatformFileDialog::directory().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ directoryUrlEntered

void QFileDialog::directoryUrlEntered ( const QUrl & directory)
signal

This signal is emitted when the user enters a directory.

Since
5.2

◆ done()

void QFileDialog::done ( int result)
overrideprotectedvirtual

\reimp

Reimplemented from QDialog.

Definition at line 2678 of file qfiledialog.cpp.

References d, disconnect(), and QDialog::done().

+ Here is the call graph for this function:

◆ fileMode()

QFileDialog::FileMode QFileDialog::fileMode ( ) const

Definition at line 1732 of file qfiledialog.cpp.

References d.

◆ fileSelected

void QFileDialog::fileSelected ( const QString & file)
signal

When the selection changes for local operations and the dialog is accepted, this signal is emitted with the (possibly empty) selected file.

See also
currentChanged(), QDialog::Accepted

Referenced by QWidgetPlatformFileDialog::QWidgetPlatformFileDialog(), getOpenFileContent(), open(), and saveFileContent().

+ Here is the caller graph for this function:

◆ filesSelected

void QFileDialog::filesSelected ( const QStringList & selected)
signal

When the selection changes for local operations and the dialog is accepted, this signal is emitted with the (possibly empty) list of selected files.

See also
currentChanged(), QDialog::Accepted

Referenced by QWidgetPlatformFileDialog::QWidgetPlatformFileDialog(), and open().

+ Here is the caller graph for this function:

◆ filter()

QDir::Filters QFileDialog::filter ( ) const
Since
4.4

Returns the filter that is used when displaying files.

See also
setFilter()

Definition at line 1514 of file qfiledialog.cpp.

References d.

Referenced by getOpenFileUrl(), getOpenFileUrls(), getSaveFileUrl(), and setOptions().

+ Here is the caller graph for this function:

◆ filterSelected

void QFileDialog::filterSelected ( const QString & filter)
signal
Since
4.3

This signal is emitted when the user selects a filter.

Referenced by QWidgetPlatformFileDialog::QWidgetPlatformFileDialog(), QFileDialogPrivate::createWidgets(), and QFileDialogPrivate::initHelper().

+ Here is the caller graph for this function:

◆ getExistingDirectory()

QString QFileDialog::getExistingDirectory ( QWidget * parent = nullptr,
const QString & caption = QString(),
const QString & dir = QString(),
Options options = ShowDirsOnly )
static

This is a convenience static function that returns an existing directory selected by the user.

This function creates a modal file dialog with the given parent widget. If parent is not \nullptr, the dialog is shown centered over the parent widget.

The dialog's working directory is set to dir, and the caption is set to caption. Either of these can be an empty string in which case the current directory and a default caption are used respectively.

The options argument holds various options about how to run the dialog. See the QFileDialog::Option enum for more information on the flags you can pass. To ensure a native file dialog, \l{QFileDialog::}{ShowDirsOnly} must be set.

On Windows and \macos, this static function uses the native file dialog and not a QFileDialog. However, the native Windows file dialog does not support displaying files in the directory chooser. You need to pass the \l{QFileDialog::}{DontUseNativeDialog} option, or set the global \l{Qt::}{AA_DontUseNativeDialogs} application attribute to display files using a QFileDialog.

Note that the \macos native file dialog does not show a title bar.

On 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 changes to {/var/tmp} after entering {/usr/tmp}. If options includes DontResolveSymlinks, the file dialog treats symlinks as regular directories.

On Windows, the dialog spins a blocking modal event loop that does not dispatch any QTimers, and if parent is not \nullptr then it positions the dialog just below the parent's title bar.

Warning
Do not delete parent during the execution of the dialog. If you want to do this, you must create the dialog yourself using one of the QFileDialog constructors.
See also
getOpenFileName(), getOpenFileNames(), getSaveFileName()

Definition at line 2565 of file qfiledialog.cpp.

References dir, QUrl::fromLocalFile(), getExistingDirectoryUrl(), options, QObject::parent(), and QStringLiteral.

+ Here is the call graph for this function:

◆ getExistingDirectoryUrl()

QUrl QFileDialog::getExistingDirectoryUrl ( QWidget * parent = nullptr,
const QString & caption = QString(),
const QUrl & dir = QUrl(),
Options options = ShowDirsOnly,
const QStringList & supportedSchemes = QStringList() )
static

This is a convenience static function that returns an existing directory selected by the user.

If the user presses Cancel, it returns an empty url.

The function is used similarly to QFileDialog::getExistingDirectory(). In particular parent, caption, dir and options are used in exactly the same way.

The main difference with QFileDialog::getExistingDirectory() comes from the ability offered to the user to select a remote directory. That's why the return type and the type of dir is QUrl.

The supportedSchemes argument allows to restrict the type of URLs the user is able to select. It is a way for the application to declare the protocols it supports to fetch the file content. An empty list means that no restriction is applied (the default). Support for local files ("file" scheme) is implicit and always enabled; it is not necessary to include it in the restriction.

When possible, this static function uses the native file dialog and not a QFileDialog. On platforms that don't support selecting remote files, Qt allows to select only local files.

See also
getExistingDirectory(), getOpenFileUrl(), getOpenFileUrls(), getSaveFileUrl()
Since
5.2

Definition at line 2606 of file qfiledialog.cpp.

References QDialog::Accepted, args, dialog, dir, Directory, QDialog::exec(), options, QObject::parent(), selectedUrls(), setSupportedSchemes(), supportedSchemes, and QList< T >::value().

Referenced by getExistingDirectory().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getOpenFileContent()

QFileDialog::getOpenFileContent ( const QString & nameFilter,
const std::function< void(const QString &, const QByteArray &)> & fileContentsReady,
QWidget * parent = nullptr )
static

This is a convenience static function that returns the content of a file selected by the user.

Use this function to access local files on Qt for WebAssembly, if the web sandbox restricts file access. Its implementation enables displaying a native file dialog in the browser, where the user selects a file based on the nameFilter parameter.

parent is ignored on Qt for WebAssembly. Pass parent on other platforms, to make the popup a child of another widget. If the platform doesn't support native file dialogs, the function falls back to QFileDialog.

The function is asynchronous and returns immediately. The fileOpenCompleted callback will be called when a file has been selected and its contents have been read into memory.

auto fileContentReady = [](const QString &fileName, const QByteArray &fileContent) {
if (fileName.isEmpty()) {
// No file was selected
} else {
// Use fileName and fileContent
}
};
QFileDialog::getOpenFileContent("Images (*.png *.xpm *.jpg)", fileContentReady);
Since
5.13

Definition at line 2306 of file qfiledialog.cpp.

References QFileDialog(), QObject::connect(), dialog, ExistingFile, fileContentReady, fileName, fileSelected(), QString::fromStdString(), QFile::open(), QWasmLocalFileAccess::openFile(), QObject::parent(), Q_UNUSED, QIODevice::readAll(), QIODeviceBase::ReadOnly, QWidget::setAttribute(), setFileMode(), setNameFilter(), QWidget::show(), QWidget::size, QString::toStdString(), void, and Qt::WA_DeleteOnClose.

+ Here is the call graph for this function:

◆ getOpenFileName()

QString QFileDialog::getOpenFileName ( QWidget * parent = nullptr,
const QString & caption = QString(),
const QString & dir = QString(),
const QString & filter = QString(),
QString * selectedFilter = nullptr,
Options options = Options() )
static

This is a convenience static function that returns an existing file selected by the user.

If the user presses Cancel, it returns a null string.

"/home",
tr("Images (*.png *.xpm *.jpg)"));

The function creates a modal file dialog with the given parent widget. If parent is not \nullptr, the dialog is shown centered over the parent widget.

The file dialog's working directory is set to dir. If dir includes a file name, the file is selected. Only files that match the given filter are shown. The selected filter is set to selectedFilter. The parameters dir, selectedFilter, and filter may be empty strings. If you want multiple filters, separate them with ';;', for example:

The options argument holds various options about how to run the dialog. See the QFileDialog::Option enum for more information on the flags you can pass.

The dialog's caption is set to caption. If caption is not specified, then a default caption will be used.

On Windows, and \macos, this static function uses the native file dialog and not a QFileDialog. Note that the \macos native file dialog does not show a title bar.

On Windows the dialog spins a blocking modal event loop that does not dispatch any QTimers, and if parent is not \nullptr then it positions the dialog just below the parent's title bar.

On 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 changes to {/var/tmp} after entering {/usr/tmp}. If options includes DontResolveSymlinks, the file dialog treats symlinks as regular directories.

Warning
Do not delete parent during the execution of the dialog. If you want to do this, you must create the dialog yourself using one of the QFileDialog constructors.
See also
getOpenFileNames(), getSaveFileName(), getExistingDirectory()

Definition at line 2102 of file qfiledialog.cpp.

References dir, QUrl::fromLocalFile(), getOpenFileUrl(), options, QObject::parent(), and QStringLiteral.

Referenced by Viewer::chooseFile(), and MainWindow::openFile().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getOpenFileNames()

QStringList QFileDialog::getOpenFileNames ( QWidget * parent = nullptr,
const QString & caption = QString(),
const QString & dir = QString(),
const QString & filter = QString(),
QString * selectedFilter = nullptr,
Options options = Options() )
static

This is a convenience static function that returns one or more existing files selected by the user.

this,
"Select one or more files to open",
"/home",
"Images (*.png *.xpm *.jpg)");

This function creates a modal file dialog with the given parent widget. If parent is not \nullptr, the dialog is shown centered over the parent widget.

The file dialog's working directory is set to dir. If dir includes a file name, the file is 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 can be empty strings. If you need multiple filters, separate them with ';;', for instance:

The dialog's caption is set to caption. If caption is not specified, then a default caption is used.

On Windows and \macos, this static function uses the native file dialog and not a QFileDialog. Note that the \macos native file dialog does not show a title bar.

On Windows the dialog spins a blocking modal event loop that does not dispatch any QTimers, and if parent is not \nullptr then it positions the dialog just below the parent's title bar.

On 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}. The options argument holds various options about how to run the dialog, see the QFileDialog::Option enum for more information on the flags you can pass.

Warning
Do not delete parent during the execution of the dialog. If you want to do this, you must create the dialog yourself using one of the QFileDialog constructors.
See also
getOpenFileName(), getSaveFileName(), getExistingDirectory()

Definition at line 2215 of file qfiledialog.cpp.

References dir, fileNames, QUrl::fromLocalFile(), getOpenFileUrls(), options, QObject::parent(), QUrl::PreferLocalFile, QStringLiteral, selectedUrls(), QList< T >::size(), QUrl::toString(), and url.

+ Here is the call graph for this function:

◆ getOpenFileUrl()

QUrl QFileDialog::getOpenFileUrl ( QWidget * parent = nullptr,
const QString & caption = QString(),
const QUrl & dir = QUrl(),
const QString & filter = QString(),
QString * selectedFilter = nullptr,
Options options = Options(),
const QStringList & supportedSchemes = QStringList() )
static

This is a convenience static function that returns an existing file selected by the user.

If the user presses Cancel, it returns an empty url.

The function is used similarly to QFileDialog::getOpenFileName(). In particular parent, caption, dir, filter, selectedFilter and options are used in exactly the same way.

The main difference with QFileDialog::getOpenFileName() comes from the ability offered to the user to select a remote file. That's why the return type and the type of dir is QUrl.

The supportedSchemes argument allows to restrict the type of URLs the user is able to select. It is a way for the application to declare the protocols it will support to fetch the file content. An empty list means that no restriction is applied (the default). Support for local files ("file" scheme) is implicit and always enabled; it is not necessary to include it in the restriction.

When possible, this static function uses the native file dialog and not a QFileDialog. On platforms that don't support selecting remote files, Qt will allow to select only local files.

See also
getOpenFileName(), getOpenFileUrls(), getSaveFileUrl(), getExistingDirectoryUrl()
Since
5.2

Definition at line 2145 of file qfiledialog.cpp.

References QDialog::Accepted, args, dialog, dir, QDialog::exec(), ExistingFile, filter(), options, QObject::parent(), selectedNameFilter(), selectedUrls(), selectNameFilter(), setSupportedSchemes(), supportedSchemes, and QList< T >::value().

Referenced by getOpenFileName().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getOpenFileUrls()

QList< QUrl > QFileDialog::getOpenFileUrls ( QWidget * parent = nullptr,
const QString & caption = QString(),
const QUrl & dir = QUrl(),
const QString & filter = QString(),
QString * selectedFilter = nullptr,
Options options = Options(),
const QStringList & supportedSchemes = QStringList() )
static

This is a convenience static function that returns one or more existing files selected by the user.

If the user presses Cancel, it returns an empty list.

The function is used similarly to QFileDialog::getOpenFileNames(). In particular parent, caption, dir, filter, selectedFilter and options are used in exactly the same way.

The main difference with QFileDialog::getOpenFileNames() comes from the ability offered to the user to select remote files. That's why the return type and the type of dir are respectively QList<QUrl> and QUrl.

The supportedSchemes argument allows to restrict the type of URLs the user can select. It is a way for the application to declare the protocols it supports to fetch the file content. An empty list means that no restriction is applied (the default). Support for local files ("file" scheme) is implicit and always enabled; it is not necessary to include it in the restriction.

When possible, this static function uses the native file dialog and not a QFileDialog. On platforms that don't support selecting remote files, Qt will allow to select only local files.

See also
getOpenFileNames(), getOpenFileUrl(), getSaveFileUrl(), getExistingDirectoryUrl()
Since
5.2

Definition at line 2260 of file qfiledialog.cpp.

References QDialog::Accepted, args, dialog, dir, QDialog::exec(), ExistingFiles, filter(), options, QObject::parent(), selectedNameFilter(), selectedUrls(), selectNameFilter(), setSupportedSchemes(), and supportedSchemes.

Referenced by getOpenFileNames().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getSaveFileName()

QString QFileDialog::getSaveFileName ( QWidget * parent = nullptr,
const QString & caption = QString(),
const QString & dir = QString(),
const QString & filter = QString(),
QString * selectedFilter = nullptr,
Options options = Options() )
static

This is a convenience static function that returns a file name selected by the user.

The file does not have to exist.

It creates a modal file dialog with the given parent widget. If parent is not \nullptr, the dialog will be shown centered over the parent widget.

"/home/jana/untitled.png",
tr("Images (*.png *.xpm *.jpg)"));

The file dialog's working directory is set to dir. If dir includes a file name, the file is selected. Only files that match the filter are shown. The filter selected is set to selectedFilter. The parameters dir, selectedFilter, and filter may be empty strings. Multiple filters are separated with ';;'. For instance:

The options argument holds various options about how to run the dialog, see the QFileDialog::Option enum for more information on the flags you can pass.

The default filter can be chosen by setting selectedFilter to the desired value.

The dialog's caption is set to caption. If caption is not specified, a default caption is used.

On Windows, and \macos, this static function uses the native file dialog and not a QFileDialog.

On Windows the dialog spins a blocking modal event loop that does not dispatch any QTimers, and if parent is not \nullptr then it positions the dialog just below the parent's title bar. On \macos, with its native file dialog, the filter argument is ignored.

On 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 changes to {/var/tmp} after entering {/usr/tmp}. If options includes DontResolveSymlinks, the file dialog treats symlinks as regular directories.

Warning
Do not delete parent during the execution of the dialog. If you want to do this, you must create the dialog yourself using one of the QFileDialog constructors.
See also
getOpenFileName(), getOpenFileNames(), getExistingDirectory()

Definition at line 2450 of file qfiledialog.cpp.

References dir, QUrl::fromLocalFile(), getSaveFileUrl(), options, QObject::parent(), and QStringLiteral.

Referenced by QPrintPreviewDialogPrivate::_q_print(), MainWindow::saveFile(), and Viewer::saveImage().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getSaveFileUrl()

QUrl QFileDialog::getSaveFileUrl ( QWidget * parent = nullptr,
const QString & caption = QString(),
const QUrl & dir = QUrl(),
const QString & filter = QString(),
QString * selectedFilter = nullptr,
Options options = Options(),
const QStringList & supportedSchemes = QStringList() )
static

This is a convenience static function that returns a file selected by the user.

The file does not have to exist. If the user presses Cancel, it returns an empty url.

The function is used similarly to QFileDialog::getSaveFileName(). In particular parent, caption, dir, filter, selectedFilter and options are used in exactly the same way.

The main difference with QFileDialog::getSaveFileName() comes from the ability offered to the user to select a remote file. That's why the return type and the type of dir is QUrl.

The supportedSchemes argument allows to restrict the type of URLs the user can select. It is a way for the application to declare the protocols it supports to save the file content. An empty list means that no restriction is applied (the default). Support for local files ("file" scheme) is implicit and always enabled; it is not necessary to include it in the restriction.

When possible, this static function uses the native file dialog and not a QFileDialog. On platforms that don't support selecting remote files, Qt will allow to select only local files.

See also
getSaveFileName(), getOpenFileUrl(), getOpenFileUrls(), getExistingDirectoryUrl()
Since
5.2

Definition at line 2493 of file qfiledialog.cpp.

References QDialog::Accepted, AcceptSave, AnyFile, args, dialog, dir, QDialog::exec(), filter(), options, QObject::parent(), selectedNameFilter(), selectedUrls(), selectNameFilter(), setAcceptMode(), setSupportedSchemes(), supportedSchemes, and QList< T >::value().

Referenced by getSaveFileName().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ history()

QStringList QFileDialog::history ( ) const

Returns the browsing history of the filedialog as a list of paths.

Definition at line 1907 of file qfiledialog.cpp.

References d, QFileSystemModel::FilePathRole, and QDir::toNativeSeparators().

Referenced by restoreState(), and saveState().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ iconProvider()

QAbstractFileIconProvider * QFileDialog::iconProvider ( ) const

Returns the icon provider used by the filedialog.

Definition at line 1974 of file qfiledialog.cpp.

References d.

Referenced by setOptions().

+ Here is the caller graph for this function:

◆ itemDelegate()

QAbstractItemDelegate * QFileDialog::itemDelegate ( ) const

Returns the item delegate used to render the items in the views in the filedialog.

Definition at line 1950 of file qfiledialog.cpp.

References d.

◆ labelText()

QString QFileDialog::labelText ( DialogLabel label) const

Returns the text shown in the filedialog in the specified label.

Definition at line 2026 of file qfiledialog.cpp.

References Accept, acceptMode, AcceptOpen, button, QDialogButtonBox::Cancel, d, FileName, FileType, LookIn, QDialogButtonBox::Open, Reject, QDialogButtonBox::Save, and QAbstractButton::text.

◆ nameFilters()

QStringList QFileDialog::nameFilters ( ) const
Since
4.4

Returns the file type filters that are in operation on this file dialog.

Definition at line 1456 of file qfiledialog.cpp.

◆ open [1/2]

void QDialog::open ( )
slot
Since
4.5

Shows the dialog as a \l{QDialog::Modal Dialogs}{window modal dialog}, returning immediately.

See also
exec(), show(), result(), setWindowModality()

Definition at line 52 of file qdialog.cpp.

◆ open() [2/2]

void QFileDialog::open ( QObject * receiver,
const char * member )
Since
4.5

This function shows the dialog, and connects the slot specified by receiver and member to the signal that informs about selection changes. If the fileMode is ExistingFiles, this is the filesSelected() signal, otherwise it is the fileSelected() signal.

The signal is disconnected from the slot when the dialog is closed.

Definition at line 835 of file qfiledialog.cpp.

References QObject::connect(), d, ExistingFiles, fileMode, fileSelected(), filesSelected(), QDialog::open(), SIGNAL, and signal.

+ Here is the call graph for this function:

◆ options()

◆ restoreState()

bool QFileDialog::restoreState ( const QByteArray & state)
Since
4.3 Restores the dialogs's layout, history and current directory to the state specified.

Typically this is used in conjunction with QSettings to restore the size from a past session.

Returns false if there are errors

Definition at line 460 of file qfiledialog.cpp.

References d, QUrl::fromLocalFile(), history(), QFileDialogMagic, QIODeviceBase::ReadOnly, setDirectoryUrl(), setViewMode(), state, and viewMode.

+ Here is the call graph for this function:

◆ saveFileContent()

QFileDialog::saveFileContent ( const QByteArray & fileContent,
const QString & fileNameHint,
QWidget * parent = nullptr )
static

This is a convenience static function that saves fileContent to a file, using a file name and location chosen by the user.

fileNameHint can be provided to suggest a file name to the user.

Use this function to save content to local files on Qt for WebAssembly, if the web sandbox restricts file access. Its implementation enables displaying a native file dialog in the browser, where the user specifies an output file based on the fileNameHint argument.

parent is ignored on Qt for WebAssembly. Pass parent on other platforms, to make the popup a child of another widget. If the platform doesn't support native file dialogs, the function falls back to QFileDialog.

The function is asynchronous and returns immediately.

QByteArray imageData; // obtained from e.g. QImage::save()
QFileDialog::saveFileContent(imageData, "myimage.png"); // with filename hint
// OR
The QFileDialog class provides a dialog that allows users to select files or directories.
Definition qfiledialog.h:28
static QString getExistingDirectory(QWidget *parent=nullptr, const QString &caption=QString(), const QString &dir=QString(), Options options=ShowDirsOnly)
This is a convenience static function that returns an existing directory selected by the user.
static QString getSaveFileName(QWidget *parent=nullptr, const QString &caption=QString(), const QString &dir=QString(), const QString &filter=QString(), QString *selectedFilter=nullptr, Options options=Options())
This is a convenience static function that returns a file name selected by the user.
void setNameFilters(const QStringList &filters)
static QString getOpenFileName(QWidget *parent=nullptr, const QString &caption=QString(), const QString &dir=QString(), const QString &filter=QString(), QString *selectedFilter=nullptr, Options options=Options())
This is a convenience static function that returns an existing file selected by the user.
void setViewMode(ViewMode mode)
QStringList selectedFiles() const
Returns a list of strings containing the absolute paths of the selected files in the dialog.
@ DontResolveSymlinks
Definition qfiledialog.h:50
static void saveFileContent(const QByteArray &fileContent, const QString &fileNameHint, QWidget *parent=nullptr)
This is a convenience static function that saves fileContent to a file, using a file name and locatio...
void setFileMode(FileMode mode)
void setNameFilter(const QString &filter)
static QStringList getOpenFileNames(QWidget *parent=nullptr, const QString &caption=QString(), const QString &dir=QString(), const QString &filter=QString(), QString *selectedFilter=nullptr, Options options=Options())
This is a convenience static function that returns one or more existing files selected by the user.
static void getOpenFileContent(const QString &nameFilter, const std::function< void(const QString &, const QByteArray &)> &fileContentsReady, QWidget *parent=nullptr)
This is a convenience static function that returns the content of a file selected by the user.
QStringList mimeTypeFilters({"image/jpeg", "image/png", "application/octet-stream" })
[12]
QByteArray imageData
[15]
XML files xml auto fileContentReady
[14]
QStringList fileNames
[4]
Since
5.14

Definition at line 2377 of file qfiledialog.cpp.

References QFileDialog(), AcceptSave, AnyFile, QObject::connect(), dialog, fileName, fileSelected(), QFile::open(), QObject::parent(), Q_UNUSED, QWasmLocalFileAccess::saveFile(), selectFile(), setAcceptMode(), QWidget::setAttribute(), setFileMode(), QWidget::show(), Qt::WA_DeleteOnClose, QIODevice::write(), and QIODeviceBase::WriteOnly.

+ Here is the call graph for this function:

◆ saveState()

QByteArray QFileDialog::saveState ( ) const
Since
4.3 Saves the state of the dialog's layout, history and current directory.

Typically this is used in conjunction with QSettings to remember the size for a future session. A version number is stored as part of the data.

Definition at line 424 of file qfiledialog.cpp.

References d, history(), QFileDialogMagic, viewMode, and QIODeviceBase::WriteOnly.

+ Here is the call graph for this function:

◆ selectedFiles()

QStringList QFileDialog::selectedFiles ( ) const

Returns a list of strings containing the absolute paths of the selected files in the dialog.

If no files are selected, or the mode is not ExistingFiles or ExistingFile, selectedFiles() contains the current path in the viewport.

See also
selectedNameFilter(), selectFile()

Definition at line 1303 of file qfiledialog.cpp.

References d, ExistingFile, ExistingFiles, file, fileMode, QFileSystemModel::FilePathRole, files, and QUrl::PreferLocalFile.

Referenced by accept(), and selectedUrls().

+ Here is the caller graph for this function:

◆ selectedMimeTypeFilter()

QString QFileDialog::selectedMimeTypeFilter ( ) const
Since
5.9
Returns
The mimetype of the file that the user selected in the file dialog.

Definition at line 1631 of file qfiledialog.cpp.

References d, HideNameFilterDetails, mimeType, qt_strip_filters(), selectedNameFilter(), and testOption().

+ Here is the call graph for this function:

◆ selectedNameFilter()

QString QFileDialog::selectedNameFilter ( ) const
Since
4.4

Returns the filter that the user selected in the file dialog.

See also
selectedFiles()

Definition at line 1498 of file qfiledialog.cpp.

References d.

Referenced by getOpenFileUrl(), getOpenFileUrls(), getSaveFileUrl(), selectedMimeTypeFilter(), and QWidgetPlatformFileDialog::selectedNameFilter().

+ Here is the caller graph for this function:

◆ selectedUrls()

QList< QUrl > QFileDialog::selectedUrls ( ) const

Returns a list of urls containing the selected files in the dialog.

If no files are selected, or the mode is not ExistingFiles or ExistingFile, selectedUrls() contains the current path in the viewport.

See also
selectedNameFilter(), selectUrl()
Since
5.2

Definition at line 1329 of file qfiledialog.cpp.

References d, file, QUrl::fromLocalFile(), and selectedFiles().

Referenced by accept(), getExistingDirectoryUrl(), getOpenFileNames(), getOpenFileUrl(), getOpenFileUrls(), getSaveFileUrl(), and QWidgetPlatformFileDialog::selectedFiles().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ selectFile()

void QFileDialog::selectFile ( const QString & filename)

Selects the given filename in the file dialog.

See also
selectedFiles()

Definition at line 1070 of file qfiledialog.cpp.

References d, fileFromPath(), QUrl::fromLocalFile(), info, QString::isEmpty(), isRelative(), QDir::isRelativePath(), QWidget::isVisible(), QModelIndex::model(), QUrl::path(), setDirectory(), QUrl::setPath(), and url.

Referenced by saveFileContent(), and selectUrl().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ selectNameFilter()

void QFileDialog::selectNameFilter ( const QString & filter)
Since
4.4

Sets the current file type filter. Multiple filters can be passed in filter by separating them with semicolons or spaces.

See also
setNameFilter(), setNameFilters(), selectedNameFilter()

Definition at line 1469 of file qfiledialog.cpp.

References d, filters, HideNameFilterDetails, i, qt_make_filter_list(), qt_strip_filters(), and testOption().

Referenced by getOpenFileUrl(), getOpenFileUrls(), getSaveFileUrl(), and QWidgetPlatformFileDialog::selectNameFilter().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ selectUrl()

void QFileDialog::selectUrl ( const QUrl & url)

Selects the given url in the file dialog.

Note
The non-native QFileDialog supports only local files.
See also
selectedUrls()
Since
5.2

Definition at line 1114 of file qfiledialog.cpp.

References d, QUrl::isLocalFile(), QUrl::isValid(), qWarning, selectFile(), QUrl::toLocalFile(), and url.

Referenced by QWidgetPlatformFileDialog::selectFile().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setAcceptMode()

void QFileDialog::setAcceptMode ( QFileDialog::AcceptMode mode)

Definition at line 1748 of file qfiledialog.cpp.

References AcceptOpen, AcceptSave, button, QDialogButtonBox::Cancel, d, QDialogButtonBox::Open, QDialogButtonBox::Save, QWidget::setAttribute(), QWidget::setEnabled(), and Qt::WA_DontShowOnScreen.

Referenced by getSaveFileUrl(), saveFileContent(), and QWidgetPlatformFileDialog::show().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setDefaultSuffix()

void QFileDialog::setDefaultSuffix ( const QString & suffix)

Definition at line 1866 of file qfiledialog.cpp.

References d.

Referenced by QWidgetPlatformFileDialog::show().

+ Here is the caller graph for this function:

◆ setDirectory() [1/2]

void QFileDialog::setDirectory ( const QDir & directory)
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 244 of file qfiledialog.h.

◆ setDirectory() [2/2]

void QFileDialog::setDirectory ( const QString & directory)

Sets the file dialog's current directory.

Note
On iOS, if you set directory to \l{QStandardPaths::standardLocations()} {QStandardPaths::standardLocations(QStandardPaths::PicturesLocation).last()}, a native image picker dialog is used for accessing the user's photo album. The filename returned can be loaded using QFile and related APIs. For this to be enabled, the Info.plist assigned to QMAKE_INFO_PLIST in the project file must contain the key NSPhotoLibraryUsageDescription. See Info.plist documentation from Apple for more information regarding this key. This feature was added in Qt 5.5.

Definition at line 929 of file qfiledialog.cpp.

References QDir::cleanPath(), d, directory(), QUrl::fromLocalFile(), QDir::isEmpty(), Qt::ItemIsDropEnabled, QModelIndex::model(), and QFileDialogPrivate::setLastVisitedDirectory().

Referenced by accept(), selectFile(), QWidgetPlatformFileDialog::setDirectory(), and setDirectoryUrl().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setDirectoryUrl()

void QFileDialog::setDirectoryUrl ( const QUrl & directory)

Sets the file dialog's current directory url.

Note
The non-native QFileDialog supports only local files.
On Windows, it is possible to pass URLs representing one of the {virtual folders}, such as "Computer" or "Network". This is done by passing a QUrl using the scheme clsid followed by the CLSID value with the curly braces removed. For example the URL clsid:374DE290-123F-4565-9164-39C4925E467B denotes the download location. For a complete list of possible values, see the MSDN documentation on \l{https://docs.microsoft.com/en-us/windows/win32/shell/knownfolderid}{KNOWNFOLDERID}. This feature was added in Qt 5.5.
See also
QUuid
Since
5.2

Definition at line 996 of file qfiledialog.cpp.

References d, directory(), Q_UNLIKELY, qWarning, setDirectory(), and QFileDialogPrivate::setLastVisitedDirectory().

Referenced by restoreState().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setFileMode()

void QFileDialog::setFileMode ( QFileDialog::FileMode mode)

Definition at line 1701 of file qfiledialog.cpp.

References d, Directory, ExistingFiles, QAbstractItemView::ExtendedSelection, ShowDirsOnly, QAbstractItemView::SingleSelection, testOption(), and tr.

Referenced by getOpenFileContent(), loadFileDialog(), saveFileContent(), and QWidgetPlatformFileDialog::show().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setFilter()

void QFileDialog::setFilter ( QDir::Filters filters)
Since
4.4

Sets the filter used by the model to filters. The filter is used to specify the kind of files that should be shown.

See also
filter()

Definition at line 1531 of file qfiledialog.cpp.

References d, filters, and QDir::Hidden.

Referenced by setOptions().

+ Here is the caller graph for this function:

◆ setHistory()

void QFileDialog::setHistory ( const QStringList & paths)

Sets the browsing history of the filedialog to contain the given paths.

Definition at line 1882 of file qfiledialog.cpp.

References d.

◆ setIconProvider()

void QFileDialog::setIconProvider ( QAbstractFileIconProvider * provider)

Sets the icon provider used by the filedialog to the specified provider.

Definition at line 1961 of file qfiledialog.cpp.

References d.

◆ setItemDelegate()

void QFileDialog::setItemDelegate ( QAbstractItemDelegate * delegate)

Sets the item delegate used to render items in the views in the file dialog to the given delegate.

Any existing delegate will be removed, but not deleted. QFileDialog does not take ownership of delegate.

Warning
You should not share the same instance of a delegate between views. Doing so can cause incorrect or unintuitive editing behavior since each view connected to a given delegate may receive the \l{QAbstractItemDelegate::}{closeEditor()} signal, and attempt to access, modify or close an editor that has already been closed.

Note that the model used is QFileSystemModel. It has custom item data roles, which is described by the \l{QFileSystemModel::}{Roles} enum. You can use a QFileIconProvider if you only want custom icons.

See also
itemDelegate(), setIconProvider(), QFileSystemModel

Definition at line 1938 of file qfiledialog.cpp.

References d.

◆ setLabelText()

void QFileDialog::setLabelText ( DialogLabel label,
const QString & text )

Sets the text shown in the filedialog in the specified label.

Definition at line 2016 of file qfiledialog.cpp.

References d, and text.

Referenced by QInputDialog::getDouble(), QInputDialog::getInt(), QInputDialog::getItem(), QInputDialog::getMultiLineText(), QInputDialog::getText(), and QWidgetPlatformFileDialog::show().

+ Here is the caller graph for this function:

◆ setNameFilter()

void QFileDialog::setNameFilter ( const QString & filter)
Since
4.4

Sets the filter used in the file dialog to the given filter.

If filter contains a pair of parentheses containing one or more filename-wildcard patterns, separated by spaces, then only the text contained in the parentheses is used as the filter. This means that these calls are all equivalent:

dialog.setNameFilter("All C++ files (*.cpp *.cc *.C *.cxx *.c++)");
dialog.setNameFilter("*.cpp *.cc *.C *.cxx *.c++");
Note
With Android's native file dialog, the mime type matching the given name filter is used because only mime types are supported.
See also
setMimeTypeFilters(), setNameFilters()

Definition at line 1377 of file qfiledialog.cpp.

References qt_make_filter_list(), and setNameFilters().

Referenced by getOpenFileContent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setNameFilters()

void QFileDialog::setNameFilters ( const QStringList & filters)
Since
4.4

Sets the filters used in the file dialog.

Note that the filter {*.*} is not portable, because the historical assumption that the file extension determines the file type is not consistent on every operating system. It is possible to have a file with no dot in its name (for example, Makefile). In a native Windows file dialog, {*.*} matches such files, while in other types of file dialogs it might not match. So, it's better to use {*} if you mean to select any file.

const QStringList filters({"Image files (*.png *.xpm *.jpg)",
"Text files (*.txt)",
"Any files (*)"
});

\l setMimeTypeFilters() has the advantage of providing all possible name filters for each file type. For example, JPEG images have three possible extensions; if your application can open such files, selecting the image/jpeg mime type as a filter allows you to open all of them.

Definition at line 1425 of file qfiledialog.cpp.

References d, filters, HideNameFilterDetails, qt_strip_filters(), and testOption().

Referenced by setNameFilter(), setOptions(), and QWidgetPlatformFileDialog::show().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setOption()

void QFileDialog::setOption ( Option option,
bool on = true )
Since
4.5 Sets the given option to be enabled if on is true; otherwise, clears the given option.

Options (particularly the \l DontUseNativeDialog option) should be set before changing dialog properties or showing the dialog.

Setting options while the dialog is visible is not guaranteed to have an immediate effect on the dialog (depending on the option and on the platform).

Setting options after changing other properties may cause these values to have no effect.

See also
options, testOption()

Definition at line 732 of file qfiledialog.cpp.

References options, and setOptions().

+ Here is the call graph for this function:

◆ setOptions()

void QFileDialog::setOptions ( Options options)

Definition at line 772 of file qfiledialog.cpp.

References d, DontResolveSymlinks, QAbstractFileIconProvider::DontUseCustomDirectoryIcons, DontUseCustomDirectoryIcons, DontUseNativeDialog, QDir::Files, filter(), HideNameFilterDetails, iconProvider(), QAbstractFileIconProvider::options(), options, ReadOnly, setFilter(), setNameFilters(), QAbstractFileIconProvider::setOptions(), and ShowDirsOnly.

Referenced by QInputDialog::getMultiLineText(), setOption(), and QWidgetPlatformFileDialog::show().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setSidebarUrls()

void QFileDialog::setSidebarUrls ( const QList< QUrl > & urls)
Since
4.3 Sets the urls that are located in the sidebar.

For instance:

Then the file dialog looks like this:

See also
sidebarUrls()

Definition at line 398 of file qfiledialog.cpp.

References d.

Referenced by loadFileDialog().

+ Here is the caller graph for this function:

◆ setSupportedSchemes()

void QFileDialog::setSupportedSchemes ( const QStringList & schemes)

Definition at line 1779 of file qfiledialog.cpp.

References d.

Referenced by getExistingDirectoryUrl(), getOpenFileUrl(), getOpenFileUrls(), and getSaveFileUrl().

+ Here is the caller graph for this function:

◆ setViewMode()

void QFileDialog::setViewMode ( QFileDialog::ViewMode mode)

Definition at line 1666 of file qfiledialog.cpp.

References d, and Detail.

Referenced by restoreState().

+ Here is the caller graph for this function:

◆ setVisible()

void QFileDialog::setVisible ( bool visible)
overridevirtual

\reimp

Reimplemented from QDialog.

Definition at line 852 of file qfiledialog.cpp.

References QDialog::setVisible(), and QWidget::visible.

+ Here is the call graph for this function:

◆ sidebarUrls()

QList< QUrl > QFileDialog::sidebarUrls ( ) const
Since
4.3 Returns a list of urls that are currently in the sidebar

Definition at line 409 of file qfiledialog.cpp.

References d.

◆ supportedSchemes()

QStringList QFileDialog::supportedSchemes ( ) const

Definition at line 1785 of file qfiledialog.cpp.

◆ testOption()

bool QFileDialog::testOption ( Option option) const
Since
4.5

Returns true if the given option is enabled; otherwise, returns false.

See also
options, setOption()

Definition at line 747 of file qfiledialog.cpp.

References d.

Referenced by accept(), selectedMimeTypeFilter(), selectNameFilter(), setFileMode(), and setNameFilters().

+ Here is the caller graph for this function:

◆ urlSelected

void QFileDialog::urlSelected ( const QUrl & url)
signal

When the selection changes and the dialog is accepted, this signal is emitted with the (possibly empty) selected url.

See also
currentUrlChanged(), QDialog::Accepted
Since
5.2

◆ urlsSelected

void QFileDialog::urlsSelected ( const QList< QUrl > & urls)
signal

When the selection changes and the dialog is accepted, this signal is emitted with the (possibly empty) list of selected urls.

See also
currentUrlChanged(), QDialog::Accepted
Since
5.2

◆ viewMode()

QFileDialog::ViewMode QFileDialog::viewMode ( ) const

Definition at line 1678 of file qfiledialog.cpp.

References d, Detail, and List.

Friends And Related Symbol Documentation

◆ QPlatformDialogHelper

friend class QPlatformDialogHelper
friend

Definition at line 241 of file qfiledialog.h.

Property Documentation

◆ acceptMode

QFileDialog::acceptMode
readwrite

The accept mode of the dialog.

The action mode defines whether the dialog is for opening or saving files.

By default, this property is set to \l{AcceptOpen}.

See also
AcceptMode

Definition at line 32 of file qfiledialog.h.

Referenced by accept(), and labelText().

◆ defaultSuffix

QFileDialog::defaultSuffix
readwrite

Suffix added to the filename if no other suffix was specified.

This property specifies a string that is added to the filename if it has no suffix yet. The suffix is typically used to indicate the file type (e.g. "txt" indicates a text file).

If the first character is a dot ('.'), it is removed.

Definition at line 33 of file qfiledialog.h.

◆ fileMode

QFileDialog::fileMode
readwrite

The file mode of the dialog.

The file mode defines the number and type of items that the user is expected to select in the dialog.

By default, this property is set to AnyFile.

This function sets the labels for the FileName and \l{QFileDialog::}{Accept} \l{DialogLabel}s. It is possible to set custom text after the call to setFileMode().

See also
FileMode

Definition at line 31 of file qfiledialog.h.

Referenced by accept(), open(), and selectedFiles().

◆ options

QFileDialog::options
readwrite

The various options that affect the look and feel of the dialog.

Since
4.5

By default, all options are disabled.

Options (particularly the \l DontUseNativeDialog option) should be set before changing dialog properties or showing the dialog.

Setting options while the dialog is visible is not guaranteed to have an immediate effect on the dialog (depending on the option and on the platform).

Setting options after changing other properties may cause these values to have no effect.

See also
setOption(), testOption()

Definition at line 34 of file qfiledialog.h.

Referenced by getExistingDirectory(), getExistingDirectoryUrl(), getOpenFileName(), getOpenFileNames(), getOpenFileUrl(), getOpenFileUrls(), getSaveFileName(), getSaveFileUrl(), setOption(), and setOptions().

◆ supportedSchemes

QFileDialog::supportedSchemes
readwrite

The URL schemes that the file dialog should allow navigating to.

Since
5.6

Setting this property allows to restrict the type of URLs the user can select. It is a way for the application to declare the protocols it supports to fetch the file content. An empty list means that no restriction is applied (the default). Support for local files ("file" scheme) is implicit and always enabled; it is not necessary to include it in the restriction.

Definition at line 35 of file qfiledialog.h.

Referenced by getExistingDirectoryUrl(), getOpenFileUrl(), getOpenFileUrls(), and getSaveFileUrl().

◆ viewMode

QFileDialog::viewMode
readwrite

The way files and directories are displayed in the dialog.

By default, the Detail mode is used to display information about files and directories.

See also
ViewMode

Definition at line 30 of file qfiledialog.h.

Referenced by restoreState(), and saveState().


The documentation for this class was generated from the following files: