QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
Public Member Functions | Protected Attributes | List of all members
QgsComposerMapItem Class Referenceabstract

An item which is drawn inside a QgsComposerMap, eg a grid or map overview. More...

#include <qgscomposermapitem.h>

Inheritance diagram for QgsComposerMapItem:
Inheritance graph
[legend]

Public Member Functions

 QgsComposerMapItem (const QString &name, QgsComposerMap *map)
 Constructor for QgsComposerMapItem. More...
 
virtual ~QgsComposerMapItem ()
 
virtual const QgsComposerMapcomposerMap () const
 Get composer map for the item. More...
 
virtual void draw (QPainter *painter)=0
 Draws the item on to a painter. More...
 
virtual bool enabled () const
 Returns whether the item will be drawn. More...
 
QString id () const
 Get the unique id for the map item. More...
 
virtual QString name () const
 Get friendly display name for the item. More...
 
virtual bool readXML (const QDomElement &itemElem, const QDomDocument &doc) override
 Sets map item state from a DOM document. More...
 
virtual void setComposerMap (QgsComposerMap *map)
 Sets composer map for the item. More...
 
virtual void setEnabled (const bool enabled)
 Controls whether the item will be drawn. More...
 
virtual 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 &elem, QDomDocument &doc) const override
 Stores map item state in DOM element. More...
 
- Public Member Functions inherited from QgsComposerObject
 QgsComposerObject (QgsComposition *composition)
 Constructor. More...
 
virtual ~QgsComposerObject ()
 
const QgsCompositioncomposition () const
 Returns the composition the item is attached to. More...
 
QgsCompositioncomposition ()
 
virtual QgsExpressionContextcreateExpressionContext () const
 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...
 
QgsDataDefineddataDefinedProperty (const DataDefinedProperty property) const
 Returns a reference to the data defined settings for one of the item's data defined properties. 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 setDataDefinedProperty (const DataDefinedProperty property, const bool active, const bool useExpression, const QString &expression, const QString &field)
 Sets parameters for a data defined property for the item. More...
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 

Protected Attributes

QgsComposerMapmComposerMap
 Associated composer map. More...
 
bool mEnabled
 True if item is to be displayed on map. More...
 
QString mName
 Friendly display name. More...
 
QString mUuid
 Unique id. More...
 
- Protected Attributes inherited from QgsComposerObject
QgsCompositionmComposition
 
QgsObjectCustomProperties mCustomProperties
 Custom properties for object. More...
 
QMap< QgsComposerObject::DataDefinedProperty, QStringmDataDefinedNames
 Map of data defined properties for the item to string name to use when exporting item to xml. More...
 

Additional Inherited Members

- Public Types inherited from QgsComposerObject
enum  DataDefinedProperty {
  NoProperty = 0, AllProperties, TestProperty, PresetPaperSize,
  PaperWidth, PaperHeight, NumPages, PaperOrientation,
  PageNumber, PositionX, PositionY, ItemWidth,
  ItemHeight, ItemRotation, Transparency, BlendMode,
  ExcludeFromExports, MapRotation, MapScale, MapXMin,
  MapYMin, MapXMax, MapYMax, MapAtlasMargin,
  MapLayers, MapStylePreset, PictureSource, SourceUrl
}
 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 QgsComposerObject
virtual void refreshDataDefinedProperty (const DataDefinedProperty property=AllProperties, const QgsExpressionContext *context=nullptr)
 Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value. More...
 
virtual void repaint ()
 Triggers a redraw for the item. More...
 
- Signals inherited from QgsComposerObject
void itemChanged ()
 Emitted when the item changes. More...
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QgsComposerObject
bool dataDefinedEvaluate (const QgsComposerObject::DataDefinedProperty property, QVariant &expressionValue, const QgsExpressionContext &context=QgsExpressionContext()) const
 Evaluate a data defined property and return the calculated value. More...
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

An item which is drawn inside a QgsComposerMap, eg a grid or map overview.

Definition at line 28 of file qgscomposermapitem.h.

Constructor & Destructor Documentation

QgsComposerMapItem::QgsComposerMapItem ( const QString name,
QgsComposerMap map 
)

Constructor for QgsComposerMapItem.

Parameters
namefriendly display name for item
mapQgsComposerMap the item is attached to

Definition at line 22 of file qgscomposermapitem.cpp.

QgsComposerMapItem::~QgsComposerMapItem ( )
virtual

Definition at line 32 of file qgscomposermapitem.cpp.

Member Function Documentation

virtual const QgsComposerMap* QgsComposerMapItem::composerMap ( ) const
inlinevirtual

Get composer map for the item.

Returns
composer map
See also
setComposerMap

Definition at line 71 of file qgscomposermapitem.h.

virtual void QgsComposerMapItem::draw ( QPainter painter)
pure virtual

Draws the item on to a painter.

Parameters
painterdestination QPainter

Implemented in QgsComposerMapGrid, and QgsComposerMapOverview.

virtual bool QgsComposerMapItem::enabled ( ) const
inlinevirtual

Returns whether the item will be drawn.

Returns
true if item will be drawn on the map
See also
setEnabled

Definition at line 100 of file qgscomposermapitem.h.

QString QgsComposerMapItem::id ( ) const
inline

Get the unique id for the map item.

Returns
unique id

Definition at line 76 of file qgscomposermapitem.h.

virtual QString QgsComposerMapItem::name ( ) const
inlinevirtual

Get friendly display name for the item.

Returns
display name
See also
setName

Definition at line 88 of file qgscomposermapitem.h.

bool QgsComposerMapItem::readXML ( const QDomElement itemElem,
const QDomDocument doc 
)
overridevirtual

Sets map item state from a DOM document.

Parameters
itemElemis DOM node corresponding to a 'ComposerMapGrid' tag
docis DOM document
See also
writeXML

Reimplemented from QgsComposerObject.

Reimplemented in QgsComposerMapGrid, and QgsComposerMapOverview.

Definition at line 46 of file qgscomposermapitem.cpp.

void QgsComposerMapItem::setComposerMap ( QgsComposerMap map)
virtual

Sets composer map for the item.

Parameters
mapcomposer map
See also
composerMap

Definition at line 55 of file qgscomposermapitem.cpp.

virtual void QgsComposerMapItem::setEnabled ( const bool  enabled)
inlinevirtual

Controls whether the item will be drawn.

Parameters
enabledset to true to enable drawing of the item
See also
enabled

Definition at line 94 of file qgscomposermapitem.h.

virtual void QgsComposerMapItem::setName ( const QString name)
inlinevirtual

Sets the friendly display name for the item.

Parameters
namedisplay name
See also
name

Definition at line 82 of file qgscomposermapitem.h.

virtual bool QgsComposerMapItem::usesAdvancedEffects ( ) const
inlinevirtual

Returns true if the item is drawn using advanced effects, such as blend modes.

Returns
true if item uses advanced effects

Reimplemented in QgsComposerMapGrid, and QgsComposerMapOverview.

Definition at line 105 of file qgscomposermapitem.h.

bool QgsComposerMapItem::writeXML ( QDomElement elem,
QDomDocument doc 
) const
overridevirtual

Stores map item state in DOM element.

Parameters
elemis DOM element corresponding to a 'ComposerMap' tag
docDOM document
See also
readXML

Reimplemented from QgsComposerObject.

Reimplemented in QgsComposerMapGrid, and QgsComposerMapOverview.

Definition at line 37 of file qgscomposermapitem.cpp.

Member Data Documentation

QgsComposerMap* QgsComposerMapItem::mComposerMap
protected

Associated composer map.

Definition at line 113 of file qgscomposermapitem.h.

bool QgsComposerMapItem::mEnabled
protected

True if item is to be displayed on map.

Definition at line 119 of file qgscomposermapitem.h.

QString QgsComposerMapItem::mName
protected

Friendly display name.

Definition at line 110 of file qgscomposermapitem.h.

QString QgsComposerMapItem::mUuid
protected

Unique id.

Definition at line 116 of file qgscomposermapitem.h.


The documentation for this class was generated from the following files: