|
QGIS API Documentation
2.6.0-Brighton
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
QGIS API Documentation
2.6.0-Brighton
|
Item representing the paper. More...
#include <qgspaperitem.h>
Public Member Functions | |
| QgsPaperItem (QgsComposition *c) | |
| QgsPaperItem (qreal x, qreal y, qreal width, qreal height, QgsComposition *composition) | |
| ~QgsPaperItem () | |
| virtual int | type () const |
| return correct graphics item type. | |
| void | paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget) |
| Reimplementation of QCanvasItem::paint. | |
| bool | writeXML (QDomElement &elem, QDomDocument &doc) const |
| stores state in Dom element | |
| bool | readXML (const QDomElement &itemElem, const QDomDocument &doc) |
| sets state from Dom document | |
| 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. | |
 Public Member Functions inherited from QgsComposerItem | |
| QgsComposerItem (QgsComposition *composition, bool manageZValue=true) | |
| Constructor. | |
| QgsComposerItem (qreal x, qreal y, qreal width, qreal height, QgsComposition *composition, bool manageZValue=true) | |
| Constructor with box position and composer object. | |
| virtual | ~QgsComposerItem () |
| virtual bool | isRemoved () const |
| Returns whether this item has been removed from the composition. | |
| void | setIsRemoved (const bool removed) |
| Sets whether this item has been removed from the composition. | |
| virtual void | setSelected (bool s) |
| Set selected, selected item should be highlighted. | |
| virtual bool | selected () const |
| Is selected. | |
| void | move (double dx, double dy) |
| Moves item in canvas coordinates. | |
| virtual void | moveContent (double dx, double dy) |
| Move Content of item. | |
| virtual Q_DECL_DEPRECATED void | zoomContent (int delta, double x, double y) |
| Zoom content of item. | |
| virtual void | zoomContent (const double factor, const QPointF point, const ZoomMode mode=QgsComposerItem::Zoom) |
| Zoom content of item. | |
| int | page () const |
| Gets the page the item is currently on. | |
| QPointF | pagePos () const |
| Returns the item's position relative to its current page. | |
| void | updatePagePos (double newPageWidth, double newPageHeight) |
| Moves the item so that it retains its relative position on the page when the paper size changes. | |
| void | setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft, int page=-1) |
| Moves the item to a new position (in canvas coordinates) | |
| 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. | |
| ItemPositionMode | lastUsedPositionMode () |
| Returns item's last used position mode. | |
| bool | _writeXML (QDomElement &itemElem, QDomDocument &doc) const |
| Writes parameter that are not subclass specific in document. | |
| bool | _readXML (const QDomElement &itemElem, const QDomDocument &doc) |
| Reads parameter that are not subclass specific in document. | |
| bool | hasFrame () const |
| Whether this item has a frame or not. | |
| void | setFrameEnabled (const bool drawFrame) |
| Set whether this item has a frame drawn around it or not. | |
| virtual void | setFrameOutlineColor (const QColor &color) |
| Sets frame outline color. | |
| QColor | frameOutlineColor () const |
| Returns the frame's outline color. | |
| virtual void | setFrameOutlineWidth (const double outlineWidth) |
| Sets frame outline width. | |
| double | frameOutlineWidth () const |
| Returns the frame's outline width. | |
| Qt::PenJoinStyle | frameJoinStyle () const |
| Returns the join style used for drawing the item's frame. | |
| void | setFrameJoinStyle (const Qt::PenJoinStyle style) |
| Sets join style used when drawing the item's frame. | |
| virtual double | estimatedFrameBleed () const |
| Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. | |
| virtual QRectF | rectWithFrame () const |
| Returns the item's rectangular bounds, including any bleed caused by the item's frame. | |
| bool | hasBackground () const |
| Whether this item has a Background or not. | |
| void | setBackgroundEnabled (const bool drawBackground) |
| Set whether this item has a Background drawn around it or not. | |
| QColor | backgroundColor () const |
| Gets the background color for this item. | |
| void | setBackgroundColor (const QColor &backgroundColor) |
| Sets the background color for this item. | |
| QPainter::CompositionMode | blendMode () const |
| Returns the item's composition blending mode. | |
| void | setBlendMode (const QPainter::CompositionMode blendMode) |
| Sets the item's composition blending mode. | |
| int | transparency () const |
| Returns the item's transparency. | |
| void | setTransparency (const int transparency) |
| Sets the item's transparency. | |
| bool | effectsEnabled () const |
| Returns whether effects (eg blend modes) are enabled for the item. | |
| void | setEffectsEnabled (const bool effectsEnabled) |
| Sets whether effects (eg blend modes) are enabled for the item. | |
| virtual void | addItem (QgsComposerItem *item) |
| Composite operations for item groups do nothing per default. | |
| virtual void | removeItems () |
| virtual void | beginItemCommand (const QString &text) |
| void | beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown) |
| Starts new composer undo command. | |
| virtual void | endItemCommand () |
| void | endCommand () |
| Finish current command and push it onto the undo stack. | |
| 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. | |
| 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. | |
| 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. | |
| Q_DECL_DEPRECATED double | fontHeightCharacterMM (const QFont &font, const QChar &c) const |
| Returns the font height of a character in millimeters. | |
| Q_DECL_DEPRECATED double | fontAscentMillimeters (const QFont &font) const |
| Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. | |
| Q_DECL_DEPRECATED double | fontDescentMillimeters (const QFont &font) const |
| Returns the font descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. | |
| Q_DECL_DEPRECATED double | fontHeightMillimeters (const QFont &font) const |
| Returns the font height in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. | |
| Q_DECL_DEPRECATED double | pixelFontSize (double pointSize) const |
| Calculates font size in mm from a font point size. | |
| 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. | |
| void | setPositionLock (const bool lock) |
| Locks / unlocks the item position for mouse drags. | |
| bool | positionLock () const |
| Returns whether position lock for mouse drags is enabled returns true if item is locked for mouse movement and resizing. | |
| double | itemRotation (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) const |
| Returns the current rotation for the composer item. | |
| Q_DECL_DEPRECATED double | rotation () const |
| Returns the rotation for the composer item. | |
| virtual void | updateItem () |
| Updates item, with the possibility to do custom update for subclasses. | |
| QString | id () const |
| Get item's id (which is not necessarly unique) | |
| virtual void | setId (const QString &id) |
| Set item's id (which is not necessarly unique) | |
| QString | uuid () const |
| Get item identification name. | |
| virtual QString | displayName () const |
| Get item display name. | |
| virtual void | setVisibility (const bool visible) |
| Sets visibility for item. | |
| bool | excludeFromExports (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) |
| Returns whether the item should be excluded from composer exports and prints. | |
| virtual void | setExcludeFromExports (const bool exclude) |
| Sets whether the item should be excluded from composer exports and prints. | |
| bool | isGroupMember () const |
| Returns whether this item is part of a group. | |
| void | setIsGroupMember (const bool isGroupMember) |
| Sets whether this item is part of a group. | |
| virtual int | numberExportLayers () const |
| Get the number of layers that this item requires for exporting as layers. | |
| virtual void | setCurrentExportLayer (const int layerIdx=-1) |
| Sets the current layer to draw for exporting. | |
| Public Member Functions inherited from QgsComposerObject | |
| QgsComposerObject (QgsComposition *composition) | |
| Constructor. | |
| virtual | ~QgsComposerObject () |
| const QgsComposition * | composition () const |
| Returns the composition the item is attached to. | |
| QgsComposition * | composition () |
| QgsDataDefined * | dataDefinedProperty (const DataDefinedProperty property) const |
| Returns a reference to the data defined settings for one of the item's data defined properties. | |
| 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. | |
Additional Inherited Members | |
| Public Types inherited from QgsComposerItem | |
| 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 } |
| enum | ZoomMode { Zoom = 0, ZoomRecenter, ZoomToPoint, NoZoom } |
| Modes for zooming item content. More... | |
| Public Slots inherited from QgsComposerItem | |
| virtual void | setRotation (double r) |
| Sets the item rotation. | |
| virtual void | setItemRotation (const double r, const bool adjustPosition=false) |
| Sets the item rotation. | |
| 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. | |
| Signals inherited from QgsComposerItem | |
| void | itemRotationChanged (double newRotation) |
| Is emitted on item rotation change. | |
| void | sizeChanged () |
| Emitted if the rectangle changes. | |
| void | frameChanged () |
| Emitted if the item's frame style changes. | |
| void | lockChanged () |
| Emitted if the item's lock status changes. | |
| Protected Member Functions inherited from QgsComposerItem | |
| virtual void | drawSelectionBoxes (QPainter *p) |
| Draws additional graphics on selected items. | |
| virtual void | drawFrame (QPainter *p) |
| Draw black frame around item. | |
| virtual void | drawBackground (QPainter *p) |
| Draw background. | |
| Q_DECL_DEPRECATED void | drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const |
| Draws arrowhead. | |
| 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) | |
| double | rectHandlerBorderTolerance () const |
| Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the item border for resizing. | |
| Q_DECL_DEPRECATED double | lockSymbolSize () const |
| Returns the size of the lock symbol depending on the composer zoom level and the item size. | |
| double | horizontalViewScaleFactor () const |
| Returns the zoom factor of the graphics view. | |
| 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. | |
| 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. | |
| 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. | |
| Q_DECL_DEPRECATED bool | cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height, double rotation) const |
| Calculates corner point after rotation and scaling. | |
| Q_DECL_DEPRECATED bool | cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const |
| Calculates corner point after rotation and scaling. | |
| Q_DECL_DEPRECATED void | sizeChangedByRotation (double &width, double &height, double rotation) |
| Calculates width / height of the bounding box of a rotated rectangle. | |
| Q_DECL_DEPRECATED void | sizeChangedByRotation (double &width, double &height) |
| Calculates width / height of the bounding box of a rotated rectangle. | |
| Q_DECL_DEPRECATED void | rotate (double angle, double &x, double &y) const |
| Rotates a point / vector. | |
| QGraphicsLineItem * | hAlignSnapItem () |
| Return horizontal align snap item. | |
| void | deleteHAlignSnapItem () |
| QGraphicsLineItem * | vAlignSnapItem () |
| Return vertical align snap item. | |
| void | deleteVAlignSnapItem () |
| void | deleteAlignItems () |
| 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. | |
| bool | shouldDrawItem () const |
| Returns whether the item should be drawn in the current context. | |
| Protected Attributes inherited from QgsComposerItem | |
| bool | mRemovedFromComposition |
| True if item has been removed from the composition. | |
| QgsComposerItem::MouseMoveAction | mCurrentMouseMoveAction |
| QPointF | mMouseMoveStartPos |
| Start point of the last mouse move action (in scene coordinates) | |
| QPointF | mLastMouseEventPos |
| Position of the last mouse move event (in scene coordinates) | |
| QGraphicsRectItem * | mBoundingResizeRectangle |
| Rectangle used during move and resize actions. | |
| QGraphicsLineItem * | mHAlignSnapItem |
| QGraphicsLineItem * | mVAlignSnapItem |
| bool | mFrame |
| True if item fram needs to be painted. | |
| bool | mBackground |
| True if item background needs to be painted. | |
| QColor | mBackgroundColor |
| Background color. | |
| Qt::PenJoinStyle | mFrameJoinStyle |
| Frame join style. | |
| bool | mItemPositionLocked |
| True if item position and size cannot be changed with mouse move. | |
| double | mLastValidViewScaleFactor |
| Backup to restore item appearance if no view scale factor is available. | |
| double | mItemRotation |
| Item rotation in degrees, clockwise. | |
| double | mEvaluatedItemRotation |
| Temporary evaluated item rotation in degrees, clockwise. | |
| QPainter::CompositionMode | mBlendMode |
| Composition blend mode for item. | |
| bool | mEffectsEnabled |
| QgsComposerEffect * | mEffect |
| int | mTransparency |
| Item transparency. | |
| bool | mExcludeFromExports |
| Whether item should be excluded in exports. | |
| bool | mEvaluatedExcludeFromExports |
| Temporary evaluated item exclusion. | |
| ItemPositionMode | mLastUsedPositionMode |
| The item's position mode. | |
| bool | mIsGroupMember |
| Whether or not this item is part of a group. | |
| int | mCurrentExportLayer |
| The layer that needs to be exported. | |
Item representing the paper.
| QgsPaperItem::QgsPaperItem | ( | QgsComposition * | c | ) |
| QgsPaperItem::QgsPaperItem | ( | qreal | x, |
| qreal | y, | ||
| qreal | width, | ||
| qreal | height, | ||
| QgsComposition * | composition | ||
| ) |
| QgsPaperItem::~QgsPaperItem | ( | ) |
| void QgsPaperItem::paint | ( | QPainter * | painter, |
| const QStyleOptionGraphicsItem * | itemStyle, | ||
| QWidget * | pWidget | ||
| ) |
Reimplementation of QCanvasItem::paint.
|
virtual |
sets state from Dom document
| itemElem | is Dom node corresponding to item tag |
| doc | is the Dom document |
Reimplemented from QgsComposerObject.
|
virtual |
Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit.
Reimplemented from QgsComposerItem.
|
inlinevirtual |
return correct graphics item type.
Reimplemented from QgsComposerItem.
|
virtual |
stores state in Dom element
| elem | is Dom element corresponding to 'Composer' tag |
| doc | Dom document |
Reimplemented from QgsComposerObject.
1.8.1.2