qgsobjectcustomproperties.h

Go to the documentation of this file.

/***************************************************************************
                          qgsobjectcustomproperties.h
                             -------------------
    begin                : April 2014
    copyright            : (C) 2014 by Martin Dobias
    email                : wonder.sk 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 QGSOBJECTCUSTOMPROPERTIES_H
#define QGSOBJECTCUSTOMPROPERTIES_H
 
#include "qgis_core.h"
 
#include <QMap>
#include <QVariant>
 
class QDomDocument;
class QDomNode;

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

    QStringList keys() const;

    void setValue( const QString &key, const QVariant &value );

    QVariant value( const QString &key, const QVariant &defaultValue = QVariant() ) const;

    void remove( const QString &key );

    bool contains( const QString &key ) const;

    void readXml( const QDomNode &parentNode, const QString &keyStartsWith = QString() );

    void writeXml( QDomNode &parentNode, QDomDocument &doc ) const;
 
  protected:
    QMap<QString, QVariant> mMap;
 
};
 
#endif // QGSOBJECTCUSTOMPROPERTIES_H