kdiroperator.h

Go to the documentation of this file.

// -*- c++ -*-
/* This file is part of the KDE libraries
    Copyright (C) 1999 Stephan Kulow <coolo@kde.org>
    2000,2001 Carsten Pfeiffer <pfeiffer@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 KDIROPERATOR_H_
#define KDIROPERATOR_H_

#include <QtGui/QWidget>
#include <QtCore/QStack>
#include <QtGui/QStyleOptionViewItem>

#include <ktoggleaction.h>
#include <kcompletion.h>
#include <kdirlister.h>
#include <kfileitem.h>
#include <kfile.h>
#include <kfile_export.h>

class QAbstractItemView;
class QModelIndex;
class QProgressBar;

class KAction;
class KActionCollection;
class KActionMenu;
class KDirLister;
class KPreviewWidgetBase;
class KFilePreviewGenerator;

namespace KIO
{
class CopyJob;
class DeleteJob;
}

class KFILE_EXPORT KDirOperator : public QWidget
{
    Q_OBJECT

public:
    enum ActionType
    {
        SortActions =  1,
        ViewActions =  2,
        NavActions  =  4,
        FileActions =  8,
        AllActions  = 15
    };

    explicit KDirOperator(const KUrl& urlName = KUrl(),
                          QWidget *parent = 0);
    virtual ~KDirOperator();

    virtual void setShowHiddenFiles(bool s);

    bool showHiddenFiles() const;

    void close();

    void setNameFilter(const QString& filter);

    QString nameFilter() const;

    void setMimeFilter(const QStringList& mimetypes);

    QStringList mimeFilter() const;

    void setNewFileMenuSupportedMimeTypes(const QStringList& mime);

    QStringList newFileMenuSupportedMimeTypes() const;

    void clearFilter();

    KUrl url() const;

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

    void setCurrentItem(const QString& url);

    void setCurrentItem(const KFileItem& item);

    void setCurrentItems(const QStringList& urls);

    void setCurrentItems(const KFileItemList& items);

    virtual void setView(QAbstractItemView *view);

    QAbstractItemView* view() const;

    virtual void setView(KFile::FileView viewKind);

    void setSorting(QDir::SortFlags);

    QDir::SortFlags sorting() const;

    bool isRoot() const;

    KDirLister* dirLister() const;

    QProgressBar* progressBar() const;

    virtual void setMode(KFile::Modes m);
    KFile::Modes mode() const;

    virtual void setPreviewWidget(KPreviewWidgetBase *w);

    KFileItemList selectedItems() const;

    bool isSelected(const KFileItem &item) const;

    int numDirs() const;

    int numFiles() const;

    KCompletion* completionObject() const;

    KCompletion* dirCompletionObject() const;

    KActionCollection* actionCollection() const;

    virtual void setViewConfig(KConfigGroup& configGroup);

    /*
     * @returns the group set by setViewConfig configuration.
     */
    KConfigGroup* viewConfigGroup() const;

    virtual void readConfig(const KConfigGroup& configGroup);

    virtual void writeConfig(KConfigGroup& configGroup);

    void setOnlyDoubleClickSelectsFiles(bool enable);

    bool onlyDoubleClickSelectsFiles() const;

    virtual bool mkdir(const QString& directory, bool enterDirectory = true);

    virtual KIO::DeleteJob* del(const KFileItemList& items, QWidget *parent = 0,
                                bool ask = true, bool showProgress = true);

    void clearHistory();

    virtual void setEnableDirHighlighting(bool enable);

    bool dirHighlighting() const;

    bool dirOnlyMode() const;

    static bool dirOnlyMode(uint mode);

    void setupMenu(int whichActions);

    virtual void setAcceptDrops(bool b);

    virtual void setDropOptions(int options);

    virtual KIO::CopyJob* trash(const KFileItemList& items, QWidget *parent,
                                bool ask = true, bool showProgress = true);

    KFilePreviewGenerator *previewGenerator() const;

    void setInlinePreviewShown(bool show);

    QStyleOptionViewItem::Position decorationPosition() const;

    void setDecorationPosition(QStyleOptionViewItem::Position position);

    bool isInlinePreviewShown() const;

    int iconsZoom() const;

    void setIsSaving(bool isSaving);

    bool isSaving() const;

protected:
    virtual QAbstractItemView* createView(QWidget *parent, KFile::FileView viewKind);

    virtual void setDirLister(KDirLister *lister);

    virtual void resizeEvent(QResizeEvent *event);

    virtual void keyPressEvent(QKeyEvent * event);

    void setupActions();

    void updateSortActions();

    void updateViewActions();

    void setupMenu();

    void prepareCompletionObjects();

    bool checkPreviewSupport();

    virtual void activatedMenu(const KFileItem &item, const QPoint &pos);

    virtual void changeEvent(QEvent *event);

    virtual bool eventFilter(QObject *watched, QEvent *event);

public Q_SLOTS:
    virtual void back();

    virtual void forward();

    virtual void home();

    virtual void cdUp();

    void updateDir();

    virtual void rereadDir();

    virtual void mkdir();

    virtual void deleteSelected();

    void updateSelectionDependentActions();

    QString makeCompletion(const QString&);

    QString makeDirCompletion(const QString&);

    virtual void trashSelected();

    void setIconsZoom(int value);

protected Q_SLOTS:
    void resetCursor();

    void pathChanged();

    virtual void selectDir(const KFileItem &item);

    void selectFile(const KFileItem &item);

    void highlightFile(const KFileItem &item);

    void sortByName();

    void sortBySize();

    void sortByDate();

    void sortByType();

    void sortReversed();

    void toggleDirsFirst();

    void toggleIgnoreCase();

    void slotCompletionMatch(const QString &match);

Q_SIGNALS:
    void urlEntered(const KUrl&);
    void updateInformation(int files, int dirs);
    void completion(const QString&);
    void finishedLoading();

    void viewChanged(QAbstractItemView *newView);

    void fileHighlighted(const KFileItem &item);
    void dirActivated(const KFileItem &item);
    void fileSelected(const KFileItem &item);
    void dropped(const KFileItem &item, QDropEvent *event, const KUrl::List &urls);

    void contextMenuAboutToShow(const KFileItem& item, QMenu* menu);

    void currentIconSizeChanged(int size);

private:
    class Private;
    Private* const d;

    Q_PRIVATE_SLOT( d, void _k_slotDetailedView() )
    Q_PRIVATE_SLOT( d, void _k_slotSimpleView() )
    Q_PRIVATE_SLOT( d, void _k_slotTreeView() )
    Q_PRIVATE_SLOT( d, void _k_slotDetailedTreeView() )
    Q_PRIVATE_SLOT( d, void _k_slotToggleHidden(bool) )
    Q_PRIVATE_SLOT( d, void _k_togglePreview(bool) )
    Q_PRIVATE_SLOT( d, void _k_toggleInlinePreviews(bool) )
    Q_PRIVATE_SLOT( d, void _k_slotOpenFileManager() )
    Q_PRIVATE_SLOT( d, void _k_slotSortByName() )
    Q_PRIVATE_SLOT( d, void _k_slotSortBySize() )
    Q_PRIVATE_SLOT( d, void _k_slotSortByDate() )
    Q_PRIVATE_SLOT( d, void _k_slotSortByType() )
    Q_PRIVATE_SLOT( d, void _k_slotSortReversed(bool) )
    Q_PRIVATE_SLOT( d, void _k_slotToggleDirsFirst() )
    Q_PRIVATE_SLOT( d, void _k_slotToggleIgnoreCase() )
    Q_PRIVATE_SLOT( d, void _k_slotStarted() )
    Q_PRIVATE_SLOT( d, void _k_slotProgress(int) )
    Q_PRIVATE_SLOT( d, void _k_slotShowProgress() )
    Q_PRIVATE_SLOT( d, void _k_slotIOFinished() )
    Q_PRIVATE_SLOT( d, void _k_slotCanceled() )
    Q_PRIVATE_SLOT( d, void _k_slotRedirected(const KUrl&) )
    Q_PRIVATE_SLOT( d, void _k_slotProperties() )
    Q_PRIVATE_SLOT( d, void _k_slotActivated(const QModelIndex&) )
    Q_PRIVATE_SLOT( d, void _k_slotSelectionChanged() )
    Q_PRIVATE_SLOT( d, void _k_openContextMenu(const QPoint&) )
    Q_PRIVATE_SLOT( d, void _k_triggerPreview(const QModelIndex&) )
    Q_PRIVATE_SLOT( d, void _k_showPreview() )
    Q_PRIVATE_SLOT( d, void _k_slotSplitterMoved(int, int) )
    Q_PRIVATE_SLOT( d, void _k_assureVisibleSelection() )
    Q_PRIVATE_SLOT( d, void _k_synchronizeSortingState(int, Qt::SortOrder) )
    Q_PRIVATE_SLOT( d, void _k_slotChangeDecorationPosition() )
    Q_PRIVATE_SLOT( d, void _k_slotExpandToUrl(const QModelIndex&) )
    Q_PRIVATE_SLOT( d, void _k_slotItemsChanged() )
    Q_PRIVATE_SLOT( d, void _k_slotDirectoryCreated(const KUrl&) )
};

#endif