qgsacademicreference.h

Go to the documentation of this file.

/***************************************************************************
                             qgsacademicreference.h
                             -----------------
    begin                : August 2026
    copyright            : (C) 2026 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSACADEMICREFERENCE_H
#define QGSACADEMICREFERENCE_H
 
#include "qgis.h"
#include "qgis_core.h"

class CORE_EXPORT QgsAcademicReference
{
  public:
    QgsAcademicReference() = default;

    bool isValid() const { return mType != Qgis::AcademicReferenceType::Unknown; }

    static QgsAcademicReference createBook( const QStringList &authors, int year, const QString &title, const QString &publisher );

    static QgsAcademicReference createJournalArticle(
      const QStringList &authors, int year, const QString &title, const QString &journal, const QString &volume = QString(), const QString &issue = QString(), const QString &pages = QString()
    );

    static QgsAcademicReference createPresentation(
      const QStringList &authors, int year, const QString &title, const QString &meeting, const QString &publisher = QString(), const QString &pages = QString()
    );

    static QgsAcademicReference createWebPage( const QStringList &authors, int year, const QString &title, const QString &url );

    static QgsAcademicReference createPreprint( const QStringList &authors, int year, const QString &title, const QString &repository, const QString &url );

    Qgis::AcademicReferenceType type() const;

    void setType( Qgis::AcademicReferenceType type );

    QStringList authors() const;

    void setAuthors( const QStringList &authors );

    int year() const;

    void setYear( int year );

    QString title() const;

    void setTitle( const QString &title );

    QString journal() const;

    void setJournal( const QString &journal );

    QString volume() const;

    void setVolume( const QString &volume );

    QString issue() const;

    void setIssue( const QString &issue );

    QString pages() const;

    void setPages( const QString &pages );

    QString publisher() const;

    void setPublisher( const QString &publisher );

    QString url() const;

    void setUrl( const QString &url );

    QString asPlainText() const;

    QString asHtml() const;
 
  private:
    QString formatted( bool asHtml ) const;
 
    Qgis::AcademicReferenceType mType = Qgis::AcademicReferenceType::Unknown;
    QStringList mAuthors;
    int mYear = 0;
    QString mTitle;
    QString mJournal;
    QString mVolume;
    QString mIssue;
    QString mPages;
    QString mPublisher;
    QString mUrl;
};
 
#endif //QGSACADEMICREFERENCE_H