QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private 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]
Collaboration diagram for QgsComposerItem:
Collaboration graph
[legend]

Public Types

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  ItemPositionMode {
  UpperLeft, UpperMiddle, UpperRight, MiddleLeft,
  Middle, MiddleRight, LowerLeft, LowerMiddle,
  LowerRight
}
 
- Public Types inherited from QgsComposerObject
enum  DataDefinedProperty {
  NoProperty = 0, AllProperties, TestProperty, PresetPaperSize,
  PaperWidth, PaperHeight, NumPages, PaperOrientation,
  PageNumber, PositionX, PositionY, ItemWidth,
  ItemHeight, ItemRotation, Transparency, BlendMode,
  MapRotation, MapScale, MapXMin, MapYMin,
  MapXMax, MapYMax, 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 setRotation (double r)
 Sets the item rotation. More...
 
virtual void setItemRotation (const double r, const bool adjustPosition=false)
 Sets the item rotation. More...
 
void repaint ()
 
virtual void refreshDataDefinedProperty (const QgsComposerObject::DataDefinedProperty property=QgsComposerObject::AllProperties)
 Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value. More...
 
- Public Slots inherited from QgsComposerObject
virtual void repaint ()
 Triggers a redraw for the item. More...
 
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...
 

Signals

void itemRotationChanged (double newRotation)
 Is emitted on item rotation change. More...
 
void sizeChanged ()
 Emitted if the rectangle changes. More...
 
void frameChanged ()
 Emitted if the item's frame style changes. More...
 
void lockChanged ()
 Emitted if the item's lock status 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 ()
 
virtual int type () const
 return correct graphics item type. More...
 
virtual bool isRemoved () const
 Returns whether this item has been removed from the composition. More...
 
void setIsRemoved (const bool removed)
 Sets whether this item has been removed from the composition. More...
 
virtual void setSelected (bool s)
 Set selected, selected item should be highlighted. More...
 
virtual bool selected () const
 Is selected. 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 void zoomContent (int delta, double x, double y)
 Zoom content of item. 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...
 
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...
 
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...
 
ItemPositionMode lastUsedPositionMode ()
 Returns item's last used position mode. 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...
 
bool _writeXML (QDomElement &itemElem, QDomDocument &doc) const
 Writes parameter that are not subclass specific in document. More...
 
bool _readXML (const QDomElement &itemElem, const QDomDocument &doc)
 Reads parameter that are not subclass specific in document. More...
 
bool hasFrame () const
 Whether this item has a frame or not. More...
 
void setFrameEnabled (const bool drawFrame)
 Set whether this item has a frame drawn around it or not. More...
 
virtual void setFrameOutlineWidth (const double outlineWidth)
 Sets frame outline width. More...
 
double frameOutlineWidth () const
 Returns the frame's outline width. More...
 
Qt::PenJoinStyle frameJoinStyle () const
 Returns the join style used for drawing the item's frame. More...
 
void setFrameJoinStyle (const Qt::PenJoinStyle style)
 Sets join style used when drawing the item's frame. More...
 
virtual double estimatedFrameBleed () const
 Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. More...
 
virtual QRectF rectWithFrame () const
 Returns the item's rectangular bounds, including any bleed caused by the item's frame. More...
 
bool hasBackground () const
 Whether this item has a Background or not. More...
 
void setBackgroundEnabled (const bool drawBackground)
 Set whether this item has a Background drawn around it or not. More...
 
QColor backgroundColor () const
 Gets the background color for this item. More...
 
void setBackgroundColor (const QColor &backgroundColor)
 Sets the background color for this item. More...
 
QPainter::CompositionMode blendMode () const
 Returns the item's composition blending mode. More...
 
void setBlendMode (const QPainter::CompositionMode blendMode)
 Sets the item's composition blending mode. More...
 
int transparency () const
 Returns the item's transparency. More...
 
void setTransparency (const int transparency)
 Sets the item's transparency. More...
 
bool effectsEnabled () const
 Returns whether effects (eg blend modes) are enabled for the item. More...
 
void setEffectsEnabled (const bool effectsEnabled)
 Sets whether effects (eg blend modes) are enabled for the item. More...
 
virtual void addItem (QgsComposerItem *item)
 Composite operations for item groups do nothing per default. More...
 
virtual void removeItems ()
 
virtual void beginItemCommand (const QString &text)
 
void beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown)
 Starts new composer undo command. More...
 
virtual void endItemCommand ()
 
void endCommand ()
 Finish current command and push it onto the undo stack. More...
 
void cancelCommand ()
 
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...
 
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...
 
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 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 fontHeightMillimeters (const QFont &font) const
 Returns the font height in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
Q_DECL_DEPRECATED double pixelFontSize (double pointSize) const
 Calculates font size in mm from a font point size. 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...
 
void setPositionLock (const bool lock)
 Locks / unlocks the item position for mouse drags. 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...
 
double itemRotation (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) const
 Returns the current rotation for the composer item. More...
 
Q_DECL_DEPRECATED double rotation () const
 Returns the rotation for the composer item. More...
 
virtual void updateItem ()
 Updates item, with the possibility to do custom update for subclasses. More...
 
QString id () const
 Get item's id (which is not necessarly unique) More...
 
virtual void setId (const QString &id)
 Set item's id (which is not necessarly unique) More...
 
QString uuid () const
 Get item identification name. More...
 
virtual QString displayName () const
 Get item display name. More...
 
virtual void setVisibility (const bool visible)
 Sets visibility for item. More...
 
bool isGroupMember () const
 Returns whether this item is part of a group. More...
 
void setIsGroupMember (const bool isGroupMember)
 Sets whether this item is part of a group. More...
 
virtual int numberExportLayers () const
 Get the number of layers that this item requires for exporting as layers. More...
 
virtual void setCurrentExportLayer (const int layerIdx=-1)
 Sets the current layer to draw for exporting. 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 bool writeXML (QDomElement &elem, QDomDocument &doc) const
 Stores item state in DOM element. More...
 
virtual bool readXML (const QDomElement &itemElem, const QDomDocument &doc)
 Sets item state from DOM element. 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 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...
 

Protected Member Functions

virtual void drawSelectionBoxes (QPainter *p)
 Draws additional graphics on selected items. More...
 
virtual void drawFrame (QPainter *p)
 Draw black frame around item. More...
 
virtual void drawBackground (QPainter *p)
 Draw background. More...
 
Q_DECL_DEPRECATED void drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
 Draws arrowhead. More...
 
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...
 
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 double lockSymbolSize () const
 Returns the size of the lock symbol depending on the composer zoom level and the item size. 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 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...
 
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...
 
Q_DECL_DEPRECATED void rotate (double angle, double &x, double &y) const
 Rotates a point / vector. More...
 
QGraphicsLineItem * hAlignSnapItem ()
 Return horizontal align snap item. More...
 
void deleteHAlignSnapItem ()
 
QGraphicsLineItem * vAlignSnapItem ()
 Return vertical align snap item. More...
 
void deleteVAlignSnapItem ()
 
void deleteAlignItems ()
 
QRectF evalItemRect (const QRectF &newRect)
 Update an item rect to consider data defined position and size of 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 Attributes

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

Private Member Functions

void refreshRotation (const bool updateItem=true, const bool rotateAroundCenter=false)
 Refresh item's rotation, considering data defined rotation setting. More...
 
void refreshTransparency (const bool updateItem=true)
 Refresh item's transparency, considering data defined transparency. More...
 
void refreshBlendMode ()
 Refresh item's blend mode, considering data defined blend mode. More...
 
void init (const bool manageZValue)
 

Private Attributes

QString mId
 
QString mUuid
 
QString mTemplateUuid
 
bool mCompositionManagesZValue
 

Friends

class QgsComposerItemGroup
 

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.

References init().

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 79 of file qgscomposeritem.cpp.

References init().

QgsComposerItem::~QgsComposerItem ( )
virtual

Member Function Documentation

bool QgsComposerItem::_readXML ( const QDomElement &  itemElem,
const QDomDocument &  doc 
)
bool QgsComposerItem::_writeXML ( QDomElement &  itemElem,
QDomDocument &  doc 
) const
virtual void QgsComposerItem::addItem ( QgsComposerItem item)
inlinevirtual

Composite operations for item groups do nothing per default.

Reimplemented in QgsComposerItemGroup.

Definition at line 355 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)

Deprecated:
use QgsComposerUtils::angle instead

Definition at line 818 of file qgscomposeritem.cpp.

References QgsComposerUtils::angle().

QColor QgsComposerItem::backgroundColor ( ) const
inline

Gets the background color for this item.

Returns
background color
Note
introduced in 2.0
See also
setBackgroundColor
hasBackground

Definition at line 301 of file qgscomposeritem.h.

Referenced by QgsComposerMap::cache(), QgsComposerMultiFrame::createNewFrame(), and setBackgroundColor().

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 474 of file qgscomposeritem.cpp.

References QgsComposition::beginCommand(), and QgsComposerObject::mComposition.

Referenced by QgsComposerView::wheelEvent().

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

Reimplemented in QgsComposerFrame.

Definition at line 358 of file qgscomposeritem.h.

Referenced by QgsComposition::removeComposerItem().

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

Returns the item's composition blending mode.

Returns
item blending mode
See also
setBlendMode

Definition at line 316 of file qgscomposeritem.h.

Referenced by QgsComposerMultiFrame::createNewFrame(), refreshBlendMode(), and setBlendMode().

void QgsComposerItem::cancelCommand ( )
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 1144 of file qgscomposeritem.cpp.

References M_PI.

Referenced by QgsComposerPicture::cornerPointOnRotatedAndScaledRect(), QgsComposerMap::cornerPointOnRotatedAndScaledRect(), cornerPointOnRotatedAndScaledRect(), and imageSizeConsideringRotation().

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 1136 of file qgscomposeritem.cpp.

References cornerPointOnRotatedAndScaledRect(), mEvaluatedItemRotation, Q_NOWARN_DEPRECATED_POP, and Q_NOWARN_DEPRECATED_PUSH.

void QgsComposerItem::deleteAlignItems ( )
protected

Definition at line 1275 of file qgscomposeritem.cpp.

References deleteHAlignSnapItem(), and deleteVAlignSnapItem().

Referenced by ~QgsComposerItem().

void QgsComposerItem::deleteHAlignSnapItem ( )
protected

Definition at line 1255 of file qgscomposeritem.cpp.

References mHAlignSnapItem.

Referenced by deleteAlignItems().

void QgsComposerItem::deleteVAlignSnapItem ( )
protected

Definition at line 1265 of file qgscomposeritem.cpp.

References mVAlignSnapItem.

Referenced by deleteAlignItems().

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 1337 of file qgscomposeritem.cpp.

References ComposerArrow, ComposerAttributeTable, ComposerFrame, ComposerItemGroup, ComposerLabel, ComposerLegend, ComposerMap, ComposerPicture, ComposerScaleBar, ComposerShape, ComposerTable, ComposerTextTable, id(), tr, and type().

Referenced by QgsComposerModel::data().

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 813 of file qgscomposeritem.cpp.

References QgsComposerUtils::drawArrowHead().

void QgsComposerItem::drawBackground ( QPainter *  p)
protectedvirtual
void QgsComposerItem::drawFrame ( QPainter *  p)
protectedvirtual
void QgsComposerItem::drawSelectionBoxes ( QPainter *  p)
protectedvirtual
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 894 of file qgscomposeritem.cpp.

References QgsComposerUtils::drawText().

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 899 of file qgscomposeritem.cpp.

References QgsComposerUtils::drawText().

bool QgsComposerItem::effectsEnabled ( ) const
inline

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

Returns
true if effects are enabled
Note
introduced in 2.0
See also
setEffectsEnabled
transparency
blendMode

Definition at line 343 of file qgscomposeritem.h.

Referenced by setEffectsEnabled().

void QgsComposerItem::endCommand ( )

Finish current command and push it onto the undo stack.

Definition at line 482 of file qgscomposeritem.cpp.

References QgsComposition::endCommand(), and QgsComposerObject::mComposition.

virtual void QgsComposerItem::endItemCommand ( )
inlinevirtual

Reimplemented in QgsComposerFrame.

Definition at line 365 of file qgscomposeritem.h.

Referenced by QgsComposition::removeComposerItem().

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 458 of file qgscomposeritem.cpp.

References hasFrame().

Referenced by rectWithFrame(), and setItemPosition().

QRectF QgsComposerItem::evalItemRect ( const QRectF &  newRect)
protected
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 913 of file qgscomposeritem.cpp.

References QgsComposerUtils::fontAscentMM().

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 918 of file qgscomposeritem.cpp.

References QgsComposerUtils::fontDescentMM().

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

Returns the font height of a character in millimeters.

Note
this method was added in version 1.7
Deprecated:
use QgsComposerUtils::fontHeightCharacterMM instead

Definition at line 908 of file qgscomposeritem.cpp.

References QgsComposerUtils::fontHeightCharacterMM().

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 923 of file qgscomposeritem.cpp.

References QgsComposerUtils::fontHeightMM().

void QgsComposerItem::frameChanged ( )
signal

Emitted if the item's frame style changes.

Note
: this function was introduced in version 2.2

Referenced by QgsComposerShape::createDefaultShapeStyleSymbol(), QgsComposerShape::refreshSymbol(), setFrameEnabled(), setFrameJoinStyle(), and setFrameOutlineWidth().

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

Definition at line 247 of file qgscomposeritem.h.

Referenced by QgsComposerMultiFrame::createNewFrame().

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

Definition at line 238 of file qgscomposeritem.h.

Referenced by QgsComposerMultiFrame::createNewFrame().

QGraphicsLineItem * QgsComposerItem::hAlignSnapItem ( )
protected

Return horizontal align snap item.

Creates a new graphics line if 0

Definition at line 1231 of file qgscomposeritem.cpp.

References mHAlignSnapItem.

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.
Note
introduced since 2.0
See also
setBackgroundEnabled
backgroundColor

Definition at line 284 of file qgscomposeritem.h.

Referenced by QgsComposerMap::cache(), QgsComposerMultiFrame::createNewFrame(), QgsComposerMap::draw(), QgsComposerMap::numberExportLayers(), QgsComposerShape::readXML(), and QgsComposerMap::shouldDrawPart().

bool QgsComposerItem::hasFrame ( ) const
inline
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)
Note
: this function was introduced in version 1.2

Definition at line 938 of file qgscomposeritem.cpp.

References mLastValidViewScaleFactor.

Referenced by QgsComposerMap::cache(), QgsComposerArrow::drawSVGMarker(), lockSymbolSize(), and rectHandlerBorderTolerance().

QString QgsComposerItem::id ( ) const
inline
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 1065 of file qgscomposeritem.cpp.

References cornerPointOnRotatedAndScaledRect(), QgsSymbolLayerV2Utils::pointOnLineWithDistance(), Q_NOWARN_DEPRECATED_POP, Q_NOWARN_DEPRECATED_PUSH, and qgsDoubleNear().

Referenced by QgsComposerPicture::imageSizeConsideringRotation(), QgsComposerMap::imageSizeConsideringRotation(), and imageSizeConsideringRotation().

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 1057 of file qgscomposeritem.cpp.

References imageSizeConsideringRotation(), mEvaluatedItemRotation, Q_NOWARN_DEPRECATED_POP, and Q_NOWARN_DEPRECATED_PUSH.

void QgsComposerItem::init ( const bool  manageZValue)
private
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 508 of file qgscomposeritem.h.

Referenced by QgsComposerMouseHandles::collectAlignCoordinates(), and setIsGroupMember().

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 116 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 562 of file qgscomposeritem.cpp.

References QgsComposerObject::EvaluatedValue, mEvaluatedItemRotation, and mItemRotation.

Referenced by QgsComposerItemGroup::addItem().

void QgsComposerItem::itemRotationChanged ( double  newRotation)
signal

Is emitted on item rotation change.

Referenced by refreshRotation().

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 1131 of file qgscomposeritem.cpp.

References QgsComposerUtils::largestRotatedRectWithinBounds().

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.
: this method was added in version 2.0

Definition at line 190 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

Referenced by setPositionLock().

double QgsComposerItem::lockSymbolSize ( ) const
protected

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

Note
: this function was introduced in version 1.2
Deprecated:
will be removed in QGIS 3.0

Definition at line 975 of file qgscomposeritem.cpp.

References horizontalViewScaleFactor().

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

Moves item in canvas coordinates.

Definition at line 567 of file qgscomposeritem.cpp.

References evalItemRect(), and setSceneRect().

Referenced by QgsComposition::addItemsFromXML(), and QgsComposerScaleBar::correctXPositionAlignment().

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 139 of file qgscomposeritem.h.

Referenced by QgsComposerView::mouseReleaseEvent().

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 523 of file qgscomposeritem.h.

int QgsComposerItem::page ( ) const

Gets the page the item is currently on.

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

Definition at line 573 of file qgscomposeritem.cpp.

References QgsComposerObject::composition(), QgsComposition::paperHeight(), and QgsComposition::spaceBetweenPages().

Referenced by _readXML(), _writeXML(), pagePos(), and updatePagePos().

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 586 of file qgscomposeritem.cpp.

References QgsComposerObject::composition(), page(), QgsComposition::paperHeight(), and QgsComposition::spaceBetweenPages().

Referenced by _writeXML(), and updatePagePos().

double QgsComposerItem::pixelFontSize ( double  pointSize) const

Calculates font size in mm from a font point size.

Deprecated:
use QgsComposerUtils::mmFontSize instead

Definition at line 928 of file qgscomposeritem.cpp.

References QgsComposerUtils::pointsToMM().

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.

Note
this method was added in version 1.2
See also
setPositionLock

Definition at line 441 of file qgscomposeritem.h.

Referenced by _readXML(), QgsComposition::composerItemAt(), QgsComposerModel::data(), drawSelectionBoxes(), QgsComposerView::endMarqueeSelect(), QgsComposerView::selectAll(), QgsComposition::selectedComposerItems(), QgsComposerView::selectInvert(), and QgsComposition::unlockAllItems().

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 957 of file qgscomposeritem.cpp.

References horizontalViewScaleFactor().

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 468 of file qgscomposeritem.cpp.

References estimatedFrameBleed().

Referenced by QgsComposerMouseHandles::collectAlignCoordinates().

void QgsComposerItem::refreshBlendMode ( )
private

Refresh item's blend mode, considering data defined blend mode.

Note
this method was added in version 2.5

Definition at line 836 of file qgscomposeritem.cpp.

References QgsComposerObject::BlendMode, blendMode(), QgsComposerObject::dataDefinedEvaluate(), QgsSymbolLayerV2Utils::decodeBlendMode(), mBlendMode, mEffect, QgsDebugMsg, and QgsComposerEffect::setCompositionMode().

Referenced by refreshDataDefinedProperty(), and setBlendMode().

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

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 QgsComposerMap, and QgsComposerPicture.

Definition at line 1286 of file qgscomposeritem.cpp.

References QgsComposerObject::AllProperties, QgsComposerObject::BlendMode, evalItemRect(), QgsComposerObject::ItemHeight, QgsComposerObject::ItemRotation, QgsComposerObject::ItemWidth, QgsComposerObject::PositionX, QgsComposerObject::PositionY, refreshBlendMode(), refreshRotation(), refreshTransparency(), setSceneRect(), and QgsComposerObject::Transparency.

Referenced by init(), QgsComposerPicture::refreshDataDefinedProperty(), and QgsComposerMap::refreshDataDefinedProperty().

void QgsComposerItem::refreshRotation ( const bool  updateItem = true,
const bool  rotateAroundCenter = false 
)
private

Refresh item's rotation, considering data defined rotation setting.

Parameters
updateItemset to false to prevent the item being automatically updated
rotateAroundCenterset to true to rotate the item around its center rather than its origin
Note
this method was added in version 2.5

Definition at line 1011 of file qgscomposeritem.cpp.

References QgsComposerObject::dataDefinedEvaluate(), QgsComposerObject::ItemRotation, itemRotationChanged(), QgsComposerObject::mComposition, mEvaluatedItemRotation, mItemRotation, QgsDebugMsg, rotation(), sizeChanged(), and QgsComposition::updateBounds().

Referenced by refreshDataDefinedProperty(), and setItemRotation().

void QgsComposerItem::refreshTransparency ( const bool  updateItem = true)
private

Refresh item's transparency, considering data defined transparency.

Parameters
updateItemset to false to prevent the item being automatically updated after the transparency is set
Note
this method was added in version 2.5

Definition at line 861 of file qgscomposeritem.cpp.

References QgsComposerObject::dataDefinedEvaluate(), mTransparency, QgsDebugMsg, QgsComposerObject::Transparency, and transparency().

Referenced by refreshDataDefinedProperty(), and setTransparency().

virtual void QgsComposerItem::removeItems ( )
inlinevirtual

Reimplemented in QgsComposerItemGroup.

Definition at line 356 of file qgscomposeritem.h.

void QgsComposerItem::repaint ( )
slot
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 1226 of file qgscomposeritem.cpp.

References QgsComposerUtils::rotate().

Q_DECL_DEPRECATED double QgsComposerItem::rotation ( ) const
inline

Returns the rotation for the composer item.

Deprecated:
Use itemRotation() instead

Definition at line 457 of file qgscomposeritem.h.

Referenced by refreshRotation().

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 933 of file qgscomposeritem.cpp.

References QgsComposerUtils::scaledFontPixelSize().

virtual bool QgsComposerItem::selected ( ) const
inlinevirtual
void QgsComposerItem::setBackgroundColor ( const QColor &  backgroundColor)

Sets the background color for this item.

Parameters
backgroundColornew background color
Returns
nothing
Note
introduced in 2.0
See also
backgroundColor
setBackgroundEnabled

Definition at line 823 of file qgscomposeritem.cpp.

References backgroundColor(), and mBackgroundColor.

Referenced by _readXML(), QgsComposerMultiFrame::createNewFrame(), and QgsComposerMap::QgsComposerMap().

void QgsComposerItem::setBackgroundEnabled ( const bool  drawBackground)
inline

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

Parameters
drawBackgrounddraw Background
Returns
nothing
Note
introduced in 2.0
See also
hasBackground
setBackgroundColor

Definition at line 293 of file qgscomposeritem.h.

Referenced by QgsComposerScaleBar::applyDefaultSettings(), QgsComposerMultiFrame::createNewFrame(), QgsComposerArrow::init(), QgsComposerPicture::init(), and QgsComposerLabel::QgsComposerLabel().

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 829 of file qgscomposeritem.cpp.

References blendMode(), mBlendMode, and refreshBlendMode().

Referenced by _readXML(), and QgsComposerMultiFrame::createNewFrame().

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 530 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
Note
introduced in 2.0
See also
effectsEnabled
setTransparency
setBlendMode

Definition at line 887 of file qgscomposeritem.cpp.

References effectsEnabled(), mEffect, and mEffectsEnabled.

Referenced by QgsComposition::setUseAdvancedEffects().

void QgsComposerItem::setFrameEnabled ( const bool  drawFrame)

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

Parameters
drawFramedraw frame
Returns
nothing
Note
introduced in 1.8
See also
hasFrame
setFrameOutlineWidth
setFrameJoinStyle

Definition at line 418 of file qgscomposeritem.cpp.

References drawFrame(), frameChanged(), and mFrame.

Referenced by QgsComposerMultiFrame::createNewFrame(), QgsComposerShape::QgsComposerShape(), and QgsComposerShape::setUseSymbolV2().

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

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

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

Definition at line 443 of file qgscomposeritem.cpp.

References frameChanged(), and mFrameJoinStyle.

Referenced by QgsComposerMultiFrame::createNewFrame().

void QgsComposerItem::setFrameOutlineWidth ( const double  outlineWidth)
virtual

Sets frame outline width.

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

Reimplemented in QgsComposerMap.

Definition at line 430 of file qgscomposeritem.cpp.

References frameChanged(), and outlineWidth.

Referenced by QgsComposerMultiFrame::createNewFrame(), and QgsComposerMap::setFrameOutlineWidth().

void QgsComposerItem::setId ( const QString &  id)
virtual

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

Parameters
idnew id for item
Note
this method was added in version 1.7
See also
id

Definition at line 1312 of file qgscomposeritem.cpp.

References id(), QgsComposerObject::itemChanged(), QgsComposition::itemsModel(), QgsComposerObject::mComposition, mId, and QgsComposerModel::updateItemDisplayName().

Referenced by _readXML(), and QgsComposerModel::setData().

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 1331 of file qgscomposeritem.cpp.

References isGroupMember(), and mIsGroupMember.

Referenced by QgsComposerItemGroup::addItem().

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 125 of file qgscomposeritem.h.

Referenced by QgsComposerModel::setItemRemoved(), and QgsComposerModel::setItemRestored().

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

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

Definition at line 607 of file qgscomposeritem.cpp.

Referenced by QgsComposition::addItemsFromXML().

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
yitem position y
widthitem width
heightitem height
itemPointitem position mode
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
Note
: this method was added in version 1.6

Definition at line 614 of file qgscomposeritem.cpp.

References QgsComposerObject::composition(), estimatedFrameBleed(), evalItemRect(), LowerLeft, LowerMiddle, LowerRight, mEvaluatedItemRotation, Middle, MiddleLeft, MiddleRight, mLastUsedPositionMode, QgsComposition::paperHeight(), setSceneRect(), QgsComposition::spaceBetweenPages(), UpperMiddle, and UpperRight.

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 997 of file qgscomposeritem.cpp.

References mItemRotation, and refreshRotation().

Referenced by _readXML(), QgsComposerItemGroup::addItem(), QgsComposerShape::readXML(), QgsComposerLabel::readXML(), and setRotation().

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
Note
this method was added in version 1.2
See also
positionLock

Definition at line 544 of file qgscomposeritem.cpp.

References QgsComposition::itemsModel(), lockChanged(), QgsComposerObject::mComposition, mItemPositionLocked, and QgsComposerModel::updateItemLockStatus().

Referenced by _readXML(), QgsComposerModel::setData(), and QgsComposition::unlockAllItems().

void QgsComposerItem::setRotation ( double  r)
virtualslot

Sets the item rotation.

Deprecated:
Use setItemRotation( double rotation ) instead

Reimplemented in QgsComposerMap.

Definition at line 990 of file qgscomposeritem.cpp.

References setItemRotation().

void QgsComposerItem::setSceneRect ( const QRectF &  rectangle)
virtual
void QgsComposerItem::setSelected ( bool  s)
virtual
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 855 of file qgscomposeritem.cpp.

References mTransparency, refreshTransparency(), and transparency().

Referenced by _readXML().

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 1378 of file qgscomposeritem.cpp.

References QgsComposition::itemsModel(), QgsComposerObject::mComposition, and QgsComposerModel::updateItemVisibility().

Referenced by _readXML(), QgsComposerModel::setData(), and QgsComposerItemGroup::setVisibility().

void QgsComposerItem::sizeChanged ( )
signal

Emitted if the rectangle changes.

Referenced by refreshRotation(), setSceneRect(), and updatePagePos().

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 1189 of file qgscomposeritem.cpp.

References QgsComposerUtils::rotate().

Referenced by QgsComposerPicture::sizeChangedByRotation(), QgsComposerMap::sizeChangedByRotation(), and sizeChangedByRotation().

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 1181 of file qgscomposeritem.cpp.

References mEvaluatedItemRotation, Q_NOWARN_DEPRECATED_POP, Q_NOWARN_DEPRECATED_PUSH, and sizeChangedByRotation().

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 903 of file qgscomposeritem.cpp.

References QgsComposerUtils::textWidthMM().

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 328 of file qgscomposeritem.h.

Referenced by refreshTransparency(), and setTransparency().

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

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

Reimplemented in QgsComposerMap.

Definition at line 460 of file qgscomposeritem.h.

Referenced by QgsComposerMap::updateItem().

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 594 of file qgscomposeritem.cpp.

References QgsComposerObject::composition(), evalItemRect(), page(), pagePos(), setSceneRect(), sizeChanged(), and QgsComposition::spaceBetweenPages().

Referenced by QgsComposition::setPaperSize().

QString QgsComposerItem::uuid ( ) const
inline

Get item identification name.

Returns
unique item identification string
Note
this method was added in version 2.0
there is not setter since one can't manually set the id
See also
id
setId

Definition at line 483 of file qgscomposeritem.h.

Referenced by QgsComposerModel::data(), QgsComposition::getComposerItemByUuid(), and QgsComposerItemGroup::readXML().

QGraphicsLineItem * QgsComposerItem::vAlignSnapItem ( )
protected

Return vertical align snap item.

Creates a new graphics line if 0

Definition at line 1243 of file qgscomposeritem.cpp.

References mVAlignSnapItem.

virtual 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 magnitude and direction (positive /negative number)
xx-position of mouse cursor (in item coordinates)
yy-position of mouse cursor (in item coordinates)

Reimplemented in QgsComposerMap.

Definition at line 145 of file qgscomposeritem.h.

Friends And Related Function Documentation

friend class QgsComposerItemGroup
friend

Definition at line 758 of file qgscomposeritem.h.

Member Data Documentation

bool QgsComposerItem::mBackground
protected

True if item background needs to be painted.

Definition at line 576 of file qgscomposeritem.h.

Referenced by _readXML(), _writeXML(), QgsComposerShape::drawBackground(), and drawBackground().

QColor QgsComposerItem::mBackgroundColor
protected

Background color.

Definition at line 578 of file qgscomposeritem.h.

Referenced by setBackgroundColor().

QPainter::CompositionMode QgsComposerItem::mBlendMode
protected

Composition blend mode for item.

Definition at line 597 of file qgscomposeritem.h.

Referenced by _writeXML(), refreshBlendMode(), and setBlendMode().

QGraphicsRectItem* QgsComposerItem::mBoundingResizeRectangle
protected

Rectangle used during move and resize actions.

Definition at line 569 of file qgscomposeritem.h.

Referenced by ~QgsComposerItem().

bool QgsComposerItem::mCompositionManagesZValue
private

Definition at line 734 of file qgscomposeritem.h.

Referenced by init(), and ~QgsComposerItem().

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 614 of file qgscomposeritem.h.

Referenced by QgsComposerMap::draw(), and QgsComposerMap::shouldDrawPart().

QgsComposerItem::MouseMoveAction QgsComposerItem::mCurrentMouseMoveAction
protected

Definition at line 562 of file qgscomposeritem.h.

QgsComposerEffect* QgsComposerItem::mEffect
protected

Definition at line 599 of file qgscomposeritem.h.

Referenced by init(), refreshBlendMode(), setEffectsEnabled(), and ~QgsComposerItem().

bool QgsComposerItem::mEffectsEnabled
protected

Definition at line 598 of file qgscomposeritem.h.

Referenced by setEffectsEnabled().

double QgsComposerItem::mEvaluatedItemRotation
protected

Temporary evaluated item rotation in degrees, clockwise.

Data defined rotation may mean this value differs from mItemRotation.

Definition at line 594 of file qgscomposeritem.h.

Referenced by cornerPointOnRotatedAndScaledRect(), imageSizeConsideringRotation(), itemRotation(), refreshRotation(), setItemPosition(), and sizeChangedByRotation().

bool QgsComposerItem::mFrame
protected
Qt::PenJoinStyle QgsComposerItem::mFrameJoinStyle
protected

Frame join style.

Definition at line 580 of file qgscomposeritem.h.

Referenced by _readXML(), _writeXML(), init(), and setFrameJoinStyle().

QGraphicsLineItem* QgsComposerItem::mHAlignSnapItem
protected

Definition at line 570 of file qgscomposeritem.h.

Referenced by deleteHAlignSnapItem(), and hAlignSnapItem().

QString QgsComposerItem::mId
private

Definition at line 728 of file qgscomposeritem.h.

Referenced by _writeXML(), QgsComposerMap::id(), and setId().

bool QgsComposerItem::mIsGroupMember
protected

Whether or not this item is part of a group.

Definition at line 609 of file qgscomposeritem.h.

Referenced by setIsGroupMember().

bool QgsComposerItem::mItemPositionLocked
protected

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

Note
: this member was added in version 1.2

Definition at line 584 of file qgscomposeritem.h.

Referenced by _writeXML(), and setPositionLock().

double QgsComposerItem::mItemRotation
protected

Item rotation in degrees, clockwise.

Definition at line 590 of file qgscomposeritem.h.

Referenced by _writeXML(), itemRotation(), QgsComposerLabel::itemShiftAdjustSize(), refreshRotation(), and setItemRotation().

QPointF QgsComposerItem::mLastMouseEventPos
protected

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

Definition at line 566 of file qgscomposeritem.h.

ItemPositionMode QgsComposerItem::mLastUsedPositionMode
protected

The item's position mode.

Note
: this member was added in version 2.0

Definition at line 606 of file qgscomposeritem.h.

Referenced by _readXML(), _writeXML(), evalItemRect(), and setItemPosition().

double QgsComposerItem::mLastValidViewScaleFactor
mutableprotected

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

Definition at line 587 of file qgscomposeritem.h.

Referenced by _readXML(), _writeXML(), QgsComposerMap::cache(), and horizontalViewScaleFactor().

QPointF QgsComposerItem::mMouseMoveStartPos
protected

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

Definition at line 564 of file qgscomposeritem.h.

bool QgsComposerItem::mRemovedFromComposition
protected

True if item has been removed from the composition.

Definition at line 560 of file qgscomposeritem.h.

QString QgsComposerItem::mTemplateUuid
private

Definition at line 732 of file qgscomposeritem.h.

Referenced by _readXML(), and QgsComposerItemGroup::readXML().

int QgsComposerItem::mTransparency
protected

Item transparency.

Definition at line 602 of file qgscomposeritem.h.

Referenced by _writeXML(), refreshTransparency(), and setTransparency().

QString QgsComposerItem::mUuid
private

Definition at line 730 of file qgscomposeritem.h.

Referenced by _readXML(), _writeXML(), and QgsComposerItemGroup::readXML().

QGraphicsLineItem* QgsComposerItem::mVAlignSnapItem
protected

Definition at line 571 of file qgscomposeritem.h.

Referenced by deleteVAlignSnapItem(), and vAlignSnapItem().


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