/*****************************************************************************
 *  
 *   This file is part of the Utopia Documents application.
 *       Copyright (c) 2008-2017 Lost Island Labs
 *           <info@utopiadocs.com>
 *   
 *   Utopia Documents is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU GENERAL PUBLIC LICENSE VERSION 3 as
 *   published by the Free Software Foundation.
 *   
 *   Utopia Documents 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 General
 *   Public License for more details.
 *   
 *   In addition, as a special exception, the copyright holders give
 *   permission to link the code of portions of this program with the OpenSSL
 *   library under certain conditions as described in each individual source
 *   file, and distribute linked combinations including the two.
 *   
 *   You must obey the GNU General Public License in all respects for all of
 *   the code used other than OpenSSL. If you modify file(s) with this
 *   exception, you may extend this exception to your version of the file(s),
 *   but you are not obligated to do so. If you do not wish to do so, delete
 *   this exception statement from your version.
 *   
 *   You should have received a copy of the GNU General Public License
 *   along with Utopia Documents. If not, see <http://www.gnu.org/licenses/>
 *  
 *****************************************************************************/

#ifndef PAPYRO_ANNOTATIONRESULTITEM_H
#define PAPYRO_ANNOTATIONRESULTITEM_H

#include <papyro/resultitem.h>

#if !defined(Q_MOC_RUN) || QT_VERSION >= 0x050000
#  include <spine/Annotation.h>
#endif

#include <QUrl>
#include <QUuid>

namespace Papyro
{

    class AnnotationResultItemPrivate;
    class AnnotationResultItem : public ResultItem
    {
    public:
        AnnotationResultItem(Spine::AnnotationHandle annotation);
        ~AnnotationResultItem();

        QString title() const;
        QString description() const;

        QString authorUri() const;
        QString semanticType() const;
        QString sourceDatabase() const;
        QString sourceDescription() const;
        QUrl sourceIcon() const;
        QUuid sourcePlugin() const;

        QString cssId() const;
        bool defaultness() const;
        bool headless() const;
        QString highlight() const;
        int weight() const;

        QString value(const QString & key) const;
        QStringList values(const QString & key) const;

        ResultItem::State contentState() const;
        QStringList content(const QString & key) const;
        QStringList contentKeys() const;
        void generateContent();

        QList< Spine::CapabilityHandle > capabilities() const;

        Spine::AnnotationHandle annotation() const;

    private:
        AnnotationResultItemPrivate * d;
    };

}

#endif // PAPYRO_ANNOTATIONRESULTITEM_H
