kfilewidget.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>
                  2008 Rafael Fernández López <ereslibre@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 KFILEWIDGET_H
#define KFILEWIDGET_H

#include "kfile_export.h"
#include "kabstractfilewidget.h"
#include <QtGui/QWidget>

class KJob;
class KFileItem;
class KDirOperator;

class KFILE_EXPORT KFileWidget : public QWidget, public KAbstractFileWidget
{
    Q_OBJECT
    Q_INTERFACES(KAbstractFileWidget)
public:
    KFileWidget(const KUrl& startDir, QWidget *parent);

    virtual ~KFileWidget();

    virtual KUrl selectedUrl() const;

    virtual KUrl::List selectedUrls() const;

    virtual KUrl baseUrl() const;

    virtual QString selectedFile() const;

    virtual QStringList selectedFiles() const;

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

    virtual void setSelection(const QString& name);

    virtual void setOperationMode( OperationMode );

    virtual OperationMode operationMode() const;

    virtual void setKeepLocation( bool keep );

    virtual bool keepsLocation() const;

    virtual void setFilter(const QString& filter);

    virtual QString currentFilter() const;

    virtual KMimeType::Ptr currentFilterMimeType();

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

    virtual QString currentMimeFilter() const;

    virtual void clearFilter();

    virtual void setPreviewWidget(KPreviewWidgetBase *w);

    virtual void setMode( KFile::Modes m );

    virtual KFile::Modes mode() const;

    virtual void setLocationLabel(const QString& text);

    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 KUrl getStartUrl( const KUrl& startDir, QString& recentDirClass, QString& fileName );

    static void setStartDir( const KUrl& directory );

    virtual void setCustomWidget(QWidget* widget);

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

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

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

protected:
    virtual void resizeEvent(QResizeEvent* event);
    virtual void showEvent(QShowEvent* event);
    virtual bool eventFilter(QObject* watched, QEvent* event);

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 );

    void accepted();

public:
    KDirOperator* dirOperator();

    void readConfig( KConfigGroup& group );

private:
    friend class KFileWidgetPrivate;
    KFileWidgetPrivate* const d;

    Q_PRIVATE_SLOT(d, void _k_slotLocationChanged(const QString&))
    Q_PRIVATE_SLOT(d, void _k_urlEntered(const KUrl&))
    Q_PRIVATE_SLOT(d, void _k_enterUrl(const KUrl&))
    Q_PRIVATE_SLOT(d, void _k_enterUrl(const QString&))
    Q_PRIVATE_SLOT(d, void _k_locationAccepted(const QString&))
    Q_PRIVATE_SLOT(d, void _k_slotFilterChanged())
    Q_PRIVATE_SLOT(d, void _k_fileHighlighted(const KFileItem&))
    Q_PRIVATE_SLOT(d, void _k_fileSelected(const KFileItem&))
    Q_PRIVATE_SLOT(d, void _k_slotLoadingFinished())
    Q_PRIVATE_SLOT(d, void _k_fileCompletion(const QString&))
    Q_PRIVATE_SLOT(d, void _k_toggleSpeedbar(bool))
    Q_PRIVATE_SLOT(d, void _k_toggleBookmarks(bool))
    Q_PRIVATE_SLOT(d, void _k_slotAutoSelectExtClicked())
    Q_PRIVATE_SLOT(d, void _k_placesViewSplitterMoved(int, int))
    Q_PRIVATE_SLOT(d, void _k_activateUrlNavigator())
    Q_PRIVATE_SLOT(d, void _k_zoomOutIconsSize())
    Q_PRIVATE_SLOT(d, void _k_zoomInIconsSize())
    Q_PRIVATE_SLOT(d, void _k_slotIconSizeSliderMoved(int))
    Q_PRIVATE_SLOT(d, void _k_slotIconSizeChanged(int))
};

#endif /* KABSTRACTFILEWIDGET_H */