QGIS API Documentation
2.8.2-Wien
|
Frame item for a composer multiframe item. More...
#include <qgscomposerframe.h>
Public Member Functions | |
QgsComposerFrame (QgsComposition *c, QgsComposerMultiFrame *mf, qreal x, qreal y, qreal width, qreal height) | |
~QgsComposerFrame () | |
void | beginItemCommand (const QString &text) override |
virtual QString | displayName () const override |
Get item display name. | |
void | endItemCommand () override |
QRectF | extent () const |
Returns the visible portion of the multi frame's content which is shown in this frame. | |
bool | hideBackgroundIfEmpty () const |
Returns whether the background and frame border should be hidden if this frame is empty. | |
bool | hidePageIfEmpty () const |
Returns whether the page should be hidden (ie, not included in composer exports) if this frame is empty. | |
bool | isEmpty () const |
Returns whether the frame is empty. | |
QgsComposerMultiFrame * | multiFrame () const |
Returns the parent multiframe for the frame. | |
void | paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget) override |
bool | readXML (const QDomElement &itemElem, const QDomDocument &doc) override |
Sets item state from DOM element. | |
void | setContentSection (const QRectF §ion) |
Sets the visible part of the multiframe's content which is visible within this frame (relative to the total multiframe extent in mm). | |
void | setHideBackgroundIfEmpty (const bool hideBackgroundIfEmpty) |
Sets whether the background and frame border should be hidden if this frame is empty. | |
void | setHidePageIfEmpty (const bool hidePageIfEmpty) |
Sets whether the page should be hidden (ie, not included in composer exports) if this frame is empty. | |
void | setSceneRect (const QRectF &rectangle) override |
Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit. | |
int | type () const override |
return correct graphics item type. | |
bool | writeXML (QDomElement &elem, QDomDocument &doc) const override |
Stores item state in DOM element. | |
![]() | |
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 () |
bool | _readXML (const QDomElement &itemElem, const QDomDocument &doc) |
Reads parameter that are not subclass specific in document. | |
bool | _writeXML (QDomElement &itemElem, QDomDocument &doc) const |
Writes parameter that are not subclass specific in document. | |
virtual void | addItem (QgsComposerItem *item) |
Composite operations for item groups do nothing per default. | |
QColor | backgroundColor () const |
Gets the background color for this item. | |
void | beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown) |
Starts new composer undo command. | |
QPainter::CompositionMode | blendMode () const |
Returns the item's composition blending mode. | |
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. | |
bool | effectsEnabled () const |
Returns whether effects (eg blend modes) are enabled for the item. | |
void | endCommand () |
Finish current command and push it onto the undo stack. | |
virtual double | estimatedFrameBleed () const |
Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. | |
bool | excludeFromExports (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) |
Returns whether the item should be excluded from composer exports and prints. | |
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 | fontHeightCharacterMM (const QFont &font, const QChar &c) const |
Returns the font height of a character in millimeters. | |
Q_DECL_DEPRECATED double | fontHeightMillimeters (const QFont &font) const |
Returns the font height in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. | |
Qt::PenJoinStyle | frameJoinStyle () const |
Returns the join style used for drawing the item's frame. | |
QColor | frameOutlineColor () const |
Returns the frame's outline color. | |
double | frameOutlineWidth () const |
Returns the frame's outline width. | |
bool | hasBackground () const |
Whether this item has a Background or not. | |
bool | hasFrame () const |
Whether this item has a frame or not. | |
QString | id () const |
Get item's id (which is not necessarly unique) | |
bool | isGroupMember () const |
Returns whether this item is part of a group. | |
virtual bool | isRemoved () const |
Returns whether this item has been removed from the composition. | |
double | itemRotation (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) const |
Returns the current rotation for the composer item. | |
ItemPositionMode | lastUsedPositionMode () |
Returns item's last used position mode. | |
void | move (double dx, double dy) |
Moves item in canvas coordinates. | |
virtual void | moveContent (double dx, double dy) |
Move Content of item. | |
virtual int | numberExportLayers () const |
Get the number of layers that this item requires for exporting as layers. | |
int | page () const |
Gets the page the item is currently on. | |
QPointF | pagePos () const |
Returns the item's position relative to its current page. | |
Q_DECL_DEPRECATED double | pixelFontSize (double pointSize) const |
Calculates font size in mm from a font point size. | |
bool | positionLock () const |
Returns whether position lock for mouse drags is enabled returns true if item is locked for mouse movement and resizing. | |
virtual QRectF | rectWithFrame () const |
Returns the item's rectangular bounds, including any bleed caused by the item's frame. | |
virtual void | removeItems () |
Q_DECL_DEPRECATED double | rotation () const |
Returns the rotation for the composer item. | |
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. | |
virtual bool | selected () const |
Is selected. | |
void | setBackgroundColor (const QColor &backgroundColor) |
Sets the background color for this item. | |
void | setBackgroundEnabled (const bool drawBackground) |
Set whether this item has a Background drawn around it or not. | |
void | setBlendMode (const QPainter::CompositionMode blendMode) |
Sets the item's composition blending mode. | |
virtual void | setCurrentExportLayer (const int layerIdx=-1) |
Sets the current layer to draw for exporting. | |
void | setEffectsEnabled (const bool effectsEnabled) |
Sets whether effects (eg blend modes) are enabled for the item. | |
virtual void | setExcludeFromExports (const bool exclude) |
Sets whether the item should be excluded from composer exports and prints. | |
virtual void | setFrameEnabled (const bool drawFrame) |
Set whether this item has a frame drawn around it or not. | |
void | setFrameJoinStyle (const Qt::PenJoinStyle style) |
Sets join style used when drawing the item's frame. | |
virtual void | setFrameOutlineColor (const QColor &color) |
Sets frame outline color. | |
virtual void | setFrameOutlineWidth (const double outlineWidth) |
Sets frame outline width. | |
virtual void | setId (const QString &id) |
Set item's id (which is not necessarly unique) | |
void | setIsGroupMember (const bool isGroupMember) |
Sets whether this item is part of a group. | |
void | setIsRemoved (const bool removed) |
Sets whether this item has been removed from the composition. | |
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. | |
void | setPositionLock (const bool lock) |
Locks / unlocks the item position for mouse drags. | |
virtual void | setSelected (bool s) |
Set selected, selected item should be highlighted. | |
void | setTransparency (const int transparency) |
Sets the item's transparency. | |
virtual void | setVisibility (const bool visible) |
Sets visibility for item. | |
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. | |
int | transparency () const |
Returns the item's transparency. | |
virtual void | updateItem () |
Updates item, with the possibility to do custom update for subclasses. | |
void | updatePagePos (double newPageWidth, double newPageHeight) |
Moves the item so that it retains its relative position on the page when the paper size changes. | |
QString | uuid () const |
Get item identification name. | |
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. | |
![]() | |
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 | |
![]() | |
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... | |
![]() | |
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. | |
void | repaint () override |
virtual void | setItemRotation (const double r, const bool adjustPosition=false) |
Sets the item rotation. | |
virtual void | setRotation (double r) |
Sets the item rotation. | |
![]() | |
void | frameChanged () |
Emitted if the item's frame style changes. | |
void | itemRotationChanged (double newRotation) |
Is emitted on item rotation change. | |
void | lockChanged () |
Emitted if the item's lock status changes. | |
void | sizeChanged () |
Emitted if the rectangle changes. | |
![]() | |
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) | |
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. | |
void | deleteAlignItems () |
void | deleteHAlignSnapItem () |
void | deleteVAlignSnapItem () |
Q_DECL_DEPRECATED void | drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const |
Draws arrowhead. | |
virtual void | drawBackground (QPainter *p) |
Draw background. | |
virtual void | drawFrame (QPainter *p) |
Draw black frame around item. | |
virtual void | drawSelectionBoxes (QPainter *p) |
Draws additional graphics on selected items. | |
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. | |
QGraphicsLineItem * | hAlignSnapItem () |
Return horizontal align snap item. | |
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 double | lockSymbolSize () const |
Returns the size of the lock symbol depending on the composer zoom level and the item size. | |
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 void | rotate (double angle, double &x, double &y) const |
Rotates a point / vector. | |
bool | shouldDrawItem () const |
Returns whether the item should be drawn in the current context. | |
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. | |
QGraphicsLineItem * | vAlignSnapItem () |
Return vertical align snap item. | |
![]() | |
bool | mBackground |
True if item background needs to be painted. | |
QColor | mBackgroundColor |
Background color. | |
QPainter::CompositionMode | mBlendMode |
Composition blend mode for item. | |
QGraphicsRectItem * | mBoundingResizeRectangle |
Rectangle used during move and resize actions. | |
int | mCurrentExportLayer |
The layer that needs to be exported. | |
QgsComposerItem::MouseMoveAction | mCurrentMouseMoveAction |
QgsComposerEffect * | mEffect |
bool | mEffectsEnabled |
bool | mEvaluatedExcludeFromExports |
Temporary evaluated item exclusion. | |
double | mEvaluatedItemRotation |
Temporary evaluated item rotation in degrees, clockwise. | |
bool | mExcludeFromExports |
Whether item should be excluded in exports. | |
bool | mFrame |
True if item fram needs to be painted. | |
Qt::PenJoinStyle | mFrameJoinStyle |
Frame join style. | |
QGraphicsLineItem * | mHAlignSnapItem |
bool | mIsGroupMember |
Whether or not this item is part of a group. | |
bool | mItemPositionLocked |
True if item position and size cannot be changed with mouse move. | |
double | mItemRotation |
Item rotation in degrees, clockwise. | |
QPointF | mLastMouseEventPos |
Position of the last mouse move event (in scene coordinates) | |
ItemPositionMode | mLastUsedPositionMode |
The item's position mode. | |
double | mLastValidViewScaleFactor |
Backup to restore item appearance if no view scale factor is available. | |
QPointF | mMouseMoveStartPos |
Start point of the last mouse move action (in scene coordinates) | |
bool | mRemovedFromComposition |
True if item has been removed from the composition. | |
int | mTransparency |
Item transparency. | |
QGraphicsLineItem * | mVAlignSnapItem |
Frame item for a composer multiframe item.
Definition at line 25 of file qgscomposerframe.h.
QgsComposerFrame::QgsComposerFrame | ( | QgsComposition * | c, |
QgsComposerMultiFrame * | mf, | ||
qreal | x, | ||
qreal | y, | ||
qreal | width, | ||
qreal | height | ||
) |
Definition at line 20 of file qgscomposerframe.cpp.
QgsComposerFrame::~QgsComposerFrame | ( | ) |
Definition at line 49 of file qgscomposerframe.cpp.
|
overridevirtual |
Reimplemented from QgsComposerItem.
Definition at line 198 of file qgscomposerframe.cpp.
|
overridevirtual |
Get item display name.
This is the item's id if set, and if not, a user-friendly string identifying item type.
Reimplemented from QgsComposerItem.
Definition at line 118 of file qgscomposerframe.cpp.
|
overridevirtual |
Reimplemented from QgsComposerItem.
Definition at line 206 of file qgscomposerframe.cpp.
|
inline |
Returns the visible portion of the multi frame's content which is shown in this frame.
Definition at line 65 of file qgscomposerframe.h.
|
inline |
Returns whether the background and frame border should be hidden if this frame is empty.
Definition at line 86 of file qgscomposerframe.h.
|
inline |
Returns whether the page should be hidden (ie, not included in composer exports) if this frame is empty.
Definition at line 72 of file qgscomposerframe.h.
bool QgsComposerFrame::isEmpty | ( | ) | const |
Returns whether the frame is empty.
Definition at line 100 of file qgscomposerframe.cpp.
|
inline |
Returns the parent multiframe for the frame.
Definition at line 44 of file qgscomposerframe.h.
|
override |
Definition at line 161 of file qgscomposerframe.cpp.
|
overridevirtual |
Sets item state from DOM element.
itemElem | is DOM node corresponding to item tag |
doc | is DOM document |
Reimplemented from QgsComposerObject.
Definition at line 67 of file qgscomposerframe.cpp.
|
inline |
Sets the visible part of the multiframe's content which is visible within this frame (relative to the total multiframe extent in mm).
section | visible portion of content |
Definition at line 39 of file qgscomposerframe.h.
void QgsComposerFrame::setHideBackgroundIfEmpty | ( | const bool | hideBackgroundIfEmpty | ) |
Sets whether the background and frame border should be hidden if this frame is empty.
hideBackgroundIfEmpty | set to true if background and border should be hidden if frame is empty |
Definition at line 89 of file qgscomposerframe.cpp.
void QgsComposerFrame::setHidePageIfEmpty | ( | const bool | hidePageIfEmpty | ) |
Sets whether the page should be hidden (ie, not included in composer exports) if this frame is empty.
hidePageIfEmpty | set to true if page should be hidden if frame is empty |
Definition at line 84 of file qgscomposerframe.cpp.
|
overridevirtual |
Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit.
Reimplemented from QgsComposerItem.
Definition at line 133 of file qgscomposerframe.cpp.
|
inlineoverridevirtual |
return correct graphics item type.
Reimplemented from QgsComposerItem.
Definition at line 57 of file qgscomposerframe.h.
|
overridevirtual |
Stores item state in DOM element.
elem | is DOM element corresponding to item tag |
doc | is the DOM document |
Reimplemented from QgsComposerObject.
Definition at line 53 of file qgscomposerframe.cpp.