kdirmodel.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 2006 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 KDIRMODEL_H
#define KDIRMODEL_H

#include <QtCore/QAbstractItemModel>
#include <kio/kio_export.h>
#include <kfileitem.h>

class KDirLister;
class KDirModelPrivate;
class JobUrlCache;

class KIO_EXPORT KDirModel : public QAbstractItemModel
{
    Q_OBJECT

public:
    explicit KDirModel( QObject* parent = 0 );
    ~KDirModel();

    void setDirLister( KDirLister* dirLister );

    KDirLister* dirLister() const;

    KFileItem itemForIndex( const QModelIndex& index ) const;

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED QModelIndex indexForItem( const KFileItem* ) const;
#endif

    QModelIndex indexForItem( const KFileItem& ) const;

    QModelIndex indexForUrl(const KUrl& url) const;

    void expandToUrl(const KUrl& url);

    void itemChanged( const QModelIndex& index );

    /***
     * Useful "default" columns. Views can use a proxy to have more control over this.
     */
    enum ModelColumns {
        Name = 0,
        Size,
        ModifiedTime,
        Permissions,
        Owner,
        Group,
        Type,
        ColumnCount
    };

    enum { ChildCountUnknown = -1 };

    enum AdditionalRoles {
        // Note: use   printf "0x%08X\n" $(($RANDOM*$RANDOM))
        // to define additional roles.
        FileItemRole = 0x07A263FF,  
        ChildCountRole = 0x2C4D0A40, 
        HasJobRole = 0x01E555A5  
    };

    enum DropsAllowedFlag {
        NoDrops = 0,
        DropOnDirectory = 1, 
        DropOnAnyFile = 2, 
        DropOnLocalExecutable = 4 
    };
    Q_DECLARE_FLAGS(DropsAllowed, DropsAllowedFlag)

    
    void setDropsAllowed(DropsAllowed dropsAllowed);

    virtual bool canFetchMore ( const QModelIndex & parent ) const;
    virtual int columnCount ( const QModelIndex & parent = QModelIndex() ) const;
    virtual QVariant data ( const QModelIndex & index, int role = Qt::DisplayRole ) const;
    virtual bool dropMimeData ( const QMimeData * data, Qt::DropAction action, int row, int column, const QModelIndex & parent );
    virtual void fetchMore ( const QModelIndex & parent );
    virtual Qt::ItemFlags flags ( const QModelIndex & index ) const;
    virtual bool hasChildren ( const QModelIndex & parent = QModelIndex() ) const;
    virtual QVariant headerData ( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const;
    virtual QModelIndex index ( int row, int column, const QModelIndex & parent = QModelIndex() ) const;
    virtual QMimeData * mimeData ( const QModelIndexList & indexes ) const;
    virtual QStringList mimeTypes () const;
    virtual QModelIndex parent ( const QModelIndex & index ) const;
    virtual int rowCount ( const QModelIndex & parent = QModelIndex() ) const;
    virtual bool setData ( const QModelIndex & index, const QVariant & value, int role = Qt::EditRole );
    virtual void sort ( int column, Qt::SortOrder order = Qt::AscendingOrder );


    static KUrl::List simplifiedUrlList( const KUrl::List & urls );

    void requestSequenceIcon(const QModelIndex& index, int sequenceIndex);

    void setJobTransfersVisible(bool value);

    bool jobTransfersVisible() const;

Q_SIGNALS:
    void expand(const QModelIndex& index);
    void needSequenceIcon(const QModelIndex& index, int sequenceIndex);

private:
    // Make those private, they shouldn't be called by applications
    virtual bool insertRows(int , int, const QModelIndex & = QModelIndex());
    virtual bool insertColumns(int, int, const QModelIndex & = QModelIndex());
    virtual bool removeRows(int, int, const QModelIndex & = QModelIndex());
    virtual bool removeColumns(int, int, const QModelIndex & = QModelIndex());

private:
    friend class KDirModelPrivate;
    KDirModelPrivate *const d;

    Q_PRIVATE_SLOT( d, void _k_slotNewItems(const KUrl&, const KFileItemList&) )
    Q_PRIVATE_SLOT( d, void _k_slotDeleteItems(const KFileItemList&) )
    Q_PRIVATE_SLOT( d, void _k_slotRefreshItems(const QList<QPair<KFileItem, KFileItem> >&) )
    Q_PRIVATE_SLOT( d, void _k_slotClear() )
    Q_PRIVATE_SLOT( d, void _k_slotRedirection(const KUrl&, const KUrl&) )
    Q_PRIVATE_SLOT( d, void _k_slotJobUrlsChanged(const QStringList&))
};

Q_DECLARE_OPERATORS_FOR_FLAGS(KDirModel::DropsAllowed)

#endif /* KDIRMODEL_H */