QGIS API Documentation  3.17.0-Master (7a14973234)
Public Types | Public Member Functions | List of all members
QgsTicksScaleBarRenderer Class Reference

A scale bar that draws segments using short ticks. More...

#include <qgsticksscalebarrenderer.h>

Inheritance diagram for QgsTicksScaleBarRenderer:
Inheritance graph
[legend]

Public Types

enum  TickPosition { TicksUp, TicksDown, TicksMiddle }
 Tick positions. More...
 
- Public Types inherited from QgsScaleBarRenderer
enum  Flag {
  Flag::FlagUsesLineSymbol = 1 << 0, Flag::FlagUsesFillSymbol = 1 << 1, Flag::FlagUsesAlternateFillSymbol = 1 << 2, Flag::FlagRespectsUnits = 1 << 3,
  Flag::FlagRespectsMapUnitsPerScaleBarUnit = 1 << 4, Flag::FlagUsesUnitLabel = 1 << 5, Flag::FlagUsesSegments = 1 << 6, Flag::FlagUsesLabelBarSpace = 1 << 7,
  Flag::FlagUsesLabelVerticalPlacement = 1 << 8, Flag::FlagUsesLabelHorizontalPlacement = 1 << 8, Flag::FlagUsesAlignment = 1 << 9, Flag::FlagUsesSubdivisions = 1 << 10,
  Flag::FlagUsesDivisionSymbol = 1 << 11, Flag::FlagUsesSubdivisionSymbol = 1 << 12, Flag::FlagUsesSubdivisionsHeight = 1 << 13
}
 Flags which control scalebar renderer behavior. More...
 

Public Member Functions

 QgsTicksScaleBarRenderer (TickPosition position=TicksMiddle)
 Constructor for QgsTicksScaleBarRenderer. More...
 
QgsTicksScaleBarRendererclone () const override
 Returns a clone of the renderer. More...
 
void draw (QgsRenderContext &context, const QgsScaleBarSettings &settings, const QgsScaleBarRenderer::ScaleBarContext &scaleContext) const override
 Draws the scalebar using the specified settings and scaleContext to a destination render context. More...
 
Flags flags () const override
 Returns the scalebar rendering flags, which dictates the renderer's behavior. More...
 
QString id () const override
 Returns the unique ID for this renderer. More...
 
void setTickPosition (TickPosition position)
 Sets the position for tick marks in the scalebar. More...
 
int sortKey () const override
 Returns a sorting key value, where renderers with a lower sort key will be shown earlier in lists. More...
 
TickPosition tickPosition () const
 Returns the position for tick marks in the scalebar. More...
 
QString visibleName () const override
 Returns the user friendly, translated name for the renderer. More...
 
- Public Member Functions inherited from QgsScaleBarRenderer
 QgsScaleBarRenderer ()=default
 Constructor for QgsScaleBarRenderer. More...
 
virtual ~QgsScaleBarRenderer ()=default
 
virtual bool applyDefaultSettings (QgsScaleBarSettings &settings) const
 Applies any default settings relating to the scalebar to the passed settings object. More...
 
virtual Q_DECL_DEPRECATED QSizeF calculateBoxSize (const QgsScaleBarSettings &settings, const QgsScaleBarRenderer::ScaleBarContext &scaleContext) const
 Calculates the required box size (in millimeters) for a scalebar using the specified settings and scaleContext. More...
 
virtual QSizeF calculateBoxSize (QgsRenderContext &context, const QgsScaleBarSettings &settings, const QgsScaleBarRenderer::ScaleBarContext &scaleContext) const
 Calculates the required box size (in millimeters) for a scalebar using the specified settings and scaleContext. More...
 
Q_DECL_DEPRECATED QString name () const
 Returns the unique name for this style. More...
 

Additional Inherited Members

- Protected Member Functions inherited from QgsScaleBarRenderer
void drawDefaultLabels (QgsRenderContext &context, const QgsScaleBarSettings &settings, const QgsScaleBarRenderer::ScaleBarContext &scaleContext) const
 Draws default scalebar labels using the specified settings and scaleContext to a destination render context. More...
 
QString firstLabelString (const QgsScaleBarSettings &settings) const
 Returns the text used for the first label in the scalebar. More...
 
Q_DECL_DEPRECATED double firstLabelXOffset (const QgsScaleBarSettings &settings) const
 Returns the x-offset (in millimeters) used for the first label in the scalebar. More...
 
double firstLabelXOffset (const QgsScaleBarSettings &settings, const QgsRenderContext &context, const ScaleBarContext &scaleContext) const
 Returns the x-offset (in render context painter units) used for the first label in the scalebar. More...
 
Q_DECL_DEPRECATED QList< double > segmentPositions (const QgsScaleBarRenderer::ScaleBarContext &scaleContext, const QgsScaleBarSettings &settings) const
 Returns a list of positions for each segment within the scalebar. More...
 
QList< double > segmentPositions (QgsRenderContext &context, const QgsScaleBarRenderer::ScaleBarContext &scaleContext, const QgsScaleBarSettings &settings) const
 Returns a list of positions for each segment within the scalebar. More...
 
QList< double > segmentWidths (const QgsScaleBarRenderer::ScaleBarContext &scaleContext, const QgsScaleBarSettings &settings) const
 Returns a list of widths of each segment of the scalebar. More...
 

Detailed Description

A scale bar that draws segments using short ticks.

Since
QGIS 3.0

Definition at line 29 of file qgsticksscalebarrenderer.h.

Member Enumeration Documentation

◆ TickPosition

Tick positions.

Enumerator
TicksUp 

Render ticks above line.

TicksDown 

Render ticks below line.

TicksMiddle 

Render ticks crossing line.

Definition at line 34 of file qgsticksscalebarrenderer.h.

Constructor & Destructor Documentation

◆ QgsTicksScaleBarRenderer()

QgsTicksScaleBarRenderer::QgsTicksScaleBarRenderer ( QgsTicksScaleBarRenderer::TickPosition  position = TicksMiddle)

Constructor for QgsTicksScaleBarRenderer.

Definition at line 24 of file qgsticksscalebarrenderer.cpp.

Member Function Documentation

◆ clone()

QgsTicksScaleBarRenderer * QgsTicksScaleBarRenderer::clone ( ) const
overridevirtual

Returns a clone of the renderer.

The caller takes ownership of the returned value.

Implements QgsScaleBarRenderer.

Definition at line 89 of file qgsticksscalebarrenderer.cpp.

◆ draw()

void QgsTicksScaleBarRenderer::draw ( QgsRenderContext context,
const QgsScaleBarSettings settings,
const QgsScaleBarRenderer::ScaleBarContext scaleContext 
) const
overridevirtual

Draws the scalebar using the specified settings and scaleContext to a destination render context.

Implements QgsScaleBarRenderer.

Definition at line 94 of file qgsticksscalebarrenderer.cpp.

◆ flags()

QgsScaleBarRenderer::Flags QgsTicksScaleBarRenderer::flags ( ) const
overridevirtual

Returns the scalebar rendering flags, which dictates the renderer's behavior.

Since
QGIS 3.14

Reimplemented from QgsScaleBarRenderer.

Definition at line 73 of file qgsticksscalebarrenderer.cpp.

◆ id()

QString QgsTicksScaleBarRenderer::id ( ) const
overridevirtual

Returns the unique ID for this renderer.

Since
QGIS 3.14

Implements QgsScaleBarRenderer.

Definition at line 30 of file qgsticksscalebarrenderer.cpp.

◆ setTickPosition()

void QgsTicksScaleBarRenderer::setTickPosition ( TickPosition  position)
inline

Sets the position for tick marks in the scalebar.

See also
tickPosition()

Definition at line 60 of file qgsticksscalebarrenderer.h.

◆ sortKey()

int QgsTicksScaleBarRenderer::sortKey ( ) const
overridevirtual

Returns a sorting key value, where renderers with a lower sort key will be shown earlier in lists.

Generally, subclasses should return QgsScaleBarRenderer::sortKey() as their sorting key.

Reimplemented from QgsScaleBarRenderer.

Definition at line 59 of file qgsticksscalebarrenderer.cpp.

◆ tickPosition()

TickPosition QgsTicksScaleBarRenderer::tickPosition ( ) const
inline

Returns the position for tick marks in the scalebar.

See also
setTickPosition()

Definition at line 66 of file qgsticksscalebarrenderer.h.

◆ visibleName()

QString QgsTicksScaleBarRenderer::visibleName ( ) const
overridevirtual

Returns the user friendly, translated name for the renderer.

Since
QGIS 3.14

Implements QgsScaleBarRenderer.

Definition at line 44 of file qgsticksscalebarrenderer.cpp.


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