kabstractfilewidget.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>

    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 KABSTRACTFILEWIDGET_H
#define KABSTRACTFILEWIDGET_H

class KPreviewWidgetBase;

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

class KPushButton;
class KActionCollection;
class KToolBar;
class KFileWidgetPrivate;
class KUrlComboBox;
class KFileFilterCombo;

class KIO_EXPORT KAbstractFileWidget
{
public:
    virtual ~KAbstractFileWidget() {}

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

    virtual KUrl selectedUrl() const = 0;

    virtual KUrl::List selectedUrls() const = 0;

    virtual KUrl baseUrl() const = 0;

    virtual QString selectedFile() const = 0;

    virtual QStringList selectedFiles() const = 0;

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

    virtual void setSelection(const QString& name) = 0;

    virtual void setOperationMode( OperationMode ) = 0;

    virtual OperationMode operationMode() const = 0;

    virtual void setKeepLocation( bool keep ) = 0;

    virtual bool keepsLocation() const = 0;

    virtual void setFilter(const QString& filter) = 0;

    virtual QString currentFilter() const = 0;

    virtual KMimeType::Ptr currentFilterMimeType() = 0;

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

    virtual QString currentMimeFilter() const = 0;

    virtual void clearFilter() = 0;

   virtual void setPreviewWidget(KPreviewWidgetBase *w) = 0;

    virtual void setMode( KFile::Modes m ) = 0;

    virtual KFile::Modes mode() const = 0;

    virtual void setLocationLabel(const QString& text) = 0;

    virtual KToolBar *toolBar() const = 0;

    virtual KPushButton *okButton() const = 0;

    virtual KPushButton *cancelButton() const = 0;

    virtual KUrlComboBox *locationEdit() const = 0;

    virtual KFileFilterCombo *filterWidget() const = 0;

    virtual KActionCollection *actionCollection() const = 0;

    virtual void setCustomWidget(QWidget* widget) = 0;

    virtual void setCustomWidget(const QString& text, QWidget* widget) = 0;

    virtual void slotOk() = 0;
    virtual void accept() = 0;
    virtual void slotCancel() = 0;

    virtual void virtual_hook( int id, void* data ) = 0;

    void setConfirmOverwrite(bool enable){  // KDE5 TODO: make this virtual
        virtual_hook(0, static_cast<void*>(&enable));
    }

    void setInlinePreviewShown(bool show) { // KDE5 TODO: make this virtual
        virtual_hook(1, static_cast<void*>(&show));
    }
};

Q_DECLARE_INTERFACE(KAbstractFileWidget, "org.kde.KAbstractFileWidget")

#endif /* KABSTRACTFILEWIDGET_H */