Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                              qgsprojectmetadata.h
       3                 :            :                              -------------------
       4                 :            :     begin                : March 2018
       5                 :            :     copyright            : (C) 2018 by Nyall Dawson
       6                 :            :     email                : nyall dot dawson at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSPROJECTMETADATA_H
      19                 :            : #define QGSPROJECTMETADATA_H
      20                 :            : 
      21                 :            : #include "qgis_sip.h"
      22                 :            : #include "qgis_core.h"
      23                 :            : #include "qgsabstractmetadatabase.h"
      24                 :            : 
      25                 :            : #include <QDateTime>
      26                 :            : 
      27                 :            : /**
      28                 :            :  * \ingroup core
      29                 :            :  * \class QgsProjectMetadata
      30                 :            :  * \brief A structured metadata store for a map layer.
      31                 :            :  *
      32                 :            :  * QgsProjectMetadata handles storage and management of the metadata
      33                 :            :  * for a QgsProject. This class is an internal QGIS format with a common
      34                 :            :  * metadata structure, which allows for code to access the metadata properties for
      35                 :            :  * projects in a uniform way.
      36                 :            :  *
      37                 :            :  * The metadata store is designed to be compatible with the Dublin Core metadata
      38                 :            :  * specifications, and will be expanded to allow compatibility with ISO specifications
      39                 :            :  * in future releases. However, the QGIS internal schema does not represent a superset
      40                 :            :  * of all existing metadata schemas and accordingly conversion from specific
      41                 :            :  * metadata formats to QgsProjectMetadata may result in a loss of information.
      42                 :            :  *
      43                 :            :  * This class is designed to follow the specifications detailed in
      44                 :            :  * the schema definition available at resources/qgis-project-metadata.xsd
      45                 :            :  * within the QGIS source code.
      46                 :            :  *
      47                 :            :  * Metadata can be validated through the use of QgsLayerMetadataValidator
      48                 :            :  * subclasses. E.g. validating against the native QGIS metadata schema can be performed
      49                 :            :  * using QgsNativeProjectMetadataValidator.
      50                 :            :  *
      51                 :            :  * \since QGIS 3.2
      52                 :            :  */
      53                 :         19 : class CORE_EXPORT QgsProjectMetadata : public QgsAbstractMetadataBase
      54                 :            : {
      55                 :            :   public:
      56                 :            : 
      57                 :            :     /**
      58                 :            :      * Constructor for QgsProjectMetadata.
      59                 :            :      */
      60                 :         13 :     QgsProjectMetadata() = default;
      61                 :            : 
      62                 :            :     QgsProjectMetadata *clone() const override SIP_FACTORY;
      63                 :            : 
      64                 :            :     /**
      65                 :            :      * Returns the project author string.
      66                 :            :      * \see setAuthor()
      67                 :            :      */
      68                 :            :     QString author() const;
      69                 :            : 
      70                 :            :     /**
      71                 :            :      * Sets the project \a author string
      72                 :            :      * \see author()
      73                 :            :      */
      74                 :            :     void setAuthor( const QString &author );
      75                 :            : 
      76                 :            :     /**
      77                 :            :      * Returns the project's creation date/timestamp.
      78                 :            :      * \see setCreationDateTime()
      79                 :            :      */
      80                 :            :     QDateTime creationDateTime() const;
      81                 :            : 
      82                 :            :     /**
      83                 :            :      * Sets the project's creation date/timestamp.
      84                 :            :      * \see creationDateTime()
      85                 :            :      */
      86                 :            :     void setCreationDateTime( const QDateTime &creationDateTime );
      87                 :            : 
      88                 :            :     bool readMetadataXml( const QDomElement &metadataElement ) override;
      89                 :            :     bool writeMetadataXml( QDomElement &metadataElement, QDomDocument &document ) const override;
      90                 :            : 
      91                 :            :     bool operator==( const QgsProjectMetadata &metadataOther ) const;
      92                 :            : 
      93                 :            :   private:
      94                 :            : 
      95                 :            :     /*
      96                 :            :      * IMPORTANT!!!!!!
      97                 :            :      *
      98                 :            :      * Do NOT add anything to this class without also updating the schema
      99                 :            :      * definition located at resources/qgis-resource-metadata.xsd
     100                 :            :      *
     101                 :            :      */
     102                 :            : 
     103                 :            :     QString mAuthor;
     104                 :            : 
     105                 :            :     QDateTime mCreationDateTime;
     106                 :            : 
     107                 :            :     /*
     108                 :            :      * IMPORTANT!!!!!!
     109                 :            :      *
     110                 :            :      * Do NOT add anything to this class without also updating the schema
     111                 :            :      * definition located at resources/qgis-resource-metadata.xsd
     112                 :            :      *
     113                 :            :      */
     114                 :            : 
     115                 :            : };
     116                 :            : 
     117                 :            : 
     118                 :            : #endif // QGSPROJECTMETADATA_H