KFileDialog
#include <kfiledialog.h>

Public Types | |
enum | OperationMode { Other = 0, Opening, Saving } |
enum | Option { ConfirmOverwrite = 0x01, ShowInlinePreview = 0x02 } |
typedef QFlags< Option > | Options |
![]() | |
enum | DialogCode |
![]() | |
enum | RenderFlag |
![]() | |
enum | PaintDeviceMetric |
Signals | |
void | fileHighlighted (const QUrl &) |
void | fileSelected (const QUrl &) |
void | filterChanged (const QString &filter) |
void | selectionChanged () |
Public Member Functions | |
KFileDialog (const QUrl &startDir, const QString &filter, QWidget *parent, QWidget *widget=nullptr) | |
~KFileDialog () override | |
KActionCollection * | actionCollection () const |
QUrl | baseUrl () const |
QPushButton * | cancelButton () const |
void | clearFilter () |
QString | currentFilter () const |
QMimeType | currentFilterMimeType () |
QString | currentMimeFilter () const |
KFileWidget * | fileWidget () |
KFileFilterCombo * | filterWidget () const |
bool | keepsLocation () const |
KUrlComboBox * | locationEdit () const |
KFile::Modes | mode () const |
QPushButton * | okButton () const |
OperationMode | operationMode () const |
QString | selectedFile () const |
QStringList | selectedFiles () const |
QUrl | selectedUrl () const |
QList< QUrl > | selectedUrls () const |
void | setConfirmOverwrite (bool enable) |
void | setFilter (const QString &filter) |
void | setInlinePreviewShown (bool show) |
void | setKeepLocation (bool keep) |
void | setLocationLabel (const QString &text) |
void | setMimeFilter (const QStringList &types, const QString &defaultType=QString()) |
void | setMode (KFile::Modes m) |
void | setOperationMode (KFileDialog::OperationMode) |
void | setPreviewWidget (KPreviewWidgetBase *w) |
void | setSelection (const QString &name) |
void | setUrl (const QUrl &url, bool clearforward=true) |
QSize | sizeHint () const override |
KToolBar * | toolBar () const |
![]() | |
QDialog (QWidget *parent, Qt::WindowFlags f) | |
virtual void | accept () |
void | accepted () |
virtual void | done (int r) |
virtual int | exec () |
QWidget * | extension () const const |
void | finished (int result) |
bool | isSizeGripEnabled () const const |
virtual QSize | minimumSizeHint () const const override |
virtual void | open () |
Qt::Orientation | orientation () const const |
virtual void | reject () |
void | rejected () |
int | result () const const |
void | setExtension (QWidget *extension) |
void | setModal (bool modal) |
void | setOrientation (Qt::Orientation orientation) |
void | setResult (int i) |
void | setSizeGripEnabled (bool) |
virtual void | setVisible (bool visible) override |
void | showExtension (bool showIt) |
![]() | |
QWidget (QWidget *parent, Qt::WindowFlags f) | |
bool | acceptDrops () const const |
QString | accessibleDescription () const const |
QString | accessibleName () const const |
QList< QAction * > | actions () const const |
void | activateWindow () |
void | addAction (QAction *action) |
void | addActions (QList< QAction * > actions) |
void | adjustSize () |
bool | autoFillBackground () const const |
QPalette::ColorRole | backgroundRole () const const |
QBackingStore * | backingStore () const const |
QSize | baseSize () const const |
QWidget * | childAt (const QPoint &p) const const |
QWidget * | childAt (int x, int y) const const |
QRect | childrenRect () const const |
QRegion | childrenRegion () const const |
void | clearFocus () |
void | clearMask () |
bool | close () |
QMargins | contentsMargins () const const |
QRect | contentsRect () const const |
Qt::ContextMenuPolicy | contextMenuPolicy () const const |
QCursor | cursor () const const |
void | customContextMenuRequested (const QPoint &pos) |
WId | effectiveWinId () const const |
void | ensurePolished () const const |
Qt::FocusPolicy | focusPolicy () const const |
QWidget * | focusProxy () const const |
QWidget * | focusWidget () const const |
const QFont & | font () const const |
QFontInfo | fontInfo () const const |
QFontMetrics | fontMetrics () const const |
QPalette::ColorRole | foregroundRole () const const |
QRect | frameGeometry () const const |
QSize | frameSize () const const |
const QRect & | geometry () const const |
void | getContentsMargins (int *left, int *top, int *right, int *bottom) const const |
QPixmap | grab (const QRect &rectangle) |
void | grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags) |
void | grabKeyboard () |
void | grabMouse () |
void | grabMouse (const QCursor &cursor) |
int | grabShortcut (const QKeySequence &key, Qt::ShortcutContext context) |
QGraphicsEffect * | graphicsEffect () const const |
QGraphicsProxyWidget * | graphicsProxyWidget () const const |
bool | hasEditFocus () const const |
bool | hasFocus () const const |
virtual bool | hasHeightForWidth () const const |
bool | hasMouseTracking () const const |
bool | hasTabletTracking () const const |
int | height () const const |
virtual int | heightForWidth (int w) const const |
void | hide () |
Qt::InputMethodHints | inputMethodHints () const const |
virtual QVariant | inputMethodQuery (Qt::InputMethodQuery query) const const |
void | insertAction (QAction *before, QAction *action) |
void | insertActions (QAction *before, QList< QAction * > actions) |
bool | isActiveWindow () const const |
bool | isAncestorOf (const QWidget *child) const const |
bool | isEnabled () const const |
bool | isEnabledTo (const QWidget *ancestor) const const |
bool | isEnabledToTLW () const const |
bool | isFullScreen () const const |
bool | isHidden () const const |
bool | isMaximized () const const |
bool | isMinimized () const const |
bool | isModal () const const |
bool | isTopLevel () const const |
bool | isVisible () const const |
bool | isVisibleTo (const QWidget *ancestor) const const |
bool | isWindow () const const |
bool | isWindowModified () const const |
QLayout * | layout () const const |
Qt::LayoutDirection | layoutDirection () const const |
QLocale | locale () const const |
void | lower () |
QPoint | mapFrom (const QWidget *parent, const QPoint &pos) const const |
QPoint | mapFromGlobal (const QPoint &pos) const const |
QPoint | mapFromParent (const QPoint &pos) const const |
QPoint | mapTo (const QWidget *parent, const QPoint &pos) const const |
QPoint | mapToGlobal (const QPoint &pos) const const |
QPoint | mapToParent (const QPoint &pos) const const |
QRegion | mask () const const |
int | maximumHeight () const const |
QSize | maximumSize () const const |
int | maximumWidth () const const |
int | minimumHeight () const const |
QSize | minimumSize () const const |
int | minimumWidth () const const |
void | move (const QPoint &) |
void | move (int x, int y) |
QWidget * | nativeParentWidget () const const |
QWidget * | nextInFocusChain () const const |
QRect | normalGeometry () const const |
void | overrideWindowFlags (Qt::WindowFlags flags) |
virtual QPaintEngine * | paintEngine () const const override |
const QPalette & | palette () const const |
QWidget * | parentWidget () const const |
QPoint | pos () const const |
QWidget * | previousInFocusChain () const const |
QWIDGETSIZE_MAX QWIDGETSIZE_MAX | |
void | raise () |
QRect | rect () const const |
void | releaseKeyboard () |
void | releaseMouse () |
void | releaseShortcut (int id) |
void | removeAction (QAction *action) |
void | render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags) |
void | render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags) |
void | repaint () |
void | repaint (const QRect &rect) |
void | repaint (const QRegion &rgn) |
void | repaint (int x, int y, int w, int h) |
void | resize (const QSize &) |
void | resize (int w, int h) |
bool | restoreGeometry (const QByteArray &geometry) |
QByteArray | saveGeometry () const const |
QScreen * | screen () const const |
void | scroll (int dx, int dy) |
void | scroll (int dx, int dy, const QRect &r) |
void | setAcceptDrops (bool on) |
void | setAccessibleDescription (const QString &description) |
void | setAccessibleName (const QString &name) |
void | setAttribute (Qt::WidgetAttribute attribute, bool on) |
void | setAutoFillBackground (bool enabled) |
void | setBackgroundRole (QPalette::ColorRole role) |
void | setBaseSize (const QSize &) |
void | setBaseSize (int basew, int baseh) |
void | setContentsMargins (const QMargins &margins) |
void | setContentsMargins (int left, int top, int right, int bottom) |
void | setContextMenuPolicy (Qt::ContextMenuPolicy policy) |
void | setCursor (const QCursor &) |
void | setDisabled (bool disable) |
void | setEditFocus (bool enable) |
void | setEnabled (bool) |
void | setFixedHeight (int h) |
void | setFixedSize (const QSize &s) |
void | setFixedSize (int w, int h) |
void | setFixedWidth (int w) |
void | setFocus () |
void | setFocus (Qt::FocusReason reason) |
void | setFocusPolicy (Qt::FocusPolicy policy) |
void | setFocusProxy (QWidget *w) |
void | setFont (const QFont &) |
void | setForegroundRole (QPalette::ColorRole role) |
void | setGeometry (const QRect &) |
void | setGeometry (int x, int y, int w, int h) |
void | setGraphicsEffect (QGraphicsEffect *effect) |
void | setHidden (bool hidden) |
void | setInputMethodHints (Qt::InputMethodHints hints) |
void | setLayout (QLayout *layout) |
void | setLayoutDirection (Qt::LayoutDirection direction) |
void | setLocale (const QLocale &locale) |
void | setMask (const QBitmap &bitmap) |
void | setMask (const QRegion ®ion) |
void | setMaximumHeight (int maxh) |
void | setMaximumSize (const QSize &) |
void | setMaximumSize (int maxw, int maxh) |
void | setMaximumWidth (int maxw) |
void | setMinimumHeight (int minh) |
void | setMinimumSize (const QSize &) |
void | setMinimumSize (int minw, int minh) |
void | setMinimumWidth (int minw) |
void | setMouseTracking (bool enable) |
void | setPalette (const QPalette &) |
void | setParent (QWidget *parent) |
void | setParent (QWidget *parent, Qt::WindowFlags f) |
void | setShortcutAutoRepeat (int id, bool enable) |
void | setShortcutEnabled (int id, bool enable) |
void | setSizeIncrement (const QSize &) |
void | setSizeIncrement (int w, int h) |
void | setSizePolicy (QSizePolicy) |
void | setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical) |
void | setStatusTip (const QString &) |
void | setStyle (QStyle *style) |
void | setStyleSheet (const QString &styleSheet) |
void | setTabletTracking (bool enable) |
void | setToolTip (const QString &) |
void | setToolTipDuration (int msec) |
void | setUpdatesEnabled (bool enable) |
void | setupUi (QWidget *widget) |
void | setWhatsThis (const QString &) |
void | setWindowFilePath (const QString &filePath) |
void | setWindowFlag (Qt::WindowType flag, bool on) |
void | setWindowFlags (Qt::WindowFlags type) |
void | setWindowIcon (const QIcon &icon) |
void | setWindowIconText (const QString &) |
void | setWindowModality (Qt::WindowModality windowModality) |
void | setWindowModified (bool) |
void | setWindowOpacity (qreal level) |
void | setWindowRole (const QString &role) |
void | setWindowState (Qt::WindowStates windowState) |
void | setWindowTitle (const QString &) |
void | show () |
void | showFullScreen () |
void | showMaximized () |
void | showMinimized () |
void | showNormal () |
QSize | size () const const |
QSize | sizeIncrement () const const |
QSizePolicy | sizePolicy () const const |
void | stackUnder (QWidget *w) |
QString | statusTip () const const |
QStyle * | style () const const |
QString | styleSheet () const const |
bool | testAttribute (Qt::WidgetAttribute attribute) const const |
QString | toolTip () const const |
int | toolTipDuration () const const |
QWidget * | topLevelWidget () const const |
bool | underMouse () const const |
void | ungrabGesture (Qt::GestureType gesture) |
void | unsetCursor () |
void | unsetLayoutDirection () |
void | unsetLocale () |
void | update () |
void | update (const QRect &rect) |
void | update (const QRegion &rgn) |
void | update (int x, int y, int w, int h) |
void | updateGeometry () |
bool | updatesEnabled () const const |
QRegion | visibleRegion () const const |
QString | whatsThis () const const |
int | width () const const |
QWidget * | window () const const |
QString | windowFilePath () const const |
Qt::WindowFlags | windowFlags () const const |
QWindow * | windowHandle () const const |
QIcon | windowIcon () const const |
void | windowIconChanged (const QIcon &icon) |
QString | windowIconText () const const |
void | windowIconTextChanged (const QString &iconText) |
Qt::WindowModality | windowModality () const const |
qreal | windowOpacity () const const |
QString | windowRole () const const |
Qt::WindowStates | windowState () const const |
QString | windowTitle () const const |
void | windowTitleChanged (const QString &title) |
Qt::WindowType | windowType () const const |
WId | winId () const const |
int | x () const const |
int | y () const const |
![]() | |
QObject (QObject *parent) | |
bool | blockSignals (bool block) |
const QObjectList & | children () const const |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) const const |
bool | disconnect (const QObject *receiver, const char *method) const const |
void | dumpObjectInfo () |
void | dumpObjectInfo () const const |
void | dumpObjectTree () |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegExp ®Exp, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_DISABLE_COPY (Class) | |
Q_DISABLE_COPY_MOVE (Class) | |
Q_DISABLE_MOVE (Class) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_NAMESPACE Q_NAMESPACE | |
Q_NAMESPACE_EXPORT (EXPORT_MACRO) | |
Q_OBJECT Q_OBJECT | |
Q_PROPERTY (...) | |
Q_REVISION Q_REVISION | |
Q_SET_OBJECT_NAME (Object) | |
Q_SIGNAL Q_SIGNAL | |
Q_SIGNALS Q_SIGNALS | |
Q_SLOT Q_SLOT | |
Q_SLOTS Q_SLOTS | |
T | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds time, Qt::TimerType timerType) |
QThread * | thread () const const |
![]() | |
int | colorCount () const const |
int | depth () const const |
int | devicePixelRatio () const const |
qreal | devicePixelRatioF () const const |
int | height () const const |
int | heightMM () const const |
int | logicalDpiX () const const |
int | logicalDpiY () const const |
bool | paintingActive () const const |
int | physicalDpiX () const const |
int | physicalDpiY () const const |
int | width () const const |
int | widthMM () const const |
Static Public Member Functions | |
static QString | getExistingDirectory (const QUrl &startDir=QUrl(), QWidget *parent=nullptr, const QString &caption=QString()) |
static QUrl | getExistingDirectoryUrl (const QUrl &startDir=QUrl(), QWidget *parent=nullptr, const QString &caption=QString()) |
static QUrl | getImageOpenUrl (const QUrl &startDir=QUrl(), QWidget *parent=nullptr, const QString &caption=QString()) |
static QString | getOpenFileName (const QUrl &startDir=QUrl(), const QString &filter=QString(), QWidget *parent=nullptr, const QString &caption=QString()) |
static QStringList | getOpenFileNames (const QUrl &startDir=QUrl(), const QString &filter=QString(), QWidget *parent=nullptr, const QString &caption=QString()) |
static QString | getOpenFileNameWId (const QUrl &startDir, const QString &filter, WId parent_id, const QString &caption) |
static QUrl | getOpenUrl (const QUrl &startDir=QUrl(), const QString &filter=QString(), QWidget *parent=nullptr, const QString &caption=QString()) |
static QList< QUrl > | getOpenUrls (const QUrl &startDir=QUrl(), const QString &filter=QString(), QWidget *parent=nullptr, const QString &caption=QString()) |
static QString | getSaveFileName (const QUrl &startDir, const QString &filter, QWidget *parent, const QString &caption, Options options) |
static QString | getSaveFileName (const QUrl &startDir=QUrl(), const QString &filter=QString(), QWidget *parent=nullptr, const QString &caption=QString()) |
static QString | getSaveFileNameWId (const QUrl &startDir, const QString &filter, WId parent_id, const QString &caption) |
static QString | getSaveFileNameWId (const QUrl &startDir, const QString &filter, WId parent_id, const QString &caption, Options options) |
static QUrl | getSaveUrl (const QUrl &startDir, const QString &filter, QWidget *parent, const QString &caption, Options options) |
static QUrl | getSaveUrl (const QUrl &startDir=QUrl(), const QString &filter=QString(), QWidget *parent=nullptr, const QString &caption=QString()) |
static QUrl | getStartUrl (const QUrl &startDir, QString &recentDirClass) |
static void | setStartDir (const QUrl &directory) |
![]() | |
QWidget * | createWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags) |
QWidget * | find (WId id) |
QWidget * | keyboardGrabber () |
QWidget * | mouseGrabber () |
void | setTabOrder (QWidget *first, QWidget *second) |
![]() | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, Functor functor) |
bool | disconnect (const QMetaObject::Connection &connection) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
Protected Slots | |
void | accept () override |
virtual void | slotCancel () |
virtual void | slotOk () |
Protected Member Functions | |
void | hideEvent (QHideEvent *event) override |
void | keyPressEvent (QKeyEvent *e) override |
![]() | |
virtual void | closeEvent (QCloseEvent *e) override |
virtual void | contextMenuEvent (QContextMenuEvent *e) override |
virtual bool | eventFilter (QObject *o, QEvent *e) override |
virtual void | resizeEvent (QResizeEvent *) override |
virtual void | showEvent (QShowEvent *event) override |
![]() | |
virtual void | actionEvent (QActionEvent *event) |
virtual void | changeEvent (QEvent *event) |
void | create (WId window, bool initializeWindow, bool destroyOldWindow) |
void | destroy (bool destroyWindow, bool destroySubWindows) |
virtual void | dragEnterEvent (QDragEnterEvent *event) |
virtual void | dragLeaveEvent (QDragLeaveEvent *event) |
virtual void | dragMoveEvent (QDragMoveEvent *event) |
virtual void | dropEvent (QDropEvent *event) |
virtual void | enterEvent (QEvent *event) |
virtual bool | event (QEvent *event) override |
virtual void | focusInEvent (QFocusEvent *event) |
bool | focusNextChild () |
virtual bool | focusNextPrevChild (bool next) |
virtual void | focusOutEvent (QFocusEvent *event) |
bool | focusPreviousChild () |
virtual void | initPainter (QPainter *painter) const const override |
virtual void | inputMethodEvent (QInputMethodEvent *event) |
virtual void | keyReleaseEvent (QKeyEvent *event) |
virtual void | leaveEvent (QEvent *event) |
virtual int | metric (QPaintDevice::PaintDeviceMetric m) const const override |
virtual void | mouseDoubleClickEvent (QMouseEvent *event) |
virtual void | mouseMoveEvent (QMouseEvent *event) |
virtual void | mousePressEvent (QMouseEvent *event) |
virtual void | mouseReleaseEvent (QMouseEvent *event) |
virtual void | moveEvent (QMoveEvent *event) |
virtual bool | nativeEvent (const QByteArray &eventType, void *message, long *result) |
virtual void | paintEvent (QPaintEvent *event) |
virtual void | tabletEvent (QTabletEvent *event) |
void | updateMicroFocus () |
virtual void | wheelEvent (QWheelEvent *event) |
![]() | |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
bool | isSignalConnected (const QMetaMethod &signal) const const |
int | receivers (const char *signal) const const |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Detailed Description
A file selection dialog.
- Warning
- This class should be avoided in new code. QFileDialog should be used instead.
- See also
- QFileDialog
Provides a user (and developer) friendly way to select files and directories.
The widget can be used as a drop in replacement for the QFileDialog widget, but has greater functionality and a nicer GUI.
You will usually want to use one of the static methods getOpenFileName(), getSaveFileName(), getOpenUrl() or for multiple files getOpenFileNames() or getOpenUrls().
The dialog has been designed to allow applications to customize it by subclassing. It uses geometry management to ensure that subclasses can easily add children that will be incorporated into the layout.

- Deprecated:
- since 5.0, use the QFileDialog API instead. Note that when the KDE QPA theme plugin is installed, the KFileWidget will then be used automatically.
Definition at line 74 of file kfiledialog.h.
Member Enumeration Documentation
◆ OperationMode
Defines some default behavior of the filedialog.
E.g. in mode Opening
and Saving
, the selected files/urls will be added to the "recent documents" list. The Saving mode also implies setKeepLocation() being set.
Other
means that no default actions are performed.
- See also
- setOperationMode
- operationMode
Definition at line 91 of file kfiledialog.h.
◆ Option
enum KFileDialog::Option |
Defines the options to use when calling getSave* functions.
- Since
- 4.4
Enumerator | |
---|---|
ConfirmOverwrite | Confirm whether to overwrite file to save. |
ShowInlinePreview | Always show an inline preview. |
Definition at line 97 of file kfiledialog.h.
Constructor & Destructor Documentation
◆ KFileDialog()
KFileDialog::KFileDialog | ( | const QUrl & | startDir, |
const QString & | filter, | ||
QWidget * | parent, | ||
QWidget * | widget = nullptr |
||
) |
Constructs a file dialog.
- Parameters
-
startDir Specifies the starting directory and/or initially selected file name, or a last used directory and optional file name using the kfiledialog:///
syntax. Refer to the KFileWidget documentation for more information on this parameter.filter A shell glob or a mimetype filter that specifies which files to display. For better consistency across applications, it is recommended to use a mimetype filter. See setFilter() and setMimeFilter() for details on how to use this argument. parent The parent widget of this dialog widget A widget, or a widget of widgets, for displaying custom data in the dialog. This can be used, for example, to display a check box with the caption "Open as read-only". When creating this widget, you don't need to specify a parent, since the widget's parent will be set automatically by KFileDialog.
- See also
- KFileWidget::KFileWidget()
Definition at line 240 of file kfiledialog.cpp.
◆ ~KFileDialog()
|
override |
Destructs the file dialog.
Definition at line 296 of file kfiledialog.cpp.
Member Function Documentation
◆ actionCollection()
KActionCollection * KFileDialog::actionCollection | ( | ) | const |
- Returns
- a pointer to the action collection, holding all the used KActions.
Definition at line 901 of file kfiledialog.cpp.
◆ baseUrl()
QUrl KFileDialog::baseUrl | ( | ) | const |
- Returns
- the currently shown directory.
Definition at line 689 of file kfiledialog.cpp.
◆ cancelButton()
QPushButton * KFileDialog::cancelButton | ( | ) | const |
- Returns
- a pointer to the Cancel-Button in the filedialog. You may use it e.g. to set a custom text to it.
Definition at line 877 of file kfiledialog.cpp.
◆ clearFilter()
void KFileDialog::clearFilter | ( | ) |
Clears any mime- or namefilter.
Does not reload the directory.
Definition at line 340 of file kfiledialog.cpp.
◆ currentFilter()
QString KFileDialog::currentFilter | ( | ) | const |
Returns the current filter as entered by the user or one of the predefined set via setFilter().
- See also
- setFilter()
- filterChanged()
Definition at line 317 of file kfiledialog.cpp.
◆ currentFilterMimeType()
QMimeType KFileDialog::currentFilterMimeType | ( | ) |
Returns the mimetype for the desired output format.
This is only valid if setMimeFilter() has been called previously.
- See also
- setFilterMimeType()
Definition at line 362 of file kfiledialog.cpp.
◆ currentMimeFilter()
QString KFileDialog::currentMimeFilter | ( | ) | const |
The mimetype for the desired output format.
This is only valid if setMimeFilter() has been called previously.
- See also
- setMimeFilter()
Definition at line 349 of file kfiledialog.cpp.
◆ fileHighlighted
|
signal |
Emitted when the user highlights a file.
- Since
- 4.4
◆ fileSelected
|
signal |
Emitted when the user selects a file.
It is only emitted in single- selection mode. The best way to get notified about selected file(s) is to connect to the accepted() signal inherited from QDialog and call selectedFile(), selectedFiles(), selectedUrl() or selectedUrls().
- Since
- 4.4
◆ fileWidget()
KFileWidget * KFileDialog::fileWidget | ( | ) |
Returns the KFileWidget that implements most of this file dialog.
If you link to libkfile you can cast this to a KFileWidget*.
Definition at line 985 of file kfiledialog.cpp.
◆ filterChanged
|
signal |
Emitted when the filter changed, i.e.
the user entered an own filter or chose one of the predefined set via setFilter().
- Parameters
-
filter contains the new filter (only the extension part, not the explanation), i.e. "*.cpp" or "*.cpp *.cc".
- See also
- setFilter()
- currentFilter()
◆ filterWidget()
KFileFilterCombo * KFileDialog::filterWidget | ( | ) | const |
- Returns
- the combobox that contains the filters You need to link to libkfile to use this widget.
Definition at line 893 of file kfiledialog.cpp.
◆ getExistingDirectory()
|
static |
Creates a modal directory-selection dialog and returns the selected directory (local only) or an empty string if none was chosen.
- Parameters
-
startDir Starting directory or kfiledialog:///
URL. Refer to the KFileWidget documentation for more information on this parameter.parent The widget the dialog will be centered on initially. caption The name of the dialog widget.
- Returns
- the path to an existing local directory.
- See also
- KFileWidget::KFileWidget()
- Deprecated:
- use QFileDialog::getExistingDirectory(parent, caption, startDir)
Definition at line 614 of file kfiledialog.cpp.
◆ getExistingDirectoryUrl()
|
static |
Creates a modal directory-selection dialog and returns the selected directory or an empty string if none was chosen.
This version supports remote urls.
- Parameters
-
startDir Starting directory or kfiledialog:///
URL. Refer to the KFileWidget documentation for more information on this parameter.parent The widget the dialog will be centered on initially. caption The name of the dialog widget.
- Returns
- the url to an existing directory (local or remote).
- See also
- KFileWidget::KFileWidget()
- Deprecated:
- use QFileDialog::getExistingDirectoryUrl(parent, caption, startDir)
Definition at line 607 of file kfiledialog.cpp.
◆ getImageOpenUrl()
|
static |
Creates a modal file dialog with an image previewer and returns the selected url or an empty string if none was chosen.
- Parameters
-
startDir Starting directory or kfiledialog:///
URL. Refer to the KFileWidget documentation for more information on this parameter.parent The widget the dialog will be centered on initially. caption The name of the dialog widget.
- See also
- KFileWidget::KFileWidget()
Definition at line 630 of file kfiledialog.cpp.
◆ getOpenFileName()
|
static |
Creates a modal file dialog and return the selected filename or an empty string if none was chosen.
Note that with this method the user must select an existing filename.
- Parameters
-
startDir Starting directory or kfiledialog:///
URL. Refer to the KFileWidget documentation for more information on this parameter.filter A shell glob or a mimetype filter that specifies which files to display. The preferred option is to set a list of mimetype names, see setMimeFilter() for details. Otherwise you can set the text to be displayed for the each glob, and provide multiple globs, see setFilter() for details. parent The widget the dialog will be centered on initially. caption The name of the dialog widget.
- See also
- KFileWidget::KFileWidget()
- Deprecated:
- use QFileDialog::getOpenFileName(parent, caption, startDir, filter)
Definition at line 439 of file kfiledialog.cpp.
◆ getOpenFileNames()
|
static |
Creates a modal file dialog and returns the selected filenames or an empty list if none was chosen.
Note that with this method the user must select an existing filename.
- Parameters
-
startDir Starting directory or kfiledialog:///
URL. Refer to the KFileWidget documentation for more information on this parameter.filter A shell glob or a mimetype filter that specifies which files to display. The preferred option is to set a list of mimetype names, see setMimeFilter() for details. Otherwise you can set the text to be displayed for the each glob, and provide multiple globs, see setFilter() for details. parent The widget the dialog will be centered on initially. caption The name of the dialog widget.
- See also
- KFileWidget::KFileWidget()
- Deprecated:
- use QFileDialog::getOpenFileNames(parent, caption, startDir, filter)
Definition at line 498 of file kfiledialog.cpp.
◆ getOpenFileNameWId()
|
static |
Use this version only if you have no QWidget available as parent widget.
This can be the case if the parent widget is a widget in another process or if the parent widget is a non-Qt widget. For example, in a GTK program.
Definition at line 474 of file kfiledialog.cpp.
◆ getOpenUrl()
|
static |
Creates a modal file dialog and returns the selected URL or an empty string if none was chosen.
Note that with this method the user must select an existing URL.
- Parameters
-
startDir Starting directory or kfiledialog:///
URL. Refer to the KFileWidget documentation for more information on this parameter.filter A shell glob or a mimetype filter that specifies which files to display. The preferred option is to set a list of mimetype names, see setMimeFilter() for details. Otherwise you can set the text to be displayed for the each glob, and provide multiple globs, see setFilter() for details. parent The widget the dialog will be centered on initially. caption The name of the dialog widget.
- See also
- KFileWidget::KFileWidget()
- Deprecated:
- use QFileDialog::getOpenFileUrl(parent, caption, startDir, filter)
Definition at line 534 of file kfiledialog.cpp.
◆ getOpenUrls()
|
static |
Creates a modal file dialog and returns the selected URLs or an empty list if none was chosen.
Note that with this method the user must select an existing filename.
- Parameters
-
startDir Starting directory or kfiledialog:///
URL. Refer to the KFileWidget documentation for more information on this parameter.filter A shell glob or a mimetype filter that specifies which files to display. The preferred option is to set a list of mimetype names, see setMimeFilter() for details. Otherwise you can set the text to be displayed for the each glob, and provide multiple globs, see setFilter() for details. parent The widget the dialog will be centered on initially. caption The name of the dialog widget.
- See also
- KFileWidget::KFileWidget()
- Deprecated:
- use QFileDialog::getOpenFileUrls(parent, caption, startDir, filter)
Definition at line 562 of file kfiledialog.cpp.
◆ getSaveFileName() [1/2]
|
static |
Creates a modal file dialog and returns the selected filename or an empty string if none was chosen.
Note that with this method the user need not select an existing filename.
- Parameters
-
startDir Starting directory or kfiledialog:///
URL. Refer to the KFileWidget documentation for more information on this parameter.filter A shell glob or a mimetype filter that specifies which files to display. The preferred option is to set a list of mimetype names, see setMimeFilter() for details. Otherwise you can set the text to be displayed for the each glob, and provide multiple globs, see setFilter() for details. parent The widget the dialog will be centered on initially. caption The name of the dialog widget. options Dialog options.
- See also
- KFileWidget::KFileWidget()
- Since
- 4.4
- Deprecated:
- use QFileDialog::getSaveFileName(parent, caption, startDir, filter, [selectedFilter], options)
Definition at line 706 of file kfiledialog.cpp.
◆ getSaveFileName() [2/2]
|
static |
Creates a modal file dialog and returns the selected filename or an empty string if none was chosen.
Note that with this method the user need not select an existing filename.
- Parameters
-
startDir Starting directory or kfiledialog:///
URL. Refer to the KFileWidget documentation for more information on this parameter.filter A shell glob or a mimetype filter that specifies which files to display. The preferred option is to set a list of mimetype names, see setMimeFilter() for details. Otherwise you can set the text to be displayed for the each glob, and provide multiple globs, see setFilter() for details. parent The widget the dialog will be centered on initially. caption The name of the dialog widget.
- See also
- KFileWidget::KFileWidget()
- Deprecated:
- use QFileDialog::getSaveFileName(parent, caption, startDir, filter)
Definition at line 697 of file kfiledialog.cpp.
◆ getSaveFileNameWId() [1/2]
|
static |
This function accepts the window id of the parent window, instead of QWidget*.
It should be used only when necessary.
Definition at line 766 of file kfiledialog.cpp.
◆ getSaveFileNameWId() [2/2]
|
static |
This function accepts the window id of the parent window, instead of QWidget*.
It should be used only when necessary.
- Since
- 4.4
Definition at line 775 of file kfiledialog.cpp.
◆ getSaveUrl() [1/2]
|
static |
Creates a modal file dialog and returns the selected filename or an empty string if none was chosen.
Note that with this method the user need not select an existing filename.
- Parameters
-
startDir Starting directory or kfiledialog:///
URL. Refer to the KFileWidget documentation for more information on this parameter.filter A shell glob or a mimetype filter that specifies which files to display. The preferred option is to set a list of mimetype names, see setMimeFilter() for details. Otherwise you can set the text to be displayed for the each glob, and provide multiple globs, see setFilter() for details. parent The widget the dialog will be centered on initially. caption The name of the dialog widget. options Dialog options.
- See also
- KFileWidget::KFileWidget()
- Since
- 4.4
- Deprecated:
- use QFileDialog::getSaveFileUrl(parent, caption, startDir, filter, [selectedFilter], options)
Definition at line 814 of file kfiledialog.cpp.
◆ getSaveUrl() [2/2]
|
static |
Creates a modal file dialog and returns the selected filename or an empty string if none was chosen.
Note that with this method the user need not select an existing filename.
- Parameters
-
startDir Starting directory or kfiledialog:///
URL. Refer to the KFileWidget documentation for more information on this parameter.filter A shell glob or a mimetype filter that specifies which files to display. The preferred option is to set a list of mimetype names, see setMimeFilter() for details. Otherwise you can set the text to be displayed for the each glob, and provide multiple globs, see setFilter() for details. parent The widget the dialog will be centered on initially. caption The name of the dialog widget.
- See also
- KFileWidget::KFileWidget()
- Deprecated:
- use QFileDialog::getSaveFileUrl(parent, caption, startDir, filter)
Definition at line 806 of file kfiledialog.cpp.
◆ getStartUrl()
This method implements the logic to determine the user's default directory to be listed.
E.g. the documents directory, home directory or a recently used directory.
- Parameters
-
startDir Starting directory or kfiledialog:///
URL. Refer to the KFileWidget documentation for more information on this parameter.recentDirClass If the kfiledialog:///
syntax is used, this will return the string to be passed to KRecentDirs::dir() and KRecentDirs::add().
- Returns
- The URL that should be listed by default (e.g. by KFileDialog or KDirSelectDialog).
- See also
- KFileWidget::KFileWidget()
- KFileWidget::getStartUrl(const QUrl& startDir, QString& recentDirClass);
Definition at line 963 of file kfiledialog.cpp.
◆ hideEvent()
|
overrideprotectedvirtual |
Reimplemented for saving the dialog geometry.
Reimplemented from QWidget.
Definition at line 953 of file kfiledialog.cpp.
◆ keepsLocation()
bool KFileDialog::keepsLocation | ( | ) | const |
- Returns
- whether the contents of the location edit are kept when changing directories.
Definition at line 916 of file kfiledialog.cpp.
◆ keyPressEvent()
|
overrideprotectedvirtual |
Reimplemented to animate the cancel button.
Reimplemented from QDialog.
Definition at line 941 of file kfiledialog.cpp.
◆ locationEdit()
KUrlComboBox * KFileDialog::locationEdit | ( | ) | const |
- Returns
- the combobox used to type the filename or full location of the file. You need to link to libkfile to use this widget.
Definition at line 885 of file kfiledialog.cpp.
◆ mode()
KFile::Modes KFileDialog::mode | ( | ) | const |
Returns the mode of the filedialog.
- See also
- setMode()
Definition at line 861 of file kfiledialog.cpp.
◆ okButton()
QPushButton * KFileDialog::okButton | ( | ) | const |
- Returns
- a pointer to the OK-Button in the filedialog. You may use it e.g. to set a custom text to it.
Definition at line 869 of file kfiledialog.cpp.
◆ operationMode()
KFileDialog::OperationMode KFileDialog::operationMode | ( | ) | const |
- Returns
- the current operation mode, Opening, Saving or Other. Default is Other.
Definition at line 933 of file kfiledialog.cpp.
◆ selectedFile()
QString KFileDialog::selectedFile | ( | ) | const |
Returns the full path of the selected file in the local filesystem.
(Local files only)
Definition at line 667 of file kfiledialog.cpp.
◆ selectedFiles()
QStringList KFileDialog::selectedFiles | ( | ) | const |
Returns a list of all selected local files.
Definition at line 675 of file kfiledialog.cpp.
◆ selectedUrl()
QUrl KFileDialog::selectedUrl | ( | ) | const |
- Returns
- The selected fully qualified filename.
Definition at line 651 of file kfiledialog.cpp.
◆ selectedUrls()
- Returns
- The list of selected URLs.
Definition at line 659 of file kfiledialog.cpp.
◆ selectionChanged
|
signal |
Emitted when the user hilights one or more files in multiselection mode.
Note: fileHighlighted() or fileSelected() are not emitted in multiselection mode. You may use selectedItems() to ask for the current highlighted items.
- See also
- fileSelected
◆ setConfirmOverwrite()
void KFileDialog::setConfirmOverwrite | ( | bool | enable | ) |
Sets whether the dialog should ask before accepting the selected file when KFileDialog::OperationMode is set to Saving.
In this case a KMessageBox appears for confirmation.
- Parameters
-
enable Set this to true to enable checking.
- Since
- 4.2
Definition at line 600 of file kfiledialog.cpp.
◆ setFilter()
void KFileDialog::setFilter | ( | const QString & | filter | ) |
Sets the filter to be used to filter
.
The filter can be either set as a space-separated list of mimetypes, which is recommended, or as a list of shell globs separated by '\n'
.
If the filter contains an unescaped '/'
, a mimetype filter is assumed. If you would like a '/'
visible in your filter it can be escaped with a '\'
. You can specify multiple mimetypes like this (separated with space):
When showing the filter to the user, the mimetypes will be automatically translated into their description like ‘PNG image’. Multiple mimetypes will be automatically summarized to a filter item ‘All supported files’. To add a filter item for all files matching '*'
, add application/octet-stream
as mimetype.
If the filter contains no unescaped '/'
, it is assumed that the filter contains conventional shell globs. Several filter items to select from can be separated by '\n'
. Every filter entry is defined through namefilter|text
to display. If no '
|' is found in the expression, just the namefilter is shown. Examples:
Note: The text to display is not parsed in any way. So, if you want to show the suffix to select by a specific filter, you must repeat it.
For better consistency across applications, it is recommended to use a mimetype filter.
- See also
- filterChanged
- setMimeFilter
Definition at line 308 of file kfiledialog.cpp.
◆ setInlinePreviewShown()
void KFileDialog::setInlinePreviewShown | ( | bool | show | ) |
Forces the inline previews to be shown or hidden, depending on show
.
- Parameters
-
show Whether to show inline previews or not.
- Since
- 4.2
Definition at line 375 of file kfiledialog.cpp.
◆ setKeepLocation()
void KFileDialog::setKeepLocation | ( | bool | keep | ) |
Sets whether the filename/url should be kept when changing directories.
This is for example useful when having a predefined filename where the full path for that file is searched.
This is implicitly set when operationMode() is KFileDialog::Saving
getSaveFileName() and getSaveUrl() set this to true by default, so that you can type in the filename and change the directory without having to type the name again.
Definition at line 909 of file kfiledialog.cpp.
◆ setLocationLabel()
void KFileDialog::setLocationLabel | ( | const QString & | text | ) |
Sets the text to be displayed in front of the selection.
The default is "Location". Most useful if you want to make clear what the location is used for.
Definition at line 301 of file kfiledialog.cpp.
◆ setMimeFilter()
void KFileDialog::setMimeFilter | ( | const QStringList & | types, |
const QString & | defaultType = QString() |
||
) |
Sets the filter up to specify the output type.
- Parameters
-
types a list of mimetypes that can be used as output format defaultType the default mimetype to use as output format, if any. If defaultType
is set, it will be set as the current item. Otherwise, a first item showing all the mimetypes will be created. Typically,defaultType
should be empty for loading and set for saving.
Do not use in conjunction with setFilter()
Definition at line 325 of file kfiledialog.cpp.
◆ setMode()
void KFileDialog::setMode | ( | KFile::Modes | m | ) |
Sets the mode of the dialog.
The mode is defined as (in kfile.h):
You can OR the values, e.g.
Definition at line 852 of file kfiledialog.cpp.
◆ setOperationMode()
void KFileDialog::setOperationMode | ( | KFileDialog::OperationMode | mode | ) |
Sets the operational mode of the filedialog to Saving
, Opening
or Other
.
This will set some flags that are specific to loading or saving files. E.g. setKeepLocation() makes mostly sense for a save-as dialog. So setOperationMode( KFileDialog::Saving ); sets setKeepLocation for example.
The mode Saving
, together with a default filter set via setMimeFilter() will make the filter combobox read-only.
The default mode is Opening
.
Call this method right after instantiating KFileDialog.
Definition at line 924 of file kfiledialog.cpp.
◆ setPreviewWidget()
void KFileDialog::setPreviewWidget | ( | KPreviewWidgetBase * | w | ) |
Adds a preview widget and enters the preview mode.
In this mode the dialog is split and the right part contains your preview widget.
Ownership is transferred to KFileDialog. You need to create the preview-widget with "new", i.e. on the heap.
- Parameters
-
w The widget to be used for the preview.
Definition at line 368 of file kfiledialog.cpp.
◆ setSelection()
void KFileDialog::setSelection | ( | const QString & | name | ) |
Sets the file name to preselect to name
.
This takes absolute URLs and relative file names.
Definition at line 429 of file kfiledialog.cpp.
◆ setStartDir()
|
static |
Used by KDirSelectDialog to share the dialog's start directory.
Definition at line 969 of file kfiledialog.cpp.
◆ setUrl()
void KFileDialog::setUrl | ( | const QUrl & | url, |
bool | clearforward = true |
||
) |
Sets the directory to view.
- Parameters
-
url URL to show. clearforward Indicates whether the forward queue should be cleared.
Definition at line 419 of file kfiledialog.cpp.
◆ sizeHint()
|
overridevirtual |
- See also
- QWidget::sizeHint()
Reimplemented from QDialog.
Definition at line 383 of file kfiledialog.cpp.
◆ toolBar()
KToolBar * KFileDialog::toolBar | ( | ) | const |
Returns a pointer to the toolbar.
You can use this to insert custom items into it, e.g.:
Definition at line 977 of file kfiledialog.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 6 2023 04:01:25 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.