kfiledialog.h

Go to the documentation of this file.

// -*- c++ -*-
/* This file is part of the KDE libraries
    Copyright (C) 1997, 1998 Richard Moore <rich@kde.org>
                  1998 Stephan Kulow <coolo@kde.org>
                  1998 Daniel Grana <grana@ie.iwi.unibe.ch>
                  2000,2001 Carsten Pfeiffer <pfeiffer@kde.org>
                  2001 Frerich Raabe <raabe@kde.org>
                  2007 David Faure <faure@kde.org>
                  2009 David Jarvie <djarvie@kde.org>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KFILEDIALOG_H
#define KFILEDIALOG_H

#include <kdialog.h>
#include <kfile.h>
#include <kurl.h>
#include <kmimetype.h>

class KAbstractFileWidget;
class KFileWidget;

class KActionCollection;
class KUrlComboBox;
class KFileFilterCombo;
class KPushButton;
class KToolBar;
class KPreviewWidgetBase;

class KFileDialogPrivate;

class KIO_EXPORT KFileDialog : public KDialog
{
    Q_OBJECT

public:

    enum OperationMode { Other = 0, Opening, Saving };

    enum Option {
        ConfirmOverwrite  = 0x01,   
        ShowInlinePreview = 0x02    
    };
    Q_DECLARE_FLAGS(Options, Option)

    
    KFileDialog( const KUrl& startDir, const QString& filter,
                 QWidget *parent, QWidget* widget = 0 );


    ~KFileDialog();

    KUrl selectedUrl() const;

    KUrl::List selectedUrls() const;

    KUrl baseUrl() const;

    QString selectedFile() const;

    QStringList selectedFiles() const;

    void setUrl(const KUrl &url, bool clearforward = true);

    void setSelection(const QString& name);

    void setOperationMode( KFileDialog::OperationMode );

    OperationMode operationMode() const;

    void setKeepLocation( bool keep );

    bool keepsLocation() const;

    void setFilter(const QString& filter);

    QString currentFilter() const;

    KMimeType::Ptr currentFilterMimeType();

    void setMimeFilter( const QStringList& types,
                        const QString& defaultType = QString() );

    QString currentMimeFilter() const;

    void clearFilter();

    void setPreviewWidget(KPreviewWidgetBase *w);

    void setInlinePreviewShown(bool show);

    void setConfirmOverwrite(bool enable);

    virtual QSize sizeHint() const;

    static QString getOpenFileName( const KUrl& startDir= KUrl(),
                                    const QString& filter= QString(),
                                    QWidget *parent= 0,
                                    const QString& caption = QString() );


   static QString getOpenFileNameWId( const KUrl& startDir,
                                      const QString& filter,
                                      WId parent_id, const QString& caption );

    static QStringList getOpenFileNames( const KUrl& startDir= KUrl(),
                                         const QString& filter = QString(),
                                         QWidget *parent = 0,
                                         const QString& caption= QString() );



    static KUrl getOpenUrl( const KUrl& startDir = KUrl(),
                            const QString& filter = QString(),
                            QWidget *parent= 0,
                            const QString& caption = QString() );



    static KUrl::List getOpenUrls( const KUrl& startDir = KUrl(),
                                   const QString& filter = QString(),
                                   QWidget *parent = 0,
                                   const QString& caption = QString() );



    static QString getSaveFileName( const KUrl& startDir = KUrl(),
                                    const QString& filter = QString(),
                                    QWidget *parent = 0,
                                    const QString& caption = QString() );

    static QString getSaveFileName( const KUrl& startDir,
                                    const QString& filter,
                                    QWidget *parent,
                                    const QString& caption,
                                    Options options );


    static QString getSaveFileNameWId( const KUrl &startDir, const QString& filter,
                                       WId parent_id,
                                       const QString& caption );

    static QString getSaveFileNameWId( const KUrl &startDir, const QString& filter,
                                       WId parent_id,
                                       const QString& caption,
                                       Options options );

    static KUrl getSaveUrl( const KUrl& startDir = KUrl(),
                            const QString& filter = QString(),
                            QWidget *parent = 0,
                            const QString& caption = QString() );

    static KUrl getSaveUrl( const KUrl& startDir,
                            const QString& filter,
                            QWidget *parent,
                            const QString& caption,
                            Options options );


    static QString getExistingDirectory( const KUrl& startDir = KUrl(),
                                         QWidget * parent = 0,
                                         const QString& caption= QString() );

    static KUrl getExistingDirectoryUrl( const KUrl& startDir = KUrl(),
                                         QWidget * parent = 0,
                                         const QString& caption= QString() );

    static KUrl getImageOpenUrl( const KUrl& startDir = KUrl(),
                                 QWidget *parent = 0,
                                 const QString& caption = QString() );

    void setMode( KFile::Modes m );

    KFile::Modes mode() const;

    void setLocationLabel(const QString& text);

    KAbstractFileWidget* fileWidget();

    KToolBar *toolBar() const;

    KPushButton *okButton() const;

    KPushButton *cancelButton() const;

    KUrlComboBox *locationEdit() const;

    KFileFilterCombo *filterWidget() const;

    KActionCollection *actionCollection() const;

    static KUrl getStartUrl( const KUrl& startDir, QString& recentDirClass );

    static void setStartDir( const KUrl& directory );

#ifdef Q_WS_WIN
public Q_SLOTS:
    int exec();
#endif

Q_SIGNALS:
    void fileSelected(const KUrl&);
    QT_MOC_COMPAT void fileSelected(const QString&); // TODO KDE5: remove

    void fileHighlighted(const KUrl&);
    QT_MOC_COMPAT void fileHighlighted(const QString&); // TODO KDE5: remove

    void selectionChanged();

    void filterChanged( const QString& filter );

protected:
    virtual void keyPressEvent( QKeyEvent *e );

    virtual void hideEvent( QHideEvent *event );

protected Q_SLOTS:
    virtual void slotOk();
    virtual void accept();
    virtual void slotCancel();

private:
    Q_DISABLE_COPY(KFileDialog)

    KFileDialogPrivate * const d;
};

#endif