QGIS API Documentation 3.39.0-Master (3783037d301)
|
An item which is drawn inside a QgsLayoutItemMap, e.g., a grid or map overview. More...
#include <qgslayoutitemmapitem.h>
Public Member Functions | |
QgsLayoutItemMapItem (const QString &name, QgsLayoutItemMap *map) | |
Constructor for QgsLayoutItemMapItem, attached to the specified map. | |
virtual bool | accept (QgsStyleEntityVisitorInterface *visitor) const |
Accepts the specified style entity visitor, causing it to visit all style entities associated with the map item. | |
QgsExpressionContext | createExpressionContext () const override |
This method needs to be reimplemented in all classes which implement this interface and return an expression context. | |
virtual void | draw (QPainter *painter)=0 |
Draws the item on to a destination painter. | |
bool | enabled () const |
Returns whether the item will be drawn. | |
virtual void | finalizeRestoreFromXml () |
Called after all pending items have been restored from XML. | |
QString | id () const |
Returns the unique id for the map item. | |
const QgsLayoutItemMap * | map () const |
Returns the layout item map for the item. | |
virtual QgsMapLayer * | mapLayer () |
Returns the internal map layer used by this item, if available. | |
QString | name () const |
Returns the friendly display name for the item. | |
virtual bool | readXml (const QDomElement &element, const QDomDocument &doc, const QgsReadWriteContext &context) |
Sets the map item state from a DOM document, where element is the DOM node corresponding to a 'LayoutMapGrid' tag. | |
virtual void | setEnabled (bool enabled) |
Controls whether the item will be drawn. | |
void | setMap (QgsLayoutItemMap *map) |
Sets the corresponding layout map for the item. | |
void | setName (const QString &name) |
Sets the friendly display name for the item. | |
void | setStackingLayer (QgsMapLayer *layer) |
Sets the item's stacking layer, which specifies where the in the map's stack the item should be rendered. | |
void | setStackingPosition (StackingPosition position) |
Sets the item's stacking position, which specifies where the in the map's stack the item should be rendered. | |
QgsMapLayer * | stackingLayer () const |
Returns the item's stacking layer, which specifies where the in the map's stack the item should be rendered. | |
StackingPosition | stackingPosition () const |
Returns the item's stacking position, which specifies where the in the map's stack the item should be rendered. | |
virtual bool | usesAdvancedEffects () const |
Returns true if the item is drawn using advanced effects, such as blend modes. | |
virtual bool | writeXml (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const |
Stores map item state in a DOM element, where element is the DOM element corresponding to a 'LayoutMap' tag. | |
Public Member Functions inherited from QgsLayoutObject | |
QgsLayoutObject (QgsLayout *layout) | |
Constructor for QgsLayoutObject, with the specified parent layout. | |
QgsExpressionContext | createExpressionContext () const override |
Creates an expression context relating to the objects' current state. | |
QStringList | customProperties () const |
Returns list of keys stored in custom properties for the object. | |
QVariant | customProperty (const QString &key, const QVariant &defaultValue=QVariant()) const |
Read a custom property from the object. | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the object's property collection, used for data defined overrides. | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the object's property collection, used for data defined overrides. | |
QgsLayout * | layout () |
Returns the layout the object is attached to. | |
const QgsLayout * | layout () const |
Returns the layout the object is attached to. | |
void | removeCustomProperty (const QString &key) |
Remove a custom property from the object. | |
void | setCustomProperty (const QString &key, const QVariant &value) |
Set a custom property for the object. | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the objects's property collection, used for data defined overrides. | |
Public Member Functions inherited from QgsExpressionContextGenerator | |
virtual | ~QgsExpressionContextGenerator ()=default |
Protected Attributes | |
bool | mEnabled |
True if item is to be displayed on map. | |
QgsLayoutItemMap * | mMap = nullptr |
Associated map. | |
QString | mName |
Friendly display name. | |
QgsMapLayerRef | mStackingLayer |
StackingPosition | mStackingPosition = StackBelowMapLabels |
QString | mUuid |
Unique id. | |
Protected Attributes inherited from QgsLayoutObject | |
QgsObjectCustomProperties | mCustomProperties |
Custom properties for object. | |
QgsPropertyCollection | mDataDefinedProperties |
QPointer< QgsLayout > | mLayout |
Additional Inherited Members | |
Public Slots inherited from QgsLayoutObject | |
virtual void | refresh () |
Refreshes the object, causing a recalculation of any property overrides. | |
Signals inherited from QgsLayoutObject | |
void | changed () |
Emitted when the object's properties change. | |
Static Public Member Functions inherited from QgsLayoutObject | |
static bool | propertyAssociatesWithParentMultiframe (DataDefinedProperty property) |
Returns true if the specified property key is normally associated with the parent QgsLayoutMultiFrame object instead of a child QgsLayoutFrame object. | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the layout object property definitions. | |
Protected Member Functions inherited from QgsLayoutObject | |
bool | readObjectPropertiesFromElement (const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context) |
Sets object properties from a DOM element. | |
bool | writeObjectPropertiesToElement (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const |
Stores object properties within an XML DOM element. | |
An item which is drawn inside a QgsLayoutItemMap, e.g., a grid or map overview.
Definition at line 32 of file qgslayoutitemmapitem.h.
Item stacking position, specifies where the in the map's stack the item should be rendered.
Enumerator | |
---|---|
StackBelowMap | Render below all map layers. |
StackBelowMapLayer | Render below a specific map layer (see stackingLayer()) |
StackAboveMapLayer | Render above a specific map layer (see stackingLayer()) |
StackBelowMapLabels | Render above all map layers, but below map labels. |
StackAboveMapLabels | Render above all map layers and labels. |
Definition at line 39 of file qgslayoutitemmapitem.h.
QgsLayoutItemMapItem::QgsLayoutItemMapItem | ( | const QString & | name, |
QgsLayoutItemMap * | map | ||
) |
Constructor for QgsLayoutItemMapItem, attached to the specified map.
The name argument gives a friendly display name for the item.
Definition at line 23 of file qgslayoutitemmapitem.cpp.
|
virtual |
Accepts the specified style entity visitor, causing it to visit all style entities associated with the map item.
Returns true
if the visitor should continue visiting other objects, or false
if visiting should be canceled.
Reimplemented in QgsLayoutItemMapGrid, and QgsLayoutItemMapOverview.
Definition at line 132 of file qgslayoutitemmapitem.cpp.
|
overridevirtual |
This method needs to be reimplemented in all classes which implement this interface and return an expression context.
Implements QgsExpressionContextGenerator.
Definition at line 124 of file qgslayoutitemmapitem.cpp.
|
pure virtual |
Draws the item on to a destination painter.
Implemented in QgsLayoutItemMapGrid, and QgsLayoutItemMapOverview.
bool QgsLayoutItemMapItem::enabled | ( | ) | const |
Returns whether the item will be drawn.
Definition at line 104 of file qgslayoutitemmapitem.cpp.
|
virtual |
Called after all pending items have been restored from XML.
Map items can use this method to run steps which must take place after all items have been restored to the layout, such as connecting to signals emitted by other items, which may not have existed in the layout at the time readXml() was called. E.g. an overview can use this to connect to its linked map item after restoration from XML.
Reimplemented in QgsLayoutItemMapOverview.
Definition at line 75 of file qgslayoutitemmapitem.cpp.
|
inline |
Returns the unique id for the map item.
Definition at line 99 of file qgslayoutitemmapitem.h.
const QgsLayoutItemMap * QgsLayoutItemMapItem::map | ( | ) | const |
Returns the layout item map for the item.
Definition at line 84 of file qgslayoutitemmapitem.cpp.
|
virtual |
Returns the internal map layer used by this item, if available.
Reimplemented in QgsLayoutItemMapOverview.
Definition at line 137 of file qgslayoutitemmapitem.cpp.
QString QgsLayoutItemMapItem::name | ( | ) | const |
Returns the friendly display name for the item.
Definition at line 94 of file qgslayoutitemmapitem.cpp.
|
virtual |
Sets the map item state from a DOM document, where element is the DOM node corresponding to a 'LayoutMapGrid' tag.
Reimplemented in QgsLayoutItemMapGrid, and QgsLayoutItemMapOverview.
Definition at line 55 of file qgslayoutitemmapitem.cpp.
|
virtual |
Controls whether the item will be drawn.
Set enabled to true
to enable drawing of the item.
Reimplemented in QgsLayoutItemMapGrid.
Definition at line 99 of file qgslayoutitemmapitem.cpp.
void QgsLayoutItemMapItem::setMap | ( | QgsLayoutItemMap * | map | ) |
Sets the corresponding layout map for the item.
Definition at line 79 of file qgslayoutitemmapitem.cpp.
void QgsLayoutItemMapItem::setName | ( | const QString & | name | ) |
Sets the friendly display name for the item.
Definition at line 89 of file qgslayoutitemmapitem.cpp.
void QgsLayoutItemMapItem::setStackingLayer | ( | QgsMapLayer * | layer | ) |
Sets the item's stacking layer, which specifies where the in the map's stack the item should be rendered.
This setting is only used when stackingPosition() is StackBelowMapLayer or StackAboveMapLayer.
Definition at line 119 of file qgslayoutitemmapitem.cpp.
|
inline |
Sets the item's stacking position, which specifies where the in the map's stack the item should be rendered.
Definition at line 150 of file qgslayoutitemmapitem.h.
QgsMapLayer * QgsLayoutItemMapItem::stackingLayer | ( | ) | const |
Returns the item's stacking layer, which specifies where the in the map's stack the item should be rendered.
This setting is only used when stackingPosition() is StackBelowMapLayer or StackAboveMapLayer.
Definition at line 114 of file qgslayoutitemmapitem.cpp.
|
inline |
Returns the item's stacking position, which specifies where the in the map's stack the item should be rendered.
Definition at line 139 of file qgslayoutitemmapitem.h.
|
virtual |
Returns true
if the item is drawn using advanced effects, such as blend modes.
Reimplemented in QgsLayoutItemMapGrid, and QgsLayoutItemMapOverview.
Definition at line 109 of file qgslayoutitemmapitem.cpp.
|
virtual |
Stores map item state in a DOM element, where element is the DOM element corresponding to a 'LayoutMap' tag.
Reimplemented in QgsLayoutItemMapGrid, and QgsLayoutItemMapOverview.
Definition at line 33 of file qgslayoutitemmapitem.cpp.
|
protected |
True if item is to be displayed on map.
Definition at line 212 of file qgslayoutitemmapitem.h.
|
protected |
Associated map.
Definition at line 206 of file qgslayoutitemmapitem.h.
|
protected |
Friendly display name.
Definition at line 203 of file qgslayoutitemmapitem.h.
|
protected |
Definition at line 216 of file qgslayoutitemmapitem.h.
|
protected |
Definition at line 214 of file qgslayoutitemmapitem.h.
|
protected |
Unique id.
Definition at line 209 of file qgslayoutitemmapitem.h.