QGIS API Documentation  2.11.0-Master
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
QgsComposerItem Class Reference

A item that forms part of a map composition. More...

#include <qgscomposeritem.h>

Inheritance diagram for QgsComposerItem:
Inheritance graph
[legend]

Public Types

enum  ItemPositionMode {
  UpperLeft, UpperMiddle, UpperRight, MiddleLeft,
  Middle, MiddleRight, LowerLeft, LowerMiddle,
  LowerRight
}
 
enum  ItemType {
  ComposerItem = UserType + 100, ComposerArrow, ComposerItemGroup, ComposerLabel,
  ComposerLegend, ComposerMap, ComposerPaper, ComposerPicture,
  ComposerScaleBar, ComposerShape, ComposerTable, ComposerAttributeTable,
  ComposerTextTable, ComposerFrame
}
 
enum  MouseMoveAction {
  MoveItem, ResizeUp, ResizeDown, ResizeLeft,
  ResizeRight, ResizeLeftUp, ResizeRightUp, ResizeLeftDown,
  ResizeRightDown, NoAction
}
 Describes the action (move or resize in different directon) to be done during mouse move. More...
 
enum  ZoomMode { Zoom = 0, ZoomRecenter, ZoomToPoint, NoZoom }
 Modes for zooming item content. More...
 
- 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,
  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

virtual void refreshDataDefinedProperty (const QgsComposerObject::DataDefinedProperty property=QgsComposerObject::AllProperties) override
 Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value. More...
 
void repaint () override
 
virtual void setItemRotation (const double r, const bool adjustPosition=false)
 Sets the item rotation. More...
 
virtual void setRotation (double r)
 Sets the item rotation. More...
 
- Public Slots inherited from QgsComposerObject
virtual void refreshDataDefinedProperty (const DataDefinedProperty property=AllProperties)
 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

void frameChanged ()
 Emitted if the item's frame style changes. More...
 
void itemRotationChanged (double newRotation)
 Is emitted on item rotation change. More...
 
void lockChanged ()
 Emitted if the item's lock status changes. More...
 
void sizeChanged ()
 Emitted if the rectangle changes. More...
 
- Signals inherited from QgsComposerObject
void itemChanged ()
 Emitted when the item changes. More...
 

Public Member Functions

 QgsComposerItem (QgsComposition *composition, bool manageZValue=true)
 Constructor. More...
 
 QgsComposerItem (qreal x, qreal y, qreal width, qreal height, QgsComposition *composition, bool manageZValue=true)
 Constructor with box position and composer object. More...
 
virtual ~QgsComposerItem ()
 
bool _readXML (const QDomElement &itemElem, const QDomDocument &doc)
 Reads parameter that are not subclass specific in document. More...
 
bool _writeXML (QDomElement &itemElem, QDomDocument &doc) const
 Writes parameter that are not subclass specific in document. More...
 
virtual void addItem (QgsComposerItem *item)
 Composite operations for item groups do nothing per default. More...
 
QColor backgroundColor () const
 Gets the background color for this item. More...
 
void beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown)
 Starts new composer undo command. More...
 
virtual void beginItemCommand (const QString &text)
 
QPainter::CompositionMode blendMode () const
 Returns the item's composition blending mode. More...
 
void cancelCommand ()
 
virtual QString displayName () const
 Get item display name. More...
 
Q_DECL_DEPRECATED void drawText (QPainter *p, double x, double y, const QString &text, const QFont &font, const QColor &c=QColor()) const
 Draws Text. More...
 
Q_DECL_DEPRECATED void drawText (QPainter *p, const QRectF &rect, const QString &text, const QFont &font, Qt::AlignmentFlag halignment=Qt::AlignLeft, Qt::AlignmentFlag valignment=Qt::AlignTop, int flags=Qt::TextWordWrap) const
 Like the above, but with a rectangle for multiline text. More...
 
bool effectsEnabled () const
 Returns whether effects (eg blend modes) are enabled for the item. More...
 
void endCommand ()
 Finish current command and push it onto the undo stack. More...
 
virtual void endItemCommand ()
 
virtual double estimatedFrameBleed () const
 Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. More...
 
bool excludeFromExports (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue)
 Returns whether the item should be excluded from composer exports and prints. More...
 
Q_DECL_DEPRECATED double fontAscentMillimeters (const QFont &font) const
 Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
Q_DECL_DEPRECATED double fontDescentMillimeters (const QFont &font) const
 Returns the font descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
Q_DECL_DEPRECATED double fontHeightCharacterMM (const QFont &font, const QChar &c) const
 Returns the font height of a character in millimeters. More...
 
Q_DECL_DEPRECATED double fontHeightMillimeters (const QFont &font) const
 Returns the font height in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
Qt::PenJoinStyle frameJoinStyle () const
 Returns the join style used for drawing the item's frame. More...
 
QColor frameOutlineColor () const
 Returns the frame's outline color. More...
 
double frameOutlineWidth () const
 Returns the frame's outline width. More...
 
bool hasBackground () const
 Whether this item has a Background or not. More...
 
bool hasFrame () const
 Whether this item has a frame or not. More...
 
QString id () const
 Get item's id (which is not necessarly unique) More...
 
bool isGroupMember () const
 Returns whether this item is part of a group. More...
 
virtual bool isRemoved () const
 Returns whether this item has been removed from the composition. More...
 
double itemRotation (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) const
 Returns the current rotation for the composer item. More...
 
ItemPositionMode lastUsedPositionMode ()
 Returns item's last used position mode. More...
 
void move (double dx, double dy)
 Moves item in canvas coordinates. More...
 
virtual void moveContent (double dx, double dy)
 Move Content of item. More...
 
virtual int numberExportLayers () const
 Get the number of layers that this item requires for exporting as layers. More...
 
int page () const
 Gets the page the item is currently on. More...
 
QPointF pagePos () const
 Returns the item's position relative to its current page. More...
 
Q_DECL_DEPRECATED double pixelFontSize (double pointSize) const
 Calculates font size in mm from a font point size. More...
 
bool positionLock () const
 Returns whether position lock for mouse drags is enabled returns true if item is locked for mouse movement and resizing. More...
 
virtual QRectF rectWithFrame () const
 Returns the item's rectangular bounds, including any bleed caused by the item's frame. More...
 
virtual void removeItems ()
 
Q_DECL_DEPRECATED double rotation () const
 Returns the rotation for the composer item. More...
 
Q_DECL_DEPRECATED QFont scaledFontPixelSize (const QFont &font) const
 Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE. More...
 
virtual bool selected () const
 Is selected. More...
 
void setBackgroundColor (const QColor &backgroundColor)
 Sets the background color for this item. More...
 
void setBackgroundEnabled (const bool drawBackground)
 Set whether this item has a Background drawn around it or not. More...
 
void setBlendMode (const QPainter::CompositionMode blendMode)
 Sets the item's composition blending mode. More...
 
virtual void setCurrentExportLayer (const int layerIdx=-1)
 Sets the current layer to draw for exporting. More...
 
void setEffectsEnabled (const bool effectsEnabled)
 Sets whether effects (eg blend modes) are enabled for the item. More...
 
virtual void setExcludeFromExports (const bool exclude)
 Sets whether the item should be excluded from composer exports and prints. More...
 
virtual void setFrameEnabled (const bool drawFrame)
 Set whether this item has a frame drawn around it or not. More...
 
void setFrameJoinStyle (const Qt::PenJoinStyle style)
 Sets join style used when drawing the item's frame. More...
 
virtual void setFrameOutlineColor (const QColor &color)
 Sets frame outline color. More...
 
virtual void setFrameOutlineWidth (const double outlineWidth)
 Sets frame outline width. More...
 
virtual void setId (const QString &id)
 Set item's id (which is not necessarly unique) More...
 
void setIsGroupMember (const bool isGroupMember)
 Sets whether this item is part of a group. More...
 
void setIsRemoved (const bool removed)
 Sets whether this item has been removed from the composition. More...
 
void setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft, int page=-1)
 Moves the item to a new position (in canvas coordinates) More...
 
void setItemPosition (double x, double y, double width, double height, ItemPositionMode itemPoint=UpperLeft, bool posIncludesFrame=false, int page=-1)
 Sets item position and width / height in one go. More...
 
void setPositionLock (const bool lock)
 Locks / unlocks the item position for mouse drags. More...
 
virtual void setSceneRect (const QRectF &rectangle)
 Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit. More...
 
virtual void setSelected (bool s)
 Set selected, selected item should be highlighted. More...
 
void setTransparency (const int transparency)
 Sets the item's transparency. More...
 
virtual void setVisibility (const bool visible)
 Sets visibility for item. More...
 
Q_DECL_DEPRECATED double textWidthMillimeters (const QFont &font, const QString &text) const
 Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
int transparency () const
 Returns the item's transparency. More...
 
virtual int type () const override
 return correct graphics item type. More...
 
virtual void updateItem ()
 Updates item, with the possibility to do custom update for subclasses. More...
 
void updatePagePos (double newPageWidth, double newPageHeight)
 Moves the item so that it retains its relative position on the page when the paper size changes. More...
 
QString uuid () const
 Get item identification name. More...
 
virtual Q_DECL_DEPRECATED void zoomContent (int delta, double x, double y)
 Zoom content of item. More...
 
virtual void zoomContent (const double factor, const QPointF point, const ZoomMode mode=QgsComposerItem::Zoom)
 Zoom content of item. 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 ()
 
QgsDataDefineddataDefinedProperty (const DataDefinedProperty property) const
 Returns a reference to the data defined settings for one of the item's data defined properties. More...
 
virtual bool readXML (const QDomElement &itemElem, const QDomDocument &doc)
 Sets item state from DOM element. 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...
 
virtual bool writeXML (QDomElement &elem, QDomDocument &doc) const
 Stores item state in DOM element. 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
 
- Public Member Functions inherited from QGraphicsRectItem
 QGraphicsRectItem (QGraphicsItem *parent)
 
 QGraphicsRectItem (const QRectF &rect, QGraphicsItem *parent)
 
 QGraphicsRectItem (qreal x, qreal y, qreal width, qreal height, QGraphicsItem *parent)
 
 ~QGraphicsRectItem ()
 
virtual QRectF boundingRect () const
 
virtual bool contains (const QPointF &point) const
 
virtual bool isObscuredBy (const QGraphicsItem *item) const
 
virtual QPainterPath opaqueArea () const
 
virtual void paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
 
QRectF rect () const
 
void setRect (const QRectF &rectangle)
 
void setRect (qreal x, qreal y, qreal width, qreal height)
 
virtual QPainterPath shape () const
 
- Public Member Functions inherited from QAbstractGraphicsShapeItem
 QAbstractGraphicsShapeItem (QGraphicsItem *parent)
 
 ~QAbstractGraphicsShapeItem ()
 
QBrush brush () const
 
QPen pen () const
 
void setBrush (const QBrush &brush)
 
void setPen (const QPen &pen)
 
- Public Member Functions inherited from QGraphicsItem
 QGraphicsItem (QGraphicsItem *parent)
 
virtual  ~QGraphicsItem ()
 
bool acceptDrops () const
 
Qt::MouseButtons acceptedMouseButtons () const
 
bool acceptHoverEvents () const
 
bool acceptsHoverEvents () const
 
bool acceptTouchEvents () const
 
virtual void advance (int phase)
 
virtual QRectF boundingRect () const =0
 
QRegion boundingRegion (const QTransform &itemToDeviceTransform) const
 
qreal boundingRegionGranularity () const
 
CacheMode cacheMode () const
 
QList< QGraphicsItem * > childItems () const
 
QList< QGraphicsItem * > children () const
 
QRectF childrenBoundingRect () const
 
void clearFocus ()
 
QPainterPath clipPath () const
 
virtual bool collidesWithItem (const QGraphicsItem *other, Qt::ItemSelectionMode mode) const
 
virtual bool collidesWithPath (const QPainterPath &path, Qt::ItemSelectionMode mode) const
 
QList< QGraphicsItem * > collidingItems (Qt::ItemSelectionMode mode) const
 
QGraphicsItemcommonAncestorItem (const QGraphicsItem *other) const
 
QCursor cursor () const
 
QVariant data (int key) const
 
QTransform deviceTransform (const QTransform &viewportTransform) const
 
qreal effectiveOpacity () const
 
void ensureVisible (const QRectF &rect, int xmargin, int ymargin)
 
void ensureVisible (qreal x, qreal y, qreal w, qreal h, int xmargin, int ymargin)
 
bool filtersChildEvents () const
 
GraphicsItemFlags flags () const
 
QGraphicsItemfocusItem () const
 
QGraphicsItemfocusProxy () const
 
void grabKeyboard ()
 
void grabMouse ()
 
QGraphicsEffectgraphicsEffect () const
 
QGraphicsItemGroupgroup () const
 
bool handlesChildEvents () const
 
bool hasCursor () const
 
bool hasFocus () const
 
void hide ()
 
Qt::InputMethodHints inputMethodHints () const
 
void installSceneEventFilter (QGraphicsItem *filterItem)
 
bool isActive () const
 
bool isAncestorOf (const QGraphicsItem *child) const
 
bool isBlockedByModalPanel (QGraphicsItem **blockingPanel) const
 
bool isClipped () const
 
bool isEnabled () const
 
bool isObscured () const
 
bool isObscured (const QRectF &rect) const
 
bool isObscured (qreal x, qreal y, qreal w, qreal h) const
 
bool isPanel () const
 
bool isSelected () const
 
bool isUnderMouse () const
 
bool isVisible () const
 
bool isVisibleTo (const QGraphicsItem *parent) const
 
bool isWidget () const
 
bool isWindow () const
 
QTransform itemTransform (const QGraphicsItem *other, bool *ok) const
 
QPointF mapFromItem (const QGraphicsItem *item, const QPointF &point) const
 
QPolygonF mapFromItem (const QGraphicsItem *item, const QRectF &rect) const
 
QPolygonF mapFromItem (const QGraphicsItem *item, const QPolygonF &polygon) const
 
QPainterPath mapFromItem (const QGraphicsItem *item, const QPainterPath &path) const
 
QPointF mapFromItem (const QGraphicsItem *item, qreal x, qreal y) const
 
QPolygonF mapFromItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const
 
QPointF mapFromParent (const QPointF &point) const
 
QPolygonF mapFromParent (const QRectF &rect) const
 
QPolygonF mapFromParent (const QPolygonF &polygon) const
 
QPainterPath mapFromParent (const QPainterPath &path) const
 
QPointF mapFromParent (qreal x, qreal y) const
 
QPolygonF mapFromParent (qreal x, qreal y, qreal w, qreal h) const
 
QPolygonF mapFromScene (const QPolygonF &polygon) const
 
QPointF mapFromScene (const QPointF &point) const
 
QPolygonF mapFromScene (const QRectF &rect) const
 
QPainterPath mapFromScene (const QPainterPath &path) const
 
QPointF mapFromScene (qreal x, qreal y) const
 
QPolygonF mapFromScene (qreal x, qreal y, qreal w, qreal h) const
 
QRectF mapRectFromItem (const QGraphicsItem *item, const QRectF &rect) const
 
QRectF mapRectFromItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const
 
QRectF mapRectFromParent (const QRectF &rect) const
 
QRectF mapRectFromParent (qreal x, qreal y, qreal w, qreal h) const
 
QRectF mapRectFromScene (qreal x, qreal y, qreal w, qreal h) const
 
QRectF mapRectFromScene (const QRectF &rect) const
 
QRectF mapRectToItem (const QGraphicsItem *item, const QRectF &rect) const
 
QRectF mapRectToItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const
 
QRectF mapRectToParent (const QRectF &rect) const
 
QRectF mapRectToParent (qreal x, qreal y, qreal w, qreal h) const
 
QRectF mapRectToScene (const QRectF &rect) const
 
QRectF mapRectToScene (qreal x, qreal y, qreal w, qreal h) const
 
QPointF mapToItem (const QGraphicsItem *item, const QPointF &point) const
 
QPolygonF mapToItem (const QGraphicsItem *item, const QRectF &rect) const
 
QPolygonF mapToItem (const QGraphicsItem *item, const QPolygonF &polygon) const
 
QPainterPath mapToItem (const QGraphicsItem *item, const QPainterPath &path) const
 
QPointF mapToItem (const QGraphicsItem *item, qreal x, qreal y) const
 
QPolygonF mapToItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const
 
QPointF mapToParent (const QPointF &point) const
 
QPolygonF mapToParent (const QRectF &rect) const
 
QPainterPath mapToParent (const QPainterPath &path) const
 
QPointF mapToParent (qreal x, qreal y) const
 
QPolygonF mapToParent (qreal x, qreal y, qreal w, qreal h) const
 
QPolygonF mapToParent (const QPolygonF &polygon) const
 
QPolygonF mapToScene (const QRectF &rect) const
 
QPainterPath mapToScene (const QPainterPath &path) const
 
QPointF mapToScene (qreal x, qreal y) const
 
QPolygonF mapToScene (qreal x, qreal y, qreal w, qreal h) const
 
QPolygonF mapToScene (const QPolygonF &polygon) const
 
QPointF mapToScene (const QPointF &point) const
 
QMatrix matrix () const
 
void moveBy (qreal dx, qreal dy)
 
qreal opacity () const
 
virtual void paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)=0
 
QGraphicsItempanel () const
 
PanelModality panelModality () const
 
QGraphicsItemparentItem () const
 
QGraphicsObjectparentObject () const
 
QGraphicsWidgetparentWidget () const
 
QPointF pos () const
 
void removeSceneEventFilter (QGraphicsItem *filterItem)
 
void resetMatrix ()
 
void resetTransform ()
 
void rotate (qreal angle)
 
qreal rotation () const
 
void scale (qreal sx, qreal sy)
 
qreal scale () const
 
QGraphicsScenescene () const
 
QRectF sceneBoundingRect () const
 
QMatrix sceneMatrix () const
 
QPointF scenePos () const
 
QTransform sceneTransform () const
 
void scroll (qreal dx, qreal dy, const QRectF &rect)
 
void setAcceptDrops (bool on)
 
void setAcceptedMouseButtons (QFlags< Qt::MouseButton > buttons)
 
void setAcceptHoverEvents (bool enabled)
 
void setAcceptsHoverEvents (bool enabled)
 
void setAcceptTouchEvents (bool enabled)
 
void setActive (bool active)
 
void setBoundingRegionGranularity (qreal granularity)
 
void setCacheMode (CacheMode mode, const QSize &logicalCacheSize)
 
void setCursor (const QCursor &cursor)
 
void setData (int key, const QVariant &value)
 
void setEnabled (bool enabled)
 
void setFiltersChildEvents (bool enabled)
 
void setFlag (GraphicsItemFlag flag, bool enabled)
 
void setFlags (QFlags< QGraphicsItem::GraphicsItemFlag > flags)
 
void setFocus (Qt::FocusReason focusReason)
 
void setFocusProxy (QGraphicsItem *item)
 
void setGraphicsEffect (QGraphicsEffect *effect)
 
void setGroup (QGraphicsItemGroup *group)
 
void setHandlesChildEvents (bool enabled)
 
void setInputMethodHints (QFlags< Qt::InputMethodHint > hints)
 
void setMatrix (const QMatrix &matrix, bool combine)
 
void setOpacity (qreal opacity)
 
void setPanelModality (PanelModality panelModality)
 
void setParentItem (QGraphicsItem *newParent)
 
void setPos (const QPointF &pos)
 
void setPos (qreal x, qreal y)
 
void setRotation (qreal angle)
 
void setScale (qreal factor)
 
void setSelected (bool selected)
 
void setToolTip (const QString &toolTip)
 
void setTransform (const QTransform &matrix, bool combine)
 
void setTransformations (const QList< QGraphicsTransform * > &transformations)
 
void setTransformOriginPoint (qreal x, qreal y)
 
void setTransformOriginPoint (const QPointF &origin)
 
void setVisible (bool visible)
 
void setX (qreal x)
 
void setY (qreal y)
 
void setZValue (qreal z)
 
void shear (qreal sh, qreal sv)
 
void show ()
 
void stackBefore (const QGraphicsItem *sibling)
 
QGraphicsObjecttoGraphicsObject ()
 
const QGraphicsObjecttoGraphicsObject () const
 
QString toolTip () const
 
QGraphicsItemtopLevelItem () const
 
QGraphicsWidgettopLevelWidget () const
 
QTransform transform () const
 
QList< QGraphicsTransform * > transformations () const
 
QPointF transformOriginPoint () const
 
void translate (qreal dx, qreal dy)
 
void ungrabKeyboard ()
 
void ungrabMouse ()
 
void unsetCursor ()
 
void update (qreal x, qreal y, qreal width, qreal height)
 
void update (const QRectF &rect)
 
QGraphicsWidgetwindow () const
 
qreal x () const
 
qreal y () const
 
qreal zValue () const
 

Protected Member Functions

Q_DECL_DEPRECATED double angle (const QPointF &p1, const QPointF &p2) const
 Returns angle of the line from p1 to p2 (clockwise, starting at N) More...
 
Q_DECL_DEPRECATED bool cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height, double rotation) const
 Calculates corner point after rotation and scaling. More...
 
Q_DECL_DEPRECATED bool cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
 Calculates corner point after rotation and scaling. More...
 
void deleteAlignItems ()
 
void deleteHAlignSnapItem ()
 
void deleteVAlignSnapItem ()
 
Q_DECL_DEPRECATED void drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
 Draws arrowhead. More...
 
virtual void drawBackground (QPainter *p)
 Draw background. More...
 
virtual void drawFrame (QPainter *p)
 Draw black frame around item. More...
 
virtual void drawSelectionBoxes (QPainter *p)
 Draws additional graphics on selected items. More...
 
QRectF evalItemRect (const QRectF &newRect, const bool resizeOnly=false)
 Evaluates an item's bounding rect to consider data defined position and size of item and reference point. More...
 
QGraphicsLineItemhAlignSnapItem ()
 Return horizontal align snap item. More...
 
double horizontalViewScaleFactor () const
 Returns the zoom factor of the graphics view. More...
 
Q_DECL_DEPRECATED bool imageSizeConsideringRotation (double &width, double &height, double rotation) const
 Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation. More...
 
Q_DECL_DEPRECATED bool imageSizeConsideringRotation (double &width, double &height) const
 Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation. More...
 
Q_DECL_DEPRECATED QRectF largestRotatedRectWithinBounds (QRectF originalRect, QRectF boundsRect, double rotation) const
 Calculates the largest scaled version of originalRect which fits within boundsRect, when it is rotated by a specified amount. More...
 
Q_DECL_DEPRECATED double lockSymbolSize () const
 Returns the size of the lock symbol depending on the composer zoom level and the item size. More...
 
double rectHandlerBorderTolerance () const
 Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the item border for resizing. More...
 
Q_DECL_DEPRECATED void rotate (double angle, double &x, double &y) const
 Rotates a point / vector. More...
 
bool shouldDrawItem () const
 Returns whether the item should be drawn in the current context. More...
 
Q_DECL_DEPRECATED void sizeChangedByRotation (double &width, double &height, double rotation)
 Calculates width / height of the bounding box of a rotated rectangle. More...
 
Q_DECL_DEPRECATED void sizeChangedByRotation (double &width, double &height)
 Calculates width / height of the bounding box of a rotated rectangle. More...
 
QGraphicsLineItemvAlignSnapItem ()
 Return vertical align snap item. More...
 
- Protected Member Functions inherited from QgsComposerObject
bool dataDefinedEvaluate (const QgsComposerObject::DataDefinedProperty property, QVariant &expressionValue)
 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)
 
- Protected Member Functions inherited from QGraphicsItem
virtual void contextMenuEvent (QGraphicsSceneContextMenuEvent *event)
 
virtual void dragEnterEvent (QGraphicsSceneDragDropEvent *event)
 
virtual void dragLeaveEvent (QGraphicsSceneDragDropEvent *event)
 
virtual void dragMoveEvent (QGraphicsSceneDragDropEvent *event)
 
virtual void dropEvent (QGraphicsSceneDragDropEvent *event)
 
virtual void focusInEvent (QFocusEvent *event)
 
virtual void focusOutEvent (QFocusEvent *event)
 
virtual void hoverEnterEvent (QGraphicsSceneHoverEvent *event)
 
virtual void hoverLeaveEvent (QGraphicsSceneHoverEvent *event)
 
virtual void hoverMoveEvent (QGraphicsSceneHoverEvent *event)
 
virtual void inputMethodEvent (QInputMethodEvent *event)
 
virtual QVariant inputMethodQuery (Qt::InputMethodQuery query) const
 
virtual QVariant itemChange (GraphicsItemChange change, const QVariant &value)
 
virtual void keyPressEvent (QKeyEvent *event)
 
virtual void keyReleaseEvent (QKeyEvent *event)
 
virtual void mouseDoubleClickEvent (QGraphicsSceneMouseEvent *event)
 
virtual void mouseMoveEvent (QGraphicsSceneMouseEvent *event)
 
virtual void mousePressEvent (QGraphicsSceneMouseEvent *event)
 
virtual void mouseReleaseEvent (QGraphicsSceneMouseEvent *event)
 
void prepareGeometryChange ()
 
virtual bool sceneEvent (QEvent *event)
 
virtual bool sceneEventFilter (QGraphicsItem *watched, QEvent *event)
 
void updateMicroFocus ()
 
virtual void wheelEvent (QGraphicsSceneWheelEvent *event)
 

Protected Attributes

bool mBackground
 True if item background needs to be painted. More...
 
QColor mBackgroundColor
 Background color. More...
 
QPainter::CompositionMode mBlendMode
 Composition blend mode for item. More...
 
QGraphicsRectItemmBoundingResizeRectangle
 Rectangle used during move and resize actions. More...
 
int mCurrentExportLayer
 The layer that needs to be exported. More...
 
QgsComposerItem::MouseMoveAction mCurrentMouseMoveAction
 
QgsComposerEffectmEffect
 
bool mEffectsEnabled
 
bool mEvaluatedExcludeFromExports
 Temporary evaluated item exclusion. More...
 
double mEvaluatedItemRotation
 Temporary evaluated item rotation in degrees, clockwise. More...
 
bool mExcludeFromExports
 Whether item should be excluded in exports. More...
 
bool mFrame
 True if item fram needs to be painted. More...
 
Qt::PenJoinStyle mFrameJoinStyle
 Frame join style. More...
 
QGraphicsLineItemmHAlignSnapItem
 
bool mIsGroupMember
 Whether or not this item is part of a group. More...
 
bool mItemPositionLocked
 True if item position and size cannot be changed with mouse move. More...
 
double mItemRotation
 Item rotation in degrees, clockwise. More...
 
QPointF mLastMouseEventPos
 Position of the last mouse move event (in scene coordinates) More...
 
ItemPositionMode mLastUsedPositionMode
 The item's position mode. More...
 
double mLastValidViewScaleFactor
 Backup to restore item appearance if no view scale factor is available. More...
 
QPointF mMouseMoveStartPos
 Start point of the last mouse move action (in scene coordinates) More...
 
bool mRemovedFromComposition
 True if item has been removed from the composition. More...
 
int mTransparency
 Item transparency. More...
 
QGraphicsLineItemmVAlignSnapItem
 
- Protected Attributes inherited from QgsComposerObject
QgsCompositionmComposition
 
QMap< QgsComposerObject::DataDefinedProperty, QStringmDataDefinedNames
 Map of data defined properties for the item to string name to use when exporting item to xml. More...
 

Friends

class QgsComposerItemGroup
 

Additional Inherited Members

- 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)
 
- Public Attributes inherited from QGraphicsItem
typedef GraphicsItemFlags
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

A item that forms part of a map composition.

Definition at line 38 of file qgscomposeritem.h.

Constructor & Destructor Documentation

QgsComposerItem::QgsComposerItem ( QgsComposition composition,
bool  manageZValue = true 
)

Constructor.

Parameters
compositionparent composition
manageZValuetrue if the z-Value of this object should be managed by mComposition

Definition at line 52 of file qgscomposeritem.cpp.

QgsComposerItem::QgsComposerItem ( qreal  x,
qreal  y,
qreal  width,
qreal  height,
QgsComposition composition,
bool  manageZValue = true 
)

Constructor with box position and composer object.

Parameters
xx coordinate of item
yy coordinate of item
widthwidth of item
heightheight of item
compositionparent composition
manageZValuetrue if the z-Value of this object should be managed by mComposition

Definition at line 81 of file qgscomposeritem.cpp.

QgsComposerItem::~QgsComposerItem ( )
virtual

Definition at line 147 of file qgscomposeritem.cpp.

Member Function Documentation

bool QgsComposerItem::_readXML ( const QDomElement itemElem,
const QDomDocument doc 
)

Reads parameter that are not subclass specific in document.

Usually called from readXML methods of subclasses

Definition at line 262 of file qgscomposeritem.cpp.

bool QgsComposerItem::_writeXML ( QDomElement itemElem,
QDomDocument doc 
) const

Writes parameter that are not subclass specific in document.

Usually called from writeXML methods of subclasses

Definition at line 172 of file qgscomposeritem.cpp.

virtual void QgsComposerItem::addItem ( QgsComposerItem item)
inlinevirtual

Composite operations for item groups do nothing per default.

Reimplemented in QgsComposerItemGroup.

Definition at line 398 of file qgscomposeritem.h.

double QgsComposerItem::angle ( const QPointF p1,
const QPointF p2 
) const
protected

Returns angle of the line from p1 to p2 (clockwise, starting at N)

Definition at line 867 of file qgscomposeritem.cpp.

QColor QgsComposerItem::backgroundColor ( ) const
inline

Gets the background color for this item.

Returns
background color
See also
setBackgroundColor
hasBackground

Definition at line 347 of file qgscomposeritem.h.

void QgsComposerItem::beginCommand ( const QString commandText,
QgsComposerMergeCommand::Context  c = QgsComposerMergeCommand::Unknown 
)

Starts new composer undo command.

Parameters
commandTextcommand title
ccontext for mergeable commands (unknown for non-mergeable commands

Definition at line 482 of file qgscomposeritem.cpp.

virtual void QgsComposerItem::beginItemCommand ( const QString text)
inlinevirtual

Reimplemented in QgsComposerFrame.

Definition at line 401 of file qgscomposeritem.h.

QPainter::CompositionMode QgsComposerItem::blendMode ( ) const
inline

Returns the item's composition blending mode.

Returns
item blending mode
See also
setBlendMode

Definition at line 361 of file qgscomposeritem.h.

void QgsComposerItem::cancelCommand ( )

Definition at line 498 of file qgscomposeritem.cpp.

bool QgsComposerItem::cornerPointOnRotatedAndScaledRect ( double &  x,
double &  y,
double  width,
double  height,
double  rotation 
) const
protected

Calculates corner point after rotation and scaling.

Deprecated:
will be removed in QGIS 3.0

Definition at line 1198 of file qgscomposeritem.cpp.

bool QgsComposerItem::cornerPointOnRotatedAndScaledRect ( double &  x,
double &  y,
double  width,
double  height 
) const
protected

Calculates corner point after rotation and scaling.

Deprecated:
will be removed in QGIS 3.0

Definition at line 1190 of file qgscomposeritem.cpp.

void QgsComposerItem::deleteAlignItems ( )
protected

Definition at line 1329 of file qgscomposeritem.cpp.

void QgsComposerItem::deleteHAlignSnapItem ( )
protected

Definition at line 1309 of file qgscomposeritem.cpp.

void QgsComposerItem::deleteVAlignSnapItem ( )
protected

Definition at line 1319 of file qgscomposeritem.cpp.

QString QgsComposerItem::displayName ( ) const
virtual

Get item display name.

This is the item's id if set, and if not, a user-friendly string identifying item type.

Returns
display name for item
See also
id
setId
Note
added in version 2.5

Reimplemented in QgsComposerMap, QgsComposerLegend, QgsComposerLabel, QgsComposerShape, and QgsComposerFrame.

Definition at line 1406 of file qgscomposeritem.cpp.

void QgsComposerItem::drawArrowHead ( QPainter p,
double  x,
double  y,
double  angle,
double  arrowHeadWidth 
) const
protected

Draws arrowhead.

Deprecated:
use QgsComposerUtils::drawArrowHead instead

Definition at line 862 of file qgscomposeritem.cpp.

void QgsComposerItem::drawBackground ( QPainter p)
protectedvirtual

Draw background.

Reimplemented in QgsComposerShape.

Definition at line 849 of file qgscomposeritem.cpp.

void QgsComposerItem::drawFrame ( QPainter p)
protectedvirtual

Draw black frame around item.

Reimplemented in QgsComposerShape, and QgsComposerItemGroup.

Definition at line 539 of file qgscomposeritem.cpp.

void QgsComposerItem::drawSelectionBoxes ( QPainter p)
protectedvirtual

Draws additional graphics on selected items.

The base implementation has no effect.

Definition at line 506 of file qgscomposeritem.cpp.

void QgsComposerItem::drawText ( QPainter p,
double  x,
double  y,
const QString text,
const QFont font,
const QColor c = QColor() 
) const

Draws Text.

Takes care about all the composer specific issues (calculation to pixel, scaling of font and painter to work around the Qt font bug)

Deprecated:
use QgsComposerUtils::drawText instead

Definition at line 943 of file qgscomposeritem.cpp.

void QgsComposerItem::drawText ( QPainter p,
const QRectF rect,
const QString text,
const QFont font,
Qt::AlignmentFlag  halignment = Qt::AlignLeft,
Qt::AlignmentFlag  valignment = Qt::AlignTop,
int  flags = Qt::TextWordWrap 
) const

Like the above, but with a rectangle for multiline text.

Parameters
ppainter to use
rectrectangle to draw into
texttext to draw
fontfont to use
halignmentoptional horizontal alignment
valignmentoptional vertical alignment
flagsallows for passing Qt::TextFlags to control appearance of rendered text
Deprecated:
use QgsComposerUtils::drawText instead

Definition at line 948 of file qgscomposeritem.cpp.

bool QgsComposerItem::effectsEnabled ( ) const
inline

Returns whether effects (eg blend modes) are enabled for the item.

Returns
true if effects are enabled
See also
setEffectsEnabled
transparency
blendMode

Definition at line 387 of file qgscomposeritem.h.

void QgsComposerItem::endCommand ( )

Finish current command and push it onto the undo stack.

Definition at line 490 of file qgscomposeritem.cpp.

virtual void QgsComposerItem::endItemCommand ( )
inlinevirtual

Reimplemented in QgsComposerFrame.

Definition at line 408 of file qgscomposeritem.h.

double QgsComposerItem::estimatedFrameBleed ( ) const
virtual

Returns the estimated amount the item's frame bleeds outside the item's actual rectangle.

For instance, if the item has a 2mm frame outline, then 1mm of this frame is drawn outside the item's rect. In this case the return value will be 1.0

Note
introduced in 2.2
See also
rectWithFrame

Reimplemented in QgsComposerShape.

Definition at line 466 of file qgscomposeritem.cpp.

QRectF QgsComposerItem::evalItemRect ( const QRectF newRect,
const bool  resizeOnly = false 
)
protected

Evaluates an item's bounding rect to consider data defined position and size of item and reference point.

Parameters
newRecttarget bouding rect for item
resizeOnlyset to true if the item is only being resized. If true then the position of the returned rect will be adjusted to account for the item's position mode
Returns
bounding box rectangle for item after data defined size and position have been set and position mode has been accounted for
Note
added in QGIS 2.5

Definition at line 711 of file qgscomposeritem.cpp.

bool QgsComposerItem::excludeFromExports ( const QgsComposerObject::PropertyValueType  valueType = QgsComposerObject::EvaluatedValue)

Returns whether the item should be excluded from composer exports and prints.

Parameters
valueTypecontrols whether the returned value is the user specified vaule, or the current evaluated value (which may be affected by data driven settings).
Returns
true if item should be excluded
Note
added in version 2.5
See also
setExcludeFromExports

Definition at line 1464 of file qgscomposeritem.cpp.

double QgsComposerItem::fontAscentMillimeters ( const QFont font) const

Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.

Deprecated:
use QgsComposerUtils::fontAscentMM instead

Definition at line 962 of file qgscomposeritem.cpp.

double QgsComposerItem::fontDescentMillimeters ( const QFont font) const

Returns the font descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.

Deprecated:
use QgsComposerUtils::fontDescentMM instead

Definition at line 967 of file qgscomposeritem.cpp.

double QgsComposerItem::fontHeightCharacterMM ( const QFont font,
const QChar c 
) const

Returns the font height of a character in millimeters.

Deprecated:
use QgsComposerUtils::fontHeightCharacterMM instead

Definition at line 957 of file qgscomposeritem.cpp.

double QgsComposerItem::fontHeightMillimeters ( const QFont font) const

Returns the font height in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.

Font height equals the font ascent+descent+1 (for baseline).

Note
Added in version 2.4
Deprecated:
use QgsComposerUtils::fontHeightMM instead

Definition at line 972 of file qgscomposeritem.cpp.

void QgsComposerItem::frameChanged ( )
signal

Emitted if the item's frame style changes.

Note
: this function was introduced in version 2.2
Qt::PenJoinStyle QgsComposerItem::frameJoinStyle ( ) const
inline

Returns the join style used for drawing the item's frame.

Returns
Join style for outline frame
Note
introduced in 2.3
See also
hasFrame
setFrameJoinStyle
frameOutlineWidth
frameOutlineColor

Definition at line 296 of file qgscomposeritem.h.

QColor QgsComposerItem::frameOutlineColor ( ) const
inline

Returns the frame's outline color.

Only used if hasFrame is true.

Returns
frame outline color
Note
introduced in 2.6
See also
hasFrame
setFrameOutlineColor
frameJoinStyle
setFrameOutlineColor

Definition at line 266 of file qgscomposeritem.h.

double QgsComposerItem::frameOutlineWidth ( ) const
inline

Returns the frame's outline width.

Only used if hasFrame is true.

Returns
Frame outline width
Note
introduced in 2.3
See also
hasFrame
setFrameOutlineWidth
frameJoinStyle
frameOutlineColor

Definition at line 286 of file qgscomposeritem.h.

QGraphicsLineItem * QgsComposerItem::hAlignSnapItem ( )
protected

Return horizontal align snap item.

Creates a new graphics line if 0

Definition at line 1285 of file qgscomposeritem.cpp.

bool QgsComposerItem::hasBackground ( ) const
inline

Whether this item has a Background or not.

Returns
true if there is a Background around this item, otherwise false.
See also
setBackgroundEnabled
backgroundColor

Definition at line 332 of file qgscomposeritem.h.

bool QgsComposerItem::hasFrame ( ) const
inline

Whether this item has a frame or not.

Returns
true if there is a frame around this item, otherwise false.
See also
setFrameEnabled
frameOutlineWidth
frameJoinStyle
frameOutlineColor

Definition at line 237 of file qgscomposeritem.h.

double QgsComposerItem::horizontalViewScaleFactor ( ) const
protected

Returns the zoom factor of the graphics view.

Returns
the factor or -1 in case of error (e.g. graphic view does not exist)

Definition at line 987 of file qgscomposeritem.cpp.

QString QgsComposerItem::id ( ) const
inline

Get item's id (which is not necessarly unique)

Returns
item id
See also
setId

Definition at line 506 of file qgscomposeritem.h.

bool QgsComposerItem::imageSizeConsideringRotation ( double &  width,
double &  height,
double  rotation 
) const
protected

Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation.

Deprecated:
will be removed in QGIS 3.0

Definition at line 1119 of file qgscomposeritem.cpp.

bool QgsComposerItem::imageSizeConsideringRotation ( double &  width,
double &  height 
) const
protected

Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation.

Deprecated:
will be removed in QGIS 3.0

Definition at line 1111 of file qgscomposeritem.cpp.

bool QgsComposerItem::isGroupMember ( ) const
inline

Returns whether this item is part of a group.

Returns
true if item is in a group
Note
added in version 2.5
See also
setIsGroupMember

Definition at line 561 of file qgscomposeritem.h.

virtual bool QgsComposerItem::isRemoved ( ) const
inlinevirtual

Returns whether this item has been removed from the composition.

Items removed from the composition are not deleted so that they can be restored via an undo command.

Returns
true if the item has been removed from the composition
Note
added in QGIS 2.5
See also
setIsRemoved

Definition at line 128 of file qgscomposeritem.h.

double QgsComposerItem::itemRotation ( const QgsComposerObject::PropertyValueType  valueType = QgsComposerObject::EvaluatedValue) const

Returns the current rotation for the composer item.

Returns
rotation for composer item
Parameters
valueTypecontrols whether the returned value is the user specified rotation, or the current evaluated rotation (which may be affected by data driven rotation settings).
Note
this method was added in version 2.1
See also
setItemRotation

Definition at line 570 of file qgscomposeritem.cpp.

void QgsComposerItem::itemRotationChanged ( double  newRotation)
signal

Is emitted on item rotation change.

QRectF QgsComposerItem::largestRotatedRectWithinBounds ( QRectF  originalRect,
QRectF  boundsRect,
double  rotation 
) const
protected

Calculates the largest scaled version of originalRect which fits within boundsRect, when it is rotated by a specified amount.

Parameters
originalRectQRectF to be rotated and scaled
boundsRectQRectF specifying the bounds which the rotated and scaled rectangle must fit within
rotationthe rotation in degrees to be applied to the rectangle
Deprecated:
use QgsComposerUtils::largestRotatedRectWithinBounds instead

Definition at line 1185 of file qgscomposeritem.cpp.

ItemPositionMode QgsComposerItem::lastUsedPositionMode ( )
inline

Returns item's last used position mode.

Note
: This property has no effect on actual's item position, which is always the top-left corner.

Definition at line 218 of file qgscomposeritem.h.

void QgsComposerItem::lockChanged ( )
signal

Emitted if the item's lock status changes.

Note
: this function was introduced in version 2.5
double QgsComposerItem::lockSymbolSize ( ) const
protected

Returns the size of the lock symbol depending on the composer zoom level and the item size.

Deprecated:
will be removed in QGIS 3.0

Definition at line 1024 of file qgscomposeritem.cpp.

void QgsComposerItem::move ( double  dx,
double  dy 
)

Moves item in canvas coordinates.

Definition at line 575 of file qgscomposeritem.cpp.

virtual void QgsComposerItem::moveContent ( double  dx,
double  dy 
)
inlinevirtual

Move Content of item.

Does nothing per default (but implemented in composer map)

Parameters
dxmove in x-direction (canvas coordinates)
dymove in y-direction(canvas coordinates)

Reimplemented in QgsComposerMap.

Definition at line 151 of file qgscomposeritem.h.

virtual int QgsComposerItem::numberExportLayers ( ) const
inlinevirtual

Get the number of layers that this item requires for exporting as layers.

Returns
0 if this item is to be placed on the same layer as the previous item, 1 if it should be placed on its own layer, and >1 if it requires multiple export layers
Note
this method was added in version 2.4
See also
setCurrentExportLayer

Reimplemented in QgsComposerMap.

Definition at line 576 of file qgscomposeritem.h.

int QgsComposerItem::page ( ) const

Gets the page the item is currently on.

Returns
page number for item, beginning on page 1
See also
pagePos
updatePagePos
Note
this method was added in version 2.4

Definition at line 581 of file qgscomposeritem.cpp.

QPointF QgsComposerItem::pagePos ( ) const

Returns the item's position relative to its current page.

Returns
position relative to the page's top left corner.
See also
page
updatePagePos
Note
this method was added in version 2.4

Definition at line 594 of file qgscomposeritem.cpp.

double QgsComposerItem::pixelFontSize ( double  pointSize) const

Calculates font size in mm from a font point size.

Deprecated:
use QgsComposerUtils::mmFontSize instead

Definition at line 977 of file qgscomposeritem.cpp.

bool QgsComposerItem::positionLock ( ) const
inline

Returns whether position lock for mouse drags is enabled returns true if item is locked for mouse movement and resizing.

See also
setPositionLock

Definition at line 481 of file qgscomposeritem.h.

double QgsComposerItem::rectHandlerBorderTolerance ( ) const
protected

Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the item border for resizing.

Definition at line 1006 of file qgscomposeritem.cpp.

QRectF QgsComposerItem::rectWithFrame ( ) const
virtual

Returns the item's rectangular bounds, including any bleed caused by the item's frame.

The bounds are returned in the item's coordinate system (see Qt's QGraphicsItem docs for more details about QGraphicsItem coordinate systems). The results differ from Qt's rect() function, as rect() makes no allowances for the portion of outlines which are drawn outside of the item.

Note
introduced in 2.2
See also
estimatedFrameBleed

Definition at line 476 of file qgscomposeritem.cpp.

void QgsComposerItem::refreshDataDefinedProperty ( const QgsComposerObject::DataDefinedProperty  property = QgsComposerObject::AllProperties)
overridevirtualslot

Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value.

Parameters
propertydata defined property to refresh. If property is set to QgsComposerItem::AllProperties then all data defined properties for the item will be refreshed.
Note
this method was added in version 2.5

Reimplemented in QgsComposerPicture.

Definition at line 1340 of file qgscomposeritem.cpp.

virtual void QgsComposerItem::removeItems ( )
inlinevirtual

Reimplemented in QgsComposerItemGroup.

Definition at line 399 of file qgscomposeritem.h.

void QgsComposerItem::repaint ( )
overrideslot

Definition at line 1335 of file qgscomposeritem.cpp.

void QgsComposerItem::rotate ( double  angle,
double &  x,
double &  y 
) const
protected

Rotates a point / vector.

Parameters
anglerotation angle in degrees, counterclockwise
xin/out: x coordinate before / after the rotation
yin/out: y cooreinate before / after the rotation
Deprecated:
use QgsComposerUtils:rotate instead

Definition at line 1280 of file qgscomposeritem.cpp.

Q_DECL_DEPRECATED double QgsComposerItem::rotation ( ) const
inline

Returns the rotation for the composer item.

Deprecated:
Use itemRotation() instead

Definition at line 497 of file qgscomposeritem.h.

QFont QgsComposerItem::scaledFontPixelSize ( const QFont font) const

Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE.

Deprecated:
use QgsComposerUtils::scaledFontPixelSize instead

Definition at line 982 of file qgscomposeritem.cpp.

virtual bool QgsComposerItem::selected ( ) const
inlinevirtual

Is selected.

Definition at line 143 of file qgscomposeritem.h.

void QgsComposerItem::setBackgroundColor ( const QColor backgroundColor)

Sets the background color for this item.

Parameters
backgroundColornew background color
Returns
nothing
See also
backgroundColor
setBackgroundEnabled

Definition at line 872 of file qgscomposeritem.cpp.

void QgsComposerItem::setBackgroundEnabled ( const bool  drawBackground)
inline

Set whether this item has a Background drawn around it or not.

Parameters
drawBackgrounddraw Background
Returns
nothing
See also
hasBackground
setBackgroundColor

Definition at line 340 of file qgscomposeritem.h.

void QgsComposerItem::setBlendMode ( const QPainter::CompositionMode  blendMode)

Sets the item's composition blending mode.

Parameters
blendModeblending mode for item
See also
blendMode

Definition at line 878 of file qgscomposeritem.cpp.

virtual void QgsComposerItem::setCurrentExportLayer ( const int  layerIdx = -1)
inlinevirtual

Sets the current layer to draw for exporting.

Parameters
layerIdxcan be set to -1 to draw all item layers, and must be less than numberExportLayers()
Note
this method was added in version 2.4
See also
numberExportLayers

Definition at line 583 of file qgscomposeritem.h.

void QgsComposerItem::setEffectsEnabled ( const bool  effectsEnabled)

Sets whether effects (eg blend modes) are enabled for the item.

Parameters
effectsEnabledset to true to enable effects
See also
effectsEnabled
setTransparency
setBlendMode

Definition at line 936 of file qgscomposeritem.cpp.

void QgsComposerItem::setExcludeFromExports ( const bool  exclude)
virtual

Sets whether the item should be excluded from composer exports and prints.

Parameters
excludeset to true to exclude the item from exports
Note
added in version 2.5
See also
excludeFromExports

Definition at line 1469 of file qgscomposeritem.cpp.

void QgsComposerItem::setFrameEnabled ( const bool  drawFrame)
virtual

Set whether this item has a frame drawn around it or not.

Parameters
drawFramedraw frame
See also
hasFrame
setFrameOutlineWidth
setFrameJoinStyle
setFrameOutlineColor

Reimplemented in QgsComposerLabel.

Definition at line 413 of file qgscomposeritem.cpp.

void QgsComposerItem::setFrameJoinStyle ( const Qt::PenJoinStyle  style)

Sets join style used when drawing the item's frame.

Parameters
styleJoin style for outline frame
Note
introduced in 2.3
See also
setFrameEnabled
frameJoinStyle
setFrameOutlineWidth
setFrameOutlineColor

Definition at line 451 of file qgscomposeritem.cpp.

void QgsComposerItem::setFrameOutlineColor ( const QColor color)
virtual

Sets frame outline color.

Parameters
colornew color for outline frame
Note
introduced in 2.6
See also
frameOutlineColor
setFrameEnabled
setFrameJoinStyle
setFrameOutlineWidth

Definition at line 425 of file qgscomposeritem.cpp.

void QgsComposerItem::setFrameOutlineWidth ( const double  outlineWidth)
virtual

Sets frame outline width.

Parameters
outlineWidthnew width for outline frame
Note
introduced in 2.2
See also
frameOutlineWidth
setFrameEnabled
setFrameJoinStyle
setFrameOutlineColor

Reimplemented in QgsComposerMap, and QgsComposerLabel.

Definition at line 438 of file qgscomposeritem.cpp.

void QgsComposerItem::setId ( const QString id)
virtual

Set item's id (which is not necessarly unique)

Parameters
idnew id for item
See also
id

Definition at line 1381 of file qgscomposeritem.cpp.

void QgsComposerItem::setIsGroupMember ( const bool  isGroupMember)

Sets whether this item is part of a group.

Parameters
isGroupMemberset to true if item is in a group
Note
added in version 2.5
See also
isGroupMember

Definition at line 1400 of file qgscomposeritem.cpp.

void QgsComposerItem::setIsRemoved ( const bool  removed)
inline

Sets whether this item has been removed from the composition.

Items removed from the composition are not deleted so that they can be restored via an undo command.

Parameters
removedset to true if the item has been removed from the composition
Note
added in QGIS 2.5
See also
isRemoved

Definition at line 137 of file qgscomposeritem.h.

void QgsComposerItem::setItemPosition ( double  x,
double  y,
ItemPositionMode  itemPoint = UpperLeft,
int  page = -1 
)

Moves the item to a new position (in canvas coordinates)

Parameters
xitem position x (mm)
yitem position y (mm)
itemPointreference point which coincides with specified position
pageif page > 0, y is interpreted as relative to the origin of the specified page, if page <= 0, y is in absolute canvas coordinates. a page number of 1 corresponds to the first page.

Definition at line 615 of file qgscomposeritem.cpp.

void QgsComposerItem::setItemPosition ( double  x,
double  y,
double  width,
double  height,
ItemPositionMode  itemPoint = UpperLeft,
bool  posIncludesFrame = false,
int  page = -1 
)

Sets item position and width / height in one go.

Parameters
xitem position x (mm)
yitem position y (mm)
widthitem width (mm)
heightitem height (mm)
itemPointreference point which coincides with specified position
posIncludesFrameset to true if the position and size arguments include the item's frame border
pageif page > 0, y is interpreted as relative to the origin of the specified page, if page <= 0, y is in absolute canvas coordinates. a page number of 1 corresponds to the first page.

Definition at line 622 of file qgscomposeritem.cpp.

void QgsComposerItem::setItemRotation ( const double  r,
const bool  adjustPosition = false 
)
virtualslot

Sets the item rotation.

Parameters
ritem rotation in degrees
adjustPositionset to true if item should be shifted so that rotation occurs around item center. If false, rotation occurs around item origin
Note
this method was added in version 2.1
See also
itemRotation

Definition at line 1046 of file qgscomposeritem.cpp.

void QgsComposerItem::setPositionLock ( const bool  lock)

Locks / unlocks the item position for mouse drags.

Parameters
lockset to true to prevent item movement and resizing via the mouse
See also
positionLock

Definition at line 552 of file qgscomposeritem.cpp.

void QgsComposerItem::setRotation ( double  r)
virtualslot

Sets the item rotation.

Deprecated:
Use setItemRotation( double rotation ) instead

Reimplemented in QgsComposerMap.

Definition at line 1039 of file qgscomposeritem.cpp.

void QgsComposerItem::setSceneRect ( const QRectF rectangle)
virtual

Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit.

Reimplemented in QgsComposerScaleBar, QgsComposerAttributeTable, QgsComposerMap, QgsComposerPicture, QgsComposerShape, QgsPaperItem, QgsComposerArrow, QgsComposerFrame, and QgsComposerItemGroup.

Definition at line 684 of file qgscomposeritem.cpp.

void QgsComposerItem::setSelected ( bool  s)
virtual

Set selected, selected item should be highlighted.

Definition at line 160 of file qgscomposeritem.cpp.

void QgsComposerItem::setTransparency ( const int  transparency)

Sets the item's transparency.

Parameters
transparencyinteger between 0 (transparent) and 255 (opaque)
See also
transparency

Definition at line 904 of file qgscomposeritem.cpp.

void QgsComposerItem::setVisibility ( const bool  visible)
virtual

Sets visibility for item.

Parameters
visibleset to true to show item, false to hide item
Note
QGraphicsItem::setVisible should not be called directly on a QgsComposerItem, as some item types (eg groups) need to override the visibility toggle.
added in version 2.5

Reimplemented in QgsComposerItemGroup.

Definition at line 1447 of file qgscomposeritem.cpp.

bool QgsComposerItem::shouldDrawItem ( ) const
protected

Returns whether the item should be drawn in the current context.

Returns
true if item should be drawn
Note
added in QGIS 2.5

Definition at line 837 of file qgscomposeritem.cpp.

void QgsComposerItem::sizeChanged ( )
signal

Emitted if the rectangle changes.

void QgsComposerItem::sizeChangedByRotation ( double &  width,
double &  height,
double  rotation 
)
protected

Calculates width / height of the bounding box of a rotated rectangle.

Deprecated:
will be removed in QGIS 3.0

Definition at line 1243 of file qgscomposeritem.cpp.

void QgsComposerItem::sizeChangedByRotation ( double &  width,
double &  height 
)
protected

Calculates width / height of the bounding box of a rotated rectangle.

Deprecated:
will be removed in QGIS 3.0

Definition at line 1235 of file qgscomposeritem.cpp.

double QgsComposerItem::textWidthMillimeters ( const QFont font,
const QString text 
) const

Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.

Deprecated:
use QgsComposerUtils::textWidthMM instead

Definition at line 952 of file qgscomposeritem.cpp.

int QgsComposerItem::transparency ( ) const
inline

Returns the item's transparency.

Returns
transparency as integer between 0 (transparent) and 255 (opaque)
See also
setTransparency

Definition at line 373 of file qgscomposeritem.h.

virtual int QgsComposerItem::type ( ) const
inlineoverridevirtual
virtual void QgsComposerItem::updateItem ( )
inlinevirtual

Updates item, with the possibility to do custom update for subclasses.

Reimplemented in QgsComposerMap.

Definition at line 500 of file qgscomposeritem.h.

void QgsComposerItem::updatePagePos ( double  newPageWidth,
double  newPageHeight 
)

Moves the item so that it retains its relative position on the page when the paper size changes.

Parameters
newPageWidthnew width of the page in mm
newPageHeightnew height of the page in mm
See also
page
pagePos
Note
this method was added in version 2.4

Definition at line 602 of file qgscomposeritem.cpp.

QString QgsComposerItem::uuid ( ) const
inline

Get item identification name.

Returns
unique item identification string
Note
there is not setter since one can't manually set the id
See also
id
setId

Definition at line 520 of file qgscomposeritem.h.

QGraphicsLineItem * QgsComposerItem::vAlignSnapItem ( )
protected

Return vertical align snap item.

Creates a new graphics line if 0

Definition at line 1297 of file qgscomposeritem.cpp.

virtual Q_DECL_DEPRECATED void QgsComposerItem::zoomContent ( int  delta,
double  x,
double  y 
)
inlinevirtual

Zoom content of item.

Does nothing per default (but implemented in composer map)

Parameters
deltavalue from wheel event that describes direction (positive /negative number)
xx-position of mouse cursor (in item coordinates)
yy-position of mouse cursor (in item coordinates)
Deprecated:
use zoomContent( double, QPointF, ZoomMode ) instead

Reimplemented in QgsComposerMap.

Definition at line 159 of file qgscomposeritem.h.

virtual void QgsComposerItem::zoomContent ( const double  factor,
const QPointF  point,
const ZoomMode  mode = QgsComposerItem::Zoom 
)
inlinevirtual

Zoom content of item.

Does nothing per default (but implemented in composer map)

Parameters
factorzoom factor, where > 1 results in a zoom in and < 1 results in a zoom out
pointitem point for zoom center
modezoom mode
Note
added in QGIS 2.5

Reimplemented in QgsComposerMap.

Definition at line 167 of file qgscomposeritem.h.

Friends And Related Function Documentation

friend class QgsComposerItemGroup
friend

Definition at line 829 of file qgscomposeritem.h.

Member Data Documentation

bool QgsComposerItem::mBackground
protected

True if item background needs to be painted.

Definition at line 629 of file qgscomposeritem.h.

QColor QgsComposerItem::mBackgroundColor
protected

Background color.

Definition at line 631 of file qgscomposeritem.h.

QPainter::CompositionMode QgsComposerItem::mBlendMode
protected

Composition blend mode for item.

Definition at line 650 of file qgscomposeritem.h.

QGraphicsRectItem* QgsComposerItem::mBoundingResizeRectangle
protected

Rectangle used during move and resize actions.

Definition at line 622 of file qgscomposeritem.h.

int QgsComposerItem::mCurrentExportLayer
protected

The layer that needs to be exported.

Note
: if -1, all layers are to be exported
: this member was added in version 2.4

Definition at line 673 of file qgscomposeritem.h.

QgsComposerItem::MouseMoveAction QgsComposerItem::mCurrentMouseMoveAction
protected

Definition at line 615 of file qgscomposeritem.h.

QgsComposerEffect* QgsComposerItem::mEffect
protected

Definition at line 652 of file qgscomposeritem.h.

bool QgsComposerItem::mEffectsEnabled
protected

Definition at line 651 of file qgscomposeritem.h.

bool QgsComposerItem::mEvaluatedExcludeFromExports
protected

Temporary evaluated item exclusion.

Data defined properties may mean this value differs from mExcludeFromExports.

Definition at line 662 of file qgscomposeritem.h.

double QgsComposerItem::mEvaluatedItemRotation
protected

Temporary evaluated item rotation in degrees, clockwise.

Data defined rotation may mean this value differs from mItemRotation.

Definition at line 647 of file qgscomposeritem.h.

bool QgsComposerItem::mExcludeFromExports
protected

Whether item should be excluded in exports.

Definition at line 658 of file qgscomposeritem.h.

bool QgsComposerItem::mFrame
protected

True if item fram needs to be painted.

Definition at line 627 of file qgscomposeritem.h.

Qt::PenJoinStyle QgsComposerItem::mFrameJoinStyle
protected

Frame join style.

Definition at line 633 of file qgscomposeritem.h.

QGraphicsLineItem* QgsComposerItem::mHAlignSnapItem
protected

Definition at line 623 of file qgscomposeritem.h.

bool QgsComposerItem::mIsGroupMember
protected

Whether or not this item is part of a group.

Definition at line 668 of file qgscomposeritem.h.

bool QgsComposerItem::mItemPositionLocked
protected

True if item position and size cannot be changed with mouse move.

Definition at line 637 of file qgscomposeritem.h.

double QgsComposerItem::mItemRotation
protected

Item rotation in degrees, clockwise.

Definition at line 643 of file qgscomposeritem.h.

QPointF QgsComposerItem::mLastMouseEventPos
protected

Position of the last mouse move event (in scene coordinates)

Definition at line 619 of file qgscomposeritem.h.

ItemPositionMode QgsComposerItem::mLastUsedPositionMode
protected

The item's position mode.

Definition at line 665 of file qgscomposeritem.h.

double QgsComposerItem::mLastValidViewScaleFactor
mutableprotected

Backup to restore item appearance if no view scale factor is available.

Definition at line 640 of file qgscomposeritem.h.

QPointF QgsComposerItem::mMouseMoveStartPos
protected

Start point of the last mouse move action (in scene coordinates)

Definition at line 617 of file qgscomposeritem.h.

bool QgsComposerItem::mRemovedFromComposition
protected

True if item has been removed from the composition.

Definition at line 613 of file qgscomposeritem.h.

int QgsComposerItem::mTransparency
protected

Item transparency.

Definition at line 655 of file qgscomposeritem.h.

QGraphicsLineItem* QgsComposerItem::mVAlignSnapItem
protected

Definition at line 624 of file qgscomposeritem.h.


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