 |
Qt 6.x
The Qt SDK
|
The QFileDialog class provides a dialog that allow 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; i.e. More... | |
| enum | FileMode { AnyFile , ExistingFile , Directory , ExistingFiles } |
| This enum is used to indicate what the user may select in the file dialog; i.e. 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 } |
| \value ShowDirsOnly Only show directories in the file 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 | done (int) |
| Closes the dialog and sets its result code to r. | |
| virtual void | accept () |
Hides the modal dialog and sets the result code to Accepted. | |
| 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. | |
| virtual void | setVisible (bool visible) |
| 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< QUrl > | selectedUrls () 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< QUrl > | sidebarUrls () 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. | |
| QAbstractItemDelegate * | itemDelegate () 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. | |
| QAbstractFileIconProvider * | iconProvider () 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. | |
| void | setVisible (bool visible) override |
| \reimp | |
| 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 |
| QStyle * | style () 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 QRect & | geometry () 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. | |
| QWidget * | window () const |
| Returns the window for this widget, i.e. | |
| QWidget * | nativeParentWidget () const |
| QWidget * | topLevelWidget () const |
| const QPalette & | palette () 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 QFont & | font () 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. | |
| QWidget * | focusProxy () 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) |
| virtual QSize | sizeHint () const |
| virtual QSize | minimumSizeHint () const |
| 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. | |
| QLayout * | layout () 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. | |
| QWidget * | focusWidget () const |
| Returns the last child of this widget that setFocus had been called on. | |
| QWidget * | nextInFocusChain () const |
| Returns the next widget in this widget's focus chain. | |
| QWidget * | previousInFocusChain () 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. | |
| QAction * | addAction (const QString &text) |
| QAction * | addAction (const QIcon &icon, const QString &text) |
| QAction * | addAction (const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type=Qt::AutoConnection) |
| QAction * | addAction (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...>> | |
| QAction * | addAction (const QString &text, Args &&...args) |
| template<typename... Args, typename = compatible_action_slot_args<Args...>> | |
| QAction * | addAction (const QIcon &icon, const QString &text, Args &&...args) |
| QWidget * | parentWidget () 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. | |
| QWidget * | childAt (int x, int y) const |
| Returns the visible child widget at the position ({x}, {y}) in the widget's coordinate system. | |
| QWidget * | childAt (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. | |
| QPaintEngine * | paintEngine () 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) |
| QBackingStore * | backingStore () const |
| QWindow * | windowHandle () const |
| If this is a native widget, return the associated QWindow. | |
| QScreen * | screen () 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. | |
| virtual bool | event (QEvent *event) |
| This virtual function receives events to an object and should return true if the event e was recognized and processed. | |
| virtual bool | eventFilter (QObject *watched, QEvent *event) |
| Filters events if this object has been installed as an event filter for the watched object. | |
| 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< QString > | bindableObjectName () |
| 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). | |
| QThread * | thread () const |
| Returns the thread in which the object lives. | |
| void | moveToThread (QThread *thread) |
| Changes the thread affinity for this object and its children. | |
| 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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer) |
| void | killTimer (int id) |
| Kills the timer with timer identifier, id. | |
| template<typename T > | |
| T | findChild (const QString &aName=QString(), 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 (const QString &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 > | |
| 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 QObjectList & | children () 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< QByteArray > | dynamicPropertyNames () const |
| QBindingStorage * | bindingStorage () |
| const QBindingStorage * | bindingStorage () const |
| QObject * | parent () 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 () |
| virtual int | devType () const |
| bool | paintingActive () const |
| virtual QPaintEngine * | paintEngine () const =0 |
| 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 will return 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 will return 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 will return 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 will return one or more existing files selected by the user. | |
| static QList< QUrl > | 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()) |
| This is a convenience static function that will return one or more existing files selected by the user. | |
| static void | getOpenFileContent (const QString &nameFilter, const std::function< void(const QString &, const QByteArray &)> &fileContentsReady) |
| This is a convenience static function that will return the content of a file selected by the user. | |
| static void | saveFileContent (const QByteArray &fileContent, const QString &fileNameHint=QString()) |
| 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 QWidget * | mouseGrabber () |
| Returns the widget that is currently grabbing the mouse input. | |
| static QWidget * | keyboardGrabber () |
| Returns the widget that is currently grabbing the keyboard input. | |
| static QWidget * | find (WId) |
| Returns a pointer to the widget with window identifier/handle id. | |
| static QWidget * | createWindowContainer (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 | keyPressEvent (QKeyEvent *event) |
| This event handler, for event event, can be reimplemented in a subclass to receive key press 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 | resizeEvent (QResizeEvent *event) |
| This event handler can be reimplemented in a subclass to receive widget resize events which are passed in the event parameter. | |
| virtual void | closeEvent (QCloseEvent *event) |
| This event handler is called with the given event when Qt receives a window close request for a top-level widget from the window system. | |
| virtual void | contextMenuEvent (QContextMenuEvent *event) |
| This event handler, for event event, can be reimplemented in a subclass to receive widget context menu events. | |
| virtual void | actionEvent (QActionEvent *event) |
| This event handler is called with the given event whenever the widget's actions are changed. | |
| virtual void | showEvent (QShowEvent *event) |
| This event handler can be reimplemented in a subclass to receive widget show events which are passed in the event parameter. | |
| 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. | |
| virtual void | changeEvent (QEvent *) |
| This event handler can be reimplemented to handle state changes. | |
| 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. | |
| QPaintDevice * | redirected (QPoint *offset) const override |
| QPainter * | sharedPainter () 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 | |
| QObject * | sender () 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 | |
| virtual int | metric (PaintDeviceMetric metric) const |
| virtual void | initPainter (QPainter *painter) const |
| virtual QPaintDevice * | redirected (QPoint *offset) const |
| virtual QPainter * | sharedPainter () const |
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 | |
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< QObjectData > | d_ptr |
| Protected Attributes inherited from QPaintDevice | |
| ushort | painters |
| Related Symbols inherited from QWidget | |
| setupUi (QWidget *widget) | |
| \macro QWIDGETSIZE_MAX | |
| Related Symbols inherited from QObject | |
| template< class T > T | qobject_cast (const QObject *object) |
| Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr. | |
| template< typename T > T | qFindChildqFindChildren (const QObject *obj, const QString &name)() |
| template< typename T > QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QString &name)() |
| QObjectList | |
| \macro Q_CLASSINFO(Name, Value) | |
The QFileDialog class provides a dialog that allow users to select files or directories.
\inmodule QtWidgets
The QFileDialog class enables a user to traverse the file system in order to select one or many files or a directory.
The easiest way to create a QFileDialog is to use the static functions.
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 may 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 will be 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 will 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 will be used if the platform has one. In that case, the widgets which would otherwise be used to construct the dialog will not be instantiated, so related accessors such as layout() and itemDelegate() will 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 to ensure that the widget-based implementation will be used instead of the native dialog.
Definition at line 27 of file qfiledialog.h.
\value AcceptOpen \value AcceptSave
| Enumerator | |
|---|---|
| AcceptOpen | |
| AcceptSave | |
Definition at line 42 of file qfiledialog.h.
\value LookIn \value FileName \value FileType \value Accept \value Reject
| Enumerator | |
|---|---|
| LookIn | |
| FileName | |
| FileType | |
| Accept | |
| Reject | |
Definition at line 44 of file qfiledialog.h.
This enum is used to indicate what the user may select in the file dialog; i.e.
what the dialog will return if the user clicks OK.
\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.
| Enumerator | |
|---|---|
| AnyFile | |
| ExistingFile | |
| Directory | |
| ExistingFiles | |
Definition at line 40 of file qfiledialog.h.
| enum QFileDialog::Option |
\value ShowDirsOnly Only show directories in the file dialog.
By default both files and directories are shown. (Valid only in the \l Directory file mode.)
\value DontResolveSymlinks Don't resolve symlinks in the file dialog. By default symlinks are resolved.
\value DontConfirmOverwrite Don't ask for confirmation if an existing file is selected. By default confirmation is requested.
Note: This option is not supported on macOS when using the native file dialog.
\value DontUseNativeDialog Don't use the native file dialog. By default, the native file dialog is used unless you use a subclass of QFileDialog that contains the Q_OBJECT macro, or the platform does not have a native dialog of the type that you require.
{Note:} This option must be set before changing dialog properties or showing the dialog.
\value ReadOnly Indicates that the model is readonly.
\value HideNameFilterDetails Indicates if the file name filter details are hidden or not.
\value DontUseCustomDirectoryIcons Always use the default directory icon. Some platforms allow the user to set a different icon. Custom icon lookup cause a big performance impact over network or removable drives. Setting this will enable the QFileIconProvider::DontUseCustomDirectoryIcons option in the icon provider. This enum value was added in Qt 5.2.
| Enumerator | |
|---|---|
| ShowDirsOnly | |
| DontResolveSymlinks | |
| DontConfirmOverwrite | |
| DontUseNativeDialog | |
| ReadOnly | |
| HideNameFilterDetails | |
| DontUseCustomDirectoryIcons | |
Definition at line 47 of file qfiledialog.h.
This enum describes the view mode of the file dialog; i.e.
what information about each file will be 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.
| Enumerator | |
|---|---|
| Detail | |
| List | |
Definition at line 38 of file qfiledialog.h.
| QFileDialog::QFileDialog | ( | QWidget * | parent, |
| Qt::WindowFlags | f | ||
| ) |
Definition at line 322 of file qfiledialog.cpp.
|
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 337 of file qfiledialog.cpp.
| QFileDialog::~QFileDialog | ( | ) |
|
protected |
Definition at line 353 of file qfiledialog.cpp.
|
overrideprotectedvirtual |
\reimp
Reimplemented from QDialog.
Definition at line 2693 of file qfiledialog.cpp.
References QFileInfo::absoluteFilePath(), QDialog::accept(), acceptMode, AcceptOpen, AnyFile, d, Directory, DontConfirmOverwrite, ExistingFile, ExistingFiles, QFileInfo::exists(), file, fileMode, QFileInfo::fileName(), files, QList< T >::first(), info, QFileInfo::isDir(), QList< T >::isEmpty(), QFileInfo::path(), selectedFiles(), selectedUrls(), setDirectory(), QString::size(), QList< T >::size(), and testOption().
Here is the call graph for this function:| QFileDialog::AcceptMode QFileDialog::acceptMode | ( | ) | const |
Definition at line 1826 of file qfiledialog.cpp.
References d.
\reimp
Reimplemented from QWidget.
Definition at line 494 of file qfiledialog.cpp.
References QWidget::changeEvent(), d, e, and QEvent::LanguageChange.
Here is the call graph for this function:When the current file changes for local operations, this signal is emitted with the new file name as the path parameter.
Referenced by QWidgetPlatformFileDialog::QWidgetPlatformFileDialog().
Here is the caller graph for this function:When the current file changes, this signal is emitted with the new file URL as the url parameter.
| QString QFileDialog::defaultSuffix | ( | ) | const |
Definition at line 1849 of file qfiledialog.cpp.
References d.
| QDir QFileDialog::directory | ( | ) | const |
Returns the directory currently being displayed in the dialog.
Definition at line 946 of file qfiledialog.cpp.
References d, dir, and QString::isEmpty().
Referenced by directoryUrl(), setDirectory(), and setDirectoryUrl().
Here is the call graph for this function: Here is the caller graph for this function: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:| QUrl QFileDialog::directoryUrl | ( | ) | const |
Returns the url of the directory currently being displayed in the dialog.
Definition at line 995 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:This signal is emitted when the user enters a directory.
|
overrideprotectedvirtual |
\reimp
Reimplemented from QDialog.
Definition at line 2649 of file qfiledialog.cpp.
References d, disconnect(), and QDialog::done().
Here is the call graph for this function:| QFileDialog::FileMode QFileDialog::fileMode | ( | ) | const |
Definition at line 1709 of file qfiledialog.cpp.
References d.
When the selection changes for local operations and the dialog is accepted, this signal is emitted with the (possibly empty) selected file.
Referenced by QWidgetPlatformFileDialog::QWidgetPlatformFileDialog(), getOpenFileContent(), open(), and saveFileContent().
Here is the caller graph for this function:
|
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.
Referenced by QWidgetPlatformFileDialog::QWidgetPlatformFileDialog(), and open().
Here is the caller graph for this function:| QDir::Filters QFileDialog::filter | ( | ) | const |
Returns the filter that is used when displaying files.
Definition at line 1491 of file qfiledialog.cpp.
References d.
Referenced by getOpenFileUrl(), getOpenFileUrls(), getSaveFileUrl(), and setOptions().
Here is the caller graph for this function:This signal is emitted when the user selects a filter.
Referenced by QWidgetPlatformFileDialog::QWidgetPlatformFileDialog().
Here is the caller graph for this function:
|
static |
This is a convenience static function that will return 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 will be 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 may be an empty string in which case the current directory and a default caption will be 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 will use 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 \l{QFileDialog::}{DontUseNativeDialog} 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 will change to {/var/tmp} after entering {/usr/tmp}. If options includes DontResolveSymlinks, the file dialog will treat symlinks as regular directories.
On Windows, the dialog will spin a blocking modal event loop that will not dispatch any QTimers, and if parent is not \nullptr then it will position the dialog just below the parent's title bar.
Definition at line 2536 of file qfiledialog.cpp.
References dir, QUrl::fromLocalFile(), getExistingDirectoryUrl(), QUrl::isEmpty(), QUrl::isLocalFile(), options, QObject::parent(), QStringLiteral, QUrl::toLocalFile(), and QUrl::toString().
Here is the call graph for this function:
|
static |
This is a convenience static function that will return 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 the exact 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 will be 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). Supported 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 will use the native file dialog and not a QFileDialog. On platforms which don't support selecting remote files, Qt will allow to select only local files.
Definition at line 2577 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:
|
static |
This is a convenience static function that will return the content of a file selected by the user.
This function is used to access local files on Qt for WebAssembly, where the web sandbox places restrictions on how such access may happen. Its implementation will make the browser display a native file dialog, where the user makes the file selection based on the parameter nameFilter.
It can also be used on other platforms, where it will fall back to using 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.
Definition at line 2282 of file qfiledialog.cpp.
References QObject::connect(), QByteArray::data(), dialog, ExistingFile, fileContentReady, fileName, fileSelected(), QString::fromStdString(), QFile::open(), QWasmLocalFileAccess::openFile(), QIODevice::readAll(), QIODeviceBase::ReadOnly, QByteArray::resize(), QWidget::setAttribute(), setFileMode(), setNameFilter(), QWidget::show(), QWidget::size, QString::toStdString(), void, and Qt::WA_DeleteOnClose.
Here is the call graph for this function:
|
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.
The function 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.
The file dialog's working directory will be set to dir. If dir includes a file name, the file will be selected. Only files that match the given filter are shown. The filter selected 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 will use 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 will spin a blocking modal event loop that will not dispatch any QTimers, and if parent is not \nullptr then it will position 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}. If options includes DontResolveSymlinks, the file dialog will treat symlinks as regular directories.
Definition at line 2079 of file qfiledialog.cpp.
References dir, QUrl::fromLocalFile(), getOpenFileUrl(), QUrl::isEmpty(), QUrl::isLocalFile(), options, QObject::parent(), QStringLiteral, QUrl::toLocalFile(), and QUrl::toString().
Referenced by Viewer::chooseFile(), and MainWindow::openFile().
Here is the call graph for this function: Here is the caller graph for this function:
|
static |
This is a convenience static function that will return one or more existing files selected by the user.
This function 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.
The file dialog's working directory will be set to dir. If dir includes a file name, the file will be selected. The filter is set to filter so that only those files which match the filter are shown. The filter selected is set to selectedFilter. The parameters dir, selectedFilter and filter may be 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 will be used.
On Windows, and \macos, this static function will use 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 will spin a blocking modal event loop that will not dispatch any QTimers, and if parent is not \nullptr then it will position 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.
Definition at line 2192 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:
|
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 the exact 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 will be 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). Supported 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 will use the native file dialog and not a QFileDialog. On platforms which don't support selecting remote files, Qt will allow to select only local files.
Definition at line 2122 of file qfiledialog.cpp.
References QDialog::Accepted, args, dialog, dir, QDialog::exec(), ExistingFile, filter(), QString::isEmpty(), 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:
|
static |
This is a convenience static function that will return 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 the exact 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 will be 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). Supported 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 will use the native file dialog and not a QFileDialog. On platforms which don't support selecting remote files, Qt will allow to select only local files.
Definition at line 2237 of file qfiledialog.cpp.
References QDialog::Accepted, args, dialog, dir, QDialog::exec(), ExistingFiles, filter(), QString::isEmpty(), 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:
|
static |
This is a convenience static function that will return 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.
The file dialog's working directory will be set to dir. If dir includes a file name, the file will be 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 will be used.
On Windows, and \macos, this static function will use the native file dialog and not a QFileDialog.
On Windows the dialog will spin a blocking modal event loop that will not dispatch any QTimers, and if parent is not \nullptr then it will position 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 will change to {/var/tmp} after entering {/usr/tmp}. If options includes DontResolveSymlinks the file dialog will treat symlinks as regular directories.
Definition at line 2422 of file qfiledialog.cpp.
References dir, QUrl::fromLocalFile(), getSaveFileUrl(), QUrl::isEmpty(), QUrl::isLocalFile(), options, QObject::parent(), QStringLiteral, QUrl::toLocalFile(), and QUrl::toString().
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:
|
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 the exact 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 will be able to select. It is a way for the application to declare the protocols it will support to save the file content. An empty list means that no restriction is applied (the default). Supported 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 will use the native file dialog and not a QFileDialog. On platforms which don't support selecting remote files, Qt will allow to select only local files.
Definition at line 2465 of file qfiledialog.cpp.
References QDialog::Accepted, AcceptSave, AnyFile, args, dialog, dir, QDialog::exec(), filter(), QString::isEmpty(), 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:| QStringList QFileDialog::history | ( | ) | const |
Returns the browsing history of the filedialog as a list of paths.
Definition at line 1884 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:| QAbstractFileIconProvider * QFileDialog::iconProvider | ( | ) | const |
Returns the icon provider used by the filedialog.
Definition at line 1951 of file qfiledialog.cpp.
References d.
Referenced by setOptions().
Here is the caller graph for this function:| QAbstractItemDelegate * QFileDialog::itemDelegate | ( | ) | const |
Returns the item delegate used to render the items in the views in the filedialog.
Definition at line 1927 of file qfiledialog.cpp.
References d.
| QString QFileDialog::labelText | ( | DialogLabel | label | ) | const |
Returns the text shown in the filedialog in the specified label.
Definition at line 2003 of file qfiledialog.cpp.
References Accept, acceptMode, AcceptOpen, button, QDialogButtonBox::Cancel, d, FileName, FileType, LookIn, QDialogButtonBox::Open, Reject, QDialogButtonBox::Save, and QAbstractButton::text.
| QStringList QFileDialog::nameFilters | ( | ) | const |
Returns the file type filters that are in operation on this file dialog.
Definition at line 1433 of file qfiledialog.cpp.
|
slot |
Shows the dialog as a \l{QDialog::Modal Dialogs}{window modal dialog}, returning immediately.
Definition at line 51 of file qdialog.cpp.
This function connects one of its signals to the slot specified by receiver and member. The specific signal depends is filesSelected() if fileMode is ExistingFiles and fileSelected() if fileMode is anything else.
The signal will be disconnected from the slot when the dialog is closed.
Definition at line 819 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:| QFileDialog::Options QFileDialog::options | ( | ) | const |
Definition at line 797 of file qfiledialog.cpp.
References d, QFileDialogOptions::DontConfirmOverwrite, DontConfirmOverwrite, QFileDialogOptions::DontResolveSymlinks, DontResolveSymlinks, QFileDialogOptions::DontUseCustomDirectoryIcons, DontUseCustomDirectoryIcons, QFileDialogOptions::DontUseNativeDialog, DontUseNativeDialog, QFileDialogOptions::HideNameFilterDetails, HideNameFilterDetails, QFileDialogOptions::ReadOnly, ReadOnly, QFileDialogOptions::ShowDirsOnly, and ShowDirsOnly.
| bool QFileDialog::restoreState | ( | const QByteArray & | state | ) |
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 450 of file qfiledialog.cpp.
References d, QUrl::fromLocalFile(), history(), QFileDialogMagic, QDataStream::Qt_5_0, QIODeviceBase::ReadOnly, setDirectoryUrl(), setViewMode(), state, and viewMode.
Here is the call graph for this function:
|
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.
This function is used to save files to the local file system on Qt for WebAssembly, where the web sandbox places restrictions on how such access may happen. Its implementation will make the browser display a native file dialog, where the user makes the file selection.
It can also be used on other platforms, where it will fall back to using QFileDialog.
The function is asynchronous and returns immediately.
Definition at line 2350 of file qfiledialog.cpp.
References AcceptSave, AnyFile, QObject::connect(), dialog, fileName, fileSelected(), QFile::open(), QWasmLocalFileAccess::saveFile(), selectFile(), setAcceptMode(), QWidget::setAttribute(), setFileMode(), QWidget::show(), QString::toStdString(), Qt::WA_DeleteOnClose, QIODevice::write(), and QIODeviceBase::WriteOnly.
Here is the call graph for this function:| QByteArray QFileDialog::saveState | ( | ) | const |
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 414 of file qfiledialog.cpp.
References d, history(), QFileDialogMagic, QDataStream::Qt_5_0, viewMode, and QIODeviceBase::WriteOnly.
Here is the call graph for this function:| 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.
Definition at line 1280 of file qfiledialog.cpp.
References d, ExistingFile, ExistingFiles, file, fileMode, QFileSystemModel::FilePathRole, files, QUrl::PreferLocalFile, and QList< T >::size().
Referenced by accept(), and selectedUrls().
Here is the call graph for this function: Here is the caller graph for this function:| QString QFileDialog::selectedMimeTypeFilter | ( | ) | const |
Definition at line 1608 of file qfiledialog.cpp.
References d, HideNameFilterDetails, QString::isNull(), mimeType, qt_strip_filters(), selectedNameFilter(), and testOption().
Here is the call graph for this function:| QString QFileDialog::selectedNameFilter | ( | ) | const |
Returns the filter that the user selected in the file dialog.
Definition at line 1475 of file qfiledialog.cpp.
References d.
Referenced by getOpenFileUrl(), getOpenFileUrls(), getSaveFileUrl(), selectedMimeTypeFilter(), and QWidgetPlatformFileDialog::selectedNameFilter().
Here is the caller graph for this function: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.
Definition at line 1306 of file qfiledialog.cpp.
References QList< T >::append(), d, file, QUrl::fromLocalFile(), QList< T >::reserve(), 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:Selects the given filename in the file dialog.
Definition at line 1047 of file qfiledialog.cpp.
References QFileInfo::absoluteDir(), d, fileFromPath(), QUrl::fromLocalFile(), info, QString::isEmpty(), isRelative(), QDir::isRelativePath(), QWidget::isVisible(), QDir::path(), 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:Sets the current file type filter. Multiple filters can be passed in filter by separating them with semicolons or spaces.
Definition at line 1446 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:Selects the given url in the file dialog.
Definition at line 1091 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:| void QFileDialog::setAcceptMode | ( | QFileDialog::AcceptMode | mode | ) |
Definition at line 1725 of file qfiledialog.cpp.
References AcceptOpen, AcceptSave, button, QDialogButtonBox::Cancel, d, QDialogButtonBox::Open, QDialogButtonBox::Save, QWidget::setAttribute(), 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:Definition at line 1843 of file qfiledialog.cpp.
References d.
Referenced by QWidgetPlatformFileDialog::show().
Here is the caller graph for this function: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 262 of file qfiledialog.h.
Sets the file dialog's current directory.
NSPhotoLibraryUsageDescription. See Info.plist documentation from Apple for more information regarding this key. This feature was added in Qt 5.5. Definition at line 906 of file qfiledialog.cpp.
References QDir::cleanPath(), d, directory(), QUrl::fromLocalFile(), QString::isEmpty(), QDir::isEmpty(), Qt::ItemIsDropEnabled, 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:Sets the file dialog's current directory url.
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.Definition at line 973 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:| void QFileDialog::setFileMode | ( | QFileDialog::FileMode | mode | ) |
Definition at line 1678 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:| void QFileDialog::setFilter | ( | QDir::Filters | filters | ) |
Sets the filter used by the model to filters. The filter is used to specify the kind of files that should be shown.
Definition at line 1508 of file qfiledialog.cpp.
References d, filters, and QDir::Hidden.
Referenced by setOptions().
Here is the caller graph for this function:| void QFileDialog::setHistory | ( | const QStringList & | paths | ) |
Sets the browsing history of the filedialog to contain the given paths.
Definition at line 1859 of file qfiledialog.cpp.
References d.
| void QFileDialog::setIconProvider | ( | QAbstractFileIconProvider * | provider | ) |
Sets the icon provider used by the filedialog to the specified provider.
Definition at line 1938 of file qfiledialog.cpp.
References d.
| 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.
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.
Definition at line 1915 of file qfiledialog.cpp.
References d.
| void QFileDialog::setLabelText | ( | DialogLabel | label, |
| const QString & | text | ||
| ) |
Sets the text shown in the filedialog in the specified label.
Definition at line 1993 of file qfiledialog.cpp.
Referenced by QInputDialog::getDouble(), QInputDialog::getInt(), QInputDialog::getItem(), QInputDialog::getMultiLineText(), QInputDialog::getText(), and QWidgetPlatformFileDialog::show().
Here is the caller graph for this function: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:
Definition at line 1354 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:| void QFileDialog::setNameFilters | ( | const QStringList & | filters | ) |
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, {*.*} will match such files, while in other types of file dialogs it may not. So it is better to use {*} if you mean to select any file.
\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 will allow you to open all of them.
Definition at line 1402 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:Options (particularly the DontUseNativeDialogs 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.
Definition at line 716 of file qfiledialog.cpp.
References options, and setOptions().
Here is the call graph for this function:Definition at line 756 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:For instance:
The file dialog will then look like this:
Definition at line 388 of file qfiledialog.cpp.
References d.
Referenced by loadFileDialog().
Here is the caller graph for this function:| void QFileDialog::setSupportedSchemes | ( | const QStringList & | schemes | ) |
Definition at line 1756 of file qfiledialog.cpp.
References d.
Referenced by getExistingDirectoryUrl(), getOpenFileUrl(), getOpenFileUrls(), and getSaveFileUrl().
Here is the caller graph for this function:| void QFileDialog::setViewMode | ( | QFileDialog::ViewMode | mode | ) |
Definition at line 1643 of file qfiledialog.cpp.
Referenced by restoreState().
Here is the caller graph for this function:
|
overridevirtual |
\reimp
Reimplemented from QDialog.
Definition at line 836 of file qfiledialog.cpp.
References d, QWidget::setAttribute(), QWidget::setVisible(), QWidget::testAttribute(), QWidget::visible, Qt::WA_DontShowOnScreen, Qt::WA_WState_ExplicitShowHide, and Qt::WA_WState_Hidden.
Here is the call graph for this function:Definition at line 399 of file qfiledialog.cpp.
References d.
| QStringList QFileDialog::supportedSchemes | ( | ) | const |
Definition at line 1762 of file qfiledialog.cpp.
| bool QFileDialog::testOption | ( | Option | option | ) | const |
Returns true if the given option is enabled; otherwise, returns false.
Definition at line 731 of file qfiledialog.cpp.
References d.
Referenced by accept(), selectedMimeTypeFilter(), selectNameFilter(), setFileMode(), and setNameFilters().
Here is the caller graph for this function:When the selection changes and the dialog is accepted, this signal is emitted with the (possibly empty) selected url.
When the selection changes and the dialog is accepted, this signal is emitted with the (possibly empty) list of selected urls.
| QFileDialog::ViewMode QFileDialog::viewMode | ( | ) | const |
Definition at line 1655 of file qfiledialog.cpp.
|
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}.
Definition at line 267 of file qfiledialog.h.
Referenced by accept(), and labelText().
|
readwrite |
suffix added to the filename if no other suffix was specified
This property specifies a string that will be added to the filename if it has no suffix already. 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 267 of file qfiledialog.h.
|
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 will set the labels for the FileName and \l{QFileDialog::}{Accept} \l{DialogLabel}s. It is possible to set custom text after the call to setFileMode().
Definition at line 267 of file qfiledialog.h.
Referenced by accept(), open(), and selectedFiles().
|
readwrite |
the various options that affect the look and feel of the dialog
By default, all options are disabled.
Options (particularly the DontUseNativeDialogs 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.
Definition at line 267 of file qfiledialog.h.
Referenced by getExistingDirectory(), getExistingDirectoryUrl(), getOpenFileName(), getOpenFileNames(), getOpenFileUrl(), getOpenFileUrls(), getSaveFileName(), getSaveFileUrl(), setOption(), and setOptions().
|
readwrite |
the URL schemes that the file dialog should allow navigating to.
Setting this property allows to restrict the type of URLs the user will be 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). Supported for local files ("file" scheme) is implicit and always enabled; it is not necessary to include it in the restriction.
Definition at line 267 of file qfiledialog.h.
Referenced by getExistingDirectoryUrl(), getOpenFileUrl(), getOpenFileUrls(), and getSaveFileUrl().
|
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.
Definition at line 267 of file qfiledialog.h.
Referenced by restoreState(), and saveState().
1.9.7