QGIS API Documentation 3.41.0-Master (092dc69654e)
|
A layout item subclass for scale bars. More...
#include <qgslayoutitemscalebar.h>
Public Member Functions | |
QgsLayoutItemScaleBar (QgsLayout *layout) | |
Constructor for QgsLayoutItemScaleBar, with the specified parent layout. | |
bool | accept (QgsStyleEntityVisitorInterface *visitor) const override |
Accepts the specified style entity visitor, causing it to visit all style entities associated with the layout item. | |
Qgis::ScaleBarAlignment | alignment () const |
Returns the scalebar alignment. | |
QgsFillSymbol * | alternateFillSymbol () const |
Returns the secondary fill symbol used to render the scalebar (only used for some scalebar types). | |
bool | applyDefaultRendererSettings (QgsScaleBarRenderer *renderer) |
Applies any default settings relating to the specified renderer to the item. | |
void | applyDefaultSettings () |
Applies the default scalebar settings to the scale bar. | |
void | applyDefaultSize (Qgis::DistanceUnit units=Qgis::DistanceUnit::Meters) |
Applies the default size to the scale bar (scale bar 1/5 of map item width) | |
double | boxContentSpace () const |
Returns the spacing (margin) between the scalebar box and content in millimeters. | |
Q_DECL_DEPRECATED QBrush | brush () const |
Returns the primary brush for the scalebar. | |
Q_DECL_DEPRECATED QBrush | brush2 () const |
Returns the secondary brush for the scalebar. | |
QgsLineSymbol * | divisionLineSymbol () const |
Returns the line symbol used to render the scalebar divisions (only used for some scalebar types). | |
ExportLayerBehavior | exportLayerBehavior () const override |
Returns the behavior of this item during exporting to layered exports (e.g. | |
Q_DECL_DEPRECATED QColor | fillColor () const |
Returns the color used for fills in the scalebar. | |
Q_DECL_DEPRECATED QColor | fillColor2 () const |
Returns the secondary color used for fills in the scalebar. | |
QgsFillSymbol * | fillSymbol () const |
Returns the primary fill symbol used to render the scalebar (only used for some scalebar types). | |
void | finalizeRestoreFromXml () override |
Called after all pending items have been restored from XML. | |
Q_DECL_DEPRECATED QFont | font () const |
Returns the font used for drawing text in the scalebar. | |
Q_DECL_DEPRECATED QColor | fontColor () const |
Returns the color used for drawing text in the scalebar. | |
Qgis::DistanceUnit | guessUnits () const |
Attempts to guess the most reasonable unit choice for the scalebar, given the current linked map's scale. | |
double | height () const |
Returns the scalebar height (in millimeters). | |
QIcon | icon () const override |
Returns the item's icon. | |
double | labelBarSpace () const |
Returns the spacing (in millimeters) between labels and the scalebar. | |
Qgis::ScaleBarDistanceLabelHorizontalPlacement | labelHorizontalPlacement () const |
Returns the horizontal placement of text labels. | |
Qgis::ScaleBarDistanceLabelVerticalPlacement | labelVerticalPlacement () const |
Returns the vertical placement of text labels. | |
Q_DECL_DEPRECATED Qt::PenCapStyle | lineCapStyle () const |
Returns the cap style used for drawing lines in the scalebar. | |
Q_DECL_DEPRECATED QColor | lineColor () const |
Returns the color used for lines in the scalebar. | |
Q_DECL_DEPRECATED Qt::PenJoinStyle | lineJoinStyle () const |
Returns the join style used for drawing lines in the scalebar. | |
QgsLineSymbol * | lineSymbol () const |
Returns the line symbol used to render the scalebar (only used for some scalebar types). | |
Q_DECL_DEPRECATED double | lineWidth () const |
Returns the line width in millimeters for lines in the scalebar. | |
QgsLayoutItemMap * | linkedMap () const |
Returns the map item linked to the scalebar. | |
double | mapUnitsPerScaleBarUnit () const |
Returns the number of map units per scale bar unit used by the scalebar. | |
double | maximumBarWidth () const |
Returns the maximum width (in millimeters) for scale bar segments. | |
Qgis::ScaleCalculationMethod | method () const |
Returns the scale calculation method, which determines how the bar's scale will be calculated. | |
double | minimumBarWidth () const |
Returns the minimum width (in millimeters) for scale bar segments. | |
QgsLayoutSize | minimumSize () const override |
Returns the minimum allowed size of the item, if applicable, or an empty size if item can be freely resized. | |
int | numberOfSegments () const |
Returns the number of segments included in the scalebar. | |
int | numberOfSegmentsLeft () const |
Returns the number of segments included in the left part of the scalebar. | |
int | numberOfSubdivisions () const |
Returns the number of subdivisions for segments included in the right part of the scalebar (only used for some scalebar types). | |
const QgsNumericFormat * | numericFormat () const |
Returns the numeric format used for numbers in the scalebar. | |
Q_DECL_DEPRECATED QPen | pen () const |
Returns the pen used for drawing outlines in the scalebar. | |
void | refreshDataDefinedProperty (QgsLayoutObject::DataDefinedProperty property=QgsLayoutObject::DataDefinedProperty::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 | resizeToMinimumWidth () |
Resizes the scale bar to its minimum width, without changing the height. | |
Qgis::ScaleBarSegmentSizeMode | segmentSizeMode () const |
Returns the size mode for the scale bar segments. | |
void | setAlignment (Qgis::ScaleBarAlignment alignment) |
Sets the scalebar alignment. | |
void | setAlternateFillSymbol (QgsFillSymbol *symbol) |
Sets the secondary fill symbol used to render the scalebar (only used for some scalebar types). | |
void | setBoxContentSpace (double space) |
Sets the space (margin) between the scalebar box and content in millimeters. | |
void | setDivisionLineSymbol (QgsLineSymbol *symbol) |
Sets the line symbol used to render the scalebar divisions (only used for some scalebar types). | |
Q_DECL_DEPRECATED void | setFillColor (const QColor &color) |
Sets the color used for fills in the scalebar. | |
Q_DECL_DEPRECATED void | setFillColor2 (const QColor &color) |
Sets the secondary color used for fills in the scalebar. | |
void | setFillSymbol (QgsFillSymbol *symbol) |
Sets the primary fill symbol used to render the scalebar (only used for some scalebar types). | |
Q_DECL_DEPRECATED void | setFont (const QFont &font) |
Sets the font used for drawing text in the scalebar. | |
Q_DECL_DEPRECATED void | setFontColor (const QColor &color) |
Sets the color used for drawing text in the scalebar. | |
void | setHeight (double height) |
Sets the scalebar height (in millimeters). | |
void | setLabelBarSpace (double space) |
Sets the spacing (in millimeters) between labels and the scalebar. | |
void | setLabelHorizontalPlacement (Qgis::ScaleBarDistanceLabelHorizontalPlacement placement) |
Sets the horizontal placement of text labels. | |
void | setLabelVerticalPlacement (Qgis::ScaleBarDistanceLabelVerticalPlacement placement) |
Sets the vertical placement of text labels. | |
Q_DECL_DEPRECATED void | setLineCapStyle (Qt::PenCapStyle style) |
Sets the cap style used when drawing the lines in the scalebar. | |
Q_DECL_DEPRECATED void | setLineColor (const QColor &color) |
Sets the color used for lines in the scalebar. | |
Q_DECL_DEPRECATED void | setLineJoinStyle (Qt::PenJoinStyle style) |
Sets the join style used when drawing the lines in the scalebar. | |
void | setLineSymbol (QgsLineSymbol *symbol) |
Sets the line symbol used to render the scalebar (only used for some scalebar types). | |
Q_DECL_DEPRECATED void | setLineWidth (double width) |
Sets the line width in millimeters for lines in the scalebar. | |
void | setLinkedMap (QgsLayoutItemMap *map) |
Sets the map item linked to the scalebar. | |
void | setMapUnitsPerScaleBarUnit (double units) |
Sets the number of map units per scale bar unit used by the scalebar. | |
void | setMaximumBarWidth (double maxWidth) |
Sets the maximum width (in millimeters) for scale bar segments. | |
void | setMethod (Qgis::ScaleCalculationMethod method) |
Sets the scale calculation method, which determines how the bar's scale will be calculated. | |
void | setMinimumBarWidth (double minWidth) |
Sets the minimum width (in millimeters) for scale bar segments. | |
void | setNumberOfSegments (int segments) |
Sets the number of segments included in the scalebar. | |
void | setNumberOfSegmentsLeft (int segments) |
Sets the number of segments included in the left part of the scalebar. | |
void | setNumberOfSubdivisions (int subdivisions) |
Sets the number of subdivisions for segments included in the right part of the scalebar (only used for some scalebar types). | |
void | setNumericFormat (QgsNumericFormat *format) |
Sets the numeric format used for numbers in the scalebar. | |
void | setSegmentSizeMode (Qgis::ScaleBarSegmentSizeMode mode) |
Sets the size mode for scale bar segments. | |
void | setStyle (const QString &name) |
Sets the scale bar style by name. | |
void | setSubdivisionLineSymbol (QgsLineSymbol *symbol) |
Sets the line symbol used to render the scalebar subdivisions (only used for some scalebar types). | |
void | setSubdivisionsHeight (double height) |
Sets the scalebar subdivisions height (in millimeters) for segments included in the right part of the scalebar (only used for some scalebar types). | |
void | setTextFormat (const QgsTextFormat &format) |
Sets the text format used for drawing text in the scalebar. | |
void | setUnitLabel (const QString &label) |
Sets the label for units. | |
void | setUnits (Qgis::DistanceUnit units) |
Sets the distance units used by the scalebar. | |
void | setUnitsPerSegment (double units) |
Sets the number of scalebar units per segment. | |
QString | style () const |
Returns the scale bar style name. | |
QgsLineSymbol * | subdivisionLineSymbol () const |
Returns the line symbol used to render the scalebar subdivisions (only used for some scalebar types). | |
double | subdivisionsHeight () const |
Returns the scalebar subdivisions height (in millimeters) for segments included in the right part of the scalebar (only used for some scalebar types). | |
QgsTextFormat | textFormat () const |
Returns the text format used for drawing text in the scalebar. | |
int | type () const override |
QString | unitLabel () const |
Returns the label for units. | |
Qgis::DistanceUnit | units () const |
Returns the distance units used by the scalebar. | |
double | unitsPerSegment () const |
Returns the number of scalebar units per segment. | |
void | update () |
Adjusts the scale bar box size and updates the item. | |
Public Member Functions inherited from QgsLayoutItem | |
QgsLayoutItem (QgsLayout *layout, bool manageZValue=true) | |
Constructor for QgsLayoutItem, with the specified parent layout. | |
~QgsLayoutItem () override | |
virtual void | attemptMove (const QgsLayoutPoint &point, bool useReferencePoint=true, bool includesFrame=false, int page=-1) |
Attempts to move the item to a specified point. | |
void | attemptMoveBy (double deltaX, double deltaY) |
Attempts to shift the item's position by a specified deltaX and deltaY, in layout units. | |
virtual void | attemptResize (const QgsLayoutSize &size, bool includesFrame=false) |
Attempts to resize the item to a specified target size. | |
void | attemptSetSceneRect (const QRectF &rect, bool includesFrame=false) |
Attempts to update the item's position and size to match the passed rect in layout coordinates. | |
QColor | backgroundColor (bool useDataDefined=true) const |
Returns the background color for this item. | |
void | beginCommand (const QString &commandText, UndoCommand command=UndoNone) |
Starts new undo command for this item. | |
QPainter::CompositionMode | blendMode () const |
Returns the item's composition blending mode. | |
void | cancelCommand () |
Cancels the current item command and discards it. | |
virtual void | cleanup () |
Called just before a batch of items are deleted, allowing them to run cleanup tasks. | |
virtual QgsGeometry | clipPath () const |
Returns the clipping path generated by this item, in layout coordinates. | |
virtual bool | containsAdvancedEffects () const |
Returns true if the item contains contents with blend modes or transparency effects which can only be reproduced by rastering the item. | |
QgsAbstractLayoutUndoCommand * | createCommand (const QString &text, int id, QUndoCommand *parent=nullptr) override |
Creates a new layout undo command with the specified text and parent. | |
QgsExpressionContext | createExpressionContext () const override |
This method needs to be reimplemented in all classes which implement this interface and return an expression context. | |
virtual QString | displayName () const |
Gets item display name. | |
void | endCommand () |
Completes the current item command and push it onto the layout's undo stack. | |
virtual double | estimatedFrameBleed () const |
Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. | |
bool | excludeFromExports () const |
Returns whether the item should be excluded from layout exports and prints. | |
virtual QgsLayoutItem::ExportLayerDetail | exportLayerDetails () const |
Returns the details for the specified current export layer. | |
virtual QgsLayoutSize | fixedSize () const |
Returns the fixed size of the item, if applicable, or an empty size if item can be freely resized. | |
bool | frameEnabled () const |
Returns true if the item includes a frame. | |
Qt::PenJoinStyle | frameJoinStyle () const |
Returns the join style used for drawing the item's frame. | |
QColor | frameStrokeColor () const |
Returns the frame's stroke color. | |
QgsLayoutMeasurement | frameStrokeWidth () const |
Returns the frame's stroke width. | |
bool | hasBackground () const |
Returns true if the item has a background. | |
QString | id () const |
Returns the item's ID name. | |
bool | isGroupMember () const |
Returns true if the item is part of a QgsLayoutItemGroup group. | |
bool | isLocked () const |
Returns true if the item is locked, and cannot be interacted with using the mouse. | |
virtual bool | isRefreshing () const |
Returns true if the item is currently refreshing content in the background. | |
virtual Flags | itemFlags () const |
Returns the item's flags, which indicate how the item behaves. | |
double | itemOpacity () const |
Returns the item's opacity. | |
double | itemRotation () const |
Returns the current rotation for the item, in degrees clockwise. | |
virtual void | moveContent (double dx, double dy) |
Moves the content of the item, by a specified dx and dy in layout units. | |
virtual bool | nextExportPart () |
Moves to the next export part for a multi-layered export item, during a multi-layered export. | |
virtual Q_DECL_DEPRECATED int | numberExportLayers () const |
Returns the number of layers that this item requires for exporting during layered exports (e.g. | |
int | page () const |
Returns the page the item is currently on, with the first page returning 0. | |
QPointF | pagePos () const |
Returns the item's position (in layout units) relative to the top left corner of its current page. | |
QgsLayoutPoint | pagePositionWithUnits () const |
Returns the item's position (in item units) relative to the top left corner of its current page. | |
void | paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget) override |
Handles preparing a paint surface for the layout item and painting the item's content. | |
QgsLayoutItemGroup * | parentGroup () const |
Returns the item's parent group, if the item is part of a QgsLayoutItemGroup group. | |
QgsLayoutPoint | positionWithUnits () const |
Returns the item's current position, including units. | |
bool | readXml (const QDomElement &itemElement, const QDomDocument &document, const QgsReadWriteContext &context) |
Sets the item state from a DOM element. | |
virtual QRectF | rectWithFrame () const |
Returns the item's rectangular bounds, including any bleed caused by the item's frame. | |
ReferencePoint | referencePoint () const |
Returns the reference point for positioning of the layout item. | |
virtual bool | requiresRasterization () const |
Returns true if the item is drawn in such a way that forces the whole layout to be rasterized when exporting to vector formats. | |
void | setBackgroundColor (const QColor &color) |
Sets the background color for this item. | |
void | setBackgroundEnabled (bool drawBackground) |
Sets whether this item has a background drawn under it or not. | |
void | setBlendMode (QPainter::CompositionMode mode) |
Sets the item's composition blending mode. | |
void | setExcludeFromExports (bool exclude) |
Sets whether the item should be excluded from layout exports and prints. | |
virtual void | setFrameEnabled (bool drawFrame) |
Sets whether this item has a frame drawn around it or not. | |
void | setFrameJoinStyle (Qt::PenJoinStyle style) |
Sets the join style used when drawing the item's frame. | |
void | setFrameStrokeColor (const QColor &color) |
Sets the frame stroke color. | |
virtual void | setFrameStrokeWidth (QgsLayoutMeasurement width) |
Sets the frame stroke width. | |
virtual void | setId (const QString &id) |
Set the item's id name. | |
void | setItemOpacity (double opacity) |
Sets the item's opacity. | |
void | setLocked (bool locked) |
Sets whether the item is locked, preventing mouse interactions with the item. | |
virtual void | setMoveContentPreviewOffset (double dx, double dy) |
Sets temporary offset for the item, by a specified dx and dy in layout units. | |
void | setParentGroup (QgsLayoutItemGroup *group) |
Sets the item's parent group. | |
void | setReferencePoint (ReferencePoint point) |
Sets the reference point for positioning of the layout item. | |
virtual void | setSelected (bool selected) |
Sets whether the item should be selected. | |
virtual void | setVisibility (bool visible) |
Sets whether the item is visible. | |
bool | shouldDrawItem () const |
Returns whether the item should be drawn in the current context. | |
QgsLayoutSize | sizeWithUnits () const |
Returns the item's current size, including units. | |
virtual void | startLayeredExport () |
Starts a multi-layer export operation. | |
virtual void | stopLayeredExport () |
Stops a multi-layer export operation. | |
int | type () const override |
Returns a unique graphics item type identifier. | |
virtual QString | uuid () const |
Returns the item identification string. | |
bool | writeXml (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const |
Stores the item state in a DOM element. | |
virtual void | zoomContent (double factor, QPointF point) |
Zooms content of item. | |
Public Member Functions inherited from QgsLayoutObject | |
QgsLayoutObject (QgsLayout *layout) | |
Constructor for QgsLayoutObject, with the specified parent layout. | |
QgsExpressionContext | createExpressionContext () const override |
Creates an expression context relating to the objects' current state. | |
QStringList | customProperties () const |
Returns list of keys stored in custom properties for the object. | |
QVariant | customProperty (const QString &key, const QVariant &defaultValue=QVariant()) const |
Read a custom property from the object. | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the object's property collection, used for data defined overrides. | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the object's property collection, used for data defined overrides. | |
QgsLayout * | layout () |
Returns the layout the object is attached to. | |
const QgsLayout * | layout () const |
Returns the layout the object is attached to. | |
void | removeCustomProperty (const QString &key) |
Remove a custom property from the object. | |
void | setCustomProperty (const QString &key, const QVariant &value) |
Set a custom property for the object. | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the objects's property collection, used for data defined overrides. | |
Public Member Functions inherited from QgsExpressionContextGenerator | |
virtual | ~QgsExpressionContextGenerator ()=default |
Public Member Functions inherited from QgsLayoutUndoObjectInterface | |
virtual | ~QgsLayoutUndoObjectInterface ()=default |
Static Public Member Functions | |
static QgsLayoutItemScaleBar * | create (QgsLayout *layout) |
Returns a new scale bar item for the specified layout. | |
Static Public Member Functions inherited from QgsLayoutObject | |
static bool | propertyAssociatesWithParentMultiframe (DataDefinedProperty property) |
Returns true if the specified property key is normally associated with the parent QgsLayoutMultiFrame object instead of a child QgsLayoutFrame object. | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the layout object property definitions. | |
Protected Member Functions | |
void | draw (QgsLayoutItemRenderContext &context) override |
Draws the item's contents using the specified item render context. | |
bool | readPropertiesFromElement (const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context) override |
Sets item state from a DOM element. | |
bool | writePropertiesToElement (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const override |
Stores item state within an XML DOM element. | |
Protected Member Functions inherited from QgsLayoutItem | |
QPointF | adjustPointForReferencePosition (QPointF point, QSizeF size, ReferencePoint reference) const |
Adjusts the specified point at which a reference position of the item sits and returns the top left corner of the item, if reference point were placed at the specified position. | |
QgsLayoutSize | applyDataDefinedSize (const QgsLayoutSize &size) |
Applies any present data defined size overrides to the specified layout size. | |
virtual QSizeF | applyItemSizeConstraint (QSizeF targetSize) |
Applies any item-specific size constraint handling to a given targetSize in layout units. | |
virtual void | drawBackground (QgsRenderContext &context) |
Draws the background for the item. | |
virtual void | drawDebugRect (QPainter *painter) |
Draws a debugging rectangle of the item's current bounds within the specified painter. | |
virtual void | drawFrame (QgsRenderContext &context) |
Draws the frame around the item. | |
void | drawRefreshingOverlay (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle) |
Draws a "refreshing" overlay icon on the item. | |
virtual QPainterPath | framePath () const |
Returns the path to use when drawing the item's frame or background. | |
QPointF | positionAtReferencePoint (ReferencePoint reference) const |
Returns the current position (in layout units) of a reference point for the item. | |
void | refreshBackgroundColor (bool updateItem=true) |
Refresh item's background color, considering data defined colors. | |
void | refreshBlendMode () |
Refresh item's blend mode, considering data defined blend mode. | |
void | refreshFrame (bool updateItem=true) |
Refresh item's frame, considering data defined colors and frame size. | |
void | refreshItemPosition () |
Refreshes an item's position by rechecking it against any possible overrides such as data defined positioning. | |
void | refreshItemRotation (QPointF *origin=nullptr) |
Refreshes an item's rotation by rechecking it against any possible overrides such as data defined rotation. | |
void | refreshItemSize () |
Refreshes an item's size by rechecking it against any possible item fixed or minimum sizes. | |
void | refreshOpacity (bool updateItem=true) |
Refresh item's opacity, considering data defined opacity. | |
virtual void | setFixedSize (const QgsLayoutSize &size) |
Sets a fixed size for the layout item, which prevents it from being freely resized. | |
virtual void | setMinimumSize (const QgsLayoutSize &size) |
Sets the minimum allowed size for the layout item. | |
QgsLayoutPoint | topLeftToReferencePoint (const QgsLayoutPoint &point) const |
Returns the position for the reference point of the item, if the top-left of the item was placed at the specified point. | |
Protected Member Functions inherited from QgsLayoutObject | |
bool | readObjectPropertiesFromElement (const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context) |
Sets object properties from a DOM element. | |
bool | writeObjectPropertiesToElement (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const |
Stores object properties within an XML DOM element. | |
Friends | |
class | QgsCompositionConverter |
A layout item subclass for scale bars.
Definition at line 34 of file qgslayoutitemscalebar.h.
QgsLayoutItemScaleBar::QgsLayoutItemScaleBar | ( | QgsLayout * | layout | ) |
Constructor for QgsLayoutItemScaleBar, with the specified parent layout.
Definition at line 52 of file qgslayoutitemscalebar.cpp.
|
overridevirtual |
Accepts the specified style entity visitor, causing it to visit all style entities associated with the layout item.
Returns true
if the visitor should continue visiting other objects, or false
if visiting should be canceled.
Reimplemented from QgsLayoutItem.
Definition at line 1523 of file qgslayoutitemscalebar.cpp.
|
inline |
Returns the scalebar alignment.
Definition at line 533 of file qgslayoutitemscalebar.h.
QgsFillSymbol * QgsLayoutItemScaleBar::alternateFillSymbol | ( | ) | const |
Returns the secondary fill symbol used to render the scalebar (only used for some scalebar types).
Ownership is not transferred.
Definition at line 268 of file qgslayoutitemscalebar.cpp.
bool QgsLayoutItemScaleBar::applyDefaultRendererSettings | ( | QgsScaleBarRenderer * | renderer | ) |
Applies any default settings relating to the specified renderer to the item.
Returns true
if settings were applied.
Definition at line 801 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::applyDefaultSettings | ( | ) |
Applies the default scalebar settings to the scale bar.
Definition at line 772 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::applyDefaultSize | ( | Qgis::DistanceUnit | units = Qgis::DistanceUnit::Meters | ) |
Applies the default size to the scale bar (scale bar 1/5 of map item width)
Definition at line 851 of file qgslayoutitemscalebar.cpp.
|
inline |
Returns the spacing (margin) between the scalebar box and content in millimeters.
Definition at line 493 of file qgslayoutitemscalebar.h.
QBrush QgsLayoutItemScaleBar::brush | ( | ) | const |
Returns the primary brush for the scalebar.
Definition at line 1052 of file qgslayoutitemscalebar.cpp.
QBrush QgsLayoutItemScaleBar::brush2 | ( | ) | const |
Returns the secondary brush for the scalebar.
This is used for alternating color style scalebars, such as single and double box styles.
Definition at line 1059 of file qgslayoutitemscalebar.cpp.
|
static |
Returns a new scale bar item for the specified layout.
The caller takes responsibility for deleting the returned object.
Definition at line 69 of file qgslayoutitemscalebar.cpp.
QgsLineSymbol * QgsLayoutItemScaleBar::divisionLineSymbol | ( | ) | const |
Returns the line symbol used to render the scalebar divisions (only used for some scalebar types).
Ownership is not transferred.
Definition at line 238 of file qgslayoutitemscalebar.cpp.
|
overrideprotectedvirtual |
Draws the item's contents using the specified item render context.
Note that the context's painter has been scaled so that painter units are pixels. Use the QgsRenderContext methods to convert from millimeters or other units to the painter's units.
Implements QgsLayoutItem.
Definition at line 85 of file qgslayoutitemscalebar.cpp.
|
overridevirtual |
Returns the behavior of this item during exporting to layered exports (e.g.
SVG or geospatial PDF).
Reimplemented from QgsLayoutItem.
Definition at line 1532 of file qgslayoutitemscalebar.cpp.
QColor QgsLayoutItemScaleBar::fillColor | ( | ) | const |
Returns the color used for fills in the scalebar.
Definition at line 989 of file qgslayoutitemscalebar.cpp.
QColor QgsLayoutItemScaleBar::fillColor2 | ( | ) | const |
Returns the secondary color used for fills in the scalebar.
Definition at line 1003 of file qgslayoutitemscalebar.cpp.
QgsFillSymbol * QgsLayoutItemScaleBar::fillSymbol | ( | ) | const |
Returns the primary fill symbol used to render the scalebar (only used for some scalebar types).
Ownership is not transferred.
Definition at line 258 of file qgslayoutitemscalebar.cpp.
|
overridevirtual |
Called after all pending items have been restored from XML.
Items can use this method to run steps which must take place after all items have been restored to the layout, such as connecting to signals emitted by other items, which may not have existed in the layout at the time readXml() was called. E.g. a scalebar can use this to connect to its linked map item after restoration from XML.
Reimplemented from QgsLayoutItem.
Definition at line 1507 of file qgslayoutitemscalebar.cpp.
QFont QgsLayoutItemScaleBar::font | ( | ) | const |
Returns the font used for drawing text in the scalebar.
Definition at line 962 of file qgslayoutitemscalebar.cpp.
QColor QgsLayoutItemScaleBar::fontColor | ( | ) | const |
Returns the color used for drawing text in the scalebar.
Definition at line 976 of file qgslayoutitemscalebar.cpp.
Qgis::DistanceUnit QgsLayoutItemScaleBar::guessUnits | ( | ) | const |
Attempts to guess the most reasonable unit choice for the scalebar, given the current linked map's scale.
This method also considers the linked map's CRS, in order to determine if metric or imperial units are more appropriate.
Definition at line 806 of file qgslayoutitemscalebar.cpp.
|
inline |
Returns the scalebar height (in millimeters).
Definition at line 457 of file qgslayoutitemscalebar.h.
|
overridevirtual |
Returns the item's icon.
Reimplemented from QgsLayoutItem.
Definition at line 64 of file qgslayoutitemscalebar.cpp.
|
inline |
Returns the spacing (in millimeters) between labels and the scalebar.
Definition at line 481 of file qgslayoutitemscalebar.h.
|
inline |
Returns the horizontal placement of text labels.
Definition at line 520 of file qgslayoutitemscalebar.h.
|
inline |
Returns the vertical placement of text labels.
Definition at line 506 of file qgslayoutitemscalebar.h.
Qt::PenCapStyle QgsLayoutItemScaleBar::lineCapStyle | ( | ) | const |
Returns the cap style used for drawing lines in the scalebar.
Definition at line 751 of file qgslayoutitemscalebar.cpp.
QColor QgsLayoutItemScaleBar::lineColor | ( | ) | const |
Returns the color used for lines in the scalebar.
Definition at line 1017 of file qgslayoutitemscalebar.cpp.
Qt::PenJoinStyle QgsLayoutItemScaleBar::lineJoinStyle | ( | ) | const |
Returns the join style used for drawing lines in the scalebar.
Definition at line 730 of file qgslayoutitemscalebar.cpp.
QgsLineSymbol * QgsLayoutItemScaleBar::lineSymbol | ( | ) | const |
Returns the line symbol used to render the scalebar (only used for some scalebar types).
Ownership is not transferred.
Definition at line 228 of file qgslayoutitemscalebar.cpp.
double QgsLayoutItemScaleBar::lineWidth | ( | ) | const |
Returns the line width in millimeters for lines in the scalebar.
Definition at line 1031 of file qgslayoutitemscalebar.cpp.
|
inline |
Returns the map item linked to the scalebar.
Definition at line 475 of file qgslayoutitemscalebar.h.
|
inline |
Returns the number of map units per scale bar unit used by the scalebar.
Definition at line 192 of file qgslayoutitemscalebar.h.
|
inline |
Returns the maximum width (in millimeters) for scale bar segments.
This property is only effective if the segmentSizeMode() is set to SegmentSizeFitWidth.
Definition at line 176 of file qgslayoutitemscalebar.h.
Qgis::ScaleCalculationMethod QgsLayoutItemScaleBar::method | ( | ) | const |
Returns the scale calculation method, which determines how the bar's scale will be calculated.
Definition at line 330 of file qgslayoutitemscalebar.cpp.
|
inline |
Returns the minimum width (in millimeters) for scale bar segments.
This property is only effective if the segmentSizeMode() is set to SegmentSizeFitWidth.
Definition at line 156 of file qgslayoutitemscalebar.h.
|
overridevirtual |
Returns the minimum allowed size of the item, if applicable, or an empty size if item can be freely resized.
Reimplemented from QgsLayoutItem.
Definition at line 74 of file qgslayoutitemscalebar.cpp.
|
inline |
Returns the number of segments included in the scalebar.
Definition at line 61 of file qgslayoutitemscalebar.h.
|
inline |
Returns the number of segments included in the left part of the scalebar.
Definition at line 75 of file qgslayoutitemscalebar.h.
|
inline |
Returns the number of subdivisions for segments included in the right part of the scalebar (only used for some scalebar types).
Definition at line 93 of file qgslayoutitemscalebar.h.
const QgsNumericFormat * QgsLayoutItemScaleBar::numericFormat | ( | ) | const |
Returns the numeric format used for numbers in the scalebar.
Definition at line 952 of file qgslayoutitemscalebar.cpp.
QPen QgsLayoutItemScaleBar::pen | ( | ) | const |
Returns the pen used for drawing outlines in the scalebar.
Definition at line 1045 of file qgslayoutitemscalebar.cpp.
|
overrideprotectedvirtual |
Sets item state from a DOM element.
element | is the DOM element for the item |
document | DOM document |
context | read write context |
Note that item subclasses should not rely on all other items being present in the layout at the time this method is called. Instead, any connections and links to other items must be made in the finalizeRestoreFromXml() method. E.g. when restoring a scalebar, the connection to the linked map's signals should be implemented in finalizeRestoreFromXml(), not readPropertiesFromElement().
Reimplemented from QgsLayoutItem.
Definition at line 1193 of file qgslayoutitemscalebar.cpp.
|
overridevirtual |
Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value.
If property is set to QgsLayoutObject::AllProperties then all data defined properties for the item will be refreshed.
Reimplemented from QgsLayoutItem.
Definition at line 444 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::resizeToMinimumWidth | ( | ) |
Resizes the scale bar to its minimum width, without changing the height.
Definition at line 888 of file qgslayoutitemscalebar.cpp.
|
inline |
Returns the size mode for the scale bar segments.
Definition at line 138 of file qgslayoutitemscalebar.h.
void QgsLayoutItemScaleBar::setAlignment | ( | Qgis::ScaleBarAlignment | alignment | ) |
Sets the scalebar alignment.
Definition at line 715 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setAlternateFillSymbol | ( | QgsFillSymbol * | symbol | ) |
Sets the secondary fill symbol used to render the scalebar (only used for some scalebar types).
Ownership of symbol is transferred to the scalebar.
Definition at line 273 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setBoxContentSpace | ( | double | space | ) |
Sets the space (margin) between the scalebar box and content in millimeters.
Definition at line 289 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setDivisionLineSymbol | ( | QgsLineSymbol * | symbol | ) |
Sets the line symbol used to render the scalebar divisions (only used for some scalebar types).
Ownership of symbol is transferred to the scalebar.
Definition at line 243 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setFillColor | ( | const QColor & | color | ) |
Sets the color used for fills in the scalebar.
Definition at line 996 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setFillColor2 | ( | const QColor & | color | ) |
Sets the secondary color used for fills in the scalebar.
Definition at line 1010 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setFillSymbol | ( | QgsFillSymbol * | symbol | ) |
Sets the primary fill symbol used to render the scalebar (only used for some scalebar types).
Ownership of symbol is transferred to the scalebar.
Definition at line 263 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setFont | ( | const QFont & | font | ) |
Sets the font used for drawing text in the scalebar.
Definition at line 967 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setFontColor | ( | const QColor & | color | ) |
Sets the color used for drawing text in the scalebar.
Definition at line 983 of file qgslayoutitemscalebar.cpp.
|
inline |
Sets the scalebar height (in millimeters).
Definition at line 463 of file qgslayoutitemscalebar.h.
|
inline |
Sets the spacing (in millimeters) between labels and the scalebar.
Definition at line 487 of file qgslayoutitemscalebar.h.
void QgsLayoutItemScaleBar::setLabelHorizontalPlacement | ( | Qgis::ScaleBarDistanceLabelHorizontalPlacement | placement | ) |
Sets the horizontal placement of text labels.
Definition at line 708 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setLabelVerticalPlacement | ( | Qgis::ScaleBarDistanceLabelVerticalPlacement | placement | ) |
Sets the vertical placement of text labels.
Definition at line 701 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setLineCapStyle | ( | Qt::PenCapStyle | style | ) |
Sets the cap style used when drawing the lines in the scalebar.
Definition at line 758 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setLineColor | ( | const QColor & | color | ) |
Sets the color used for lines in the scalebar.
Definition at line 1024 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setLineJoinStyle | ( | Qt::PenJoinStyle | style | ) |
Sets the join style used when drawing the lines in the scalebar.
Definition at line 737 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setLineSymbol | ( | QgsLineSymbol * | symbol | ) |
Sets the line symbol used to render the scalebar (only used for some scalebar types).
Ownership of symbol is transferred to the scalebar.
Definition at line 233 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setLineWidth | ( | double | width | ) |
Sets the line width in millimeters for lines in the scalebar.
Definition at line 1038 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setLinkedMap | ( | QgsLayoutItemMap * | map | ) |
Sets the map item linked to the scalebar.
Definition at line 300 of file qgslayoutitemscalebar.cpp.
|
inline |
Sets the number of map units per scale bar unit used by the scalebar.
Definition at line 198 of file qgslayoutitemscalebar.h.
void QgsLayoutItemScaleBar::setMaximumBarWidth | ( | double | maxWidth | ) |
Sets the maximum width (in millimeters) for scale bar segments.
This property is only effective if the segmentSizeMode() is set to SegmentSizeFitWidth.
Definition at line 204 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setMethod | ( | Qgis::ScaleCalculationMethod | method | ) |
Sets the scale calculation method, which determines how the bar's scale will be calculated.
Definition at line 335 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setMinimumBarWidth | ( | double | minWidth | ) |
Sets the minimum width (in millimeters) for scale bar segments.
This property is only effective if the segmentSizeMode() is set to SegmentSizeFitWidth.
Definition at line 192 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setNumberOfSegments | ( | int | segments | ) |
Sets the number of segments included in the scalebar.
Definition at line 156 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setNumberOfSegmentsLeft | ( | int | segments | ) |
Sets the number of segments included in the left part of the scalebar.
Definition at line 278 of file qgslayoutitemscalebar.cpp.
|
inline |
Sets the number of subdivisions for segments included in the right part of the scalebar (only used for some scalebar types).
Definition at line 104 of file qgslayoutitemscalebar.h.
void QgsLayoutItemScaleBar::setNumericFormat | ( | QgsNumericFormat * | format | ) |
Sets the numeric format used for numbers in the scalebar.
Ownership of format is transferred to the scalebar.
Definition at line 957 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setSegmentSizeMode | ( | Qgis::ScaleBarSegmentSizeMode | mode | ) |
Sets the size mode for scale bar segments.
Definition at line 180 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setStyle | ( | const QString & | name | ) |
Sets the scale bar style by name.
The name parameter gives the (untranslated) style name. Possibilities are: 'Single Box', 'Double Box', 'Line Ticks Middle', 'Line Ticks Down', 'Line Ticks Up', 'Stepped Line', 'Hollow', 'Numeric'.
Definition at line 928 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setSubdivisionLineSymbol | ( | QgsLineSymbol * | symbol | ) |
Sets the line symbol used to render the scalebar subdivisions (only used for some scalebar types).
Ownership of symbol is transferred to the scalebar.
Definition at line 253 of file qgslayoutitemscalebar.cpp.
|
inline |
Sets the scalebar subdivisions height (in millimeters) for segments included in the right part of the scalebar (only used for some scalebar types).
Definition at line 118 of file qgslayoutitemscalebar.h.
void QgsLayoutItemScaleBar::setTextFormat | ( | const QgsTextFormat & | format | ) |
Sets the text format used for drawing text in the scalebar.
Definition at line 221 of file qgslayoutitemscalebar.cpp.
|
inline |
Sets the label for units.
Definition at line 210 of file qgslayoutitemscalebar.h.
void QgsLayoutItemScaleBar::setUnits | ( | Qgis::DistanceUnit | units | ) |
Sets the distance units used by the scalebar.
Definition at line 722 of file qgslayoutitemscalebar.cpp.
void QgsLayoutItemScaleBar::setUnitsPerSegment | ( | double | units | ) |
Sets the number of scalebar units per segment.
Definition at line 167 of file qgslayoutitemscalebar.cpp.
QString QgsLayoutItemScaleBar::style | ( | ) | const |
Returns the scale bar style name.
Definition at line 940 of file qgslayoutitemscalebar.cpp.
QgsLineSymbol * QgsLayoutItemScaleBar::subdivisionLineSymbol | ( | ) | const |
Returns the line symbol used to render the scalebar subdivisions (only used for some scalebar types).
Ownership is not transferred.
Definition at line 248 of file qgslayoutitemscalebar.cpp.
|
inline |
Returns the scalebar subdivisions height (in millimeters) for segments included in the right part of the scalebar (only used for some scalebar types).
Definition at line 111 of file qgslayoutitemscalebar.h.
QgsTextFormat QgsLayoutItemScaleBar::textFormat | ( | ) | const |
Returns the text format used for drawing text in the scalebar.
Definition at line 216 of file qgslayoutitemscalebar.cpp.
|
override |
Definition at line 59 of file qgslayoutitemscalebar.cpp.
|
inline |
Returns the label for units.
Definition at line 204 of file qgslayoutitemscalebar.h.
|
inline |
Returns the distance units used by the scalebar.
Definition at line 545 of file qgslayoutitemscalebar.h.
|
inline |
Returns the number of scalebar units per segment.
Definition at line 124 of file qgslayoutitemscalebar.h.
void QgsLayoutItemScaleBar::update | ( | ) |
Adjusts the scale bar box size and updates the item.
Definition at line 907 of file qgslayoutitemscalebar.cpp.
|
overrideprotectedvirtual |
Stores item state within an XML DOM element.
element | is the DOM element to store the item's properties in |
document | DOM document |
context | read write context |
Reimplemented from QgsLayoutItem.
Definition at line 1066 of file qgslayoutitemscalebar.cpp.
|
friend |
Definition at line 710 of file qgslayoutitemscalebar.h.