udsentry.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 2000-2005 David Faure <faure@kde.org>
   Copyright (C) 2007 Norbert Frese <nf2@scheinwelt.at>
   Copyright (C) 2007 Thiago Macieira <thiago@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 version 2 as published by the Free Software Foundation.

   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 UDSENTRY_H
#define UDSENTRY_H

#include <QtCore/QString>
#include <QtCore/QList>
#include <QtCore/QSharedData>

#include <kio/kio_export.h>

namespace KIO
{
    class UDSEntryPrivate;
    class KIO_EXPORT UDSEntry
    {
    public:

        UDSEntry();
        UDSEntry(const UDSEntry &other);
        ~UDSEntry();
        UDSEntry &operator=(const UDSEntry &other);

        QString stringValue( uint field ) const;

        long long numberValue( uint field, long long defaultValue = 0 ) const;

        // Convenience methods.
        // Let's not add one method per field, only methods that have some more logic
        // than just calling stringValue(field) or numberValue(field).

        bool isDir() const;
        bool isLink() const;

        void insert(uint field, const QString& value);

        void insert(uint field, long long l);

        int count() const;

        bool contains(uint field) const;

        bool remove(uint field);

        QList<uint> listFields() const;

        void clear();

        enum StandardFieldTypes {
            // First let's define the item types: bit field

            UDS_STRING = 0x01000000,
            UDS_NUMBER   = 0x02000000,
            UDS_TIME   = 0x04000000 | UDS_NUMBER,

            // The rest isn't a bit field

            UDS_SIZE = 1 | UDS_NUMBER,
            UDS_SIZE_LARGE = 2 | UDS_NUMBER,
            UDS_USER = 3 | UDS_STRING,
            UDS_ICON_NAME = 4 | UDS_STRING,
            UDS_GROUP = 5 | UDS_STRING,
            UDS_NAME = 6 | UDS_STRING,
            UDS_LOCAL_PATH = 7 | UDS_STRING,
            UDS_HIDDEN = 8 | UDS_NUMBER,
            UDS_ACCESS = 9 | UDS_NUMBER,
            UDS_MODIFICATION_TIME = 10 | UDS_TIME,
            UDS_ACCESS_TIME = 11 | UDS_TIME,
            UDS_CREATION_TIME = 12 | UDS_TIME,
            UDS_FILE_TYPE = 13 | UDS_NUMBER,
            UDS_LINK_DEST = 14 | UDS_STRING,
            UDS_URL = 15 | UDS_STRING,
            UDS_MIME_TYPE = 16 | UDS_STRING,
            UDS_GUESSED_MIME_TYPE = 17 | UDS_STRING,
            UDS_XML_PROPERTIES = 18 | UDS_STRING,

            UDS_EXTENDED_ACL = 19 | UDS_NUMBER,
            UDS_ACL_STRING = 20 | UDS_STRING,
            UDS_DEFAULT_ACL_STRING = 21 | UDS_STRING,

            UDS_DISPLAY_NAME = 22 | UDS_STRING,
            UDS_TARGET_URL = 23 | UDS_STRING,

            UDS_DISPLAY_TYPE = 24 | UDS_STRING,

            UDS_NEPOMUK_URI = 25 | UDS_STRING,

            UDS_ICON_OVERLAY_NAMES = 26 | UDS_STRING,

            UDS_NEPOMUK_QUERY = 27 | UDS_STRING,

            UDS_COMMENT = 28 | UDS_STRING,

            UDS_DEVICE_ID = 29 | UDS_NUMBER,
            UDS_INODE = 30 | UDS_NUMBER,

            UDS_EXTRA = 100 | UDS_STRING,
            UDS_EXTRA_END = 140 | UDS_STRING
        };

    private:
        friend class UDSEntryPrivate;
        QSharedDataPointer<UDSEntryPrivate> d;
    };

    typedef QList<UDSEntry> UDSEntryList;
} // end namespace

KIO_EXPORT QDataStream & operator<< ( QDataStream & s, const KIO::UDSEntry & a );
KIO_EXPORT QDataStream & operator>> ( QDataStream & s, KIO::UDSEntry & a );

#endif /*UDSENTRY_H*/