QGIS API Documentation
3.18.1-Zürich (202f1bf7e5)
|
The QgsLegendSettings class stores the appearance and layout settings for legend drawing with QgsLegendRenderer. More...
#include <qgslegendsettings.h>
Public Member Functions | |
QgsLegendSettings () | |
double | boxSpace () const |
Returns the legend box space (in millimeters), which is the empty margin around the inside of the legend's rectangle. More... | |
int | columnCount () const |
Returns the desired minimum number of columns to show in the legend. More... | |
double | columnSpace () const |
Returns the margin space between adjacent columns (in millimeters). More... | |
Q_DECL_DEPRECATED int | dpi () const |
bool | drawRasterStroke () const |
Returns whether a stroke will be drawn around raster symbol items. More... | |
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. More... | |
void | drawText (QPainter *p, double x, double y, const QString &text, const QFont &font) const |
Draws Text. More... | |
bool | equalColumnWidth () const |
Returns true if all columns should have equal widths. More... | |
QStringList | evaluateItemText (const QString &text, const QgsExpressionContext &context) const |
Splits a string using the wrap char taking into account handling empty wrap char which means no wrapping. More... | |
double | fontAscentMillimeters (const QFont &font) const |
Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More... | |
QColor | fontColor () const |
Returns the font color used for legend items. More... | |
double | fontDescentMillimeters (const QFont &font) const |
Returns the font descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More... | |
double | fontHeightCharacterMM (const QFont &font, QChar c) const |
Returns the font height of a character in millimeters. More... | |
QColor | layerFontColor () const |
Returns layer font color, defaults to fontColor() More... | |
double | lineSpacing () const |
Returns the line spacing to use between lines of legend text. More... | |
Q_DECL_DEPRECATED double | mapScale () const |
Returns the legend map scale. More... | |
Q_DECL_DEPRECATED double | mapUnitsPerPixel () const |
Returns the factor of map units per pixel for symbols with size given in map units calculated by dpi and mmPerMapUnit. More... | |
double | maximumSymbolSize () const |
Returns the maximum symbol size (in mm). More... | |
double | minimumSymbolSize () const |
Returns the minimum symbol size (in mm). More... | |
Q_DECL_DEPRECATED double | mmPerMapUnit () const |
double | pixelFontSize (double pointSize) const |
Calculates font to from point size to pixel size. More... | |
QColor | rasterStrokeColor () const |
Returns the stroke color for the stroke drawn around raster symbol items. More... | |
double | rasterStrokeWidth () const |
Returns the stroke width (in millimeters) for the stroke drawn around raster symbol items. More... | |
QgsLegendStyle & | rstyle (QgsLegendStyle::Style s) |
Returns modifiable reference to the style for a legend component. More... | |
QFont | scaledFontPixelSize (const QFont &font) const |
Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE. More... | |
void | setBoxSpace (double s) |
Sets the legend box space (in millimeters), which is the empty margin around the inside of the legend's rectangle. More... | |
void | setColumnCount (int c) |
Sets the desired minimum number of columns to show in the legend. More... | |
void | setColumnSpace (double s) |
Sets the margin space between adjacent columns (in millimeters). More... | |
Q_DECL_DEPRECATED void | setDpi (int dpi) |
void | setDrawRasterStroke (bool enabled) |
Sets whether a stroke will be drawn around raster symbol items. More... | |
void | setEqualColumnWidth (bool s) |
Sets whether all columns should have equal widths. More... | |
void | setFontColor (const QColor &c) |
Sets the font color used for legend items. More... | |
void | setLayerFontColor (const QColor &fontColor) |
Sets layer font color to fontColor Overrides fontColor() More... | |
void | setLineSpacing (double s) |
Sets the line spacing to use between lines of legend text. More... | |
Q_DECL_DEPRECATED void | setMapScale (double scale) |
Sets the legend map scale. More... | |
Q_DECL_DEPRECATED void | setMapUnitsPerPixel (double mapUnitsPerPixel) |
Sets the mmPerMapUnit calculated by mapUnitsPerPixel mostly taken from the map settings. More... | |
void | setMaximumSymbolSize (double size) |
Set the maximum symbol size for symbol (in millimeters). More... | |
void | setMinimumSymbolSize (double size) |
Set the minimum symbol size for symbol (in millimeters). More... | |
Q_DECL_DEPRECATED void | setMmPerMapUnit (double mmPerMapUnit) |
void | setRasterStrokeColor (const QColor &color) |
Sets the stroke color for the stroke drawn around raster symbol items. More... | |
void | setRasterStrokeWidth (double width) |
Sets the stroke width for the stroke drawn around raster symbol items. More... | |
void | setSplitLayer (bool s) |
Sets whether layer components can be split over multiple columns. More... | |
void | setStyle (QgsLegendStyle::Style s, const QgsLegendStyle &style) |
Sets the style for a legend component. More... | |
void | setSymbolAlignment (Qt::AlignmentFlag alignment) |
Sets the alignment for placement of legend symbols. More... | |
void | setSymbolSize (QSizeF s) |
Sets the default symbol size (in millimeters) used for legend items. More... | |
void | setTitle (const QString &t) |
Sets the title for the legend, which will be rendered above all legend items. More... | |
void | setTitleAlignment (Qt::AlignmentFlag alignment) |
Sets the alignment of the legend title. More... | |
Q_DECL_DEPRECATED void | setUseAdvancedEffects (bool use) |
void | setWmsLegendSize (QSizeF s) |
Sets the desired size (in millimeters) of WMS legend graphics shown in the legend. More... | |
void | setWrapChar (const QString &t) |
Sets a string to use as a wrapping character. More... | |
bool | splitLayer () const |
Returns true if layer components can be split over multiple columns. More... | |
QStringList | splitStringForWrapping (const QString &stringToSplt) const |
Splits a string using the wrap char taking into account handling empty wrap char which means no wrapping. More... | |
QgsLegendStyle | style (QgsLegendStyle::Style s) const |
Returns the style for a legend component. More... | |
Qt::AlignmentFlag | symbolAlignment () const |
Returns the alignment for placement of legend symbols. More... | |
QSizeF | symbolSize () const |
Returns the default symbol size (in millimeters) used for legend items. More... | |
double | textWidthMillimeters (const QFont &font, const QString &text) const |
Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More... | |
QString | title () const |
Returns the title for the legend, which will be rendered above all legend items. More... | |
Qt::AlignmentFlag | titleAlignment () const |
Returns the alignment of the legend title. More... | |
Q_DECL_DEPRECATED bool | useAdvancedEffects () const |
QSizeF | wmsLegendSize () const |
Returns the size (in millimeters) of WMS legend graphics shown in the legend. More... | |
QString | wrapChar () const |
Returns the string used as a wrapping character. More... | |
The QgsLegendSettings class stores the appearance and layout settings for legend drawing with QgsLegendRenderer.
The content of the legend is given in QgsLegendModel class.
Definition at line 38 of file qgslegendsettings.h.
QgsLegendSettings::QgsLegendSettings | ( | ) |
Definition at line 23 of file qgslegendsettings.cpp.
|
inline |
Returns the legend box space (in millimeters), which is the empty margin around the inside of the legend's rectangle.
Definition at line 96 of file qgslegendsettings.h.
|
inline |
Returns the desired minimum number of columns to show in the legend.
If legend components have forced column breaks then the actual number of columns in the rendered legend may be larger than this value.
Definition at line 148 of file qgslegendsettings.h.
|
inline |
Returns the margin space between adjacent columns (in millimeters).
Definition at line 131 of file qgslegendsettings.h.
int QgsLegendSettings::dpi | ( | ) | const |
Definition at line 81 of file qgslegendsettings.cpp.
|
inline |
Returns whether a stroke will be drawn around raster symbol items.
Definition at line 300 of file qgslegendsettings.h.
void QgsLegendSettings::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.
p | painter to use |
rect | rectangle to draw into |
text | text to draw |
font | font to use |
halignment | optional horizontal alignment |
valignment | optional vertical alignment |
flags | allows for passing Qt::TextFlags to control appearance of rendered text |
Definition at line 128 of file qgslegendsettings.cpp.
void QgsLegendSettings::drawText | ( | QPainter * | p, |
double | x, | ||
double | y, | ||
const QString & | text, | ||
const QFont & | font | ||
) | const |
Draws Text.
Takes care about all the composer specific issues (calculation to pixel, scaling of font and painter to work around the Qt font bug)
Definition at line 116 of file qgslegendsettings.cpp.
|
inline |
Returns true
if all columns should have equal widths.
If false
is returned then columns will be individually resized to their minimum possible width.
Definition at line 181 of file qgslegendsettings.h.
QStringList QgsLegendSettings::evaluateItemText | ( | const QString & | text, |
const QgsExpressionContext & | context | ||
) | const |
Splits a string using the wrap char taking into account handling empty wrap char which means no wrapping.
Returns the actual text to render for a legend item, split into separate lines.
The expression context argument is used to correctly evaluated expressions contained within legend item text.
Definition at line 91 of file qgslegendsettings.cpp.
double QgsLegendSettings::fontAscentMillimeters | ( | const QFont & | font | ) | const |
Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
Definition at line 174 of file qgslegendsettings.cpp.
|
inline |
Returns the font color used for legend items.
Definition at line 197 of file qgslegendsettings.h.
double QgsLegendSettings::fontDescentMillimeters | ( | const QFont & | font | ) | const |
Returns the font descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
Definition at line 181 of file qgslegendsettings.cpp.
double QgsLegendSettings::fontHeightCharacterMM | ( | const QFont & | font, |
QChar | c | ||
) | const |
Returns the font height of a character in millimeters.
Definition at line 167 of file qgslegendsettings.cpp.
|
inline |
Returns layer font color, defaults to fontColor()
Definition at line 212 of file qgslegendsettings.h.
|
inline |
Returns the line spacing to use between lines of legend text.
Definition at line 373 of file qgslegendsettings.h.
double QgsLegendSettings::mapScale | ( | ) | const |
Returns the legend map scale.
The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
Definition at line 61 of file qgslegendsettings.cpp.
double QgsLegendSettings::mapUnitsPerPixel | ( | ) | const |
Returns the factor of map units per pixel for symbols with size given in map units calculated by dpi and mmPerMapUnit.
Definition at line 71 of file qgslegendsettings.cpp.
|
inline |
Returns the maximum symbol size (in mm).
0.0 means there is no maximum set.
Definition at line 243 of file qgslegendsettings.h.
|
inline |
Returns the minimum symbol size (in mm).
A value 0.0 means there is no minimum set.
Definition at line 261 of file qgslegendsettings.h.
double QgsLegendSettings::mmPerMapUnit | ( | ) | const |
Definition at line 41 of file qgslegendsettings.cpp.
double QgsLegendSettings::pixelFontSize | ( | double | pointSize | ) | const |
Calculates font to from point size to pixel size.
Definition at line 151 of file qgslegendsettings.cpp.
|
inline |
Returns the stroke color for the stroke drawn around raster symbol items.
The stroke is only drawn if drawRasterStroke() is true
.
Definition at line 320 of file qgslegendsettings.h.
|
inline |
Returns the stroke width (in millimeters) for the stroke drawn around raster symbol items.
The stroke is only drawn if drawRasterStroke() is true
.
Definition at line 341 of file qgslegendsettings.h.
|
inline |
Returns modifiable reference to the style for a legend component.
Definition at line 74 of file qgslegendsettings.h.
QFont QgsLegendSettings::scaledFontPixelSize | ( | const QFont & | font | ) | const |
Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE.
Definition at line 143 of file qgslegendsettings.cpp.
|
inline |
Sets the legend box space (in millimeters), which is the empty margin around the inside of the legend's rectangle.
Definition at line 104 of file qgslegendsettings.h.
|
inline |
Sets the desired minimum number of columns to show in the legend.
If legend components have forced column breaks then the actual number of columns in the rendered legend may be larger than this value.
Definition at line 158 of file qgslegendsettings.h.
|
inline |
Sets the margin space between adjacent columns (in millimeters).
Definition at line 138 of file qgslegendsettings.h.
void QgsLegendSettings::setDpi | ( | int | dpi | ) |
Definition at line 86 of file qgslegendsettings.cpp.
|
inline |
Sets whether a stroke will be drawn around raster symbol items.
enabled | set to true to draw borders |
Definition at line 310 of file qgslegendsettings.h.
|
inline |
Sets whether all columns should have equal widths.
If false
, then then columns will be individually resized to their minimum possible width.
Definition at line 190 of file qgslegendsettings.h.
|
inline |
Sets the font color used for legend items.
Definition at line 204 of file qgslegendsettings.h.
|
inline |
Sets layer font color to fontColor Overrides fontColor()
Definition at line 221 of file qgslegendsettings.h.
|
inline |
Sets the line spacing to use between lines of legend text.
Definition at line 380 of file qgslegendsettings.h.
void QgsLegendSettings::setMapScale | ( | double | scale | ) |
Sets the legend map scale.
The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
Definition at line 66 of file qgslegendsettings.cpp.
void QgsLegendSettings::setMapUnitsPerPixel | ( | double | mapUnitsPerPixel | ) |
Sets the mmPerMapUnit calculated by mapUnitsPerPixel mostly taken from the map settings.
Definition at line 76 of file qgslegendsettings.cpp.
|
inline |
Set the maximum symbol size for symbol (in millimeters).
A symbol size of 0.0 indicates no maximum is set.
Definition at line 253 of file qgslegendsettings.h.
|
inline |
Set the minimum symbol size for symbol (in millimeters).
A symbol size of 0.0 indicates no minimum is set.
Definition at line 271 of file qgslegendsettings.h.
void QgsLegendSettings::setMmPerMapUnit | ( | double | mmPerMapUnit | ) |
Definition at line 46 of file qgslegendsettings.cpp.
|
inline |
Sets the stroke color for the stroke drawn around raster symbol items.
The stroke is only drawn if drawRasterStroke() is true
.
color | stroke color |
Definition at line 331 of file qgslegendsettings.h.
|
inline |
Sets the stroke width for the stroke drawn around raster symbol items.
The stroke is only drawn if drawRasterStroke() is true
.
width | stroke width in millimeters |
Definition at line 352 of file qgslegendsettings.h.
|
inline |
Sets whether layer components can be split over multiple columns.
Definition at line 172 of file qgslegendsettings.h.
|
inline |
Sets the style for a legend component.
Definition at line 88 of file qgslegendsettings.h.
|
inline |
Sets the alignment for placement of legend symbols.
Only Qt::AlignLeft or Qt::AlignRight are supported values.
Definition at line 281 of file qgslegendsettings.h.
|
inline |
Sets the default symbol size (in millimeters) used for legend items.
Definition at line 235 of file qgslegendsettings.h.
|
inline |
Sets the title for the legend, which will be rendered above all legend items.
Definition at line 48 of file qgslegendsettings.h.
|
inline |
Sets the alignment of the legend title.
Definition at line 67 of file qgslegendsettings.h.
void QgsLegendSettings::setUseAdvancedEffects | ( | bool | use | ) |
Definition at line 56 of file qgslegendsettings.cpp.
|
inline |
Sets the desired size (in millimeters) of WMS legend graphics shown in the legend.
Definition at line 366 of file qgslegendsettings.h.
|
inline |
Sets a string to use as a wrapping character.
Whenever this string is encountered inside legend component text it will be automatically replaced with a new line character.
Definition at line 114 of file qgslegendsettings.h.
|
inline |
Returns true
if layer components can be split over multiple columns.
Definition at line 165 of file qgslegendsettings.h.
QStringList QgsLegendSettings::splitStringForWrapping | ( | const QString & | stringToSplt | ) | const |
Splits a string using the wrap char taking into account handling empty wrap char which means no wrapping.
Definition at line 97 of file qgslegendsettings.cpp.
|
inline |
Returns the style for a legend component.
Definition at line 81 of file qgslegendsettings.h.
|
inline |
Returns the alignment for placement of legend symbols.
Only Qt::AlignLeft or Qt::AlignRight are supported values.
Definition at line 291 of file qgslegendsettings.h.
|
inline |
Returns the default symbol size (in millimeters) used for legend items.
Definition at line 228 of file qgslegendsettings.h.
double QgsLegendSettings::textWidthMillimeters | ( | const QFont & | font, |
const QString & | text | ||
) | const |
Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
Definition at line 156 of file qgslegendsettings.cpp.
|
inline |
Returns the title for the legend, which will be rendered above all legend items.
Definition at line 55 of file qgslegendsettings.h.
|
inline |
Returns the alignment of the legend title.
Definition at line 61 of file qgslegendsettings.h.
bool QgsLegendSettings::useAdvancedEffects | ( | ) | const |
Definition at line 51 of file qgslegendsettings.cpp.
|
inline |
Returns the size (in millimeters) of WMS legend graphics shown in the legend.
Definition at line 359 of file qgslegendsettings.h.
|
inline |
Returns the string used as a wrapping character.
Whenever this string is encountered inside legend component text it will be automatically replaced with a new line character.
Definition at line 124 of file qgslegendsettings.h.