qgsprojectmetadata.h

Go to the documentation of this file.

/***************************************************************************
                             qgsprojectmetadata.h
                             -------------------
    begin                : March 2018
    copyright            : (C) 2018 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 QGSPROJECTMETADATA_H
#define QGSPROJECTMETADATA_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsabstractmetadatabase.h"
 
#include <QDateTime>

class CORE_EXPORT QgsProjectMetadata : public QgsAbstractMetadataBase
{
    Q_GADGET
 
    Q_PROPERTY( QString author READ author )
 
  public:
    QgsProjectMetadata() = default;
 
    QgsProjectMetadata *clone() const override SIP_FACTORY;

    QString author() const;

    void setAuthor( const QString &author );

    QDateTime creationDateTime() const;

    void setCreationDateTime( const QDateTime &creationDateTime );
 
    bool readMetadataXml( const QDomElement &metadataElement, const QgsReadWriteContext &context = QgsReadWriteContext() ) override;
    bool writeMetadataXml( QDomElement &metadataElement, QDomDocument &document, const QgsReadWriteContext &context = QgsReadWriteContext() ) const override;
    void combine( const QgsAbstractMetadataBase *other ) override;
    void registerTranslations( QgsTranslationContext *translationContext ) const override;
 
    bool operator==( const QgsProjectMetadata &metadataOther ) const;
 
  private:
    /*
     * IMPORTANT!!!!!!
     *
     * Do NOT add anything to this class without also updating the schema
     * definition located at resources/qgis-resource-metadata.xsd
     *
     */
 
    QString mAuthor;
 
    /*
     * IMPORTANT!!!!!!
     *
     * Do NOT add anything to this class without also updating the schema
     * definition located at resources/qgis-resource-metadata.xsd
     *
     */
};
 
 
#endif // QGSPROJECTMETADATA_H