qgscomposerobject.h

Go to the documentation of this file.

/***************************************************************************
                         qgscomposerobject.h
                             -------------------
    begin                : July 2014
    copyright            : (C) 2014 by Nyall Dawson,Radim Blazek
    email                : nyall dot dawson 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 QGSCOMPOSEROBJECT_H
#define QGSCOMPOSEROBJECT_H

#include "qgsobjectcustomproperties.h"
#include "qgsexpressioncontext.h"
#include <QObject>
#include <QDomNode>
#include <QMap>

class QgsComposition;
class QPainter;
class QgsDataDefined;

class CORE_EXPORT QgsComposerObject: public QObject
{
    Q_OBJECT
  public:

    enum DataDefinedProperty
    {
      NoProperty = 0, 
      AllProperties, 
      TestProperty, 
      //composer page properties
      PresetPaperSize, 
      PaperWidth, 
      PaperHeight, 
      NumPages, 
      PaperOrientation, 
      //general composer item properties
      PageNumber, 
      PositionX, 
      PositionY, 
      ItemWidth, 
      ItemHeight, 
      ItemRotation, 
      Transparency, 
      BlendMode, 
      ExcludeFromExports, 
      //composer map
      MapRotation, 
      MapScale, 
      MapXMin, 
      MapYMin, 
      MapXMax, 
      MapYMax, 
      MapAtlasMargin, 
      MapLayers, 
      MapStylePreset, 
      //composer picture
      PictureSource, 
      //html item
      SourceUrl 
    };

    enum PropertyValueType
    {
      EvaluatedValue = 0, 
      OriginalValue 
    };

    QgsComposerObject( QgsComposition* composition );
    virtual ~QgsComposerObject();

    const QgsComposition* composition() const { return mComposition; }

    QgsComposition* composition() { return mComposition; }

    virtual bool writeXML( QDomElement& elem, QDomDocument & doc ) const;

    virtual bool readXML( const QDomElement& itemElem, const QDomDocument& doc );

    QgsDataDefined* dataDefinedProperty( const DataDefinedProperty property ) const;

    void setDataDefinedProperty( const DataDefinedProperty property, const bool active, const bool useExpression, const QString &expression, const QString &field );

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

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

    void removeCustomProperty( const QString &key );

    QStringList customProperties() const;

    virtual QgsExpressionContext* createExpressionContext() const;

  public slots:

    virtual void repaint();

    virtual void refreshDataDefinedProperty( const DataDefinedProperty property = AllProperties, const QgsExpressionContext* context = nullptr );

  protected:

    QgsComposition* mComposition;

    QMap< QgsComposerObject::DataDefinedProperty, QString > mDataDefinedNames;

    QgsObjectCustomProperties mCustomProperties;

    bool dataDefinedEvaluate( const QgsComposerObject::DataDefinedProperty property, QVariant &expressionValue, const QgsExpressionContext& context = QgsExpressionContext() ) const;

  signals:
    void itemChanged();

  private slots:
    void prepareDataDefinedExpressions() const;

  private:

    //mutable since expressions in data defineds need to be preparable
    mutable QMap< QgsComposerObject::DataDefinedProperty, QgsDataDefined* > mDataDefinedProperties;

    friend class TestQgsComposerObject;
};

#endif