Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                           qgsobjectcustomproperties.h
       3                 :            :                              -------------------
       4                 :            :     begin                : April 2014
       5                 :            :     copyright            : (C) 2014 by Martin Dobias
       6                 :            :     email                : wonder.sk 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 QGSOBJECTCUSTOMPROPERTIES_H
      19                 :            : #define QGSOBJECTCUSTOMPROPERTIES_H
      20                 :            : 
      21                 :            : #include <QMap>
      22                 :            : #include <QVariant>
      23                 :            : #include "qgis_core.h"
      24                 :            : 
      25                 :            : class QDomDocument;
      26                 :            : class QDomNode;
      27                 :            : 
      28                 :            : /**
      29                 :            :  * \ingroup core
      30                 :            :  * \brief Simple key-value store (keys = strings, values = variants) that supports loading/saving to/from XML
      31                 :            :  * in \verbatim <customproperties> \endverbatim element.
      32                 :            :  *
      33                 :            :  * \since QGIS 2.4
      34                 :            :  */
      35                 :         69 : class CORE_EXPORT QgsObjectCustomProperties
      36                 :            : {
      37                 :            :   public:
      38                 :            : 
      39                 :            :     /**
      40                 :            :      * Constructor for QgsObjectCustomProperties.
      41                 :            :      */
      42                 :         89 :     QgsObjectCustomProperties() = default;
      43                 :            : 
      44                 :            :     /**
      45                 :            :      * Returns a list of all stored keys.
      46                 :            :      */
      47                 :            :     QStringList keys() const;
      48                 :            : 
      49                 :            :     /**
      50                 :            :      * Add an entry to the store with the specified \a key.
      51                 :            :      *
      52                 :            :      * If an entry with the same \a key exists already, it will be overwritten.
      53                 :            :      */
      54                 :            :     void setValue( const QString &key, const QVariant &value );
      55                 :            : 
      56                 :            :     /**
      57                 :            :      * Returns the value for the given \a key.
      58                 :            :      *
      59                 :            :      * If the \a key is not present in the properties, the \a defaultValue will be returned.
      60                 :            :      */
      61                 :            :     QVariant value( const QString &key, const QVariant &defaultValue = QVariant() ) const;
      62                 :            : 
      63                 :            :     /**
      64                 :            :      * Removes a \a key (entry) from the store.
      65                 :            :      */
      66                 :            :     void remove( const QString &key );
      67                 :            : 
      68                 :            :     /**
      69                 :            :      * Returns TRUE if the properties contains a \a key with the specified name.
      70                 :            :      *
      71                 :            :      * \since QGIS 3.14
      72                 :            :      */
      73                 :            :     bool contains( const QString &key ) const;
      74                 :            : 
      75                 :            :     /**
      76                 :            :      * Read store contents from an XML node.
      77                 :            :      * \param parentNode node to read from
      78                 :            :      * \param keyStartsWith reads only properties starting with the specified string (or all if the string is empty)
      79                 :            :      *
      80                 :            :      * \see writeXml()
      81                 :            :      */
      82                 :            :     void readXml( const QDomNode &parentNode, const QString &keyStartsWith = QString() );
      83                 :            : 
      84                 :            :     /**
      85                 :            :      * Writes the store contents to an XML node.
      86                 :            :      *
      87                 :            :      * \see readXml()
      88                 :            :      */
      89                 :            :     void writeXml( QDomNode &parentNode, QDomDocument &doc ) const;
      90                 :            : 
      91                 :            :   protected:
      92                 :            :     QMap<QString, QVariant> mMap;
      93                 :            : 
      94                 :            : };
      95                 :            : 
      96                 :            : #endif // QGSOBJECTCUSTOMPROPERTIES_H