QGIS API Documentation
3.0.2-Girona (307d082)
|
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. More... | |
virtual void | draw (QPainter *painter)=0 |
Draws the item on to a destination painter. More... | |
bool | enabled () const |
Returns whether the item will be drawn. More... | |
virtual void | finalizeRestoreFromXml () |
Called after all pending items have been restored from XML. More... | |
QString | id () const |
Returns the unique id for the map item. More... | |
const QgsLayoutItemMap * | map () const |
Returns the layout item map for the item. More... | |
QString | name () const |
Returns the friendly display name for the item. More... | |
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. More... | |
void | setEnabled (bool enabled) |
Controls whether the item will be drawn. More... | |
void | setMap (QgsLayoutItemMap *map) |
Sets the corresponding layout map for the item. More... | |
void | setName (const QString &name) |
Sets the friendly display name for the item. More... | |
virtual bool | usesAdvancedEffects () const |
Returns true if the item is drawn using advanced effects, such as blend modes. More... | |
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. More... | |
Public Member Functions inherited from QgsLayoutObject | |
QgsLayoutObject (QgsLayout *layout) | |
Constructor for QgsLayoutObject, with the specified parent layout. More... | |
QgsExpressionContext | createExpressionContext () const override |
Creates an expression context relating to the objects' current state. More... | |
QStringList | customProperties () const |
Return list of keys stored in custom properties for the object. More... | |
QVariant | customProperty (const QString &key, const QVariant &defaultValue=QVariant()) const |
Read a custom property from the object. More... | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the object's property collection, used for data defined overrides. More... | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the object's property collection, used for data defined overrides. More... | |
const QgsLayout * | layout () const |
Returns the layout the object is attached to. More... | |
QgsLayout * | layout () |
Returns the layout the object is attached to. More... | |
void | removeCustomProperty (const QString &key) |
Remove a custom property from the object. More... | |
void | setCustomProperty (const QString &key, const QVariant &value) |
Set a custom property for the object. More... | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the objects's property collection, used for data defined overrides. More... | |
Public Member Functions inherited from QgsExpressionContextGenerator | |
virtual | ~QgsExpressionContextGenerator ()=default |
Protected Attributes | |
bool | mEnabled |
True if item is to be displayed on map. More... | |
QgsLayoutItemMap * | mMap = nullptr |
Associated map. More... | |
QString | mName |
Friendly display name. More... | |
QString | mUuid |
Unique id. More... | |
Protected Attributes inherited from QgsLayoutObject | |
QgsObjectCustomProperties | mCustomProperties |
Custom properties for object. More... | |
QgsPropertyCollection | mDataDefinedProperties |
QPointer< QgsLayout > | mLayout |
Additional Inherited Members | |
Public Types inherited from QgsLayoutObject | |
enum | DataDefinedProperty { NoProperty = 0, AllProperties, TestProperty, PresetPaperSize, PaperWidth, PaperHeight, NumPages, PaperOrientation, PageNumber, PositionX, PositionY, ItemWidth, ItemHeight, ItemRotation, Transparency, Opacity, BlendMode, ExcludeFromExports, FrameColor, BackgroundColor, MapRotation, MapScale, MapXMin, MapYMin, MapXMax, MapYMax, MapAtlasMargin, MapLayers, MapStylePreset, PictureSource, PictureSvgBackgroundColor, PictureSvgStrokeColor, PictureSvgStrokeWidth, SourceUrl, LegendTitle, LegendColumnCount, ScalebarFillColor, ScalebarFillColor2, ScalebarLineColor, ScalebarLineWidth } |
Data defined properties for different item types. More... | |
enum | PropertyValueType { EvaluatedValue = 0, OriginalValue } |
Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property. More... | |
Public Slots inherited from QgsLayoutObject | |
virtual void | refresh () |
Refreshes the object, causing a recalculation of any property overrides. More... | |
Signals inherited from QgsLayoutObject | |
void | changed () |
Emitted when the object's properties change. More... | |
Static Public Member Functions inherited from QgsLayoutObject | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the layout object property definitions. More... | |
Protected Member Functions inherited from QgsLayoutObject | |
bool | readObjectPropertiesFromElement (const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context) |
Sets object properties from a DOM element. More... | |
bool | writeObjectPropertiesToElement (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const |
Stores object properties within an XML DOM element. More... | |
An item which is drawn inside a QgsLayoutItemMap, e.g., a grid or map overview.
Definition at line 32 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 22 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 79 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 50 of file qgslayoutitemmapitem.cpp.
|
inline |
Returns the unique id for the map item.
Definition at line 89 of file qgslayoutitemmapitem.h.
const QgsLayoutItemMap * QgsLayoutItemMapItem::map | ( | ) | const |
Returns the layout item map for the item.
Definition at line 59 of file qgslayoutitemmapitem.cpp.
QString QgsLayoutItemMapItem::name | ( | ) | const |
Returns the friendly display name for the item.
Definition at line 69 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 41 of file qgslayoutitemmapitem.cpp.
void QgsLayoutItemMapItem::setEnabled | ( | bool | enabled | ) |
Controls whether the item will be drawn.
Set enabled to true to enable drawing of the item.
Definition at line 74 of file qgslayoutitemmapitem.cpp.
void QgsLayoutItemMapItem::setMap | ( | QgsLayoutItemMap * | map | ) |
Sets the corresponding layout map for the item.
Definition at line 54 of file qgslayoutitemmapitem.cpp.
void QgsLayoutItemMapItem::setName | ( | const QString & | name | ) |
Sets the friendly display name for the item.
Definition at line 64 of file qgslayoutitemmapitem.cpp.
|
virtual |
Returns true if the item is drawn using advanced effects, such as blend modes.
Reimplemented in QgsLayoutItemMapGrid, and QgsLayoutItemMapOverview.
Definition at line 84 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 32 of file qgslayoutitemmapitem.cpp.
|
protected |
True if item is to be displayed on map.
Definition at line 132 of file qgslayoutitemmapitem.h.
|
protected |
Associated map.
Definition at line 126 of file qgslayoutitemmapitem.h.
|
protected |
Friendly display name.
Definition at line 123 of file qgslayoutitemmapitem.h.
|
protected |
Unique id.
Definition at line 129 of file qgslayoutitemmapitem.h.