QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
Public Member Functions | List of all members
QgsLegendSettings Class Reference
core library

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
 
int columnCount () const
 
double columnSpace () const
 
int dpi () const
 
bool drawRasterBorder () const
 Returns whether a border will be drawn around raster symbol items. More...
 
void drawText (QPainter *p, double x, double y, const QString &text, const QFont &font) const
 Draws Text. 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...
 
bool equalColumnWidth () const
 
double fontAscentMillimeters (const QFont &font) const
 Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
QColor fontColor () const
 
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...
 
double lineSpacing () const
 
double mapScale () const
 
double mmPerMapUnit () const
 
double pixelFontSize (double pointSize) const
 Calculates font to from point size to pixel size. More...
 
QColor rasterBorderColor () const
 Returns the border color for the border drawn around raster symbol items. More...
 
double rasterBorderWidth () const
 Returns the border width (in millimeters) for the border drawn around raster symbol items. More...
 
QgsComposerLegendStyle & rstyle (QgsComposerLegendStyle::Style s)
 Returns reference to modifiable style. 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)
 
void setColumnCount (int c)
 
void setColumnSpace (double s)
 
void setDpi (int dpi)
 
void setDrawRasterBorder (bool enabled)
 Sets whether a border will be drawn around raster symbol items. More...
 
void setEqualColumnWidth (bool s)
 
void setFontColor (const QColor &c)
 
void setLineSpacing (double s)
 
void setMapScale (double scale)
 
void setMmPerMapUnit (double mmPerMapUnit)
 
void setRasterBorderColor (const QColor &color)
 Sets the border color for the border drawn around raster symbol items. More...
 
void setRasterBorderWidth (double width)
 Sets the border width for the border drawn around raster symbol items. More...
 
void setSplitLayer (bool s)
 
void setStyle (QgsComposerLegendStyle::Style s, const QgsComposerLegendStyle &style)
 
void setSymbolSize (QSizeF s)
 
void setTitle (const QString &t)
 
void setTitleAlignment (Qt::AlignmentFlag alignment)
 Sets the alignment of the legend title. More...
 
void setUseAdvancedEffects (bool use)
 
void setWmsLegendSize (QSizeF s)
 
void setWrapChar (const QString &t)
 
bool splitLayer () const
 
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...
 
QgsComposerLegendStyle style (QgsComposerLegendStyle::Style s) const
 Returns style. More...
 
QSizeF symbolSize () const
 
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
 
Qt::AlignmentFlag titleAlignment () const
 Returns the alignment of the legend title. More...
 
bool useAdvancedEffects () const
 
QSizeF wmsLegendSize () const
 
QString wrapChar () const
 

Detailed Description

The QgsLegendSettings class stores the appearance and layout settings for legend drawing with QgsLegendRenderer.

The content of the legend is given in QgsLegendModel class.

Note
added in 2.6

Definition at line 36 of file qgslegendsettings.h.

Constructor & Destructor Documentation

◆ QgsLegendSettings()

QgsLegendSettings::QgsLegendSettings ( )

Definition at line 20 of file qgslegendsettings.cpp.

Member Function Documentation

◆ boxSpace()

double QgsLegendSettings::boxSpace ( ) const
inline

Definition at line 61 of file qgslegendsettings.h.

◆ columnCount()

int QgsLegendSettings::columnCount ( ) const
inline

Definition at line 70 of file qgslegendsettings.h.

◆ columnSpace()

double QgsLegendSettings::columnSpace ( ) const
inline

Definition at line 67 of file qgslegendsettings.h.

◆ dpi()

int QgsLegendSettings::dpi ( ) const
inline

Definition at line 155 of file qgslegendsettings.h.

◆ drawRasterBorder()

bool QgsLegendSettings::drawRasterBorder ( ) const
inline

Returns whether a border will be drawn around raster symbol items.

See also
setDrawRasterBorder()
rasterBorderColor()
rasterBorderWidth()
Note
added in QGIS 2.12

Definition at line 91 of file qgslegendsettings.h.

◆ drawText() [1/2]

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 67 of file qgslegendsettings.cpp.

◆ drawText() [2/2]

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.

Parameters
ppainter to use
rectrectangle to draw into
texttext to draw
fontfont to use
halignmentoptional horizontal alignment
valignmentoptional vertical alignment
flagsallows for passing Qt::TextFlags to control appearance of rendered text

Definition at line 80 of file qgslegendsettings.cpp.

◆ equalColumnWidth()

bool QgsLegendSettings::equalColumnWidth ( ) const
inline

Definition at line 76 of file qgslegendsettings.h.

◆ fontAscentMillimeters()

double QgsLegendSettings::fontAscentMillimeters ( const QFont &  font) const

Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.

Definition at line 123 of file qgslegendsettings.cpp.

◆ fontColor()

QColor QgsLegendSettings::fontColor ( ) const
inline

Definition at line 79 of file qgslegendsettings.h.

◆ fontDescentMillimeters()

double QgsLegendSettings::fontDescentMillimeters ( const QFont &  font) const

Returns the font descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.

Definition at line 130 of file qgslegendsettings.cpp.

◆ fontHeightCharacterMM()

double QgsLegendSettings::fontHeightCharacterMM ( const QFont &  font,
QChar  c 
) const

Returns the font height of a character in millimeters.

Definition at line 116 of file qgslegendsettings.cpp.

◆ lineSpacing()

double QgsLegendSettings::lineSpacing ( ) const
inline

Definition at line 143 of file qgslegendsettings.h.

◆ mapScale()

double QgsLegendSettings::mapScale ( ) const
inline

Definition at line 152 of file qgslegendsettings.h.

◆ mmPerMapUnit()

double QgsLegendSettings::mmPerMapUnit ( ) const
inline

Definition at line 146 of file qgslegendsettings.h.

◆ pixelFontSize()

double QgsLegendSettings::pixelFontSize ( double  pointSize) const

Calculates font to from point size to pixel size.

Definition at line 104 of file qgslegendsettings.cpp.

◆ rasterBorderColor()

QColor QgsLegendSettings::rasterBorderColor ( ) const
inline

Returns the border color for the border drawn around raster symbol items.

The border is only drawn if drawRasterBorder() is true.

See also
setRasterBorderColor()
drawRasterBorder()
rasterBorderWidth()
Note
added in QGIS 2.12

Definition at line 109 of file qgslegendsettings.h.

◆ rasterBorderWidth()

double QgsLegendSettings::rasterBorderWidth ( ) const
inline

Returns the border width (in millimeters) for the border drawn around raster symbol items.

The border is only drawn if drawRasterBorder() is true.

See also
setRasterBorderWidth()
drawRasterBorder()
rasterBorderColor()
Note
added in QGIS 2.12

Definition at line 128 of file qgslegendsettings.h.

◆ rstyle()

QgsComposerLegendStyle& QgsLegendSettings::rstyle ( QgsComposerLegendStyle::Style  s)
inline

Returns reference to modifiable style.

Definition at line 56 of file qgslegendsettings.h.

◆ scaledFontPixelSize()

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 96 of file qgslegendsettings.cpp.

◆ setBoxSpace()

void QgsLegendSettings::setBoxSpace ( double  s)
inline

Definition at line 62 of file qgslegendsettings.h.

◆ setColumnCount()

void QgsLegendSettings::setColumnCount ( int  c)
inline

Definition at line 71 of file qgslegendsettings.h.

◆ setColumnSpace()

void QgsLegendSettings::setColumnSpace ( double  s)
inline

Definition at line 68 of file qgslegendsettings.h.

◆ setDpi()

void QgsLegendSettings::setDpi ( int  dpi)
inline

Definition at line 156 of file qgslegendsettings.h.

◆ setDrawRasterBorder()

void QgsLegendSettings::setDrawRasterBorder ( bool  enabled)
inline

Sets whether a border will be drawn around raster symbol items.

Parameters
enabledset to true to draw borders
See also
drawRasterBorder()
setRasterBorderColor()
setRasterBorderWidth()
Note
added in QGIS 2.12

Definition at line 100 of file qgslegendsettings.h.

◆ setEqualColumnWidth()

void QgsLegendSettings::setEqualColumnWidth ( bool  s)
inline

Definition at line 77 of file qgslegendsettings.h.

◆ setFontColor()

void QgsLegendSettings::setFontColor ( const QColor &  c)
inline

Definition at line 80 of file qgslegendsettings.h.

◆ setLineSpacing()

void QgsLegendSettings::setLineSpacing ( double  s)
inline

Definition at line 144 of file qgslegendsettings.h.

◆ setMapScale()

void QgsLegendSettings::setMapScale ( double  scale)
inline

Definition at line 153 of file qgslegendsettings.h.

◆ setMmPerMapUnit()

void QgsLegendSettings::setMmPerMapUnit ( double  mmPerMapUnit)
inline

Definition at line 147 of file qgslegendsettings.h.

◆ setRasterBorderColor()

void QgsLegendSettings::setRasterBorderColor ( const QColor &  color)
inline

Sets the border color for the border drawn around raster symbol items.

The border is only drawn if drawRasterBorder() is true.

Parameters
colorborder color
See also
rasterBorderColor()
setDrawRasterBorder()
setRasterBorderWidth()
Note
added in QGIS 2.12

Definition at line 119 of file qgslegendsettings.h.

◆ setRasterBorderWidth()

void QgsLegendSettings::setRasterBorderWidth ( double  width)
inline

Sets the border width for the border drawn around raster symbol items.

The border is only drawn if drawRasterBorder() is true.

Parameters
widthborder width in millimeters
See also
rasterBorderWidth()
setDrawRasterBorder()
setRasterBorderColor()
Note
added in QGIS 2.12

Definition at line 138 of file qgslegendsettings.h.

◆ setSplitLayer()

void QgsLegendSettings::setSplitLayer ( bool  s)
inline

Definition at line 74 of file qgslegendsettings.h.

◆ setStyle()

void QgsLegendSettings::setStyle ( QgsComposerLegendStyle::Style  s,
const QgsComposerLegendStyle &  style 
)
inline

Definition at line 59 of file qgslegendsettings.h.

◆ setSymbolSize()

void QgsLegendSettings::setSymbolSize ( QSizeF  s)
inline

Definition at line 83 of file qgslegendsettings.h.

◆ setTitle()

void QgsLegendSettings::setTitle ( const QString &  t)
inline

Definition at line 41 of file qgslegendsettings.h.

◆ setTitleAlignment()

void QgsLegendSettings::setTitleAlignment ( Qt::AlignmentFlag  alignment)
inline

Sets the alignment of the legend title.

Parameters
alignmentText alignment for drawing the legend title
See also
titleAlignment

Definition at line 53 of file qgslegendsettings.h.

◆ setUseAdvancedEffects()

void QgsLegendSettings::setUseAdvancedEffects ( bool  use)
inline

Definition at line 150 of file qgslegendsettings.h.

◆ setWmsLegendSize()

void QgsLegendSettings::setWmsLegendSize ( QSizeF  s)
inline

Definition at line 141 of file qgslegendsettings.h.

◆ setWrapChar()

void QgsLegendSettings::setWrapChar ( const QString &  t)
inline

Definition at line 64 of file qgslegendsettings.h.

◆ splitLayer()

bool QgsLegendSettings::splitLayer ( ) const
inline

Definition at line 73 of file qgslegendsettings.h.

◆ splitStringForWrapping()

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 53 of file qgslegendsettings.cpp.

◆ style()

QgsComposerLegendStyle QgsLegendSettings::style ( QgsComposerLegendStyle::Style  s) const
inline

Returns style.

Definition at line 58 of file qgslegendsettings.h.

◆ symbolSize()

QSizeF QgsLegendSettings::symbolSize ( ) const
inline

Definition at line 82 of file qgslegendsettings.h.

◆ textWidthMillimeters()

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 109 of file qgslegendsettings.cpp.

◆ title()

QString QgsLegendSettings::title ( ) const
inline

Definition at line 42 of file qgslegendsettings.h.

◆ titleAlignment()

Qt::AlignmentFlag QgsLegendSettings::titleAlignment ( ) const
inline

Returns the alignment of the legend title.

Returns
Qt::AlignmentFlag for the legend title
See also
setTitleAlignment

Definition at line 48 of file qgslegendsettings.h.

◆ useAdvancedEffects()

bool QgsLegendSettings::useAdvancedEffects ( ) const
inline

Definition at line 149 of file qgslegendsettings.h.

◆ wmsLegendSize()

QSizeF QgsLegendSettings::wmsLegendSize ( ) const
inline

Definition at line 140 of file qgslegendsettings.h.

◆ wrapChar()

QString QgsLegendSettings::wrapChar ( ) const
inline

Definition at line 65 of file qgslegendsettings.h.

The documentation for this class was generated from the following files:
Generated on Sun Jun 24 2018 11:42:48 for QGIS API Documentation by   doxygen 1.8.13