utils.h

Go to the documentation of this file.

/*
   This file is part of the Nepomuk KDE project.
   Copyright (C) 2010 Sebastian Trueg <trueg@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) version 3, or any
   later version accepted by the membership of KDE e.V. (or its
   successor approved by the membership of KDE e.V.), which shall
   act as a proxy defined in Section 6 of version 3 of the license.

   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
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef _NEPOMUK_UTILS_GLOBAL_H_
#define _NEPOMUK_UTILS_GLOBAL_H_

#include "nepomukutils_export.h"
#include "resource.h"

#include <QtCore/QFlags>
#include <QtCore/QDateTime>
#include <QtCore/QList>

#include "kurl.h"

namespace Nepomuk {
    class Variant;

    namespace Types {
        class Property;
    }

    namespace Utils {
        enum PropertyFormatFlag {
            NoPropertyFormatFlags = 0x0,

            WithKioLinks = 0x1
        };
        Q_DECLARE_FLAGS( PropertyFormatFlags, PropertyFormatFlag )

        
        NEPOMUKUTILS_EXPORT QString formatPropertyValue( const Nepomuk::Types::Property& property,
                                                         const Nepomuk::Variant& value,
                                                         const QList<Nepomuk::Resource>& resources = QList<Nepomuk::Resource>(),
                                                         PropertyFormatFlags flags = NoPropertyFormatFlags );

        NEPOMUKUTILS_EXPORT Nepomuk::Resource createCopyEvent( const KUrl& src,
                                                               const KUrl& dest,
                                                               const QDateTime& startTime = QDateTime(),
                                                               const KUrl& referrer = KUrl() );

        NEPOMUKUTILS_EXPORT void finishCopyEvent( Nepomuk::Resource& eventResource, const QDateTime& endTime );
    }
}

Q_DECLARE_OPERATORS_FOR_FLAGS( Nepomuk::Utils::PropertyFormatFlags )

#endif