k3fileview.h

Go to the documentation of this file.

// -*- c++ -*-
/* This file is part of the KDE libraries
    Copyright (C) 1997 Stephan Kulow <coolo@kde.org>
    Copyright (C) 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 KFILEVIEW_H
#define KFILEVIEW_H

class QPoint;
class QWidget;
class QDropEvent;
class KActionCollection;

#include "kde3support_export.h"
#include "kfileitem.h"
#include "kfile.h"

class KDE3SUPPORT_EXPORT K3FileViewSignaler : public QObject
{
    Q_OBJECT

public:
    void activate( const KFileItem &item );

    void highlightFile( const KFileItem &item );

    void activateMenu( const KFileItem &item, const QPoint& pos );

    void changeSorting( QDir::SortFlags sorting );

    void dropURLs( const KFileItem &item, QDropEvent *event, const KUrl::List &urls);

Q_SIGNALS:
    void dirActivated( const KFileItem &item );

    void sortingChanged( QDir::SortFlags );

    void fileHighlighted( const KFileItem &item );
    void fileSelected( const KFileItem &item );
    void activatedMenu( const KFileItem &item, const QPoint &pos );
    void dropped( const KFileItem &item, QDropEvent *event, const KUrl::List &urls );
};

class KDE3SUPPORT_EXPORT K3FileView {

public:
    K3FileView();

    virtual ~K3FileView();

    void addItemList(const KFileItemList &list);

    virtual QWidget *widget() = 0;

    QWidget *widget() const;

    void setCurrentItem( const QString &filename );

    virtual void setCurrentItem( const KFileItem &item ) = 0;

    virtual KFileItem currentFileItem() const = 0;

    virtual void clear();

    virtual void updateView(bool f = true);

    virtual void updateView(const KFileItem&);

    virtual void removeItem(const KFileItem &item);

    virtual void listingCompleted();

    QDir::SortFlags sorting() const;

    virtual void setSorting(QDir::SortFlags sort);

    bool isReversed() const;

    void sortReversed();

    uint count() const;

    uint numFiles() const;

    uint numDirs() const;

    virtual void setSelectionMode( KFile::SelectionMode sm );
    virtual KFile::SelectionMode selectionMode() const;

    enum ViewMode {
        Files       = 1,
        Directories = 2,
        All = Files | Directories
    };
    virtual void setViewMode( ViewMode vm );
    virtual ViewMode viewMode() const;

    QString viewName() const;

    void setViewName( const QString& name );

    virtual void setParentView(K3FileView *parent);

    virtual void insertItem( const KFileItem &i);

    virtual void clearView() = 0;

    virtual void ensureItemVisible( const KFileItem &i ) = 0;

    virtual void clearSelection() = 0;

    virtual void selectAll();

    virtual void invertSelection();

    virtual void setSelected(const KFileItem &, bool enable) = 0;

    virtual bool isSelected( const KFileItem & ) const = 0;

    KFileItemList selectedItems() const;

    KFileItemList items() const;

    virtual KFileItem firstFileItem() const = 0;
    virtual KFileItem nextItem( const KFileItem & ) const = 0;
    virtual KFileItem prevItem( const KFileItem & ) const = 0;

    void setOnlyDoubleClickSelectsFiles( bool enable );

    bool onlyDoubleClickSelectsFiles() const;

    bool updateNumbers(const KFileItem &i);

    virtual KActionCollection * actionCollection() const;

    K3FileViewSignaler * signaler() const;

    virtual void readConfig( KConfigGroup *);
    virtual void writeConfig( KConfigGroup *);

    enum DropOptions {
        AutoOpenDirs  = 1
    };
    virtual void setDropOptions(int options);

    int dropOptions();

    static QString sortingKey( const QString& value, bool isDir, QDir::SortFlags SortFlags);

    static QString sortingKey( KIO::filesize_t value, bool isDir,QDir::SortFlags SortFlags);

    static int autoOpenDelay();

protected:
    K3FileViewSignaler *sig;

private:
    class K3FileViewPrivate;
    K3FileViewPrivate* const d;
};

#endif // KFILEINFOLISTWIDGET_H