QGIS API Documentation 3.41.0-Master (af5edcb665c)
Loading...
Searching...
No Matches
qgslayoutobject.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgslayoutobject.cpp
3 -------------------
4 begin : June 2017
5 copyright : (C) 2017 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#include "qgslayoutobject.h"
19#include "moc_qgslayoutobject.cpp"
20#include "qgsexpressioncontextutils.h"
21#include "qgslayout.h"
22#include "qgslayoutreportcontext.h"
23
24#include <QPainter>
25
26QgsPropertiesDefinition QgsLayoutObject::sPropertyDefinitions;
27
28void QgsLayoutObject::initPropertyDefinitions()
29{
30 if ( !sPropertyDefinitions.isEmpty() )
31 return;
32
33 sPropertyDefinitions = QgsPropertiesDefinition
34 {
35 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::TestProperty ), QgsPropertyDefinition( "dataDefinedProperty", QgsPropertyDefinition::DataTypeString, "invalid property", QString() ) },
36 {
37 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>"
38 "|<b>B5</b>|<b>B4</b>|<b>B3</b>|<b>B2</b>|<b>B1</b>|<b>B0</b>"
39 "|<b>Legal</b>|<b>Ansi A</b>|<b>Ansi B</b>|<b>Ansi C</b>|<b>Ansi D</b>|<b>Ansi E</b>"
40 "|<b>Arch A</b>|<b>Arch B</b>|<b>Arch C</b>|<b>Arch D</b>|<b>Arch E</b>|<b>Arch E1</b>]"
41 ) )
42 },
43 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PaperWidth ), QgsPropertyDefinition( "dataDefinedPaperWidth", QObject::tr( "Page width" ), QgsPropertyDefinition::DoublePositive ) },
44 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PaperHeight ), QgsPropertyDefinition( "dataDefinedPaperHeight", QObject::tr( "Page height" ), QgsPropertyDefinition::DoublePositive ) },
45 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::NumPages ), QgsPropertyDefinition( "dataDefinedNumPages", QObject::tr( "Number of pages" ), QgsPropertyDefinition::IntegerPositive ) },
46 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PaperOrientation ), QgsPropertyDefinition( "dataDefinedPaperOrientation", QgsPropertyDefinition::DataTypeString, QObject::tr( "Symbol size" ), QObject::tr( "string " ) + QLatin1String( "[<b>portrait</b>|<b>landscape</b>]" ) ) },
47 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PageNumber ), QgsPropertyDefinition( "dataDefinedPageNumber", QObject::tr( "Page number" ), QgsPropertyDefinition::IntegerPositive ) },
48 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PositionX ), QgsPropertyDefinition( "dataDefinedPositionX", QObject::tr( "Position (X)" ), QgsPropertyDefinition::Double ) },
49 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PositionY ), QgsPropertyDefinition( "dataDefinedPositionY", QObject::tr( "Position (Y)" ), QgsPropertyDefinition::Double ) },
50 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ItemWidth ), QgsPropertyDefinition( "dataDefinedWidth", QObject::tr( "Width" ), QgsPropertyDefinition::DoublePositive ) },
51 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ItemHeight ), QgsPropertyDefinition( "dataDefinedHeight", QObject::tr( "Height" ), QgsPropertyDefinition::DoublePositive ) },
52 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ItemRotation ), QgsPropertyDefinition( "dataDefinedRotation", QObject::tr( "Rotation angle" ), QgsPropertyDefinition::Rotation ) },
53 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::Transparency ), QgsPropertyDefinition( "dataDefinedTransparency", QObject::tr( "Transparency" ), QgsPropertyDefinition::Opacity ) },
54 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::Opacity ), QgsPropertyDefinition( "dataDefinedOpacity", QObject::tr( "Opacity" ), QgsPropertyDefinition::Opacity ) },
55 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::BlendMode ), QgsPropertyDefinition( "dataDefinedBlendMode", QObject::tr( "Blend mode" ), QgsPropertyDefinition::BlendMode ) },
56 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ExcludeFromExports ), QgsPropertyDefinition( "dataDefinedExcludeExports", QObject::tr( "Exclude item from exports" ), QgsPropertyDefinition::Boolean ) },
57 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::FrameColor ), QgsPropertyDefinition( "dataDefinedFrameColor", QObject::tr( "Frame color" ), QgsPropertyDefinition::ColorWithAlpha ) },
58 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::BackgroundColor ), QgsPropertyDefinition( "dataDefinedBackgroundColor", QObject::tr( "Background color" ), QgsPropertyDefinition::ColorWithAlpha ) },
59 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MarginLeft ), QgsPropertyDefinition( "dataDefinedMarginLeft", QObject::tr( "Left margin" ), QgsPropertyDefinition::DoublePositive ) },
60 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MarginTop ), QgsPropertyDefinition( "dataDefinedMarginTop", QObject::tr( "Top margin" ), QgsPropertyDefinition::DoublePositive ) },
61 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MarginRight ), QgsPropertyDefinition( "dataDefinedMarginRight", QObject::tr( "Right margin" ), QgsPropertyDefinition::DoublePositive ) },
62 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MarginBottom ), QgsPropertyDefinition( "dataDefinedMarginBottom", QObject::tr( "Bottom margin" ), QgsPropertyDefinition::DoublePositive ) },
63 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapRotation ), QgsPropertyDefinition( "dataDefinedMapRotation", QObject::tr( "Map rotation" ), QgsPropertyDefinition::Rotation ) },
64 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapScale ), QgsPropertyDefinition( "dataDefinedMapScale", QObject::tr( "Map scale" ), QgsPropertyDefinition::DoublePositive ) },
65 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapXMin ), QgsPropertyDefinition( "dataDefinedMapXMin", QObject::tr( "Extent minimum X" ), QgsPropertyDefinition::Double ) },
66 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapYMin ), QgsPropertyDefinition( "dataDefinedMapYMin", QObject::tr( "Extent minimum Y" ), QgsPropertyDefinition::Double ) },
67 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapXMax ), QgsPropertyDefinition( "dataDefinedMapXMax", QObject::tr( "Extent maximum X" ), QgsPropertyDefinition::Double ) },
68 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapYMax ), QgsPropertyDefinition( "dataDefinedMapYMax", QObject::tr( "Extent maximum Y" ), QgsPropertyDefinition::Double ) },
69 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapLabelMargin ), QgsPropertyDefinition( "dataDefinedMapLabelMargin", QObject::tr( "Label margin" ), QgsPropertyDefinition::DoublePositive ) },
70 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapAtlasMargin ), QgsPropertyDefinition( "dataDefinedMapAtlasMargin", QObject::tr( "Atlas margin" ), QgsPropertyDefinition::DoublePositive ) },
71 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapLayers ), QgsPropertyDefinition( "dataDefinedMapLayers", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map Layers" ), tr( "list of map layer names separated by | characters" ) ) },
72 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapStylePreset ), QgsPropertyDefinition( "dataDefinedMapStylePreset", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map theme" ), tr( "name of an existing map theme (case-sensitive)" ) ) },
73 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridEnabled ), QgsPropertyDefinition( "dataDefinedMapGridEnabled", QObject::tr( "Grid enabled" ), QgsPropertyDefinition::Boolean ) },
74 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridIntervalX ), QgsPropertyDefinition( "dataDefinedMapGridIntervalX", QObject::tr( "Grid interval X" ), QgsPropertyDefinition::DoublePositive ) },
75 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridIntervalY ), QgsPropertyDefinition( "dataDefinedMapGridIntervalY", QObject::tr( "Grid interval Y" ), QgsPropertyDefinition::DoublePositive ) },
76 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridOffsetX ), QgsPropertyDefinition( "dataDefinedMapGridOffsetX", QObject::tr( "Grid offset X" ), QgsPropertyDefinition::Double ) },
77 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridOffsetY ), QgsPropertyDefinition( "dataDefinedMapGridOffsetY", QObject::tr( "Grid offset Y" ), QgsPropertyDefinition::Double ) },
78 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridFrameSize ), QgsPropertyDefinition( "dataDefinedMapGridFrameSize", QObject::tr( "Grid frame size" ), QgsPropertyDefinition::DoublePositive ) },
79 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridFrameLineThickness ), QgsPropertyDefinition( "dataDefinedMapGridFrameLineThickness", QObject::tr( "Grid frame line thickness" ), QgsPropertyDefinition::DoublePositive ) },
80 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridCrossSize ), QgsPropertyDefinition( "dataDefinedMapGridCrossSize", QObject::tr( "Grid cross size" ), QgsPropertyDefinition::DoublePositive ) },
81 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridFrameMargin ), QgsPropertyDefinition( "dataDefinedMapGridFrameMargin", QObject::tr( "Grid frame margin" ), QgsPropertyDefinition::DoublePositive ) },
82 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridLabelDistance ), QgsPropertyDefinition( "dataDefinedMapGridLabelDistance", QObject::tr( "Grid label distance" ), QgsPropertyDefinition::DoublePositive ) },
83 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayLeft ), QgsPropertyDefinition( "dataDefinedMapGridAnnotationDisplayLeft", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map grid annotation display left" ), QObject::tr( "string " ) + QLatin1String( "[<b>all</b>|<b>x_only</b>|<b>y_only</b>|<b>disabled</b>]" ) ) },
84 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayRight ), QgsPropertyDefinition( "dataDefinedMapGridAnnotationDisplayRight", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map grid annotation display right" ), QObject::tr( "string " ) + QLatin1String( "[<b>all</b>|<b>x_only</b>|<b>y_only</b>|<b>disabled</b>]" ) ) },
85 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayTop ), QgsPropertyDefinition( "dataDefinedMapGridAnnotationDisplayTop", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map grid annotation display top" ), QObject::tr( "string " ) + QLatin1String( "[<b>all</b>|<b>x_only</b>|<b>y_only</b>|<b>disabled</b>]" ) ) },
86 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayBottom ), QgsPropertyDefinition( "dataDefinedMapGridAnnotationDisplayBottom", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map grid annotation display bottom" ), QObject::tr( "string " ) + QLatin1String( "[<b>all</b>|<b>x_only</b>|<b>y_only</b>|<b>disabled</b>]" ) ) },
87 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsLeft ), QgsPropertyDefinition( "dataDefinedMapGridFrameDivisionsLeft", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map grid frame divisions display left" ), QObject::tr( "string " ) + QLatin1String( "[<b>all</b>|<b>x_only</b>|<b>y_only</b>|<b>disabled</b>]" ) ) },
88 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsRight ), QgsPropertyDefinition( "dataDefinedMapGridFrameDivisionsRight", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map grid frame divisions display right" ), QObject::tr( "string " ) + QLatin1String( "[<b>all</b>|<b>x_only</b>|<b>y_only</b>|<b>disabled</b>]" ) ) },
89 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsTop ), QgsPropertyDefinition( "dataDefinedMapGridFrameDivisionsTop", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map grid frame divisions display top" ), QObject::tr( "string " ) + QLatin1String( "[<b>all</b>|<b>x_only</b>|<b>y_only</b>|<b>disabled</b>]" ) ) },
90 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsBottom ), QgsPropertyDefinition( "dataDefinedMapGridFrameDivisionsBottom", QgsPropertyDefinition::DataTypeString, QObject::tr( "Map grid frame divisions display bottom" ), QObject::tr( "string " ) + QLatin1String( "[<b>all</b>|<b>x_only</b>|<b>y_only</b>|<b>disabled</b>]" ) ) },
91 { 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\"...]')" ) ) },
92 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::StartDateTime ), QgsPropertyDefinition( "dataDefinedStartDateTime", QObject::tr( "Temporal range start date / time" ), QgsPropertyDefinition::DateTime ) },
93 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::EndDateTime ), QgsPropertyDefinition( "dataDefinedEndDateTime", QObject::tr( "Temporal range end date / time" ), QgsPropertyDefinition::DateTime ) },
94 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapZRangeLower ), QgsPropertyDefinition( "dataDefinedZRangeLower", QObject::tr( "Z range lower limit" ), QgsPropertyDefinition::Double ) },
95 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::MapZRangeUpper ), QgsPropertyDefinition( "dataDefinedZRangeUpper", QObject::tr( "Z range upper limit" ), QgsPropertyDefinition::Double ) },
96 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PictureSource ), QgsPropertyDefinition( "dataDefinedSource", QObject::tr( "Picture source (URL)" ), QgsPropertyDefinition::String ) },
97 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::SourceUrl ), QgsPropertyDefinition( "dataDefinedSourceUrl", QObject::tr( "Source URL" ), QgsPropertyDefinition::String ) },
98 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PictureSvgBackgroundColor ), QgsPropertyDefinition( "dataDefinedSvgBackgroundColor", QObject::tr( "SVG background color" ), QgsPropertyDefinition::ColorWithAlpha ) },
99 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PictureSvgStrokeColor ), QgsPropertyDefinition( "dataDefinedSvgStrokeColor", QObject::tr( "SVG stroke color" ), QgsPropertyDefinition::ColorWithAlpha ) },
100 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::PictureSvgStrokeWidth ), QgsPropertyDefinition( "dataDefinedSvgStrokeWidth", QObject::tr( "SVG stroke width" ), QgsPropertyDefinition::StrokeWidth ) },
101 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::LegendTitle ), QgsPropertyDefinition( "dataDefinedLegendTitle", QObject::tr( "Legend title" ), QgsPropertyDefinition::String ) },
102 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::LegendColumnCount ), QgsPropertyDefinition( "dataDefinedLegendColumns", QObject::tr( "Number of columns" ), QgsPropertyDefinition::IntegerPositiveGreaterZero ) },
103 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarFillColor ), QgsPropertyDefinition( "dataDefinedScalebarFill", QObject::tr( "Fill color" ), QgsPropertyDefinition::ColorWithAlpha ) },
104 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarFillColor2 ), QgsPropertyDefinition( "dataDefinedScalebarFill2", QObject::tr( "Secondary fill color" ), QgsPropertyDefinition::ColorWithAlpha ) },
105 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarLineColor ), QgsPropertyDefinition( "dataDefinedScalebarLineColor", QObject::tr( "Line color" ), QgsPropertyDefinition::ColorWithAlpha ) },
106 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarLineWidth ), QgsPropertyDefinition( "dataDefinedScalebarLineWidth", QObject::tr( "Line width" ), QgsPropertyDefinition::StrokeWidth ) },
107 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::AttributeTableSourceLayer ), QgsPropertyDefinition( "dataDefinedAttributeTableSourceLayer", QObject::tr( "Table source layer" ), QgsPropertyDefinition::String ) },
108 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarLeftSegments ), QgsPropertyDefinition( "dataDefinedScaleBarLeftSegments", QObject::tr( "Segments to the left of 0" ), QgsPropertyDefinition::IntegerPositive )},
109 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarRightSegments ), QgsPropertyDefinition( "dataDefinedScaleBarRightSegments", QObject::tr( "Segments to the right of 0" ), QgsPropertyDefinition::IntegerPositive ) },
110 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarSegmentWidth ), QgsPropertyDefinition( "dataDefinedScalebarSegmentWidth", QObject::tr( "Length of a segment in map units" ), QgsPropertyDefinition::DoublePositive ) },
111 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarMinimumWidth ), QgsPropertyDefinition( "dataDefinedScalebarMinWidth", QObject::tr( "Minimum length of a segment in mm" ), QgsPropertyDefinition::DoublePositive ) },
112 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarMaximumWidth ), QgsPropertyDefinition( "dataDefinedScalebarMaxWidth", QObject::tr( "Maximum length of a segment in mm" ), QgsPropertyDefinition::DoublePositive ) },
113 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarHeight ), QgsPropertyDefinition( "dataDefinedScalebarHeight", QObject::tr( "Scalebar height in mm" ), QgsPropertyDefinition::DoublePositive ) },
114 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarSubdivisionHeight ), QgsPropertyDefinition( "dataDefinedScalebarSubdivisionHeight", QObject::tr( "Subdivision height in mm" ), QgsPropertyDefinition::DoublePositive ) },
115 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ScalebarRightSegmentSubdivisions ), QgsPropertyDefinition( "dataDefinedScalebarRightSegmentSubdivisions", QObject::tr( "Number of subdivisions in segments to the right of 0" ), QgsPropertyDefinition::IntegerPositive ) },
116 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileTolerance ), QgsPropertyDefinition( "dataDefinedElevationProfileTolerance", QObject::tr( "Tolerance" ), QgsPropertyDefinition::DoublePositive ) },
117 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileDistanceMajorInterval ), QgsPropertyDefinition( "dataDefinedElevationProfileDistanceMajorInterval", QObject::tr( "Major grid line interval for elevation axis" ), QgsPropertyDefinition::DoublePositive ) },
118 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileDistanceMinorInterval ), QgsPropertyDefinition( "dataDefinedElevationProfileDistanceMinorInterval", QObject::tr( "Minor grid line interval for elevation axis" ), QgsPropertyDefinition::DoublePositive ) },
119 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileDistanceLabelInterval ), QgsPropertyDefinition( "dataDefinedElevationProfileDistanceLabelInterval", QObject::tr( "Label interval for elevation axis" ), QgsPropertyDefinition::DoublePositive ) },
120 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileElevationMajorInterval ), QgsPropertyDefinition( "dataDefinedElevationProfileElevationMajorInterval", QObject::tr( "Major grid line interval for distance axis" ), QgsPropertyDefinition::DoublePositive ) },
121 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileElevationMinorInterval ), QgsPropertyDefinition( "dataDefinedElevationProfileElevationMinorInterval", QObject::tr( "Minor grid line interval for distance axis" ), QgsPropertyDefinition::DoublePositive ) },
122 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileElevationLabelInterval ), QgsPropertyDefinition( "dataDefinedElevationProfileElevationLabelInterval", QObject::tr( "Label interval for distance axis" ), QgsPropertyDefinition::DoublePositive ) },
123 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileMinimumDistance ), QgsPropertyDefinition( "dataDefinedElevationProfileMinimumDistance", QObject::tr( "Minimum distance" ), QgsPropertyDefinition::DoublePositive ) },
124 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileMaximumDistance ), QgsPropertyDefinition( "dataDefinedElevationProfileMaximumDistance", QObject::tr( "Maximum distance" ), QgsPropertyDefinition::DoublePositive ) },
125 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileMinimumElevation ), QgsPropertyDefinition( "dataDefinedElevationProfileMinimumElevation", QObject::tr( "Minimum elevation" ), QgsPropertyDefinition::Double ) },
126 { static_cast< int >( QgsLayoutObject::DataDefinedProperty::ElevationProfileMaximumElevation ), QgsPropertyDefinition( "dataDefinedElevationProfileMaximumElevation", QObject::tr( "Maximum elevation" ), QgsPropertyDefinition::Double ) },
127 };
128}
129
130const QgsPropertiesDefinition &QgsLayoutObject::propertyDefinitions()
131{
132 QgsLayoutObject::initPropertyDefinitions();
133 return sPropertyDefinitions;
134}
135
136bool QgsLayoutObject::propertyAssociatesWithParentMultiframe( QgsLayoutObject::DataDefinedProperty property )
137{
138 switch ( property )
139 {
140 case QgsLayoutObject::DataDefinedProperty::SourceUrl:
141 case QgsLayoutObject::DataDefinedProperty::AttributeTableSourceLayer:
142 return true;
143
144 case QgsLayoutObject::DataDefinedProperty::NoProperty:
145 case QgsLayoutObject::DataDefinedProperty::AllProperties:
146 case QgsLayoutObject::DataDefinedProperty::TestProperty:
147 case QgsLayoutObject::DataDefinedProperty::PresetPaperSize:
148 case QgsLayoutObject::DataDefinedProperty::PaperWidth:
149 case QgsLayoutObject::DataDefinedProperty::PaperHeight:
150 case QgsLayoutObject::DataDefinedProperty::NumPages:
151 case QgsLayoutObject::DataDefinedProperty::PaperOrientation:
152 case QgsLayoutObject::DataDefinedProperty::PageNumber:
153 case QgsLayoutObject::DataDefinedProperty::PositionX:
154 case QgsLayoutObject::DataDefinedProperty::PositionY:
155 case QgsLayoutObject::DataDefinedProperty::ItemWidth:
156 case QgsLayoutObject::DataDefinedProperty::ItemHeight:
157 case QgsLayoutObject::DataDefinedProperty::ItemRotation:
158 case QgsLayoutObject::DataDefinedProperty::Transparency:
159 case QgsLayoutObject::DataDefinedProperty::Opacity:
160 case QgsLayoutObject::DataDefinedProperty::BlendMode:
161 case QgsLayoutObject::DataDefinedProperty::ExcludeFromExports:
162 case QgsLayoutObject::DataDefinedProperty::FrameColor:
163 case QgsLayoutObject::DataDefinedProperty::BackgroundColor:
164 case QgsLayoutObject::DataDefinedProperty::MapRotation:
165 case QgsLayoutObject::DataDefinedProperty::MapScale:
166 case QgsLayoutObject::DataDefinedProperty::MapXMin:
167 case QgsLayoutObject::DataDefinedProperty::MapYMin:
168 case QgsLayoutObject::DataDefinedProperty::MapXMax:
169 case QgsLayoutObject::DataDefinedProperty::MapYMax:
170 case QgsLayoutObject::DataDefinedProperty::MapAtlasMargin:
171 case QgsLayoutObject::DataDefinedProperty::MapLayers:
172 case QgsLayoutObject::DataDefinedProperty::MapStylePreset:
173 case QgsLayoutObject::DataDefinedProperty::MapLabelMargin:
174 case QgsLayoutObject::DataDefinedProperty::MapGridEnabled:
175 case QgsLayoutObject::DataDefinedProperty::MapGridIntervalX:
176 case QgsLayoutObject::DataDefinedProperty::MapGridIntervalY:
177 case QgsLayoutObject::DataDefinedProperty::MapGridOffsetX:
178 case QgsLayoutObject::DataDefinedProperty::MapGridOffsetY:
179 case QgsLayoutObject::DataDefinedProperty::MapGridFrameSize:
180 case QgsLayoutObject::DataDefinedProperty::MapGridFrameMargin:
181 case QgsLayoutObject::DataDefinedProperty::MapGridLabelDistance:
182 case QgsLayoutObject::DataDefinedProperty::MapGridCrossSize:
183 case QgsLayoutObject::DataDefinedProperty::MapGridFrameLineThickness:
184 case QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayLeft:
185 case QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayRight:
186 case QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayTop:
187 case QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayBottom:
188 case QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsLeft:
189 case QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsRight:
190 case QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsTop:
191 case QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsBottom:
192 case QgsLayoutObject::DataDefinedProperty::PictureSource:
193 case QgsLayoutObject::DataDefinedProperty::PictureSvgBackgroundColor:
194 case QgsLayoutObject::DataDefinedProperty::PictureSvgStrokeColor:
195 case QgsLayoutObject::DataDefinedProperty::PictureSvgStrokeWidth:
196 case QgsLayoutObject::DataDefinedProperty::LegendTitle:
197 case QgsLayoutObject::DataDefinedProperty::LegendColumnCount:
198 case QgsLayoutObject::DataDefinedProperty::ScalebarFillColor:
199 case QgsLayoutObject::DataDefinedProperty::ScalebarFillColor2:
200 case QgsLayoutObject::DataDefinedProperty::ScalebarLineColor:
201 case QgsLayoutObject::DataDefinedProperty::ScalebarLineWidth:
202 case QgsLayoutObject::DataDefinedProperty::ScalebarLeftSegments:
203 case QgsLayoutObject::DataDefinedProperty::ScalebarRightSegments:
204 case QgsLayoutObject::DataDefinedProperty::ScalebarSegmentWidth:
205 case QgsLayoutObject::DataDefinedProperty::ScalebarMinimumWidth:
206 case QgsLayoutObject::DataDefinedProperty::ScalebarMaximumWidth:
207 case QgsLayoutObject::DataDefinedProperty::ScalebarHeight:
208 case QgsLayoutObject::DataDefinedProperty::ScalebarRightSegmentSubdivisions:
209 case QgsLayoutObject::DataDefinedProperty::ScalebarSubdivisionHeight:
210 case QgsLayoutObject::DataDefinedProperty::MapCrs:
211 case QgsLayoutObject::DataDefinedProperty::StartDateTime:
212 case QgsLayoutObject::DataDefinedProperty::EndDateTime:
213 case QgsLayoutObject::DataDefinedProperty::MapZRangeLower:
214 case QgsLayoutObject::DataDefinedProperty::MapZRangeUpper:
215 case QgsLayoutObject::DataDefinedProperty::ElevationProfileTolerance:
216 case QgsLayoutObject::DataDefinedProperty::ElevationProfileDistanceMajorInterval:
217 case QgsLayoutObject::DataDefinedProperty::ElevationProfileDistanceMinorInterval:
218 case QgsLayoutObject::DataDefinedProperty::ElevationProfileDistanceLabelInterval:
219 case QgsLayoutObject::DataDefinedProperty::ElevationProfileElevationMajorInterval:
220 case QgsLayoutObject::DataDefinedProperty::ElevationProfileElevationMinorInterval:
221 case QgsLayoutObject::DataDefinedProperty::ElevationProfileElevationLabelInterval:
222 case QgsLayoutObject::DataDefinedProperty::ElevationProfileMinimumDistance:
223 case QgsLayoutObject::DataDefinedProperty::ElevationProfileMaximumDistance:
224 case QgsLayoutObject::DataDefinedProperty::ElevationProfileMinimumElevation:
225 case QgsLayoutObject::DataDefinedProperty::ElevationProfileMaximumElevation:
226 case QgsLayoutObject::DataDefinedProperty::MarginLeft:
227 case QgsLayoutObject::DataDefinedProperty::MarginRight:
228 case QgsLayoutObject::DataDefinedProperty::MarginTop:
229 case QgsLayoutObject::DataDefinedProperty::MarginBottom:
230 return false;
231 }
232 return false;
233}
234
235QgsLayoutObject::QgsLayoutObject( QgsLayout *layout )
236 : QObject( nullptr )
237 , mLayout( layout )
238{
239 initPropertyDefinitions();
240
241 if ( mLayout )
242 {
243 connect( mLayout, &QgsLayout::refreshed, this, &QgsLayoutObject::refresh );
244 connect( &mLayout->reportContext(), &QgsLayoutReportContext::changed, this, &QgsLayoutObject::refresh );
245 }
246}
247
248const QgsLayout *QgsLayoutObject::layout() const
249{
250 return mLayout.data();
251}
252
253QgsLayout *QgsLayoutObject::layout()
254{
255 return mLayout.data();
256}
257
258void QgsLayoutObject::setCustomProperty( const QString &key, const QVariant &value )
259{
260 mCustomProperties.setValue( key, value );
261}
262
263QVariant QgsLayoutObject::customProperty( const QString &key, const QVariant &defaultValue ) const
264{
265 return mCustomProperties.value( key, defaultValue );
266}
267
268void QgsLayoutObject::removeCustomProperty( const QString &key )
269{
270 mCustomProperties.remove( key );
271}
272
273QStringList QgsLayoutObject::customProperties() const
274{
275 return mCustomProperties.keys();
276}
277
278QgsExpressionContext QgsLayoutObject::createExpressionContext() const
279{
280 if ( mLayout )
281 {
282 return mLayout->createExpressionContext();
283 }
284 else
285 {
286 return QgsExpressionContext() << QgsExpressionContextUtils::globalScope();
287 }
288}
289
290bool QgsLayoutObject::writeObjectPropertiesToElement( QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext & ) const
291{
292 if ( parentElement.isNull() )
293 {
294 return false;
295 }
296
297 //create object element
298 QDomElement objectElement = document.createElement( QStringLiteral( "LayoutObject" ) );
299
300 QDomElement ddPropsElement = document.createElement( QStringLiteral( "dataDefinedProperties" ) );
301 mDataDefinedProperties.writeXml( ddPropsElement, sPropertyDefinitions );
302 objectElement.appendChild( ddPropsElement );
303
304 //custom properties
305 mCustomProperties.writeXml( objectElement, document );
306
307 parentElement.appendChild( objectElement );
308 return true;
309}
310
311bool QgsLayoutObject::readObjectPropertiesFromElement( const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext & )
312{
313 Q_UNUSED( document )
314 if ( parentElement.isNull() )
315 {
316 return false;
317 }
318
319 const QDomNodeList objectNodeList = parentElement.elementsByTagName( QStringLiteral( "LayoutObject" ) );
320 if ( objectNodeList.size() < 1 )
321 {
322 return false;
323 }
324 const QDomElement objectElement = objectNodeList.at( 0 ).toElement();
325
326 const QDomNode propsNode = objectElement.namedItem( QStringLiteral( "dataDefinedProperties" ) );
327 if ( !propsNode.isNull() )
328 {
329 mDataDefinedProperties.readXml( propsNode.toElement(), sPropertyDefinitions );
330 }
331
332 //custom properties
333 mCustomProperties.readXml( objectElement );
334
335 return true;
336}
QgsAbstractPropertyCollection::readXml
virtual bool readXml(const QDomElement &collectionElem, const QgsPropertiesDefinition &definitions)
Reads property collection state from an XML element.
Definition qgspropertycollection.cpp:108
QgsAbstractPropertyCollection::writeXml
virtual bool writeXml(QDomElement &collectionElem, const QgsPropertiesDefinition &definitions) const
Writes the current state of the property collection into an XML element.
Definition qgspropertycollection.cpp:99
QgsExpressionContextUtils::globalScope
static QgsExpressionContextScope * globalScope()
Creates a new scope which contains variables and functions relating to the global QGIS context.
Definition qgsexpressioncontextutils.cpp:45
QgsExpressionContext
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
Definition qgsexpressioncontext.h:471
QgsLayoutObject::customProperties
QStringList customProperties() const
Returns list of keys stored in custom properties for the object.
Definition qgslayoutobject.cpp:273
QgsLayoutObject::customProperty
QVariant customProperty(const QString &key, const QVariant &defaultValue=QVariant()) const
Read a custom property from the object.
Definition qgslayoutobject.cpp:263
QgsLayoutObject::propertyDefinitions
static const QgsPropertiesDefinition & propertyDefinitions()
Returns the layout object property definitions.
Definition qgslayoutobject.cpp:130
QgsLayoutObject::mCustomProperties
QgsObjectCustomProperties mCustomProperties
Custom properties for object.
Definition qgslayoutobject.h:396
QgsLayoutObject::mDataDefinedProperties
QgsPropertyCollection mDataDefinedProperties
Definition qgslayoutobject.h:393
QgsLayoutObject::readObjectPropertiesFromElement
bool readObjectPropertiesFromElement(const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context)
Sets object properties from a DOM element.
Definition qgslayoutobject.cpp:311
QgsLayoutObject::layout
const QgsLayout * layout() const
Returns the layout the object is attached to.
Definition qgslayoutobject.cpp:248
QgsLayoutObject::setCustomProperty
void setCustomProperty(const QString &key, const QVariant &value)
Set a custom property for the object.
Definition qgslayoutobject.cpp:258
QgsLayoutObject::refresh
virtual void refresh()
Refreshes the object, causing a recalculation of any property overrides.
Definition qgslayoutobject.h:360
QgsLayoutObject::mLayout
QPointer< QgsLayout > mLayout
Definition qgslayoutobject.h:391
QgsLayoutObject::createExpressionContext
QgsExpressionContext createExpressionContext() const override
Creates an expression context relating to the objects' current state.
Definition qgslayoutobject.cpp:278
QgsLayoutObject::removeCustomProperty
void removeCustomProperty(const QString &key)
Remove a custom property from the object.
Definition qgslayoutobject.cpp:268
QgsLayoutObject::DataDefinedProperty
DataDefinedProperty
Data defined properties for different item types.
Definition qgslayoutobject.h:142
QgsLayoutObject::DataDefinedProperty::MapYMin
@ MapYMin
Map extent y minimum.
QgsLayoutObject::DataDefinedProperty::MapZRangeUpper
@ MapZRangeUpper
Map frame Z-range lower value.
QgsLayoutObject::DataDefinedProperty::ScalebarMinimumWidth
@ ScalebarMinimumWidth
Scalebar segment minimum width.
QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsBottom
@ MapGridFrameDivisionsBottom
Map frame division display bottom.
QgsLayoutObject::DataDefinedProperty::MapGridIntervalX
@ MapGridIntervalX
Map grid interval X.
QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsTop
@ MapGridFrameDivisionsTop
Map frame division display top.
QgsLayoutObject::DataDefinedProperty::ExcludeFromExports
@ ExcludeFromExports
Exclude item from exports.
QgsLayoutObject::DataDefinedProperty::PaperWidth
@ PaperWidth
Paper width (deprecated)
QgsLayoutObject::DataDefinedProperty::StartDateTime
@ StartDateTime
Temporal range's start DateTime.
QgsLayoutObject::DataDefinedProperty::PictureSvgStrokeColor
@ PictureSvgStrokeColor
SVG stroke color.
QgsLayoutObject::DataDefinedProperty::MapZRangeLower
@ MapZRangeLower
Map frame Z-range lower value.
QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayLeft
@ MapGridAnnotationDisplayLeft
Map annotation display left.
QgsLayoutObject::DataDefinedProperty::TestProperty
@ TestProperty
Dummy property with no effect on item.
QgsLayoutObject::DataDefinedProperty::PaperOrientation
@ PaperOrientation
Paper orientation.
QgsLayoutObject::DataDefinedProperty::MapXMax
@ MapXMax
Map extent x maximum.
QgsLayoutObject::DataDefinedProperty::MapGridFrameMargin
@ MapGridFrameMargin
Map grid frame margin.
QgsLayoutObject::DataDefinedProperty::MapStylePreset
@ MapStylePreset
Layer and style map theme.
QgsLayoutObject::DataDefinedProperty::PageNumber
@ PageNumber
Page number for item placement.
QgsLayoutObject::DataDefinedProperty::MapYMax
@ MapYMax
Map extent y maximum.
QgsLayoutObject::DataDefinedProperty::MapGridCrossSize
@ MapGridCrossSize
Map grid cross size.
QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayRight
@ MapGridAnnotationDisplayRight
Map annotation display right.
QgsLayoutObject::DataDefinedProperty::NumPages
@ NumPages
Number of pages in composition (deprecated)
QgsLayoutObject::DataDefinedProperty::ElevationProfileMaximumDistance
@ ElevationProfileMaximumDistance
Maximum distance value for elevation profile.
QgsLayoutObject::DataDefinedProperty::PaperHeight
@ PaperHeight
Paper height (deprecated)
QgsLayoutObject::DataDefinedProperty::ScalebarRightSegments
@ ScalebarRightSegments
Number of segments on the right of 0.
QgsLayoutObject::DataDefinedProperty::ScalebarLineColor
@ ScalebarLineColor
Scalebar line color (deprecated, use data defined properties on scalebar line symbol instead)
QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayTop
@ MapGridAnnotationDisplayTop
Map annotation display top.
QgsLayoutObject::DataDefinedProperty::ElevationProfileElevationMinorInterval
@ ElevationProfileElevationMinorInterval
Minor grid line interval for elevation profile elevation axis.
QgsLayoutObject::DataDefinedProperty::MapGridAnnotationDisplayBottom
@ MapGridAnnotationDisplayBottom
Map annotation display bottom.
QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsRight
@ MapGridFrameDivisionsRight
Map frame division display right.
QgsLayoutObject::DataDefinedProperty::ScalebarRightSegmentSubdivisions
@ ScalebarRightSegmentSubdivisions
Number of subdivisions per segment on right of 0.
QgsLayoutObject::DataDefinedProperty::ElevationProfileDistanceMinorInterval
@ ElevationProfileDistanceMinorInterval
Minor grid line interval for elevation profile distance axis.
QgsLayoutObject::DataDefinedProperty::Transparency
@ Transparency
Item transparency (deprecated)
QgsLayoutObject::DataDefinedProperty::MapGridLabelDistance
@ MapGridLabelDistance
Map grid label distance.
QgsLayoutObject::DataDefinedProperty::ElevationProfileMinimumDistance
@ ElevationProfileMinimumDistance
Minimum distance value for elevation profile.
QgsLayoutObject::DataDefinedProperty::ElevationProfileMaximumElevation
@ ElevationProfileMaximumElevation
Maximum elevation value for elevation profile.
QgsLayoutObject::DataDefinedProperty::ScalebarMaximumWidth
@ ScalebarMaximumWidth
Scalebar segment maximum width.
QgsLayoutObject::DataDefinedProperty::ElevationProfileDistanceLabelInterval
@ ElevationProfileDistanceLabelInterval
Label interval for elevation profile distance axis.
QgsLayoutObject::DataDefinedProperty::MapGridIntervalY
@ MapGridIntervalY
Map grid interval Y.
QgsLayoutObject::DataDefinedProperty::ElevationProfileTolerance
@ ElevationProfileTolerance
Tolerance distance for elevation profiles.
QgsLayoutObject::DataDefinedProperty::EndDateTime
@ EndDateTime
Temporal range's end DateTime.
QgsLayoutObject::DataDefinedProperty::ScalebarFillColor2
@ ScalebarFillColor2
Scalebar secondary fill color (deprecated, use data defined properties on scalebar fill symbol 2 inst...
QgsLayoutObject::DataDefinedProperty::ScalebarSubdivisionHeight
@ ScalebarSubdivisionHeight
Scalebar subdivision height.
QgsLayoutObject::DataDefinedProperty::ElevationProfileMinimumElevation
@ ElevationProfileMinimumElevation
Minimum elevation value for elevation profile.
QgsLayoutObject::DataDefinedProperty::BackgroundColor
@ BackgroundColor
Item background color.
QgsLayoutObject::DataDefinedProperty::PresetPaperSize
@ PresetPaperSize
Preset paper size for composition.
QgsLayoutObject::DataDefinedProperty::ScalebarFillColor
@ ScalebarFillColor
Scalebar fill color (deprecated, use data defined properties on scalebar fill symbol 1 instead)
QgsLayoutObject::DataDefinedProperty::MapGridFrameSize
@ MapGridFrameSize
Map grid frame size.
QgsLayoutObject::DataDefinedProperty::ScalebarLineWidth
@ ScalebarLineWidth
Scalebar line width (deprecated, use data defined properties on scalebar line symbol instead)
QgsLayoutObject::DataDefinedProperty::PictureSvgBackgroundColor
@ PictureSvgBackgroundColor
SVG background color.
QgsLayoutObject::DataDefinedProperty::PictureSource
@ PictureSource
Picture source url.
QgsLayoutObject::DataDefinedProperty::AttributeTableSourceLayer
@ AttributeTableSourceLayer
Attribute table source layer.
QgsLayoutObject::DataDefinedProperty::ScalebarLeftSegments
@ ScalebarLeftSegments
Number of segments on the left of 0.
QgsLayoutObject::DataDefinedProperty::ElevationProfileElevationLabelInterval
@ ElevationProfileElevationLabelInterval
Label interval for elevation profile elevation axis.
QgsLayoutObject::DataDefinedProperty::MapGridFrameLineThickness
@ MapGridFrameLineThickness
Map grid frame line thickness.
QgsLayoutObject::DataDefinedProperty::ElevationProfileDistanceMajorInterval
@ ElevationProfileDistanceMajorInterval
Major grid line interval for elevation profile distance axis.
QgsLayoutObject::DataDefinedProperty::ScalebarSegmentWidth
@ ScalebarSegmentWidth
Scalebar width in map units of a single segment.
QgsLayoutObject::DataDefinedProperty::ElevationProfileElevationMajorInterval
@ ElevationProfileElevationMajorInterval
Major grid line interval for elevation profile elevation axis.
QgsLayoutObject::DataDefinedProperty::LegendColumnCount
@ LegendColumnCount
Legend column count.
QgsLayoutObject::DataDefinedProperty::MapGridFrameDivisionsLeft
@ MapGridFrameDivisionsLeft
Map frame division display left.
QgsLayoutObject::DataDefinedProperty::MapXMin
@ MapXMin
Map extent x minimum.
QgsLayoutObject::DataDefinedProperty::PictureSvgStrokeWidth
@ PictureSvgStrokeWidth
SVG stroke width.
QgsLayoutObject::DataDefinedProperty::AllProperties
@ AllProperties
All properties for item.
QgsLayoutObject::QgsLayoutObject
QgsLayoutObject(QgsLayout *layout)
Constructor for QgsLayoutObject, with the specified parent layout.
Definition qgslayoutobject.cpp:235
QgsLayoutObject::writeObjectPropertiesToElement
bool writeObjectPropertiesToElement(QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const
Stores object properties within an XML DOM element.
Definition qgslayoutobject.cpp:290
QgsLayoutObject::propertyAssociatesWithParentMultiframe
static bool propertyAssociatesWithParentMultiframe(DataDefinedProperty property)
Returns true if the specified property key is normally associated with the parent QgsLayoutMultiFrame...
Definition qgslayoutobject.cpp:136
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:49
QgsLayout::refreshed
void refreshed()
Emitted when the layout has been refreshed and items should also be refreshed and updated.
QgsObjectCustomProperties::setValue
void setValue(const QString &key, const QVariant &value)
Add an entry to the store with the specified key.
Definition qgsobjectcustomproperties.cpp:31
QgsObjectCustomProperties::keys
QStringList keys() const
Returns a list of all stored keys.
Definition qgsobjectcustomproperties.cpp:26
QgsObjectCustomProperties::writeXml
void writeXml(QDomNode &parentNode, QDomDocument &doc) const
Writes the store contents to an XML node.
Definition qgsobjectcustomproperties.cpp:124
QgsObjectCustomProperties::remove
void remove(const QString &key)
Removes a key (entry) from the store.
Definition qgsobjectcustomproperties.cpp:41
QgsObjectCustomProperties::value
QVariant value(const QString &key, const QVariant &defaultValue=QVariant()) const
Returns the value for the given key.
Definition qgsobjectcustomproperties.cpp:36
QgsObjectCustomProperties::readXml
void readXml(const QDomNode &parentNode, const QString &keyStartsWith=QString())
Read store contents from an XML node.
Definition qgsobjectcustomproperties.cpp:51
QgsPropertyDefinition
Definition for a property.
Definition qgsproperty.h:45
QgsPropertyDefinition::Double
@ Double
Double value (including negative values)
Definition qgsproperty.h:55
QgsPropertyDefinition::StrokeWidth
@ StrokeWidth
Line stroke width.
Definition qgsproperty.h:70
QgsPropertyDefinition::String
@ String
Any string value.
Definition qgsproperty.h:59
QgsPropertyDefinition::DateTime
@ DateTime
DateTime value.
Definition qgsproperty.h:77
QgsPropertyDefinition::BlendMode
@ BlendMode
Blend mode.
Definition qgsproperty.h:65
QgsPropertyDefinition::Boolean
@ Boolean
Boolean value.
Definition qgsproperty.h:51
QgsPropertyDefinition::IntegerPositiveGreaterZero
@ IntegerPositiveGreaterZero
Non-zero positive integer values.
Definition qgsproperty.h:54
QgsPropertyDefinition::IntegerPositive
@ IntegerPositive
Positive integer values (including 0)
Definition qgsproperty.h:53
QgsPropertyDefinition::Opacity
@ Opacity
Opacity (0-100)
Definition qgsproperty.h:60
QgsPropertyDefinition::Rotation
@ Rotation
Rotation (value between 0-360 degrees)
Definition qgsproperty.h:58
QgsPropertyDefinition::ColorWithAlpha
@ ColorWithAlpha
Color with alpha channel.
Definition qgsproperty.h:62
QgsPropertyDefinition::DoublePositive
@ DoublePositive
Positive double value (including 0)
Definition qgsproperty.h:56
QgsPropertyDefinition::DataTypeString
@ DataTypeString
Property requires a string value.
Definition qgsproperty.h:90
QgsReadWriteContext
The class is used as a container of context for various read/write operations on other objects.
Definition qgsreadwritecontext.h:34
QgsPropertiesDefinition
QMap< int, QgsPropertyDefinition > QgsPropertiesDefinition
Definition of available properties.
Definition qgspropertycollection.h:32
Generated on Thu Dec 26 2024 02:19:01 for QGIS API Documentation by doxygen 1.9.8