api/4.0/qgslayoutobject_8cpp_source.html

/***************************************************************************

                            qgslayoutobject.cpp

                             -------------------

    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.                                   *

 *                                                                         *

 ***************************************************************************/


#include "qgslayoutobject.h"


#include "qgsexpressioncontextutils.h"

#include "qgslayout.h"

#include "qgslayoutreportcontext.h"


#include <QPainter>

#include <QString>


#include "moc_qgslayoutobject.cpp"


using namespace Qt::StringLiterals;


QgsPropertiesDefinition QgsLayoutObject::sPropertyDefinitions;


void QgsLayoutObject::initPropertyDefinitions()

{

  if ( !sPropertyDefinitions.isEmpty() )

    return;


  sPropertyDefinitions = QgsPropertiesDefinition {

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::TestProperty ), QgsPropertyDefinition( "dataDefinedProperty", QgsPropertyDefinition::DataTypeString, "invalid property", QString() ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PresetPaperSize ),

      QgsPropertyDefinition(

        "dataDefinedPaperSize",

        QgsPropertyDefinition::DataTypeString,

        QObject::tr( "Paper size" ),

        QObject::tr( "string " )

          + QLatin1String(

            "[<b>A5</b>|<b>A4</b>|<b>A3</b>|<b>A2</b>|<b>A1</b>|<b>A0</b>"

            "|<b>B5</b>|<b>B4</b>|<b>B3</b>|<b>B2</b>|<b>B1</b>|<b>B0</b>"

            "|<b>Legal</b>|<b>Ansi A</b>|<b>Ansi B</b>|<b>Ansi C</b>|<b>Ansi D</b>|<b>Ansi E</b>"

            "|<b>Arch A</b>|<b>Arch B</b>|<b>Arch C</b>|<b>Arch D</b>|<b>Arch E</b>|<b>Arch E1</b>]"

          )

      ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PaperWidth ), QgsPropertyDefinition( "dataDefinedPaperWidth", QObject::tr( "Page width" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PaperHeight ), QgsPropertyDefinition( "dataDefinedPaperHeight", QObject::tr( "Page height" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::NumPages ), QgsPropertyDefinition( "dataDefinedNumPages", QObject::tr( "Number of pages" ), QgsPropertyDefinition::IntegerPositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PaperOrientation ),

      QgsPropertyDefinition( "dataDefinedPaperOrientation", QgsPropertyDefinition::DataTypeString, QObject::tr( "Symbol size" ), QObject::tr( "string " ) + "[<b>portrait</b>|<b>landscape</b>]"_L1 ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PageNumber ), QgsPropertyDefinition( "dataDefinedPageNumber", QObject::tr( "Page number" ), QgsPropertyDefinition::IntegerPositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PositionX ), QgsPropertyDefinition( "dataDefinedPositionX", QObject::tr( "Position (X)" ), QgsPropertyDefinition::Double ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PositionY ), QgsPropertyDefinition( "dataDefinedPositionY", QObject::tr( "Position (Y)" ), QgsPropertyDefinition::Double ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ItemWidth ), QgsPropertyDefinition( "dataDefinedWidth", QObject::tr( "Width" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ItemHeight ), QgsPropertyDefinition( "dataDefinedHeight", QObject::tr( "Height" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ItemRotation ), QgsPropertyDefinition( "dataDefinedRotation", QObject::tr( "Rotation angle" ), QgsPropertyDefinition::Rotation ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::Transparency ), QgsPropertyDefinition( "dataDefinedTransparency", QObject::tr( "Transparency" ), QgsPropertyDefinition::Opacity ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::Opacity ), QgsPropertyDefinition( "dataDefinedOpacity", QObject::tr( "Opacity" ), QgsPropertyDefinition::Opacity ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::BlendMode ), QgsPropertyDefinition( "dataDefinedBlendMode", QObject::tr( "Blend mode" ), QgsPropertyDefinition::BlendMode ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ExcludeFromExports ),

      QgsPropertyDefinition( "dataDefinedExcludeExports", QObject::tr( "Exclude item from exports" ), QgsPropertyDefinition::Boolean ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::FrameColor ), QgsPropertyDefinition( "dataDefinedFrameColor", QObject::tr( "Frame color" ), QgsPropertyDefinition::ColorWithAlpha ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::BackgroundColor ),

      QgsPropertyDefinition( "dataDefinedBackgroundColor", QObject::tr( "Background color" ), QgsPropertyDefinition::ColorWithAlpha ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MarginLeft ), QgsPropertyDefinition( "dataDefinedMarginLeft", QObject::tr( "Left margin" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MarginTop ), QgsPropertyDefinition( "dataDefinedMarginTop", QObject::tr( "Top margin" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MarginRight ), QgsPropertyDefinition( "dataDefinedMarginRight", QObject::tr( "Right margin" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MarginBottom ),

      QgsPropertyDefinition( "dataDefinedMarginBottom", QObject::tr( "Bottom margin" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapRotation ), QgsPropertyDefinition( "dataDefinedMapRotation", QObject::tr( "Map rotation" ), QgsPropertyDefinition::Rotation ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapScale ), QgsPropertyDefinition( "dataDefinedMapScale", QObject::tr( "Map scale" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapXMin ), QgsPropertyDefinition( "dataDefinedMapXMin", QObject::tr( "Extent minimum X" ), QgsPropertyDefinition::Double ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapYMin ), QgsPropertyDefinition( "dataDefinedMapYMin", QObject::tr( "Extent minimum Y" ), QgsPropertyDefinition::Double ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapXMax ), QgsPropertyDefinition( "dataDefinedMapXMax", QObject::tr( "Extent maximum X" ), QgsPropertyDefinition::Double ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapYMax ), QgsPropertyDefinition( "dataDefinedMapYMax", QObject::tr( "Extent maximum Y" ), QgsPropertyDefinition::Double ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapLabelMargin ),

      QgsPropertyDefinition( "dataDefinedMapLabelMargin", QObject::tr( "Label margin" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapAtlasMargin ),

      QgsPropertyDefinition( "dataDefinedMapAtlasMargin", QObject::tr( "Atlas margin" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapLayers ),

      QgsPropertyDefinition( "dataDefinedMapLayers", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map Layers" ), tr( "list of map layer names separated by | characters" ) ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapStylePreset ),

      QgsPropertyDefinition( "dataDefinedMapStylePreset", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map theme" ), tr( "name of an existing map theme (case-sensitive)" ) ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridEnabled ), QgsPropertyDefinition( "dataDefinedMapGridEnabled", QObject::tr( "Grid enabled" ), QgsPropertyDefinition::Boolean ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridIntervalX ),

      QgsPropertyDefinition( "dataDefinedMapGridIntervalX", QObject::tr( "Grid interval X" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridIntervalY ),

      QgsPropertyDefinition( "dataDefinedMapGridIntervalY", QObject::tr( "Grid interval Y" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridOffsetX ), QgsPropertyDefinition( "dataDefinedMapGridOffsetX", QObject::tr( "Grid offset X" ), QgsPropertyDefinition::Double ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridOffsetY ), QgsPropertyDefinition( "dataDefinedMapGridOffsetY", QObject::tr( "Grid offset Y" ), QgsPropertyDefinition::Double ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridFrameSize ),

      QgsPropertyDefinition( "dataDefinedMapGridFrameSize", QObject::tr( "Grid frame size" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridFrameLineThickness ),

      QgsPropertyDefinition( "dataDefinedMapGridFrameLineThickness", QObject::tr( "Grid frame line thickness" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridCrossSize ),

      QgsPropertyDefinition( "dataDefinedMapGridCrossSize", QObject::tr( "Grid cross size" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridFrameMargin ),

      QgsPropertyDefinition( "dataDefinedMapGridFrameMargin", QObject::tr( "Grid frame margin" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridLabelDistance ),

      QgsPropertyDefinition( "dataDefinedMapGridLabelDistance", QObject::tr( "Grid label distance" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayLeft ),

      QgsPropertyDefinition( "dataDefinedMapGridAnnotationDisplayLeft", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map grid annotation display left" ), QObject::tr( "string " ) + "[<b>all</b>|<b>x_only</b>|<b>y_only</b>|<b>disabled</b>]"_L1 ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayRight ),

      QgsPropertyDefinition( "dataDefinedMapGridAnnotationDisplayRight", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map grid annotation display right" ), QObject::tr( "string " ) + "[<b>all</b>|<b>x_only</b>|<b>y_only</b>|<b>disabled</b>]"_L1 ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayTop ),

      QgsPropertyDefinition( "dataDefinedMapGridAnnotationDisplayTop", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map grid annotation display top" ), QObject::tr( "string " ) + "[<b>all</b>|<b>x_only</b>|<b>y_only</b>|<b>disabled</b>]"_L1 ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayBottom ),

      QgsPropertyDefinition( "dataDefinedMapGridAnnotationDisplayBottom", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map grid annotation display bottom" ), QObject::tr( "string " ) + "[<b>all</b>|<b>x_only</b>|<b>y_only</b>|<b>disabled</b>]"_L1 ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsLeft ),

      QgsPropertyDefinition( "dataDefinedMapGridFrameDivisionsLeft", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map grid frame divisions display left" ), QObject::tr( "string " ) + "[<b>all</b>|<b>x_only</b>|<b>y_only</b>|<b>disabled</b>]"_L1 ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsRight ),

      QgsPropertyDefinition( "dataDefinedMapGridFrameDivisionsRight", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map grid frame divisions display right" ), QObject::tr( "string " ) + "[<b>all</b>|<b>x_only</b>|<b>y_only</b>|<b>disabled</b>]"_L1 ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsTop ),

      QgsPropertyDefinition( "dataDefinedMapGridFrameDivisionsTop", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map grid frame divisions display top" ), QObject::tr( "string " ) + "[<b>all</b>|<b>x_only</b>|<b>y_only</b>|<b>disabled</b>]"_L1 ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsBottom ),

      QgsPropertyDefinition( "dataDefinedMapGridFrameDivisionsBottom", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map grid frame divisions display bottom" ), QObject::tr( "string " ) + "[<b>all</b>|<b>x_only</b>|<b>y_only</b>|<b>disabled</b>]"_L1 ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridDrawAnnotation ),

      QgsPropertyDefinition( "dataDefinedMapGridDrawAnnotation", QObject::tr( "Draw map grid annotation" ), QgsPropertyDefinition::Boolean, QString(), QObject::tr( "Allows control over the visibility of individual grid annotations" ) ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapCrs ),

      QgsPropertyDefinition(

        "dataDefinedCrs",

        QgsPropertyDefinition::DataTypeString,

        QObject::tr( "Map CRS" ),

        QObject::tr( "string representing a CRS, either an authority/id pair (e.g. 'EPSG:4326'), a proj string prefixes by \"PROJ:\" (e.g. 'PROJ: +proj=...') or a WKT string prefixed by \"WKT:\" (e.g. 'WKT:GEOGCRS[\"WGS 84\"...]')" )

      ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::StartDateTime ),

      QgsPropertyDefinition( "dataDefinedStartDateTime", QObject::tr( "Temporal range start date / time" ), QgsPropertyDefinition::DateTime ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::EndDateTime ),

      QgsPropertyDefinition( "dataDefinedEndDateTime", QObject::tr( "Temporal range end date / time" ), QgsPropertyDefinition::DateTime ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapZRangeLower ), QgsPropertyDefinition( "dataDefinedZRangeLower", QObject::tr( "Z range lower limit" ), QgsPropertyDefinition::Double ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapZRangeUpper ), QgsPropertyDefinition( "dataDefinedZRangeUpper", QObject::tr( "Z range upper limit" ), QgsPropertyDefinition::Double ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PictureSource ), QgsPropertyDefinition( "dataDefinedSource", QObject::tr( "Picture source (URL)" ), QgsPropertyDefinition::String ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::SourceUrl ), QgsPropertyDefinition( "dataDefinedSourceUrl", QObject::tr( "Source URL" ), QgsPropertyDefinition::String ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PictureSvgBackgroundColor ),

      QgsPropertyDefinition( "dataDefinedSvgBackgroundColor", QObject::tr( "SVG background color" ), QgsPropertyDefinition::ColorWithAlpha ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PictureSvgStrokeColor ),

      QgsPropertyDefinition( "dataDefinedSvgStrokeColor", QObject::tr( "SVG stroke color" ), QgsPropertyDefinition::ColorWithAlpha ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PictureSvgStrokeWidth ),

      QgsPropertyDefinition( "dataDefinedSvgStrokeWidth", QObject::tr( "SVG stroke width" ), QgsPropertyDefinition::StrokeWidth ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::LegendTitle ), QgsPropertyDefinition( "dataDefinedLegendTitle", QObject::tr( "Legend title" ), QgsPropertyDefinition::String ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::LegendColumnCount ),

      QgsPropertyDefinition( "dataDefinedLegendColumns", QObject::tr( "Number of columns" ), QgsPropertyDefinition::IntegerPositiveGreaterZero ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::LegendAutoWrapWidth ),

      QgsPropertyDefinition( "dataDefinedLegendAutoWrapWidth", QObject::tr( "Text wrapping width in mm" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarFillColor ),

      QgsPropertyDefinition( "dataDefinedScalebarFill", QObject::tr( "Fill color" ), QgsPropertyDefinition::ColorWithAlpha ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarFillColor2 ),

      QgsPropertyDefinition( "dataDefinedScalebarFill2", QObject::tr( "Secondary fill color" ), QgsPropertyDefinition::ColorWithAlpha ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarLineColor ),

      QgsPropertyDefinition( "dataDefinedScalebarLineColor", QObject::tr( "Line color" ), QgsPropertyDefinition::ColorWithAlpha ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarLineWidth ),

      QgsPropertyDefinition( "dataDefinedScalebarLineWidth", QObject::tr( "Line width" ), QgsPropertyDefinition::StrokeWidth ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::AttributeTableSourceLayer ),

      QgsPropertyDefinition( "dataDefinedAttributeTableSourceLayer", QObject::tr( "Table source layer" ), QgsPropertyDefinition::String ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarLeftSegments ),

      QgsPropertyDefinition( "dataDefinedScaleBarLeftSegments", QObject::tr( "Segments to the left of 0" ), QgsPropertyDefinition::IntegerPositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarRightSegments ),

      QgsPropertyDefinition( "dataDefinedScaleBarRightSegments", QObject::tr( "Segments to the right of 0" ), QgsPropertyDefinition::IntegerPositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarSegmentWidth ),

      QgsPropertyDefinition( "dataDefinedScalebarSegmentWidth", QObject::tr( "Length of a segment in map units" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarMinimumWidth ),

      QgsPropertyDefinition( "dataDefinedScalebarMinWidth", QObject::tr( "Minimum length of a segment in mm" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarMaximumWidth ),

      QgsPropertyDefinition( "dataDefinedScalebarMaxWidth", QObject::tr( "Maximum length of a segment in mm" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarHeight ),

      QgsPropertyDefinition( "dataDefinedScalebarHeight", QObject::tr( "Scalebar height in mm" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarSubdivisionHeight ),

      QgsPropertyDefinition( "dataDefinedScalebarSubdivisionHeight", QObject::tr( "Subdivision height in mm" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarRightSegmentSubdivisions ),

      QgsPropertyDefinition( "dataDefinedScalebarRightSegmentSubdivisions", QObject::tr( "Number of subdivisions in segments to the right of 0" ), QgsPropertyDefinition::IntegerPositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileTolerance ),

      QgsPropertyDefinition( "dataDefinedElevationProfileTolerance", QObject::tr( "Tolerance" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileDistanceMajorInterval ),

      QgsPropertyDefinition( "dataDefinedElevationProfileDistanceMajorInterval", QObject::tr( "Major grid line interval for elevation axis" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileDistanceMinorInterval ),

      QgsPropertyDefinition( "dataDefinedElevationProfileDistanceMinorInterval", QObject::tr( "Minor grid line interval for elevation axis" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileDistanceLabelInterval ),

      QgsPropertyDefinition( "dataDefinedElevationProfileDistanceLabelInterval", QObject::tr( "Label interval for elevation axis" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileElevationMajorInterval ),

      QgsPropertyDefinition( "dataDefinedElevationProfileElevationMajorInterval", QObject::tr( "Major grid line interval for distance axis" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileElevationMinorInterval ),

      QgsPropertyDefinition( "dataDefinedElevationProfileElevationMinorInterval", QObject::tr( "Minor grid line interval for distance axis" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileElevationLabelInterval ),

      QgsPropertyDefinition( "dataDefinedElevationProfileElevationLabelInterval", QObject::tr( "Label interval for distance axis" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileMinimumDistance ),

      QgsPropertyDefinition( "dataDefinedElevationProfileMinimumDistance", QObject::tr( "Minimum distance" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileMaximumDistance ),

      QgsPropertyDefinition( "dataDefinedElevationProfileMaximumDistance", QObject::tr( "Maximum distance" ), QgsPropertyDefinition::DoublePositive ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileMinimumElevation ),

      QgsPropertyDefinition( "dataDefinedElevationProfileMinimumElevation", QObject::tr( "Minimum elevation" ), QgsPropertyDefinition::Double ) },

    { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileMaximumElevation ),

      QgsPropertyDefinition( "dataDefinedElevationProfileMaximumElevation", QObject::tr( "Maximum elevation" ), QgsPropertyDefinition::Double ) },

  };

}


const QgsPropertiesDefinition &QgsLayoutObject::propertyDefinitions()

{

  QgsLayoutObject::initPropertyDefinitions();

  return sPropertyDefinitions;

}


bool QgsLayoutObject::propertyAssociatesWithParentMultiframe( QgsLayoutObject::DataDefinedProperty property )

{

  switch ( property )

  {

    case QgsLayoutObject::DataDefinedProperty::SourceUrl:

    case QgsLayoutObject::DataDefinedProperty::AttributeTableSourceLayer:

      return true;


    case QgsLayoutObject::DataDefinedProperty::NoProperty:

    case QgsLayoutObject::DataDefinedProperty::AllProperties:

    case QgsLayoutObject::DataDefinedProperty::TestProperty:

    case QgsLayoutObject::DataDefinedProperty::PresetPaperSize:

    case QgsLayoutObject::DataDefinedProperty::PaperWidth:

    case QgsLayoutObject::DataDefinedProperty::PaperHeight:

    case QgsLayoutObject::DataDefinedProperty::NumPages:

    case QgsLayoutObject::DataDefinedProperty::PaperOrientation:

    case QgsLayoutObject::DataDefinedProperty::PageNumber:

    case QgsLayoutObject::DataDefinedProperty::PositionX:

    case QgsLayoutObject::DataDefinedProperty::PositionY:

    case QgsLayoutObject::DataDefinedProperty::ItemWidth:

    case QgsLayoutObject::DataDefinedProperty::ItemHeight:

    case QgsLayoutObject::DataDefinedProperty::ItemRotation:

    case QgsLayoutObject::DataDefinedProperty::Transparency:

    case QgsLayoutObject::DataDefinedProperty::Opacity:

    case QgsLayoutObject::DataDefinedProperty::BlendMode:

    case QgsLayoutObject::DataDefinedProperty::ExcludeFromExports:

    case QgsLayoutObject::DataDefinedProperty::FrameColor:

    case QgsLayoutObject::DataDefinedProperty::BackgroundColor:

    case QgsLayoutObject::DataDefinedProperty::MapRotation:

    case QgsLayoutObject::DataDefinedProperty::MapScale:

    case QgsLayoutObject::DataDefinedProperty::MapXMin:

    case QgsLayoutObject::DataDefinedProperty::MapYMin:

    case QgsLayoutObject::DataDefinedProperty::MapXMax:

    case QgsLayoutObject::DataDefinedProperty::MapYMax:

    case QgsLayoutObject::DataDefinedProperty::MapAtlasMargin:

    case QgsLayoutObject::DataDefinedProperty::MapLayers:

    case QgsLayoutObject::DataDefinedProperty::MapStylePreset:

    case QgsLayoutObject::DataDefinedProperty::MapLabelMargin:

    case QgsLayoutObject::DataDefinedProperty::MapGridEnabled:

    case QgsLayoutObject::DataDefinedProperty::MapGridIntervalX:

    case QgsLayoutObject::DataDefinedProperty::MapGridIntervalY:

    case QgsLayoutObject::DataDefinedProperty::MapGridOffsetX:

    case QgsLayoutObject::DataDefinedProperty::MapGridOffsetY:

    case QgsLayoutObject::DataDefinedProperty::MapGridFrameSize:

    case QgsLayoutObject::DataDefinedProperty::MapGridFrameMargin:

    case QgsLayoutObject::DataDefinedProperty::MapGridLabelDistance:

    case QgsLayoutObject::DataDefinedProperty::MapGridCrossSize:

    case QgsLayoutObject::DataDefinedProperty::MapGridFrameLineThickness:

    case QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayLeft:

    case QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayRight:

    case QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayTop:

    case QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayBottom:

    case QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsLeft:

    case QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsRight:

    case QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsTop:

    case QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsBottom:

    case QgsLayoutObject::DataDefinedProperty::MapGridDrawAnnotation:

    case QgsLayoutObject::DataDefinedProperty::PictureSource:

    case QgsLayoutObject::DataDefinedProperty::PictureSvgBackgroundColor:

    case QgsLayoutObject::DataDefinedProperty::PictureSvgStrokeColor:

    case QgsLayoutObject::DataDefinedProperty::PictureSvgStrokeWidth:

    case QgsLayoutObject::DataDefinedProperty::LegendTitle:

    case QgsLayoutObject::DataDefinedProperty::LegendColumnCount:

    case QgsLayoutObject::DataDefinedProperty::LegendAutoWrapWidth:

    case QgsLayoutObject::DataDefinedProperty::ScalebarFillColor:

    case QgsLayoutObject::DataDefinedProperty::ScalebarFillColor2:

    case QgsLayoutObject::DataDefinedProperty::ScalebarLineColor:

    case QgsLayoutObject::DataDefinedProperty::ScalebarLineWidth:

    case QgsLayoutObject::DataDefinedProperty::ScalebarLeftSegments:

    case QgsLayoutObject::DataDefinedProperty::ScalebarRightSegments:

    case QgsLayoutObject::DataDefinedProperty::ScalebarSegmentWidth:

    case QgsLayoutObject::DataDefinedProperty::ScalebarMinimumWidth:

    case QgsLayoutObject::DataDefinedProperty::ScalebarMaximumWidth:

    case QgsLayoutObject::DataDefinedProperty::ScalebarHeight:

    case QgsLayoutObject::DataDefinedProperty::ScalebarRightSegmentSubdivisions:

    case QgsLayoutObject::DataDefinedProperty::ScalebarSubdivisionHeight:

    case QgsLayoutObject::DataDefinedProperty::MapCrs:

    case QgsLayoutObject::DataDefinedProperty::StartDateTime:

    case QgsLayoutObject::DataDefinedProperty::EndDateTime:

    case QgsLayoutObject::DataDefinedProperty::MapZRangeLower:

    case QgsLayoutObject::DataDefinedProperty::MapZRangeUpper:

    case QgsLayoutObject::DataDefinedProperty::ElevationProfileTolerance:

    case QgsLayoutObject::DataDefinedProperty::ElevationProfileDistanceMajorInterval:

    case QgsLayoutObject::DataDefinedProperty::ElevationProfileDistanceMinorInterval:

    case QgsLayoutObject::DataDefinedProperty::ElevationProfileDistanceLabelInterval:

    case QgsLayoutObject::DataDefinedProperty::ElevationProfileElevationMajorInterval:

    case QgsLayoutObject::DataDefinedProperty::ElevationProfileElevationMinorInterval:

    case QgsLayoutObject::DataDefinedProperty::ElevationProfileElevationLabelInterval:

    case QgsLayoutObject::DataDefinedProperty::ElevationProfileMinimumDistance:

    case QgsLayoutObject::DataDefinedProperty::ElevationProfileMaximumDistance:

    case QgsLayoutObject::DataDefinedProperty::ElevationProfileMinimumElevation:

    case QgsLayoutObject::DataDefinedProperty::ElevationProfileMaximumElevation:

    case QgsLayoutObject::DataDefinedProperty::MarginLeft:

    case QgsLayoutObject::DataDefinedProperty::MarginRight:

    case QgsLayoutObject::DataDefinedProperty::MarginTop:

    case QgsLayoutObject::DataDefinedProperty::MarginBottom:

      return false;

  }

  return false;

}


QgsLayoutObject::QgsLayoutObject( QgsLayout *layout )

  : QObject( nullptr )

  , mLayout( layout )

{

  initPropertyDefinitions();


  if ( mLayout )

  {

    connect( mLayout, &QgsLayout::refreshed, this, &QgsLayoutObject::refresh );

    connect( &mLayout->reportContext(), &QgsLayoutReportContext::changed, this, &QgsLayoutObject::refresh );

  }

}


const QgsLayout *QgsLayoutObject::layout() const

{

  return mLayout.data();

}


QgsLayout *QgsLayoutObject::layout()

{

  return mLayout.data();

}


void QgsLayoutObject::setCustomProperty( const QString &key, const QVariant &value )

{

  mCustomProperties.setValue( key, value );

}


QVariant QgsLayoutObject::customProperty( const QString &key, const QVariant &defaultValue ) const

{

  return mCustomProperties.value( key, defaultValue );

}


void QgsLayoutObject::removeCustomProperty( const QString &key )

{

  mCustomProperties.remove( key );

}


QStringList QgsLayoutObject::customProperties() const

{

  return mCustomProperties.keys();

}


QgsExpressionContext QgsLayoutObject::createExpressionContext() const

{

  if ( mLayout )

  {

    return mLayout->createExpressionContext();

  }

  else

  {

    return QgsExpressionContext() << QgsExpressionContextUtils::globalScope();

  }

}


bool QgsLayoutObject::writeObjectPropertiesToElement( QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext & ) const

{

  if ( parentElement.isNull() )

  {

    return false;

  }


  //create object element

  QDomElement objectElement = document.createElement( u"LayoutObject"_s );


  QDomElement ddPropsElement = document.createElement( u"dataDefinedProperties"_s );

  mDataDefinedProperties.writeXml( ddPropsElement, sPropertyDefinitions );

  objectElement.appendChild( ddPropsElement );


  //custom properties

  mCustomProperties.writeXml( objectElement, document );


  parentElement.appendChild( objectElement );

  return true;

}


bool QgsLayoutObject::readObjectPropertiesFromElement( const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext & )

{

  Q_UNUSED( document )

  if ( parentElement.isNull() )

  {

    return false;

  }


  const QDomNodeList objectNodeList = parentElement.elementsByTagName( u"LayoutObject"_s );

  if ( objectNodeList.size() < 1 )

  {

    return false;

  }

  const QDomElement objectElement = objectNodeList.at( 0 ).toElement();


  const QDomNode propsNode = objectElement.namedItem( u"dataDefinedProperties"_s );

  if ( !propsNode.isNull() )

  {

    mDataDefinedProperties.readXml( propsNode.toElement(), sPropertyDefinitions );

  }


  //custom properties

  mCustomProperties.readXml( objectElement );


  return true;

}


QgsExpressionContextUtils::globalScope
static QgsExpressionContextScope * globalScope()
Creates a new scope which contains variables and functions relating to the global QGIS context.
Definition qgsexpressioncontextutils.cpp:50

QgsExpressionContext
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
Definition qgsexpressioncontext.h:491

QgsLayoutObject::customProperties
QStringList customProperties() const
Returns list of keys stored in custom properties for the object.
Definition qgslayoutobject.cpp:348

QgsLayoutObject::customProperty
QVariant customProperty(const QString &key, const QVariant &defaultValue=QVariant()) const
Read a custom property from the object.
Definition qgslayoutobject.cpp:338

QgsLayoutObject::propertyDefinitions
static const QgsPropertiesDefinition & propertyDefinitions()
Returns the layout object property definitions.
Definition qgslayoutobject.cpp:203

QgsLayoutObject::mCustomProperties
QgsObjectCustomProperties mCustomProperties
Custom properties for object.
Definition qgslayoutobject.h:406

QgsLayoutObject::mDataDefinedProperties
QgsPropertyCollection mDataDefinedProperties
Definition qgslayoutobject.h:403

QgsLayoutObject::readObjectPropertiesFromElement
bool readObjectPropertiesFromElement(const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context)
Sets object properties from a DOM element.
Definition qgslayoutobject.cpp:386

QgsLayoutObject::layout
const QgsLayout * layout() const
Returns the layout the object is attached to.
Definition qgslayoutobject.cpp:323

QgsLayoutObject::setCustomProperty
void setCustomProperty(const QString &key, const QVariant &value)
Set a custom property for the object.
Definition qgslayoutobject.cpp:333

QgsLayoutObject::refresh
virtual void refresh()
Refreshes the object, causing a recalculation of any property overrides.
Definition qgslayoutobject.h:371

QgsLayoutObject::mLayout
QPointer< QgsLayout > mLayout
Definition qgslayoutobject.h:401

QgsLayoutObject::createExpressionContext
QgsExpressionContext createExpressionContext() const override
Creates an expression context relating to the objects' current state.
Definition qgslayoutobject.cpp:353

QgsLayoutObject::removeCustomProperty
void removeCustomProperty(const QString &key)
Remove a custom property from the object.
Definition qgslayoutobject.cpp:343

QgsLayoutObject::DataDefinedProperty
DataDefinedProperty
Data defined properties for different item types.
Definition qgslayoutobject.h:150

QgsLayoutObject::DataDefinedProperty::PositionX
@ PositionX
X position on page.
Definition qgslayoutobject.h:162

QgsLayoutObject::DataDefinedProperty::ItemWidth
@ ItemWidth
Width of item.
Definition qgslayoutobject.h:164

QgsLayoutObject::DataDefinedProperty::MapYMin
@ MapYMin
Map extent y minimum.
Definition qgslayoutobject.h:181

QgsLayoutObject::DataDefinedProperty::MapZRangeUpper
@ MapZRangeUpper
Map frame Z-range lower value.
Definition qgslayoutobject.h:211

QgsLayoutObject::DataDefinedProperty::ScalebarMinimumWidth
@ ScalebarMinimumWidth
Scalebar segment minimum width.
Definition qgslayoutobject.h:227

QgsLayoutObject::DataDefinedProperty::MapGridOffsetY
@ MapGridOffsetY
Map grid offset Y.
Definition qgslayoutobject.h:192

QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsBottom
@ MapGridFrameDivisionsBottom
Map frame division display bottom.
Definition qgslayoutobject.h:205

QgsLayoutObject::DataDefinedProperty::MapGridEnabled
@ MapGridEnabled
Map grid enabled.
Definition qgslayoutobject.h:188

QgsLayoutObject::DataDefinedProperty::MapGridIntervalX
@ MapGridIntervalX
Map grid interval X.
Definition qgslayoutobject.h:189

QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsTop
@ MapGridFrameDivisionsTop
Map frame division display top.
Definition qgslayoutobject.h:204

QgsLayoutObject::DataDefinedProperty::ExcludeFromExports
@ ExcludeFromExports
Exclude item from exports.
Definition qgslayoutobject.h:170

QgsLayoutObject::DataDefinedProperty::PaperWidth
@ PaperWidth
Paper width (deprecated).
Definition qgslayoutobject.h:156

QgsLayoutObject::DataDefinedProperty::StartDateTime
@ StartDateTime
Temporal range's start DateTime.
Definition qgslayoutobject.h:208

QgsLayoutObject::DataDefinedProperty::MapLayers
@ MapLayers
Map layer set.
Definition qgslayoutobject.h:185

QgsLayoutObject::DataDefinedProperty::PictureSvgStrokeColor
@ PictureSvgStrokeColor
SVG stroke color.
Definition qgslayoutobject.h:215

QgsLayoutObject::DataDefinedProperty::MapZRangeLower
@ MapZRangeLower
Map frame Z-range lower value.
Definition qgslayoutobject.h:210

QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayLeft
@ MapGridAnnotationDisplayLeft
Map annotation display left.
Definition qgslayoutobject.h:198

QgsLayoutObject::DataDefinedProperty::MapRotation
@ MapRotation
Map rotation.
Definition qgslayoutobject.h:178

QgsLayoutObject::DataDefinedProperty::ItemRotation
@ ItemRotation
Rotation of item.
Definition qgslayoutobject.h:166

QgsLayoutObject::DataDefinedProperty::TestProperty
@ TestProperty
Dummy property with no effect on item.
Definition qgslayoutobject.h:153

QgsLayoutObject::DataDefinedProperty::PositionY
@ PositionY
Y position on page.
Definition qgslayoutobject.h:163

QgsLayoutObject::DataDefinedProperty::PaperOrientation
@ PaperOrientation
Paper orientation.
Definition qgslayoutobject.h:159

QgsLayoutObject::DataDefinedProperty::MapXMax
@ MapXMax
Map extent x maximum.
Definition qgslayoutobject.h:182

QgsLayoutObject::DataDefinedProperty::MapGridFrameMargin
@ MapGridFrameMargin
Map grid frame margin.
Definition qgslayoutobject.h:194

QgsLayoutObject::DataDefinedProperty::MapStylePreset
@ MapStylePreset
Layer and style map theme.
Definition qgslayoutobject.h:186

QgsLayoutObject::DataDefinedProperty::PageNumber
@ PageNumber
Page number for item placement.
Definition qgslayoutobject.h:161

QgsLayoutObject::DataDefinedProperty::MapCrs
@ MapCrs
Map CRS.
Definition qgslayoutobject.h:207

QgsLayoutObject::DataDefinedProperty::MapYMax
@ MapYMax
Map extent y maximum.
Definition qgslayoutobject.h:183

QgsLayoutObject::DataDefinedProperty::MapAtlasMargin
@ MapAtlasMargin
Map atlas margin.
Definition qgslayoutobject.h:184

QgsLayoutObject::DataDefinedProperty::MapGridDrawAnnotation
@ MapGridDrawAnnotation
Map annotation visibility (for individual annotations).
Definition qgslayoutobject.h:206

QgsLayoutObject::DataDefinedProperty::MapGridCrossSize
@ MapGridCrossSize
Map grid cross size.
Definition qgslayoutobject.h:196

QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayRight
@ MapGridAnnotationDisplayRight
Map annotation display right.
Definition qgslayoutobject.h:199

QgsLayoutObject::DataDefinedProperty::NumPages
@ NumPages
Number of pages in composition (deprecated).
Definition qgslayoutobject.h:158

QgsLayoutObject::DataDefinedProperty::ElevationProfileMaximumDistance
@ ElevationProfileMaximumDistance
Maximum distance value for elevation profile.
Definition qgslayoutobject.h:246

QgsLayoutObject::DataDefinedProperty::PaperHeight
@ PaperHeight
Paper height (deprecated).
Definition qgslayoutobject.h:157

QgsLayoutObject::DataDefinedProperty::MapGridOffsetX
@ MapGridOffsetX
Map grid offset X.
Definition qgslayoutobject.h:191

QgsLayoutObject::DataDefinedProperty::ItemHeight
@ ItemHeight
Height of item.
Definition qgslayoutobject.h:165

QgsLayoutObject::DataDefinedProperty::ScalebarRightSegments
@ ScalebarRightSegments
Number of segments on the right of 0.
Definition qgslayoutobject.h:225

QgsLayoutObject::DataDefinedProperty::ScalebarLineColor
@ ScalebarLineColor
Scalebar line color (deprecated, use data defined properties on scalebar line symbol instead).
Definition qgslayoutobject.h:234

QgsLayoutObject::DataDefinedProperty::MarginBottom
@ MarginBottom
Bottom margin.
Definition qgslayoutobject.h:176

QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayTop
@ MapGridAnnotationDisplayTop
Map annotation display top.
Definition qgslayoutobject.h:200

QgsLayoutObject::DataDefinedProperty::ElevationProfileElevationMinorInterval
@ ElevationProfileElevationMinorInterval
Minor grid line interval for elevation profile elevation axis.
Definition qgslayoutobject.h:243

QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayBottom
@ MapGridAnnotationDisplayBottom
Map annotation display bottom.
Definition qgslayoutobject.h:201

QgsLayoutObject::DataDefinedProperty::LegendAutoWrapWidth
@ LegendAutoWrapWidth
Legend text automatic wrapping width.
Definition qgslayoutobject.h:222

QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsRight
@ MapGridFrameDivisionsRight
Map frame division display right.
Definition qgslayoutobject.h:203

QgsLayoutObject::DataDefinedProperty::ScalebarRightSegmentSubdivisions
@ ScalebarRightSegmentSubdivisions
Number of subdivisions per segment on right of 0.
Definition qgslayoutobject.h:230

QgsLayoutObject::DataDefinedProperty::ElevationProfileDistanceMinorInterval
@ ElevationProfileDistanceMinorInterval
Minor grid line interval for elevation profile distance axis.
Definition qgslayoutobject.h:240

QgsLayoutObject::DataDefinedProperty::Transparency
@ Transparency
Item transparency (deprecated).
Definition qgslayoutobject.h:167

QgsLayoutObject::DataDefinedProperty::MapGridLabelDistance
@ MapGridLabelDistance
Map grid label distance.
Definition qgslayoutobject.h:195

QgsLayoutObject::DataDefinedProperty::ElevationProfileMinimumDistance
@ ElevationProfileMinimumDistance
Minimum distance value for elevation profile.
Definition qgslayoutobject.h:245

QgsLayoutObject::DataDefinedProperty::ElevationProfileMaximumElevation
@ ElevationProfileMaximumElevation
Maximum elevation value for elevation profile.
Definition qgslayoutobject.h:248

QgsLayoutObject::DataDefinedProperty::ScalebarMaximumWidth
@ ScalebarMaximumWidth
Scalebar segment maximum width.
Definition qgslayoutobject.h:228

QgsLayoutObject::DataDefinedProperty::ElevationProfileDistanceLabelInterval
@ ElevationProfileDistanceLabelInterval
Label interval for elevation profile distance axis.
Definition qgslayoutobject.h:241

QgsLayoutObject::DataDefinedProperty::ScalebarHeight
@ ScalebarHeight
Scalebar height.
Definition qgslayoutobject.h:229

QgsLayoutObject::DataDefinedProperty::MapGridIntervalY
@ MapGridIntervalY
Map grid interval Y.
Definition qgslayoutobject.h:190

QgsLayoutObject::DataDefinedProperty::ElevationProfileTolerance
@ ElevationProfileTolerance
Tolerance distance for elevation profiles.
Definition qgslayoutobject.h:238

QgsLayoutObject::DataDefinedProperty::SourceUrl
@ SourceUrl
Html source url.
Definition qgslayoutobject.h:218

QgsLayoutObject::DataDefinedProperty::EndDateTime
@ EndDateTime
Temporal range's end DateTime.
Definition qgslayoutobject.h:209

QgsLayoutObject::DataDefinedProperty::ScalebarFillColor2
@ ScalebarFillColor2
Scalebar secondary fill color (deprecated, use data defined properties on scalebar fill symbol 2 inst...
Definition qgslayoutobject.h:233

QgsLayoutObject::DataDefinedProperty::ScalebarSubdivisionHeight
@ ScalebarSubdivisionHeight
Scalebar subdivision height.
Definition qgslayoutobject.h:231

QgsLayoutObject::DataDefinedProperty::ElevationProfileMinimumElevation
@ ElevationProfileMinimumElevation
Minimum elevation value for elevation profile.
Definition qgslayoutobject.h:247

QgsLayoutObject::DataDefinedProperty::BackgroundColor
@ BackgroundColor
Item background color.
Definition qgslayoutobject.h:172

QgsLayoutObject::DataDefinedProperty::MapScale
@ MapScale
Map scale.
Definition qgslayoutobject.h:179

QgsLayoutObject::DataDefinedProperty::BlendMode
@ BlendMode
Item blend mode.
Definition qgslayoutobject.h:169

QgsLayoutObject::DataDefinedProperty::PresetPaperSize
@ PresetPaperSize
Preset paper size for composition.
Definition qgslayoutobject.h:155

QgsLayoutObject::DataDefinedProperty::ScalebarFillColor
@ ScalebarFillColor
Scalebar fill color (deprecated, use data defined properties on scalebar fill symbol 1 instead).
Definition qgslayoutobject.h:232

QgsLayoutObject::DataDefinedProperty::MapGridFrameSize
@ MapGridFrameSize
Map grid frame size.
Definition qgslayoutobject.h:193

QgsLayoutObject::DataDefinedProperty::ScalebarLineWidth
@ ScalebarLineWidth
Scalebar line width (deprecated, use data defined properties on scalebar line symbol instead).
Definition qgslayoutobject.h:235

QgsLayoutObject::DataDefinedProperty::MarginLeft
@ MarginLeft
Left margin.
Definition qgslayoutobject.h:173

QgsLayoutObject::DataDefinedProperty::PictureSvgBackgroundColor
@ PictureSvgBackgroundColor
SVG background color.
Definition qgslayoutobject.h:214

QgsLayoutObject::DataDefinedProperty::MarginRight
@ MarginRight
Right margin.
Definition qgslayoutobject.h:175

QgsLayoutObject::DataDefinedProperty::Opacity
@ Opacity
Item opacity.
Definition qgslayoutobject.h:168

QgsLayoutObject::DataDefinedProperty::PictureSource
@ PictureSource
Picture source url.
Definition qgslayoutobject.h:213

QgsLayoutObject::DataDefinedProperty::AttributeTableSourceLayer
@ AttributeTableSourceLayer
Attribute table source layer.
Definition qgslayoutobject.h:237

QgsLayoutObject::DataDefinedProperty::ScalebarLeftSegments
@ ScalebarLeftSegments
Number of segments on the left of 0.
Definition qgslayoutobject.h:224

QgsLayoutObject::DataDefinedProperty::ElevationProfileElevationLabelInterval
@ ElevationProfileElevationLabelInterval
Label interval for elevation profile elevation axis.
Definition qgslayoutobject.h:244

QgsLayoutObject::DataDefinedProperty::MapGridFrameLineThickness
@ MapGridFrameLineThickness
Map grid frame line thickness.
Definition qgslayoutobject.h:197

QgsLayoutObject::DataDefinedProperty::ElevationProfileDistanceMajorInterval
@ ElevationProfileDistanceMajorInterval
Major grid line interval for elevation profile distance axis.
Definition qgslayoutobject.h:239

QgsLayoutObject::DataDefinedProperty::FrameColor
@ FrameColor
Item frame color.
Definition qgslayoutobject.h:171

QgsLayoutObject::DataDefinedProperty::ScalebarSegmentWidth
@ ScalebarSegmentWidth
Scalebar width in map units of a single segment.
Definition qgslayoutobject.h:226

QgsLayoutObject::DataDefinedProperty::ElevationProfileElevationMajorInterval
@ ElevationProfileElevationMajorInterval
Major grid line interval for elevation profile elevation axis.
Definition qgslayoutobject.h:242

QgsLayoutObject::DataDefinedProperty::LegendTitle
@ LegendTitle
Legend title.
Definition qgslayoutobject.h:220

QgsLayoutObject::DataDefinedProperty::LegendColumnCount
@ LegendColumnCount
Legend column count.
Definition qgslayoutobject.h:221

QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsLeft
@ MapGridFrameDivisionsLeft
Map frame division display left.
Definition qgslayoutobject.h:202

QgsLayoutObject::DataDefinedProperty::NoProperty
@ NoProperty
No property.
Definition qgslayoutobject.h:151

QgsLayoutObject::DataDefinedProperty::MapXMin
@ MapXMin
Map extent x minimum.
Definition qgslayoutobject.h:180

QgsLayoutObject::DataDefinedProperty::MapLabelMargin
@ MapLabelMargin
Map label margin.
Definition qgslayoutobject.h:187

QgsLayoutObject::DataDefinedProperty::PictureSvgStrokeWidth
@ PictureSvgStrokeWidth
SVG stroke width.
Definition qgslayoutobject.h:216

QgsLayoutObject::DataDefinedProperty::AllProperties
@ AllProperties
All properties for item.
Definition qgslayoutobject.h:152

QgsLayoutObject::DataDefinedProperty::MarginTop
@ MarginTop
Top margin.
Definition qgslayoutobject.h:174

QgsLayoutObject::QgsLayoutObject
QgsLayoutObject(QgsLayout *layout)
Constructor for QgsLayoutObject, with the specified parent layout.
Definition qgslayoutobject.cpp:310

QgsLayoutObject::writeObjectPropertiesToElement
bool writeObjectPropertiesToElement(QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const
Stores object properties within an XML DOM element.
Definition qgslayoutobject.cpp:365

QgsLayoutObject::propertyAssociatesWithParentMultiframe
static bool propertyAssociatesWithParentMultiframe(DataDefinedProperty property)
Returns true if the specified property key is normally associated with the parent QgsLayoutMultiFrame...
Definition qgslayoutobject.cpp:209

QgsLayoutReportContext::changed
void changed()
Emitted certain settings in the context is changed, e.g.

QgsLayout
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition qgslayout.h:50

QgsLayout::refreshed
void refreshed()
Emitted when the layout has been refreshed and items should also be refreshed and updated.

QgsPropertyDefinition::Double
@ Double
Double value (including negative values).
Definition qgsproperty.h:56

QgsPropertyDefinition::StrokeWidth
@ StrokeWidth
Line stroke width.
Definition qgsproperty.h:71

QgsPropertyDefinition::String
@ String
Any string value.
Definition qgsproperty.h:60

QgsPropertyDefinition::DateTime
@ DateTime
DateTime value.
Definition qgsproperty.h:78

QgsPropertyDefinition::BlendMode
@ BlendMode
Blend mode.
Definition qgsproperty.h:66

QgsPropertyDefinition::Boolean
@ Boolean
Boolean value.
Definition qgsproperty.h:52

QgsPropertyDefinition::IntegerPositiveGreaterZero
@ IntegerPositiveGreaterZero
Non-zero positive integer values.
Definition qgsproperty.h:55

QgsPropertyDefinition::IntegerPositive
@ IntegerPositive
Positive integer values (including 0).
Definition qgsproperty.h:54

QgsPropertyDefinition::Opacity
@ Opacity
Opacity (0-100).
Definition qgsproperty.h:61

QgsPropertyDefinition::Rotation
@ Rotation
Rotation (value between 0-360 degrees).
Definition qgsproperty.h:59

QgsPropertyDefinition::ColorWithAlpha
@ ColorWithAlpha
Color with alpha channel.
Definition qgsproperty.h:63

QgsPropertyDefinition::DoublePositive
@ DoublePositive
Positive double value (including 0).
Definition qgsproperty.h:57

QgsPropertyDefinition::DataTypeString
@ DataTypeString
Property requires a string value.
Definition qgsproperty.h:91

QgsReadWriteContext
A container for the context for various read/write operations on objects.
Definition qgsreadwritecontext.h:38

qgsexpressioncontextutils.h

qgslayout.h

qgslayoutobject.h

qgslayoutreportcontext.h

QgsPropertiesDefinition
QMap< int, QgsPropertyDefinition > QgsPropertiesDefinition
Definition of available properties.
Definition qgspropertycollection.h:32