qgsprojectproperty.h

Go to the documentation of this file.

/***************************************************************************
                                  qgsproject.h

                      Implements persistent project state.

                              -------------------
  begin                : February 24, 2005
  copyright            : (C) 2005 by Mark Coletti
  email                : mcoletti at gmail.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 QGSPROJECTPROPERTY_H
#define QGSPROJECTPROPERTY_H

#include <QHash>
#include <QVariant>
#include <QStringList>

class QDomNode;
class QDomElement;
class QDomDocument;


class CORE_EXPORT QgsProperty
{
  public:
    QgsProperty();
    virtual ~QgsProperty();

    virtual void dump( int tabs = 0 ) const = 0;

    virtual bool isKey() const = 0;

    virtual bool isValue() const = 0;

    virtual bool isLeaf() const = 0;

    virtual bool readXML( QDomNode & keyNode ) = 0;

    virtual bool writeXML( const QString & nodeName,
                           QDomElement   & element,
                           QDomDocument  & document ) = 0;

    virtual QVariant value() const = 0;

}; // class QgsProperty




class CORE_EXPORT QgsPropertyValue : public QgsProperty
{
  public:
    QgsPropertyValue() {}

    QgsPropertyValue( const QVariant &value )
        : value_( value )
    {}

    virtual ~QgsPropertyValue();

    virtual bool isKey() const override { return false; }

    virtual bool isValue() const override { return true; }

    QVariant value() const override { return value_; }

    bool isLeaf() const override { return true; }

    void dump( int tabs = 0 ) const override;

    bool readXML( QDomNode & keyNode ) override;

    bool writeXML( const QString & nodeName,
                   QDomElement   & element,
                   QDomDocument  & document ) override;

    int count() const { return 0; }

    void entryList( QStringList & keyName, QStringList & entries ) const
    { Q_UNUSED( keyName ); Q_UNUSED( entries ); /* NOP */ }

  private:

    QVariant value_;

}; // class QgsPropertyValue




class CORE_EXPORT QgsPropertyKey : public QgsProperty
{
  public:
    QgsPropertyKey( const QString &name = "" );
    virtual ~QgsPropertyKey();

    // @{
    // @note not available in python bindings
    QString name() const { return mName; }

    QString &name() { return mName; }
    // @}


    QVariant value() const override;


    QgsPropertyKey *addKey( const QString & keyName )
    {
      delete mProperties.take( keyName );
      mProperties.insert( keyName, new QgsPropertyKey( keyName ) );

      return dynamic_cast<QgsPropertyKey*>( mProperties.value( keyName ) );
    }


    void removeKey( const QString & keyName )
    {
      delete mProperties.take( keyName );
    }

    QgsPropertyValue * setValue( const QString & name, const QVariant & value )
    {
      delete mProperties.take( name );
      mProperties.insert( name, new QgsPropertyValue( value ) );

      return dynamic_cast<QgsPropertyValue*>( mProperties.value( name ) );
    }

    QgsPropertyValue * setValue( const QVariant & value )
    {
      return setValue( name(), value );
    }

    void dump( int tabs = 0 ) const override;

    bool readXML( QDomNode & keyNode ) override;

    bool writeXML( const QString &nodeName, QDomElement & element, QDomDocument & document ) override;

    int count() const { return mProperties.count(); }

    /* virtual */ bool isEmpty() const { return mProperties.isEmpty(); }

    virtual bool isKey() const override { return true; }

    virtual bool isValue() const override { return false; }

    void entryList( QStringList & entries ) const;

    void subkeyList( QStringList & entries ) const;

    bool isLeaf() const override;

    virtual void clear()
    {
      mName = "";
      clearKeys();
    }

    virtual void clearKeys()
    {
      qDeleteAll( mProperties );
      mProperties.clear();
    }

    QgsProperty * find( QString & propertyName )
    {
      return mProperties.value( propertyName );
    }

  private:

    QString mName;

    QHash < QString, QgsProperty* > mProperties;

}; // class QgsPropertyKey

#endif