File: qgslayoutitem.py

package info (click to toggle)
qgis 3.40.10%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,183,672 kB
  • sloc: cpp: 1,595,771; python: 372,544; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 161
file content (147 lines) | stat: -rw-r--r-- 12,760 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# The following has been generated automatically from src/core/layout/qgslayoutitem.h
QgsLayoutItem.UpperLeft = QgsLayoutItem.ReferencePoint.UpperLeft
QgsLayoutItem.UpperMiddle = QgsLayoutItem.ReferencePoint.UpperMiddle
QgsLayoutItem.UpperRight = QgsLayoutItem.ReferencePoint.UpperRight
QgsLayoutItem.MiddleLeft = QgsLayoutItem.ReferencePoint.MiddleLeft
QgsLayoutItem.Middle = QgsLayoutItem.ReferencePoint.Middle
QgsLayoutItem.MiddleRight = QgsLayoutItem.ReferencePoint.MiddleRight
QgsLayoutItem.LowerLeft = QgsLayoutItem.ReferencePoint.LowerLeft
QgsLayoutItem.LowerMiddle = QgsLayoutItem.ReferencePoint.LowerMiddle
QgsLayoutItem.LowerRight = QgsLayoutItem.ReferencePoint.LowerRight
QgsLayoutItem.UndoNone = QgsLayoutItem.UndoCommand.UndoNone
QgsLayoutItem.UndoIncrementalMove = QgsLayoutItem.UndoCommand.UndoIncrementalMove
QgsLayoutItem.UndoIncrementalResize = QgsLayoutItem.UndoCommand.UndoIncrementalResize
QgsLayoutItem.UndoStrokeColor = QgsLayoutItem.UndoCommand.UndoStrokeColor
QgsLayoutItem.UndoStrokeWidth = QgsLayoutItem.UndoCommand.UndoStrokeWidth
QgsLayoutItem.UndoBackgroundColor = QgsLayoutItem.UndoCommand.UndoBackgroundColor
QgsLayoutItem.UndoOpacity = QgsLayoutItem.UndoCommand.UndoOpacity
QgsLayoutItem.UndoMarginLeft = QgsLayoutItem.UndoCommand.UndoMarginLeft
QgsLayoutItem.UndoMarginTop = QgsLayoutItem.UndoCommand.UndoMarginTop
QgsLayoutItem.UndoMarginBottom = QgsLayoutItem.UndoCommand.UndoMarginBottom
QgsLayoutItem.UndoMarginRight = QgsLayoutItem.UndoCommand.UndoMarginRight
QgsLayoutItem.UndoSetId = QgsLayoutItem.UndoCommand.UndoSetId
QgsLayoutItem.UndoRotation = QgsLayoutItem.UndoCommand.UndoRotation
QgsLayoutItem.UndoExportLayerName = QgsLayoutItem.UndoCommand.UndoExportLayerName
QgsLayoutItem.UndoShapeStyle = QgsLayoutItem.UndoCommand.UndoShapeStyle
QgsLayoutItem.UndoShapeCornerRadius = QgsLayoutItem.UndoCommand.UndoShapeCornerRadius
QgsLayoutItem.UndoNodeMove = QgsLayoutItem.UndoCommand.UndoNodeMove
QgsLayoutItem.UndoAtlasMargin = QgsLayoutItem.UndoCommand.UndoAtlasMargin
QgsLayoutItem.UndoMapRotation = QgsLayoutItem.UndoCommand.UndoMapRotation
QgsLayoutItem.UndoZoomContent = QgsLayoutItem.UndoCommand.UndoZoomContent
QgsLayoutItem.UndoOverviewStyle = QgsLayoutItem.UndoCommand.UndoOverviewStyle
QgsLayoutItem.UndoGridFramePenColor = QgsLayoutItem.UndoCommand.UndoGridFramePenColor
QgsLayoutItem.UndoMapGridFrameFill1Color = QgsLayoutItem.UndoCommand.UndoMapGridFrameFill1Color
QgsLayoutItem.UndoMapGridFrameFill2Color = QgsLayoutItem.UndoCommand.UndoMapGridFrameFill2Color
QgsLayoutItem.UndoMapAnnotationDistance = QgsLayoutItem.UndoCommand.UndoMapAnnotationDistance
QgsLayoutItem.UndoMapGridAnnotationFontColor = QgsLayoutItem.UndoCommand.UndoMapGridAnnotationFontColor
QgsLayoutItem.UndoMapGridLineSymbol = QgsLayoutItem.UndoCommand.UndoMapGridLineSymbol
QgsLayoutItem.UndoMapGridMarkerSymbol = QgsLayoutItem.UndoCommand.UndoMapGridMarkerSymbol
QgsLayoutItem.UndoMapGridIntervalRange = QgsLayoutItem.UndoCommand.UndoMapGridIntervalRange
QgsLayoutItem.UndoMapLabelMargin = QgsLayoutItem.UndoCommand.UndoMapLabelMargin
QgsLayoutItem.UndoPictureRotation = QgsLayoutItem.UndoCommand.UndoPictureRotation
QgsLayoutItem.UndoPictureFillColor = QgsLayoutItem.UndoCommand.UndoPictureFillColor
QgsLayoutItem.UndoPictureStrokeColor = QgsLayoutItem.UndoCommand.UndoPictureStrokeColor
QgsLayoutItem.UndoPictureStrokeWidth = QgsLayoutItem.UndoCommand.UndoPictureStrokeWidth
QgsLayoutItem.UndoPictureNorthOffset = QgsLayoutItem.UndoCommand.UndoPictureNorthOffset
QgsLayoutItem.UndoLabelText = QgsLayoutItem.UndoCommand.UndoLabelText
QgsLayoutItem.UndoLabelFont = QgsLayoutItem.UndoCommand.UndoLabelFont
QgsLayoutItem.UndoLabelMargin = QgsLayoutItem.UndoCommand.UndoLabelMargin
QgsLayoutItem.UndoLabelFontColor = QgsLayoutItem.UndoCommand.UndoLabelFontColor
QgsLayoutItem.UndoLegendText = QgsLayoutItem.UndoCommand.UndoLegendText
QgsLayoutItem.UndoLegendColumnCount = QgsLayoutItem.UndoCommand.UndoLegendColumnCount
QgsLayoutItem.UndoLegendSymbolWidth = QgsLayoutItem.UndoCommand.UndoLegendSymbolWidth
QgsLayoutItem.UndoLegendSymbolHeight = QgsLayoutItem.UndoCommand.UndoLegendSymbolHeight
QgsLayoutItem.UndoLegendMaxSymbolSize = QgsLayoutItem.UndoCommand.UndoLegendMaxSymbolSize
QgsLayoutItem.UndoLegendMinSymbolSize = QgsLayoutItem.UndoCommand.UndoLegendMinSymbolSize
QgsLayoutItem.UndoLegendWmsLegendWidth = QgsLayoutItem.UndoCommand.UndoLegendWmsLegendWidth
QgsLayoutItem.UndoLegendWmsLegendHeight = QgsLayoutItem.UndoCommand.UndoLegendWmsLegendHeight
QgsLayoutItem.UndoLegendTitleSpaceBottom = QgsLayoutItem.UndoCommand.UndoLegendTitleSpaceBottom
QgsLayoutItem.UndoLegendGroupSpace = QgsLayoutItem.UndoCommand.UndoLegendGroupSpace
QgsLayoutItem.UndoLegendGroupIndent = QgsLayoutItem.UndoCommand.UndoLegendGroupIndent
QgsLayoutItem.UndoLegendSubgroupIndent = QgsLayoutItem.UndoCommand.UndoLegendSubgroupIndent
QgsLayoutItem.UndoLegendLayerSpace = QgsLayoutItem.UndoCommand.UndoLegendLayerSpace
QgsLayoutItem.UndoLegendSymbolSpace = QgsLayoutItem.UndoCommand.UndoLegendSymbolSpace
QgsLayoutItem.UndoLegendIconSymbolSpace = QgsLayoutItem.UndoCommand.UndoLegendIconSymbolSpace
QgsLayoutItem.UndoLegendFontColor = QgsLayoutItem.UndoCommand.UndoLegendFontColor
QgsLayoutItem.UndoLegendBoxSpace = QgsLayoutItem.UndoCommand.UndoLegendBoxSpace
QgsLayoutItem.UndoLegendColumnSpace = QgsLayoutItem.UndoCommand.UndoLegendColumnSpace
QgsLayoutItem.UndoLegendLineSpacing = QgsLayoutItem.UndoCommand.UndoLegendLineSpacing
QgsLayoutItem.UndoLegendRasterStrokeWidth = QgsLayoutItem.UndoCommand.UndoLegendRasterStrokeWidth
QgsLayoutItem.UndoLegendRasterStrokeColor = QgsLayoutItem.UndoCommand.UndoLegendRasterStrokeColor
QgsLayoutItem.UndoLegendTitleFont = QgsLayoutItem.UndoCommand.UndoLegendTitleFont
QgsLayoutItem.UndoLegendGroupFont = QgsLayoutItem.UndoCommand.UndoLegendGroupFont
QgsLayoutItem.UndoLegendLayerFont = QgsLayoutItem.UndoCommand.UndoLegendLayerFont
QgsLayoutItem.UndoLegendItemFont = QgsLayoutItem.UndoCommand.UndoLegendItemFont
QgsLayoutItem.UndoScaleBarLineWidth = QgsLayoutItem.UndoCommand.UndoScaleBarLineWidth
QgsLayoutItem.UndoScaleBarSegmentSize = QgsLayoutItem.UndoCommand.UndoScaleBarSegmentSize
QgsLayoutItem.UndoScaleBarSegmentsLeft = QgsLayoutItem.UndoCommand.UndoScaleBarSegmentsLeft
QgsLayoutItem.UndoScaleBarSegments = QgsLayoutItem.UndoCommand.UndoScaleBarSegments
QgsLayoutItem.UndoScaleBarHeight = QgsLayoutItem.UndoCommand.UndoScaleBarHeight
QgsLayoutItem.UndoScaleBarSubdivisions = QgsLayoutItem.UndoCommand.UndoScaleBarSubdivisions
QgsLayoutItem.UndoScaleBarSubdivisionsHeight = QgsLayoutItem.UndoCommand.UndoScaleBarSubdivisionsHeight
QgsLayoutItem.UndoScaleBarFontColor = QgsLayoutItem.UndoCommand.UndoScaleBarFontColor
QgsLayoutItem.UndoScaleBarFillColor = QgsLayoutItem.UndoCommand.UndoScaleBarFillColor
QgsLayoutItem.UndoScaleBarFillColor2 = QgsLayoutItem.UndoCommand.UndoScaleBarFillColor2
QgsLayoutItem.UndoScaleBarStrokeColor = QgsLayoutItem.UndoCommand.UndoScaleBarStrokeColor
QgsLayoutItem.UndoScaleBarUnitText = QgsLayoutItem.UndoCommand.UndoScaleBarUnitText
QgsLayoutItem.UndoScaleBarMapUnitsSegment = QgsLayoutItem.UndoCommand.UndoScaleBarMapUnitsSegment
QgsLayoutItem.UndoScaleBarLabelBarSize = QgsLayoutItem.UndoCommand.UndoScaleBarLabelBarSize
QgsLayoutItem.UndoScaleBarBoxContentSpace = QgsLayoutItem.UndoCommand.UndoScaleBarBoxContentSpace
QgsLayoutItem.UndoArrowStrokeWidth = QgsLayoutItem.UndoCommand.UndoArrowStrokeWidth
QgsLayoutItem.UndoArrowHeadWidth = QgsLayoutItem.UndoCommand.UndoArrowHeadWidth
QgsLayoutItem.UndoArrowHeadFillColor = QgsLayoutItem.UndoCommand.UndoArrowHeadFillColor
QgsLayoutItem.UndoArrowHeadStrokeColor = QgsLayoutItem.UndoCommand.UndoArrowHeadStrokeColor
QgsLayoutItem.UndoElevationProfileTolerance = QgsLayoutItem.UndoCommand.UndoElevationProfileTolerance
QgsLayoutItem.UndoElevationProfileChartBackground = QgsLayoutItem.UndoCommand.UndoElevationProfileChartBackground
QgsLayoutItem.UndoElevationProfileChartBorder = QgsLayoutItem.UndoCommand.UndoElevationProfileChartBorder
QgsLayoutItem.UndoElevationProfileDistanceMajorGridlines = QgsLayoutItem.UndoCommand.UndoElevationProfileDistanceMajorGridlines
QgsLayoutItem.UndoElevationProfileDistanceMinorGridlines = QgsLayoutItem.UndoCommand.UndoElevationProfileDistanceMinorGridlines
QgsLayoutItem.UndoElevationProfileDistanceFormat = QgsLayoutItem.UndoCommand.UndoElevationProfileDistanceFormat
QgsLayoutItem.UndoElevationProfileDistanceFont = QgsLayoutItem.UndoCommand.UndoElevationProfileDistanceFont
QgsLayoutItem.UndoElevationProfileDistanceLabels = QgsLayoutItem.UndoCommand.UndoElevationProfileDistanceLabels
QgsLayoutItem.UndoElevationProfileElevationMajorGridlines = QgsLayoutItem.UndoCommand.UndoElevationProfileElevationMajorGridlines
QgsLayoutItem.UndoElevationProfileElevationMinorGridlines = QgsLayoutItem.UndoCommand.UndoElevationProfileElevationMinorGridlines
QgsLayoutItem.UndoElevationProfileElevationFormat = QgsLayoutItem.UndoCommand.UndoElevationProfileElevationFormat
QgsLayoutItem.UndoElevationProfileElevationFont = QgsLayoutItem.UndoCommand.UndoElevationProfileElevationFont
QgsLayoutItem.UndoElevationProfileElevationLabels = QgsLayoutItem.UndoCommand.UndoElevationProfileElevationLabels
QgsLayoutItem.UndoElevationProfileMinimumDistance = QgsLayoutItem.UndoCommand.UndoElevationProfileMinimumDistance
QgsLayoutItem.UndoElevationProfileMaximumDistance = QgsLayoutItem.UndoCommand.UndoElevationProfileMaximumDistance
QgsLayoutItem.UndoElevationProfileMinimumElevation = QgsLayoutItem.UndoCommand.UndoElevationProfileMinimumElevation
QgsLayoutItem.UndoElevationProfileMaximumElevation = QgsLayoutItem.UndoCommand.UndoElevationProfileMaximumElevation
QgsLayoutItem.UndoCustomCommand = QgsLayoutItem.UndoCommand.UndoCustomCommand
QgsLayoutItem.FlagOverridesPaint = QgsLayoutItem.Flag.FlagOverridesPaint
QgsLayoutItem.FlagProvidesClipPath = QgsLayoutItem.Flag.FlagProvidesClipPath
QgsLayoutItem.FlagDisableSceneCaching = QgsLayoutItem.Flag.FlagDisableSceneCaching
QgsLayoutItem.Flags = lambda flags=0: QgsLayoutItem.Flag(flags)
QgsLayoutItem.CanGroupWithAnyOtherItem = QgsLayoutItem.ExportLayerBehavior.CanGroupWithAnyOtherItem
QgsLayoutItem.CanGroupWithItemsOfSameType = QgsLayoutItem.ExportLayerBehavior.CanGroupWithItemsOfSameType
QgsLayoutItem.MustPlaceInOwnLayer = QgsLayoutItem.ExportLayerBehavior.MustPlaceInOwnLayer
QgsLayoutItem.ItemContainsSubLayers = QgsLayoutItem.ExportLayerBehavior.ItemContainsSubLayers
from enum import Enum


def _force_int(v): return int(v.value) if isinstance(v, Enum) else v


QgsLayoutItem.Flag.__bool__ = lambda flag: bool(_force_int(flag))
QgsLayoutItem.Flag.__eq__ = lambda flag1, flag2: _force_int(flag1) == _force_int(flag2)
QgsLayoutItem.Flag.__and__ = lambda flag1, flag2: _force_int(flag1) & _force_int(flag2)
QgsLayoutItem.Flag.__or__ = lambda flag1, flag2: QgsLayoutItem.Flag(_force_int(flag1) | _force_int(flag2))
try:
    QgsLayoutItem.ExportLayerDetail.__attribute_docs__ = {'name': 'User-friendly name for the export layer', 'mapLayerId': 'Associated map layer ID, or an empty string if this export layer is not associated with a map layer', 'compositionMode': 'Associated composition mode if this layer is associated with a map layer\n\n.. versionadded:: 3.14', 'opacity': 'Associated opacity, if this layer is associated with a map layer\n\n.. versionadded:: 3.14', 'mapTheme': 'Associated map theme, or an empty string if this export layer does not need to be associated with a map theme', 'groupName': 'Associated group name, if this layer is associated with an export group.\n\n.. versionadded:: 3.40'}
    QgsLayoutItem.ExportLayerDetail.__doc__ = """Contains details of a particular export layer relating to a layout item.

.. versionadded:: 3.10"""
    QgsLayoutItem.ExportLayerDetail.__group__ = ['layout']
except (NameError, AttributeError):
    pass
try:
    QgsLayoutItem.__attribute_docs__ = {'frameChanged': "Emitted if the item's frame style changes.\n", 'lockChanged': "Emitted if the item's lock status changes.\n\n.. seealso:: :py:func:`isLocked`\n\n.. seealso:: :py:func:`setLocked`\n", 'rotationChanged': 'Emitted on item rotation change.\n', 'sizePositionChanged': "Emitted when the item's size or position changes.\n", 'backgroundTaskCountChanged': 'Emitted whenever the number of background tasks an item is executing\nchanges.\n\n.. versionadded:: 3.10\n', 'clipPathChanged': "Emitted when the item's clipping path has changed.\n\n.. seealso:: :py:func:`clipPath`\n\n.. versionadded:: 3.16\n"}
    QgsLayoutItem.__signal_arguments__ = {'rotationChanged': ['newRotation: float'], 'backgroundTaskCountChanged': ['count: int']}
    QgsLayoutItem.__group__ = ['layout']
except (NameError, AttributeError):
    pass
try:
    QgsLayoutItemRenderContext.__group__ = ['layout']
except (NameError, AttributeError):
    pass