16#ifndef QGSLEGENDSETTINGS_H
17#define QGSLEGENDSETTINGS_H
47 void setTitle(
const QString &t ) { mTitle = t; }
54 QString
title()
const {
return mTitle; }
222 Q_DECL_DEPRECATED
void setLayerFontColor( const QColor &fontColor )
SIP_DEPRECATED;
229 QSizeF symbolSize()
const {
return mSymbolSize;}
395 Q_DECL_DEPRECATED
void setLineSpacing(
double s );
405 Q_DECL_DEPRECATED
void setMmPerMapUnit(
double mmPerMapUnit )
SIP_DEPRECATED;
415 Q_DECL_DEPRECATED
void setUseAdvancedEffects(
bool use )
SIP_DEPRECATED;
431 Q_DECL_DEPRECATED
void setMapScale(
double scale )
SIP_DEPRECATED;
445 Q_DECL_DEPRECATED
void setMapUnitsPerPixel(
double mapUnitsPerPixel )
SIP_DEPRECATED;
478 QStringList splitStringForWrapping( const QString &stringToSplt ) const;
484 void drawText( QPainter *p,
double x,
double y, const QString &text, const QFont &font ) const;
496 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;
499 QFont scaledFontPixelSize( const QFont &font ) const;
502 double pixelFontSize(
double pointSize ) const;
505 double textWidthMillimeters( const QFont &font, const QString &text ) const;
508 double fontHeightCharacterMM( const QFont &font, QChar
c ) const;
511 double fontAscentMillimeters( const QFont &font ) const;
514 double fontDescentMillimeters( const QFont &font ) const;
520 Qgis::LegendJsonRenderFlags jsonRenderFlags() const;
526 void setJsonRenderFlags( const
Qgis::LegendJsonRenderFlags &jsonRenderFlags );
533 Qt::AlignmentFlag mTitleAlignment = Qt::AlignLeft;
544 double mMaxSymbolSize = 0.0;
547 double mMinSymbolSize = 0.0;
550 QSizeF mWmsLegendSize;
553 bool mSynchronousLegendRequests = false;
556 double mLineSpacing = 1;
559 double mColumnSpace = 2;
562 int mColumnCount = 1;
565 bool mSplitLayer = false;
568 bool mEqualColumnWidth = false;
570 bool mRasterSymbolStroke = true;
571 QColor mRasterStrokeColor;
572 double mRasterStrokeWidth = 0.0;
577 double mMmPerMapUnit = 1;
580 bool mUseAdvancedEffects = true;
583 double mMapScale = 1;
589 Qt::AlignmentFlag mSymbolAlignment = Qt::AlignLeft;
592 Qgis::LegendJsonRenderFlags mJsonRenderFlags;
The Qgis class provides global constants for use throughout the application.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
The QgsLegendSettings class stores the appearance and layout settings for legend drawing with QgsLege...
int columnCount() const
Returns the desired minimum number of columns to show in the legend.
void setSymbolAlignment(Qt::AlignmentFlag alignment)
Sets the alignment for placement of legend symbols.
QString wrapChar() const
Returns the string used as a wrapping character.
void setWrapChar(const QString &t)
Sets a string to use as a wrapping character.
void setRasterStrokeColor(const QColor &color)
Sets the stroke color for the stroke drawn around raster symbol items.
void setStyle(QgsLegendStyle::Style s, const QgsLegendStyle &style)
Sets the style for a legend component.
void setColumnSpace(double s)
Sets the margin space between adjacent columns (in millimeters).
QgsLegendStyle style(QgsLegendStyle::Style s) const
Returns the style for a legend component.
void setTitle(const QString &t)
Sets the title for the legend, which will be rendered above all legend items.
bool drawRasterStroke() const
Returns whether a stroke will be drawn around raster symbol items.
void setDrawRasterStroke(bool enabled)
Sets whether a stroke will be drawn around raster symbol items.
QSizeF wmsLegendSize() const
Returns the size (in millimeters) of WMS legend graphics shown in the legend.
double minimumSymbolSize() const
Returns the minimum symbol size (in mm).
double rasterStrokeWidth() const
Returns the stroke width (in millimeters) for the stroke drawn around raster symbol items.
void setColumnCount(int c)
Sets the desired minimum number of columns to show in the legend.
void setTitleAlignment(Qt::AlignmentFlag alignment)
Sets the alignment of the legend title.
Qt::AlignmentFlag titleAlignment() const
Returns the alignment of the legend title.
double maximumSymbolSize() const
Returns the maximum symbol size (in mm).
QString title() const
Returns the title for the legend, which will be rendered above all legend items.
QColor rasterStrokeColor() const
Returns the stroke color for the stroke drawn around raster symbol items.
Q_DECL_DEPRECATED double lineSpacing() const
Returns the line spacing to use between lines of legend text.
void setSplitLayer(bool s)
Sets whether layer components can be split over multiple columns.
double columnSpace() const
Returns the margin space between adjacent columns (in millimeters).
QgsLegendStyle & rstyle(QgsLegendStyle::Style s)
Returns modifiable reference to the style for a legend component.
void setEqualColumnWidth(bool s)
Sets whether all columns should have equal widths.
void setBoxSpace(double s)
Sets the legend box space (in millimeters), which is the empty margin around the inside of the legend...
void setSynchronousLegendRequests(bool b)
Sets whether to request legend graphics synchronously.
bool synchronousLegendRequests() const
Returns whether to request legend graphics synchronously.
double boxSpace() const
Returns the legend box space (in millimeters), which is the empty margin around the inside of the leg...
void setMaximumSymbolSize(double size)
Set the maximum symbol size for symbol (in millimeters).
bool splitLayer() const
Returns true if layer components can be split over multiple columns.
void setMinimumSymbolSize(double size)
Set the minimum symbol size for symbol (in millimeters).
void setRasterStrokeWidth(double width)
Sets the stroke width for the stroke drawn around raster symbol items.
Qt::AlignmentFlag symbolAlignment() const
Returns the alignment for placement of legend symbols.
bool equalColumnWidth() const
Returns true if all columns should have equal widths.
void setSymbolSize(QSizeF s)
Sets the default symbol size (in millimeters) used for legend items.
void setWmsLegendSize(QSizeF s)
Sets the desired size (in millimeters) of WMS legend graphics shown in the legend.
Contains detailed styling information relating to how a layout legend should be rendered.
Style
Component of legends which can be styled.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c