qgslayoutobject.h

Go to the documentation of this file.

/***************************************************************************
                         qgslayoutobject.h
                             -------------------
    begin                : June 2017
    copyright            : (C) 2017 by Nyall Dawson
    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 QGSLAYOUTOBJECT_H
#define QGSLAYOUTOBJECT_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsexpressioncontextgenerator.h"
#include "qgsobjectcustomproperties.h"
#include "qgspropertycollection.h"
 
#include <QDomNode>
#include <QMap>
#include <QObject>
#include <QPointer>
 
class QgsLayout;
class QPainter;
class QgsReadWriteContext;

class CORE_EXPORT QgsLayoutObject : public QObject, public QgsExpressionContextGenerator
{
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutitem.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutitemgroup.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutitemmap.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutitempicture.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutitemlabel.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutitemlegend.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutitempolygon.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutitempolyline.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutitemscalebar.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutframe.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutitemshape.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutitempage.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutitemmarker.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutitemelevationprofile.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutitemchart.h" );
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( QgsLayoutItem *item = qobject_cast< QgsLayoutItem * >( sipCpp ) )
    {
      // the conversions have to be static, because they're using multiple inheritance
      // (seen in PyQt4 .sip files for some QGraphicsItem classes)
      switch ( item->type() )
      {
        // FREAKKKKIIN IMPORTANT!
        // IF YOU PUT SOMETHING HERE, PUT IT IN QgsLayoutItem CASTING **ALSO**
        // (it's not enough for it to be in only one of the places, as sip inconsistently
        // decides which casting code to perform here)
 
        // really, these *should* use the constants from QgsLayoutItemRegistry, but sip doesn't like that!
        case QGraphicsItem::UserType + 101:
          sipType = sipType_QgsLayoutItemGroup;
          *sipCppRet = static_cast<QgsLayoutItemGroup *>( sipCpp );
          break;
        case QGraphicsItem::UserType + 102:
          sipType = sipType_QgsLayoutItemPage;
          *sipCppRet = static_cast<QgsLayoutItemPage *>( sipCpp );
          break;
        case QGraphicsItem::UserType + 103:
          sipType = sipType_QgsLayoutItemMap;
          *sipCppRet = static_cast<QgsLayoutItemMap *>( sipCpp );
          break;
        case QGraphicsItem::UserType + 104:
          sipType = sipType_QgsLayoutItemPicture;
          *sipCppRet = static_cast<QgsLayoutItemPicture *>( sipCpp );
          break;
        case QGraphicsItem::UserType + 105:
          sipType = sipType_QgsLayoutItemLabel;
          *sipCppRet = static_cast<QgsLayoutItemLabel *>( sipCpp );
          break;
        case QGraphicsItem::UserType + 106:
          sipType = sipType_QgsLayoutItemLegend;
          *sipCppRet = static_cast<QgsLayoutItemLegend *>( sipCpp );
          break;
        case QGraphicsItem::UserType + 107:
          sipType = sipType_QgsLayoutItemShape;
          *sipCppRet = static_cast<QgsLayoutItemShape *>( sipCpp );
          break;
        case QGraphicsItem::UserType + 108:
          sipType = sipType_QgsLayoutItemPolygon;
          *sipCppRet = static_cast<QgsLayoutItemPolygon *>( sipCpp );
          break;
        case QGraphicsItem::UserType + 109:
          sipType = sipType_QgsLayoutItemPolyline;
          *sipCppRet = static_cast<QgsLayoutItemPolyline *>( sipCpp );
          break;
        case QGraphicsItem::UserType + 110:
          sipType = sipType_QgsLayoutItemScaleBar;
          *sipCppRet = static_cast<QgsLayoutItemScaleBar *>( sipCpp );
          break;
        case QGraphicsItem::UserType + 111:
          sipType = sipType_QgsLayoutFrame;
          *sipCppRet = static_cast<QgsLayoutFrame *>( sipCpp );
          break;
        case QGraphicsItem::UserType + 117:
          sipType = sipType_QgsLayoutItemMarker;
          *sipCppRet = static_cast<QgsLayoutItemMarker *>( sipCpp );
          break;
        case QGraphicsItem::UserType + 118:
          sipType = sipType_QgsLayoutItemElevationProfile;
          *sipCppRet = static_cast<QgsLayoutItemElevationProfile *>( sipCpp );
          break;
        case QGraphicsItem::UserType + 119:
          sipType = sipType_QgsLayoutItemChart;
          *sipCppRet = static_cast<QgsLayoutItemChart *>( sipCpp );
          break;
 
          // did you read that comment above? NO? Go read it now. You're about to break stuff.
 
        default:
          sipType = sipType_QgsLayoutItem;
      }
    }
    else
      sipType = NULL;
    SIP_END
#endif
 
    // clang-format off
  Q_OBJECT
 
  public:
 
    // *INDENT-OFF*

    enum class DataDefinedProperty SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsLayoutObject, DataDefinedProperty ) : int
    {
      NoProperty = 0, 
      AllProperties,  
      TestProperty,   
      //composer page properties
      PresetPaperSize,  
      PaperWidth,       
      PaperHeight,      
      NumPages,         
      PaperOrientation, 
      //general composer item properties
      PageNumber,         
      PositionX,          
      PositionY,          
      ItemWidth,          
      ItemHeight,         
      ItemRotation,       
      Transparency,       
      Opacity,            
      BlendMode,          
      ExcludeFromExports, 
      FrameColor,         
      BackgroundColor,    
      MarginLeft,         
      MarginTop,          
      MarginRight,        
      MarginBottom,       
      //composer map
      MapRotation,                    
      MapScale,                       
      MapXMin,                        
      MapYMin,                        
      MapXMax,                        
      MapYMax,                        
      MapAtlasMargin,                 
      MapLayers,                      
      MapStylePreset,                 
      MapLabelMargin,                 
      MapGridEnabled,                 
      MapGridIntervalX,               
      MapGridIntervalY,               
      MapGridOffsetX,                 
      MapGridOffsetY,                 
      MapGridFrameSize,               
      MapGridFrameMargin,             
      MapGridLabelDistance,           
      MapGridCrossSize,               
      MapGridFrameLineThickness,      
      MapGridAnnotationDisplayLeft,   
      MapGridAnnotationDisplayRight,  
      MapGridAnnotationDisplayTop,    
      MapGridAnnotationDisplayBottom, 
      MapGridFrameDivisionsLeft,      
      MapGridFrameDivisionsRight,     
      MapGridFrameDivisionsTop,       
      MapGridFrameDivisionsBottom,    
      MapGridDrawAnnotation,          
      MapCrs,                         
      StartDateTime,                  
      EndDateTime,                    
      MapZRangeLower,                 
      MapZRangeUpper,                 
      //composer picture
      PictureSource,             
      PictureSvgBackgroundColor, 
      PictureSvgStrokeColor,     
      PictureSvgStrokeWidth,     
      //html item
      SourceUrl, 
      //legend item
      LegendTitle,         
      LegendColumnCount,   
      LegendAutoWrapWidth, 
      //scalebar item
      ScalebarLeftSegments,             
      ScalebarRightSegments,            
      ScalebarSegmentWidth,             
      ScalebarMinimumWidth,             
      ScalebarMaximumWidth,             
      ScalebarHeight,                   
      ScalebarRightSegmentSubdivisions, 
      ScalebarSubdivisionHeight,        
      ScalebarFillColor,                
      ScalebarFillColor2,               
      ScalebarLineColor,                
      ScalebarLineWidth,                
      //table item
      AttributeTableSourceLayer,              
      ElevationProfileTolerance,              
      ElevationProfileDistanceMajorInterval,  
      ElevationProfileDistanceMinorInterval,  
      ElevationProfileDistanceLabelInterval,  
      ElevationProfileElevationMajorInterval, 
      ElevationProfileElevationMinorInterval, 
      ElevationProfileElevationLabelInterval, 
      ElevationProfileMinimumDistance,        
      ElevationProfileMaximumDistance,        
      ElevationProfileMinimumElevation,       
      ElevationProfileMaximumElevation,       
    };
    // clang-format on
 
    // *INDENT-ON*

    enum PropertyValueType
    {
      EvaluatedValue = 0, 
      OriginalValue       
    };

    static const QgsPropertiesDefinition &propertyDefinitions();

    static bool propertyAssociatesWithParentMultiframe( DataDefinedProperty property );

    explicit QgsLayoutObject( QgsLayout *layout );

    SIP_SKIP const QgsLayout *layout() const;

    QgsLayout *layout();

    QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; }

    const QgsPropertyCollection &dataDefinedProperties() const SIP_SKIP { return mDataDefinedProperties; }

    void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; }
 

    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;

    QgsExpressionContext createExpressionContext() const override;
 
  public slots:

    virtual void refresh() {}
 
  signals:

    void changed();
 
  protected:
    bool writeObjectPropertiesToElement( QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context ) const;

    bool readObjectPropertiesFromElement( const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context );
 
    QPointer< QgsLayout > mLayout;
 
    QgsPropertyCollection mDataDefinedProperties;

    QgsObjectCustomProperties mCustomProperties;
 
  private:
    static QgsPropertiesDefinition sPropertyDefinitions;
 
    static void initPropertyDefinitions();
 
    friend class TestQgsLayoutObject;
    friend class QgsCompositionConverter;
};
 
#endif //QGSLAYOUTOBJECT_H