mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
99 lines
3.2 KiB
Plaintext
99 lines
3.2 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/metadata/qgsprojectmetadata.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
class QgsProjectMetadata : QgsAbstractMetadataBase
|
|
{
|
|
%Docstring(signature="appended")
|
|
A structured metadata store for a project.
|
|
|
|
:py:class:`QgsProjectMetadata` handles storage and management of the
|
|
metadata for a :py:class:`QgsProject`. This class is an internal QGIS
|
|
format with a common metadata structure, which allows for code to access
|
|
the metadata properties for projects in a uniform way.
|
|
|
|
The metadata store is designed to be compatible with the Dublin Core
|
|
metadata specifications, and will be expanded to allow compatibility
|
|
with ISO specifications in future releases. However, the QGIS internal
|
|
schema does not represent a superset of all existing metadata schemas
|
|
and accordingly conversion from specific metadata formats to
|
|
:py:class:`QgsProjectMetadata` may result in a loss of information.
|
|
|
|
This class is designed to follow the specifications detailed in the
|
|
schema definition available at resources/qgis-project-metadata.xsd
|
|
within the QGIS source code.
|
|
|
|
Metadata can be validated through the use of
|
|
:py:class:`QgsLayerMetadataValidator` subclasses. E.g. validating
|
|
against the native QGIS metadata schema can be performed using
|
|
:py:class:`QgsNativeProjectMetadataValidator`.
|
|
|
|
.. versionadded:: 3.2
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsprojectmetadata.h"
|
|
%End
|
|
public:
|
|
|
|
QgsProjectMetadata();
|
|
|
|
virtual QgsProjectMetadata *clone() const /Factory/;
|
|
|
|
|
|
QString author() const;
|
|
%Docstring
|
|
Returns the project author string.
|
|
|
|
.. seealso:: :py:func:`setAuthor`
|
|
%End
|
|
|
|
void setAuthor( const QString &author );
|
|
%Docstring
|
|
Sets the project ``author`` string
|
|
|
|
.. seealso:: :py:func:`author`
|
|
%End
|
|
|
|
QDateTime creationDateTime() const;
|
|
%Docstring
|
|
Returns the project's creation date/timestamp.
|
|
|
|
.. seealso:: :py:func:`setCreationDateTime`
|
|
%End
|
|
|
|
void setCreationDateTime( const QDateTime &creationDateTime );
|
|
%Docstring
|
|
Sets the project's creation date/timestamp.
|
|
|
|
.. seealso:: :py:func:`creationDateTime`
|
|
%End
|
|
|
|
virtual bool readMetadataXml( const QDomElement &metadataElement );
|
|
|
|
virtual bool writeMetadataXml( QDomElement &metadataElement, QDomDocument &document ) const;
|
|
|
|
virtual void combine( const QgsAbstractMetadataBase *other );
|
|
|
|
|
|
bool operator==( const QgsProjectMetadata &metadataOther ) const;
|
|
|
|
};
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/metadata/qgsprojectmetadata.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|