Public Member Functions |
| | QgsComposerScaleBar (QgsComposition *composition) |
| | ~QgsComposerScaleBar () |
| void | adjustBoxSize () |
| | Sets box size suitable to content.
|
| Alignment | alignment () const |
| | Left / Middle/ Right.
|
| void | applyDefaultSettings () |
| | Apply default settings.
|
| void | applyDefaultSize (ScaleBarUnits u=Meters) |
| | Apply default size (scale bar 1/5 of map item width)
|
| double | boxContentSpace () const |
| QBrush | brush () const |
| | Returns the primary brush for the scalebar.
|
| QBrush | brush2 () const |
| | Returns the secondary brush for the scalebar.
|
| const QgsComposerMap * | composerMap () const |
| void | correctXPositionAlignment (double width, double widthAfter) |
| | Moves scalebar position to the left / right depending on alignment and change in item width.
|
| QString | firstLabelString () const |
| | Returns string of first label (important for drawing, labeling, size calculation.
|
| QFont | font () const |
| QColor | fontColor () const |
| | Returns the color used for drawing text in the scalebar.
|
| double | height () const |
| double | labelBarSpace () const |
| Qt::PenCapStyle | lineCapStyle () const |
| | Returns the cap style used for drawing lines in the scalebar.
|
| Qt::PenJoinStyle | lineJoinStyle () const |
| | Returns the join style used for drawing lines in the scalebar.
|
| double | numMapUnitsPerScaleBarUnit () const |
| int | numSegments () const |
| int | numSegmentsLeft () const |
| double | numUnitsPerSegment () const |
| void | paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget) override |
| | Reimplementation of QCanvasItem::paint.
|
| QPen | pen () const |
| | Returns the pen used for drawing the scalebar.
|
| bool | readXML (const QDomElement &itemElem, const QDomDocument &doc) override |
| | sets state from Dom document
|
| double | segmentMillimeters () const |
| void | segmentPositions (QList< QPair< double, double > > &posWidthList) const |
| | Returns the x - positions of the segment borders (in item coordinates) and the width of the segment.
|
| void | setAlignment (Alignment a) |
| void | setBoxContentSpace (double space) |
| void | setBrush (const QBrush &brush) |
| | Sets primary brush for the scalebar.
|
| void | setBrush2 (const QBrush &brush) |
| | Sets secondary brush for the scalebar.
|
| void | setComposerMap (const QgsComposerMap *map) |
| void | setFont (const QFont &font) |
| void | setFontColor (const QColor &c) |
| | Sets the color used for drawing text in the scalebar.
|
| void | setHeight (double h) |
| void | setLabelBarSpace (double space) |
| void | setLineCapStyle (Qt::PenCapStyle style) |
| | Sets cap style used when drawing the lines in the scalebar.
|
| void | setLineJoinStyle (Qt::PenJoinStyle style) |
| | Sets join style used when drawing the lines in the scalebar.
|
| void | setNumMapUnitsPerScaleBarUnit (double d) |
| void | setNumSegments (int nSegments) |
| void | setNumSegmentsLeft (int nSegmentsLeft) |
| void | setNumUnitsPerSegment (double units) |
| void | setPen (const QPen &pen) |
| | Sets the pen used for drawing the scalebar.
|
| 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.
|
| void | setStyle (const QString &styleName) |
| | Sets style by name.
|
| void | setUnitLabeling (const QString &label) |
| void | setUnits (ScaleBarUnits u) |
| QString | style () const |
| | Returns style name.
|
| virtual int | type () const override |
| | return correct graphics item type.
|
| QString | unitLabeling () const |
| ScaleBarUnits | units () const |
| void | update () |
| | Adjusts box size and calls QgsComposerItem::update()
|
| bool | writeXML (QDomElement &elem, QDomDocument &doc) const override |
| | stores 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.
|
| virtual void | beginItemCommand (const QString &text) |
| QPainter::CompositionMode | blendMode () const |
| | Returns the item's composition blending mode.
|
| void | cancelCommand () |
| virtual QString | displayName () const |
| | Get item display name.
|
| 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 void | endItemCommand () |
| 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.
|
Protected Member Functions |
| double | mapWidth () const |
| | Returns diagonal of composer map in selected units (map units / meters / feet / nautical miles)
|
| void | refreshSegmentMillimeters () |
| | Calculates with of a segment in mm and stores it in mSegmentMillimeters.
|
| 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 | dataDefinedEvaluate (const QgsComposerObject::DataDefinedProperty property, QVariant &expressionValue) |
| | Evaluate a data defined property and return the calculated value.
|
Public Slots inherited from QgsComposerItem
1.8.1.2