kfileitem.h

Go to the documentation of this file.

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

#include <sys/stat.h>

#include <kio/global.h>
#include <kio/udsentry.h>
#include <kurl.h>

#include <kacl.h>
#include <kmimetype.h>
#include <kfilemetainfo.h>
#include <kdatetime.h>
#include <QtCore/QList>

class KFileItemPrivate;

class KIO_EXPORT KFileItem
{
public:
    enum { Unknown = static_cast<mode_t>(-1) };

    enum FileTimes {
        // warning: don't change without looking at the Private class
        ModificationTime = 0,
        AccessTime = 1,
        CreationTime = 2
        //ChangeTime
    };

    KFileItem();

    KFileItem( const KIO::UDSEntry& entry, const KUrl& itemOrDirUrl,
               bool delayedMimeTypes = false,
               bool urlIsDirectory = false );

    KFileItem( mode_t mode, mode_t permissions, const KUrl& url,
               bool delayedMimeTypes = false );

    KFileItem( const KUrl &url, const QString &mimeType, mode_t mode );

    KFileItem(const KFileItem& other);
    KFileItem& operator=(const KFileItem& other);

    ~KFileItem();

    void refresh();

    void refreshMimeType();

    KUrl url() const;

    void setUrl( const KUrl &url );

    void setName( const QString &name );

    mode_t permissions() const;

    QString permissionsString() const;

    bool hasExtendedACL() const;

    KACL ACL() const;

    KACL defaultACL() const;

    mode_t mode() const;

    QString user() const;

    QString group() const;

    bool isLink() const;

    bool isDir() const;

    bool isFile() const;

    bool isReadable() const;

    bool isWritable() const;

    bool isHidden() const;

    bool isDesktopFile() const;

    QString linkDest() const;

    KUrl targetUrl() const;

    KUrl nepomukUri() const;

    QString localPath() const;

    KIO::filesize_t size() const;

    KDateTime time( FileTimes which ) const;
#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED time_t time( unsigned int which ) const;
#endif

    QString timeString( FileTimes which = ModificationTime ) const;
#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED QString timeString( unsigned int which) const;
#endif

    bool isLocalFile() const;

    QString text() const;

    QString name( bool lowerCase = false ) const;

    QString mimetype() const;

    KMimeType::Ptr determineMimeType() const;

    KMimeType::Ptr mimeTypePtr() const;

    bool isMimeTypeKnown() const;

    QString mimeComment() const;

    QString iconName() const;

    QPixmap pixmap( int _size, int _state=0 ) const;

    QStringList overlays() const;

    QString comment() const;

    QString getStatusBarInfo() const;

    QString getToolTipText(int maxcount = 6) const;

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED bool acceptsDrops() const;
#endif

    void run( QWidget* parentWidget = 0 ) const;

    KIO::UDSEntry entry() const;

    bool isMarked() const;
    void mark();
    void unmark();

    bool isRegularFile() const;

    bool cmp( const KFileItem & item ) const;

    bool operator==(const KFileItem& other) const;

    bool operator!=(const KFileItem& other) const;


    operator QVariant() const;

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void setExtraData( const void *key, void *value );
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED const void * extraData( const void *key ) const;
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void removeExtraData( const void *key );
#endif

    void setMetaInfo( const KFileMetaInfo & info ) const;

    KFileMetaInfo metaInfo(bool autoget = true,
                           int what = KFileMetaInfo::ContentInfo | KFileMetaInfo::TechnicalInfo) const;

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void assign( const KFileItem & item );
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void setUDSEntry( const KIO::UDSEntry& entry, const KUrl& url,
                                     bool delayedMimeTypes = false,
                                     bool urlIsDirectory = false );
#endif

    KUrl mostLocalUrl(bool &local) const; // KDE4 TODO: bool* local = 0

    KUrl mostLocalUrl() const; // KDE5: merge with above version

    bool isNull() const;

private:
    QSharedDataPointer<KFileItemPrivate> d;

private:
    KIO_EXPORT friend QDataStream & operator<< ( QDataStream & s, const KFileItem & a );
    KIO_EXPORT friend QDataStream & operator>> ( QDataStream & s, KFileItem & a );
};

Q_DECLARE_METATYPE(KFileItem)

Q_CORE_EXPORT uint qHash(const QString &key);
inline uint qHash(const KFileItem& item){ return qHash(item.url().url()); }

class KIO_EXPORT KFileItemList : public QList<KFileItem>
{
public:
  KFileItemList();

  KFileItemList( const QList<KFileItem> &items );

  KFileItem findByName( const QString& fileName ) const;

  KFileItem findByUrl( const KUrl& url ) const;

  KUrl::List urlList() const;

  KUrl::List targetUrlList() const;

  // TODO KDE-5 add d pointer here so that we can merge KFileItemListProperties into KFileItemList
};

KIO_EXPORT QDataStream & operator<< ( QDataStream & s, const KFileItem & a );
KIO_EXPORT QDataStream & operator>> ( QDataStream & s, KFileItem & a );

KIO_EXPORT QDebug operator<<(QDebug stream, const KFileItem& item);

#endif