Provides an interface to retrieve and manipulate WMS parameters received from the client. More...

#include <qgswmsparameters.h>

Inheritance diagram for QgsWms::QgsWmsParameters:

Public Types
enum	DxfFormatOption { SCALE , MODE , LAYERATTRIBUTES , USE_TITLE_AS_LAYERNAME , CODEC , NO_MTEXT , FORCE_2D , EXPORT_LINES_WITH_ZERO_WIDTH }
	Options for DXF format. More...

enum	Format { NONE , JPG , PNG , SVG , PDF , TEXT , XML , HTML , GML , JSON }
	Output format for the response. More...

enum	PdfFormatOption { RASTERIZE_WHOLE_IMAGE , FORCE_VECTOR_OUTPUT , APPEND_GEOREFERENCE , EXPORT_METADATA , TEXT_RENDER_FORMAT , SIMPLIFY_GEOMETRY , WRITE_GEO_PDF , USE_ISO_32000_EXTENSION_FORMAT_GEOREFERENCING , USE_OGC_BEST_PRACTICE_FORMAT_GEOREFERENCING , INCLUDE_GEO_PDF_FEATURES , EXPORT_THEMES , PREDEFINED_MAP_SCALES , LOSSLESS_IMAGE_COMPRESSION , DISABLE_TILED_RASTER_RENDERING }

Public Member Functions
	QgsWmsParameters ()
	Constructor for WMS parameters with default values only.

	QgsWmsParameters (const QgsServerParameters &parameters)
	Constructor for WMS parameters with specific values.

virtual	~QgsWmsParameters () override=default

bool	addLayerGroups () const
	Returns true if layer groups shall be added to GetLegendGraphic results.

QStringList	allLayersNickname () const
	Returns nickname of layers found in LAYER and LAYERS parameters.

QStringList	allStyles () const
	Returns styles found in STYLE and STYLES parameters.

QStringList	atlasPk () const
	Returns the ATLAS_PK parameter.

QString	backgroundColor () const
	Returns BGCOLOR parameter or an empty string if not defined.

QColor	backgroundColorAsColor () const
	Returns BGCOLOR parameter as a QColor or its default value if not defined.

QString	bbox () const
	Returns BBOX if defined or an empty string.

QgsRectangle	bboxAsRectangle () const
	Returns BBOX as a rectangle if defined and valid.

QString	boxSpace () const
	Returns BOXSPACE parameter or an empty string if not defined.

double	boxSpaceAsDouble () const
	Returns BOXSPACE as a double or its default value if not defined.

QgsWmsParametersComposerMap	composerMapParameters (int mapId) const
	Returns the requested parameters for a composer map parameter.

QString	composerTemplate () const
	Returns TEMPLATE parameter or an empty string if not defined.

QString	crs () const
	Returns CRS or an empty string if none is defined.

QMap< QString, QString >	dimensionValues () const
	Returns the dimensions parameter.

QString	dpi () const
	Returns DPI parameter or an empty string if not defined.

double	dpiAsDouble () const
	Returns DPI parameter as an int or its default value if not defined.

void	dump () const
	Dumps parameters.

QString	dxfCodec () const
	Returns the DXF CODEC parameter.

QStringList	dxfLayerAttributes () const
	Returns the DXF LAYERATTRIBUTES parameter.

Qgis::FeatureSymbologyExport	dxfMode () const
	Returns the DXF MODE parameter.

double	dxfScale () const
	Returns the DXF SCALE parameter.

bool	dxfUseLayerTitleAsName () const
	Returns the DXF USE_TITLE_AS_LAYERNAME parameter.

bool	exportLinesWithZeroWidth () const

QList< QgsWmsParametersExternalLayer >	externalLayersParameters () const
	Returns parameters for each external layer.

QString	externalWMSUri (const QString &id) const
	Returns the external WMS uri.

QString	featureCount () const
	Returns FEATURE_COUNT parameter or an empty string if none is defined.

int	featureCountAsInt () const
	Returns FEATURE_COUNT as an integer.

QString	filterGeom () const
	Returns the filter geometry found in FILTER_GEOM parameter.

QStringList	filters () const
	Returns the list of filters found in FILTER parameter.

Format	format () const
	Returns format.

QString	formatAsString () const
	Returns FORMAT parameter as a string.

template<typename T >
QMap< T, QString >	formatOptions () const
	Returns the format options for an output format.

QString	height () const
	Returns HEIGHT parameter or an empty string if not defined.

int	heightAsInt () const
	Returns HEIGHT parameter as an int or its default value if not defined.

QStringList	highlightGeom () const
	Returns HIGHLIGHT_GEOM as a list of string in WKT.

QList< QgsGeometry >	highlightGeomAsGeom () const
	Returns HIGHLIGHT_GEOM as a list of geometries.

QStringList	highlightLabelBufferColor () const
	Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of string.

QList< QColor >	highlightLabelBufferColorAsColor () const
	Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of colors.

QStringList	highlightLabelBufferSize () const
	Returns HIGHLIGHT_LABELBUFFERSIZE.

QList< double >	highlightLabelBufferSizeAsFloat () const
	Returns HIGHLIGHT_LABELBUFFERSIZE as a list of float.

QStringList	highlightLabelColor () const
	Returns HIGHLIGHT_LABELCOLOR as a list of string.

QList< QColor >	highlightLabelColorAsColor () const
	Returns HIGHLIGHT_LABELCOLOR as a list of color.

QList< double >	highlightLabelDistance () const
	Returns HIGHLIGHT_LABEL_DISTANCE as a list of double.

QStringList	highlightLabelFont () const
	Returns HIGHLIGHT_LABELFONT.

QStringList	highlightLabelHorizontalAlignment () const
	Returns HIGHLIGHT_LABEL_HORIZONTAL_ALIGNMENT as a list of string.

QList< double >	highlightLabelRotation () const
	Returns HIGHLIGHT_LABEL_ROTATION as a list of double.

QStringList	highlightLabelSize () const
	Returns HIGHLIGHT_LABELSIZE as a list of string.

QList< int >	highlightLabelSizeAsInt () const
	Returns HIGHLIGHT_LABELSIZE as a list of int An exception is raised if an invalid size is found.

QStringList	highlightLabelString () const
	Returns HIGHLIGHT_LABELSTRING as a list of string.

QStringList	highlightLabelVerticalAlignment () const
	Returns HIGHLIGHT_LABEL_VERTICAL_ALIGNMENT as a list of string.

QStringList	highlightLabelWeight () const
	Returns HIGHLIGHT_LABELWEIGHT as a list of string.

QList< int >	highlightLabelWeightAsInt () const
	Returns HIGHLIGHT_LABELWEIGHT as a list of int.

QList< QgsWmsParametersHighlightLayer >	highlightLayersParameters () const
	Returns parameters for each highlight layer.

QStringList	highlightSymbol () const
	Returns HIGHLIGHT_SYMBOL as a list of string.

bool	htmlInfoOnlyMapTip () const
	Returns `true` if only maptip information is requested for HTML feature info response.

QString	i () const
	Returns I parameter or an empty string if not defined.

int	iAsInt () const
	Returns I parameter as an int or its default value if not defined.

QString	iconLabelSpace () const
	Returns ICONLABELSPACE parameter or an empty string if not defined.

double	iconLabelSpaceAsDouble () const
	Returns ICONLABELSPACE as a double or its default value if not defined.

QString	imageQuality () const
	Returns IMAGE_QUALITY parameter or an empty string if not defined.

int	imageQualityAsInt () const
	Returns IMAGE_QUALITY parameter as an integer.

Format	infoFormat () const
	Returns infoFormat.

QString	infoFormatAsString () const
	Returns INFO_FORMAT parameter as a string.

bool	infoFormatIsImage () const
	Checks if INFO_FORMAT parameter is one of the image formats (PNG, JPG).

int	infoFormatVersion () const
	Returns the infoFormat version for GML.

bool	isForce2D () const

QFont	itemFont () const
	Returns the item font (built thanks to the ITEMFONTFAMILY, ITEMFONTSIZE, ITEMFONTBOLD, ... parameters).

QString	itemFontBold () const
	Returns ITEMFONTBOLD parameter or an empty string if not defined.

bool	itemFontBoldAsBool () const
	Returns ITEMFONTBOLD as a boolean or its default value if not defined.

QString	itemFontColor () const
	Returns ITEMFONTCOLOR parameter or an empty string if not defined.

QColor	itemFontColorAsColor () const
	Returns ITEMFONTCOLOR as a color.

QString	itemFontFamily () const
	Returns ITEMFONTFAMILY parameter or an empty string if not defined.

QString	itemFontItalic () const
	Returns ITEMFONTITALIC parameter or an empty string if not defined.

bool	itemFontItalicAsBool () const
	Returns ITEMFONTITALIC as a boolean or its default value if not defined.

QString	itemFontSize () const
	Returns ITEMFONTSIZE parameter or an empty string if not defined.

double	itemFontSizeAsDouble () const
	Returns ITEMFONTSIZE as a double.

QString	j () const
	Returns J parameter or an empty string if not defined.

int	jAsInt () const
	Returns J parameter as an int or its default value if not defined.

QFont	layerFont () const
	Returns the layer font (built thanks to the LAYERFONTFAMILY, LAYERFONTSIZE, LAYERFONTBOLD, ... parameters).

QString	layerFontBold () const
	Returns LAYERFONTBOLD parameter or an empty string if not defined.

bool	layerFontBoldAsBool () const
	Returns LAYERFONTBOLD as a boolean or its default value if not defined.

QString	layerFontColor () const
	Returns LAYERFONTCOLOR parameter or an empty string if not defined.

QColor	layerFontColorAsColor () const
	Returns LAYERFONTCOLOR as a color or its defined value if not defined.

QString	layerFontFamily () const
	Returns LAYERFONTFAMILY parameter or an empty string if not defined.

QString	layerFontItalic () const
	Returns LAYERFONTITALIC parameter or an empty string if not defined.

bool	layerFontItalicAsBool () const
	Returns LAYERFONTITALIC as a boolean or its default value if not defined.

QString	layerFontSize () const
	Returns LAYERFONTSIZE parameter or an empty string if not defined.

double	layerFontSizeAsDouble () const
	Returns LAYERFONTSIZE as a double.

QString	layerSpace () const
	Returns LAYERSPACE parameter or an empty string if not defined.

double	layerSpaceAsDouble () const
	Returns LAYERSPACE as a double or its default value if not defined.

QList< QgsWmsParametersLayer >	layersParameters () const
	Returns parameters for each layer found in LAYER/LAYERS.

QString	layerTitle () const
	Returns LAYERTITLE parameter or an empty string if not defined.

bool	layerTitleAsBool () const
	Returns LAYERTITLE as a bool or its default value if not defined.

QString	layerTitleSpace () const
	Returns LAYERTITLESPACE parameter or an empty string if not defined.

double	layerTitleSpaceAsDouble () const
	Returns LAYERTITLESPACE as a double.

QString	layoutParameter (const QString &id, bool &ok) const
	Returns a layout parameter thanks to its id.

QgsLegendSettings	legendSettings () const
	Returns legend settings.

QString	lineTolerance () const
	Returns FI_LINE_TOLERANCE parameter or an empty string if not defined.

int	lineToleranceAsInt () const
	Returns FI_LINE_TOLERANCE parameter as an integer.

bool	noMText () const

QStringList	opacities () const
	Returns the list of opacities found in OPACITIES parameter.

QList< int >	opacitiesAsInt () const
	Returns the list of opacities found in OPACITIES parameter as integers.

QgsWmsParameter	operator[] (QgsWmsParameter::Name name) const
	Returns the parameter corresponding to name.

bool	pdfAppendGeoreference () const
	Returns true if georeference info shall be added to the pdf.

bool	pdfDisableTiledRasterRendering () const
	Returns true if rasters shall be untiled in the pdf.

QStringList	pdfExportMapThemes () const
	Returns map themes for geospatial PDF export.

bool	pdfExportMetadata () const
	Returns true if metadata shall be added to the pdf.

bool	pdfForceVectorOutput () const
	Returns if pdf should be exported as vector.

bool	pdfLosslessImageCompression () const
	Returns true if images embedded in pdf must be compressed using a lossless algorithm.

QVector< qreal >	pdfPredefinedMapScales () const
	Returns list of map scales.

bool	pdfSimplifyGeometries () const
	Returns if geometries shall to be simplified.

Qgis::TextRenderFormat	pdfTextRenderFormat () const
	Returns text render format for pdf export.

bool	pdfUseIso32000ExtensionFormatGeoreferencing () const
	Returns true, if Iso32000 georeferencing shall be used.

bool	pdfUseOgcBestPracticeFormatGeoreferencing () const
	Returns true if OGC best practice georeferencing shall be used.

QString	pointTolerance () const
	Returns FI_POINT_TOLERANCE parameter or an empty string if not defined.

int	pointToleranceAsInt () const
	Returns FI_POINT_TOLERANCE parameter as an integer.

QString	polygonTolerance () const
	Returns FI_POLYGON_TOLERANCE parameter or an empty string if not defined.

int	polygonToleranceAsInt () const
	Returns FI_POLYGON_TOLERANCE parameter as an integer.

QStringList	queryLayersNickname () const
	Returns nickname of layers found in QUERY_LAYERS parameter.

QString	request () const override
	Returns REQUEST parameter as a string or an empty string if not defined.

QString	rule () const
	Returns RULE parameter or an empty string if none is defined.

QString	ruleLabel () const
	Returns RULELABEL parameter or an empty string if none is defined.

bool	ruleLabelAsBool () const
	Returns RULELABEL as a bool.

QString	scale () const
	Returns SCALE parameter or an empty string if none is defined.

double	scaleAsDouble () const
	Returns SCALE as a double.

QStringList	selections () const
	Returns the list of feature selection found in SELECTION parameter.

void	set (QgsWmsParameter::Name name, const QVariant &value)
	Sets a parameter value thanks to its name.

QString	showFeatureCount () const
	Returns SHOWFEATURECOUNT parameter or an empty string if none is defined.

bool	showFeatureCountAsBool () const
	Returns SHOWFEATURECOUNT as a bool.

bool	showRuleDetailsAsBool () const
	Returns SHOWRULEDETAILS as a bool.

QString	sldBody () const
	Returns SLD_body if defined or an empty string.

QString	srcHeight () const
	Returns SRCHEIGHT parameter or an empty string if not defined.

int	srcHeightAsInt () const
	Returns SRCHEIGHT parameter as an int or its default value if not defined.

QString	srcWidth () const
	Returns SRCWIDTH parameter or an empty string if not defined.

int	srcWidthAsInt () const
	Returns SRCWIDTH parameter as an int or its default value if not defined.

QString	symbolHeight () const
	Returns SYMBOLHEIGHT parameter or an empty string if not defined.

double	symbolHeightAsDouble () const
	Returns SYMBOLHEIGHT as a double or its default value if not defined.

QString	symbolSpace () const
	Returns SYMBOLSPACE parameter or an empty string if not defined.

double	symbolSpaceAsDouble () const
	Returns SYMBOLSPACE as a double or its default value if not defined.

QString	symbolWidth () const
	Returns SYMBOLWIDTH parameter or an empty string if not defined.

double	symbolWidthAsDouble () const
	Returns SYMBOLWIDTH as a double or its default value if not defined.

QString	tiled () const
	Returns TILED parameter or an empty string if not defined.

bool	tiledAsBool () const
	Returns TILED parameter as a boolean.

QString	transparent () const
	Returns TRANSPARENT parameter or an empty string if not defined.

bool	transparentAsBool () const
	Returns TRANSPARENT parameter as a bool or its default value if not defined.

QString	version () const override
	Returns VERSION parameter as a string or an empty string if not defined.

QgsProjectVersion	versionAsNumber () const
	Returns VERSION parameter if defined or its default value.

bool	versionIsValid (const QString version) const
	Returns `true` if version is valid, `false` otherwise.

QString	width () const
	Returns WIDTH parameter or an empty string if not defined.

int	widthAsInt () const
	Returns WIDTH parameter as an int or its default value if not defined.

bool	withDisplayName () const
	withDisplayName

bool	withGeometry () const
	Returns if the client wants the feature info response with geometry information.

bool	withMapTip () const
	withMapTip

QString	withMapTipAsString () const
	withMapTipAsString

QString	wmsPrecision () const
	Returns WMS_PRECISION parameter or an empty string if not defined.

int	wmsPrecisionAsInt () const
	Returns WMS_PRECISION parameter as an int or its default value if not defined.

QString	wmtver () const
	Returns WMTVER parameter or an empty string if not defined.

bool	writeGeospatialPdf () const
	Returns if a geospatial PDF shall be exported.

QString	x () const
	Returns X parameter or an empty string if not defined.

int	xAsInt () const
	Returns X parameter as an int or its default value if not defined.

QString	y () const
	Returns Y parameter or an empty string if not defined.

int	yAsInt () const
	Returns Y parameter as an int or its default value if not defined.

Public Member Functions inherited from QgsServerParameters
	QgsServerParameters ()
	Constructor.

	QgsServerParameters (const QUrlQuery &query)
	Constructor.

virtual	~QgsServerParameters ()=default

void	add (const QString &key, const QString &value)
	Adds a parameter.

void	clear ()
	Removes all parameters.

QString	fileName () const
	Returns FILE_NAME parameter as a string or an empty string if not defined.

void	load (const QUrlQuery &query)
	Loads new parameters.

QString	map () const
	Returns MAP parameter as a string or an empty string if not defined.

void	remove (const QString &key)
	Removes a parameter.

void	remove (QgsServerParameter::Name name)
	Removes a parameter.

QString	service () const
	Returns SERVICE parameter as a string or an empty string if not defined.

QMap< QString, QString >	toMap () const
	Returns all parameters in a map.

QUrlQuery	urlQuery () const
	Returns a url query with underlying parameters.

QString	value (const QString &key) const
	Returns the value of a parameter.

Static Public Member Functions
static QString	formatAsString (Format format)
	Returns format parameter as a string.

Additional Inherited Members
Protected Attributes inherited from QgsServerParameters
QMap< QString, QString >	mUnmanagedParameters

Detailed Description

Provides an interface to retrieve and manipulate WMS parameters received from the client.

Definition at line 334 of file qgswmsparameters.h.

Member Enumeration Documentation

◆ DxfFormatOption

enum QgsWms::QgsWmsParameters::DxfFormatOption

Options for DXF format.

Enumerator
SCALE
MODE
LAYERATTRIBUTES
USE_TITLE_AS_LAYERNAME
CODEC
NO_MTEXT
FORCE_2D
EXPORT_LINES_WITH_ZERO_WIDTH

Definition at line 357 of file qgswmsparameters.h.

◆ Format

enum QgsWms::QgsWmsParameters::Format

Output format for the response.

Enumerator
NONE
JPG
PNG
SVG
PDF
TEXT
XML
HTML
GML
JSON

Definition at line 341 of file qgswmsparameters.h.

◆ PdfFormatOption

enum QgsWms::QgsWmsParameters::PdfFormatOption

Enumerator
RASTERIZE_WHOLE_IMAGE
FORCE_VECTOR_OUTPUT
APPEND_GEOREFERENCE
EXPORT_METADATA
TEXT_RENDER_FORMAT
SIMPLIFY_GEOMETRY
WRITE_GEO_PDF
USE_ISO_32000_EXTENSION_FORMAT_GEOREFERENCING
USE_OGC_BEST_PRACTICE_FORMAT_GEOREFERENCING
INCLUDE_GEO_PDF_FEATURES
EXPORT_THEMES
PREDEFINED_MAP_SCALES
LOSSLESS_IMAGE_COMPRESSION
DISABLE_TILED_RASTER_RENDERING

Definition at line 370 of file qgswmsparameters.h.

Constructor & Destructor Documentation

◆ QgsWmsParameters() [1/2]

QgsWms::QgsWmsParameters::QgsWmsParameters ( const QgsServerParameters & parameters )

Constructor for WMS parameters with specific values.

Parameters

parameters Map of parameters where keys are parameters' names.

Definition at line 570 of file qgswmsparameters.cpp.

◆ QgsWmsParameters() [2/2]

QgsWms::QgsWmsParameters::QgsWmsParameters ( )

Constructor for WMS parameters with default values only.

Definition at line 218 of file qgswmsparameters.cpp.

◆ ~QgsWmsParameters()

virtual QgsWms::QgsWmsParameters::~QgsWmsParameters ( )

overridevirtualdefault

Member Function Documentation

◆ addLayerGroups()

bool QgsWms::QgsWmsParameters::addLayerGroups ( ) const

Returns true if layer groups shall be added to GetLegendGraphic results.

Definition at line 1049 of file qgswmsparameters.cpp.

◆ allLayersNickname()

QStringList QgsWms::QgsWmsParameters::allLayersNickname ( ) const

Returns nickname of layers found in LAYER and LAYERS parameters.

Returns: nickname of layers

Definition at line 1494 of file qgswmsparameters.cpp.

◆ allStyles()

QStringList QgsWms::QgsWmsParameters::allStyles ( ) const

Returns styles found in STYLE and STYLES parameters.

Returns: name of styles

Definition at line 1534 of file qgswmsparameters.cpp.

◆ atlasPk()

QStringList QgsWms::QgsWmsParameters::atlasPk ( ) const

Returns the ATLAS_PK parameter.

Returns: The ATLAS_PK parameter

Since: QGIS 3.6

Definition at line 1366 of file qgswmsparameters.cpp.

◆ backgroundColor()

QString QgsWms::QgsWmsParameters::backgroundColor ( ) const

Returns BGCOLOR parameter or an empty string if not defined.

Returns: BGCOLOR parameter

Definition at line 1794 of file qgswmsparameters.cpp.

◆ backgroundColorAsColor()

QColor QgsWms::QgsWmsParameters::backgroundColorAsColor ( ) const

Returns BGCOLOR parameter as a QColor or its default value if not defined.

An exception is raised if BGCOLOR is defined and cannot be converted.

Returns: background color parameter

Exceptions

QgsBadRequestException

Definition at line 1799 of file qgswmsparameters.cpp.

◆ bbox()

QString QgsWms::QgsWmsParameters::bbox ( ) const

Returns BBOX if defined or an empty string.

Returns: bbox parameter

Definition at line 736 of file qgswmsparameters.cpp.

◆ bboxAsRectangle()

QgsRectangle QgsWms::QgsWmsParameters::bboxAsRectangle ( ) const

Returns BBOX as a rectangle if defined and valid.

An exception is raised if the BBOX string cannot be converted into a rectangle.

Returns: bbox as rectangle

Exceptions

QgsBadRequestException

Definition at line 741 of file qgswmsparameters.cpp.

◆ boxSpace()

QString QgsWms::QgsWmsParameters::boxSpace ( ) const

Returns BOXSPACE parameter or an empty string if not defined.

Returns: BOXSPACE parameter or an empty string if not defined.

Definition at line 1074 of file qgswmsparameters.cpp.

◆ boxSpaceAsDouble()

double QgsWms::QgsWmsParameters::boxSpaceAsDouble ( ) const

Returns BOXSPACE as a double or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns: boxSpace

Exceptions

QgsBadRequestException

Definition at line 1079 of file qgswmsparameters.cpp.

◆ composerMapParameters()

QgsWmsParametersComposerMap QgsWms::QgsWmsParameters::composerMapParameters ( int mapId ) const

Returns the requested parameters for a composer map parameter.

An exception is raised if parameters are defined and cannot be converted like EXTENT, SCALE, ROTATION, GRID_INTERVAL_X and GRID_INTERVAL_Y.

Parameters

mapId the composer map id.

Returns: parameters for the composer map.

Exceptions

QgsBadRequestException

Definition at line 1809 of file qgswmsparameters.cpp.

◆ composerTemplate()

QString QgsWms::QgsWmsParameters::composerTemplate ( ) const

Returns TEMPLATE parameter or an empty string if not defined.

Returns: TEMPLATE parameter

Definition at line 1804 of file qgswmsparameters.cpp.

◆ crs()

QString QgsWms::QgsWmsParameters::crs ( ) const

Returns CRS or an empty string if none is defined.

Returns: crs parameter as string

Definition at line 713 of file qgswmsparameters.cpp.

◆ dimensionValues()

QMap< QString, QString > QgsWms::QgsWmsParameters::dimensionValues ( ) const

Returns the dimensions parameter.

Since: QGIS 3.10

Definition at line 2432 of file qgswmsparameters.cpp.

◆ dpi()

QString QgsWms::QgsWmsParameters::dpi ( ) const

Returns DPI parameter or an empty string if not defined.

Returns: DPI parameter

Definition at line 786 of file qgswmsparameters.cpp.

◆ dpiAsDouble()

double QgsWms::QgsWmsParameters::dpiAsDouble ( ) const

Returns DPI parameter as an int or its default value if not defined.

An exception is raised if DPI is defined and cannot be converted.

Returns: dpi parameter

Exceptions

QgsBadRequestException

Definition at line 791 of file qgswmsparameters.cpp.

◆ dump()

void QgsWms::QgsWmsParameters::dump ( ) const

Dumps parameters.

Definition at line 662 of file qgswmsparameters.cpp.

◆ dxfCodec()

QString QgsWms::QgsWmsParameters::dxfCodec ( ) const

Returns the DXF CODEC parameter.

Since: QGIS 3.8

Definition at line 2272 of file qgswmsparameters.cpp.

◆ dxfLayerAttributes()

QStringList QgsWms::QgsWmsParameters::dxfLayerAttributes ( ) const

Returns the DXF LAYERATTRIBUTES parameter.

Since: QGIS 3.8

Definition at line 2209 of file qgswmsparameters.cpp.

◆ dxfMode()

Qgis::FeatureSymbologyExport QgsWms::QgsWmsParameters::dxfMode ( ) const

Returns the DXF MODE parameter.

Since: QGIS 3.8

Definition at line 2248 of file qgswmsparameters.cpp.

◆ dxfScale()

double QgsWms::QgsWmsParameters::dxfScale ( ) const

Returns the DXF SCALE parameter.

Since: QGIS 3.8

Definition at line 2235 of file qgswmsparameters.cpp.

◆ dxfUseLayerTitleAsName()

bool QgsWms::QgsWmsParameters::dxfUseLayerTitleAsName ( ) const

Returns the DXF USE_TITLE_AS_LAYERNAME parameter.

Since: QGIS 3.8

Definition at line 2222 of file qgswmsparameters.cpp.

◆ exportLinesWithZeroWidth()

bool QgsWms::QgsWmsParameters::exportLinesWithZeroWidth ( ) const

Returns: true if the lines are export to dxf with minimal (hairline) width

Since: QGIS 3.38

Definition at line 1609 of file qgswmsparameters.cpp.

◆ externalLayersParameters()

QList< QgsWmsParametersExternalLayer > QgsWms::QgsWmsParameters::externalLayersParameters ( ) const

Returns parameters for each external layer.

Since: QGIS 3.8

Definition at line 1777 of file qgswmsparameters.cpp.

◆ externalWMSUri()

QString QgsWms::QgsWmsParameters::externalWMSUri ( const QString & id ) const

Returns the external WMS uri.

Parameters

id	the id of the external wms

Returns: uri string or an empty string if the external wms id does not exist

Definition at line 2049 of file qgswmsparameters.cpp.

◆ featureCount()

QString QgsWms::QgsWmsParameters::featureCount ( ) const

Returns FEATURE_COUNT parameter or an empty string if none is defined.

Returns: FEATURE_COUNT parameter or an empty string if none is defined

Definition at line 1064 of file qgswmsparameters.cpp.

◆ featureCountAsInt()

int QgsWms::QgsWmsParameters::featureCountAsInt ( ) const

Returns FEATURE_COUNT as an integer.

An exception is raised if an invalid parameter is found.

Returns: FeatureCount

Exceptions

QgsBadRequestException

Definition at line 1069 of file qgswmsparameters.cpp.

◆ filterGeom()

QString QgsWms::QgsWmsParameters::filterGeom ( ) const

Returns the filter geometry found in FILTER_GEOM parameter.

Returns: the filter geometry as Well Known Text.

Definition at line 1474 of file qgswmsparameters.cpp.

◆ filters()

QStringList QgsWms::QgsWmsParameters::filters ( ) const

Returns the list of filters found in FILTER parameter.

Returns: the list of filter

Definition at line 1466 of file qgswmsparameters.cpp.

◆ format()

QgsWmsParameters::Format QgsWms::QgsWmsParameters::format ( ) const

Returns format.

If the FORMAT parameter is not used, then the default value is PNG.

Returns: format

Definition at line 867 of file qgswmsparameters.cpp.

◆ formatAsString() [1/2]

QString QgsWms::QgsWmsParameters::formatAsString ( ) const

Returns FORMAT parameter as a string.

Returns: FORMAT parameter as string

Definition at line 856 of file qgswmsparameters.cpp.

◆ formatAsString() [2/2]

QString QgsWms::QgsWmsParameters::formatAsString ( const QgsWmsParameters::Format format )

static

Returns format parameter as a string.

Since: QGIS 3.8

Definition at line 861 of file qgswmsparameters.cpp.

◆ formatOptions()

template<typename T >

QMap< T, QString > QgsWms::QgsWmsParameters::formatOptions ( ) const

inline

Returns the format options for an output format.

Possible template types are QgsWmsParameters::PdfFormatOption or QgsWmsParameters::DxfFormatOption

Returns: a key-value map

Since: QGIS 3.32

Definition at line 1501 of file qgswmsparameters.h.

◆ height()

QString QgsWms::QgsWmsParameters::height ( ) const

Returns HEIGHT parameter or an empty string if not defined.

Returns: height parameter

Definition at line 746 of file qgswmsparameters.cpp.

◆ heightAsInt()

int QgsWms::QgsWmsParameters::heightAsInt ( ) const

Returns HEIGHT parameter as an int or its default value if not defined.

An exception is raised if HEIGHT is defined and cannot be converted.

Returns: height parameter

Exceptions

QgsBadRequestException

Definition at line 756 of file qgswmsparameters.cpp.

◆ highlightGeom()

QStringList QgsWms::QgsWmsParameters::highlightGeom ( ) const

Returns HIGHLIGHT_GEOM as a list of string in WKT.

Returns: highlight geometries

Definition at line 698 of file qgswmsparameters.cpp.

◆ highlightGeomAsGeom()

QList< QgsGeometry > QgsWms::QgsWmsParameters::highlightGeomAsGeom ( ) const

Returns HIGHLIGHT_GEOM as a list of geometries.

An exception is raised if an invalid geometry is found.

Returns: highlight geometries

Exceptions

QgsBadRequestException

Definition at line 703 of file qgswmsparameters.cpp.

◆ highlightLabelBufferColor()

QStringList QgsWms::QgsWmsParameters::highlightLabelBufferColor ( ) const

Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of string.

Returns: highlight label buffer color

Definition at line 1411 of file qgswmsparameters.cpp.

◆ highlightLabelBufferColorAsColor()

QList< QColor > QgsWms::QgsWmsParameters::highlightLabelBufferColorAsColor ( ) const

Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of colors.

An axception is raised if an invalid color is found.

Returns: highlight label buffer color

Exceptions

QgsBadRequestException

Definition at line 1416 of file qgswmsparameters.cpp.

◆ highlightLabelBufferSize()

QStringList QgsWms::QgsWmsParameters::highlightLabelBufferSize ( ) const

Returns HIGHLIGHT_LABELBUFFERSIZE.

Returns: highlight label buffer size

Definition at line 1421 of file qgswmsparameters.cpp.

◆ highlightLabelBufferSizeAsFloat()

QList< double > QgsWms::QgsWmsParameters::highlightLabelBufferSizeAsFloat ( ) const

Returns HIGHLIGHT_LABELBUFFERSIZE as a list of float.

An exception is raised if an invalid size is found.

Returns: highlight label buffer size

Exceptions

QgsBadRequestException

Definition at line 1426 of file qgswmsparameters.cpp.

◆ highlightLabelColor()

QStringList QgsWms::QgsWmsParameters::highlightLabelColor ( ) const

Returns HIGHLIGHT_LABELCOLOR as a list of string.

Returns: highlight label color

Definition at line 1386 of file qgswmsparameters.cpp.

◆ highlightLabelColorAsColor()

QList< QColor > QgsWms::QgsWmsParameters::highlightLabelColorAsColor ( ) const

Returns HIGHLIGHT_LABELCOLOR as a list of color.

An exception is raised if an invalid color is found.

Returns: highlight label color

Exceptions

QgsBadRequestException

Definition at line 1391 of file qgswmsparameters.cpp.

◆ highlightLabelDistance()

QList< double > QgsWms::QgsWmsParameters::highlightLabelDistance ( ) const

Returns HIGHLIGHT_LABEL_DISTANCE as a list of double.

Returns: highlight label distance

Definition at line 1436 of file qgswmsparameters.cpp.

◆ highlightLabelFont()

QStringList QgsWms::QgsWmsParameters::highlightLabelFont ( ) const

Returns HIGHLIGHT_LABELFONT.

Returns: highlight label font

Definition at line 1406 of file qgswmsparameters.cpp.

◆ highlightLabelHorizontalAlignment()

QStringList QgsWms::QgsWmsParameters::highlightLabelHorizontalAlignment ( ) const

Returns HIGHLIGHT_LABEL_HORIZONTAL_ALIGNMENT as a list of string.

Returns: highlight label horizontal alignment strings

Definition at line 1441 of file qgswmsparameters.cpp.

◆ highlightLabelRotation()

QList< double > QgsWms::QgsWmsParameters::highlightLabelRotation ( ) const

Returns HIGHLIGHT_LABEL_ROTATION as a list of double.

Returns: highlight label rotation

Definition at line 1431 of file qgswmsparameters.cpp.

◆ highlightLabelSize()

QStringList QgsWms::QgsWmsParameters::highlightLabelSize ( ) const

Returns HIGHLIGHT_LABELSIZE as a list of string.

Returns: highlight label size

Definition at line 1376 of file qgswmsparameters.cpp.

◆ highlightLabelSizeAsInt()

QList< int > QgsWms::QgsWmsParameters::highlightLabelSizeAsInt ( ) const

Returns HIGHLIGHT_LABELSIZE as a list of int An exception is raised if an invalid size is found.

Returns: highlight label size

Exceptions

QgsBadRequestException

Definition at line 1381 of file qgswmsparameters.cpp.

◆ highlightLabelString()

QStringList QgsWms::QgsWmsParameters::highlightLabelString ( ) const

Returns HIGHLIGHT_LABELSTRING as a list of string.

Returns: highlight label string

Definition at line 1371 of file qgswmsparameters.cpp.

◆ highlightLabelVerticalAlignment()

QStringList QgsWms::QgsWmsParameters::highlightLabelVerticalAlignment ( ) const

Returns HIGHLIGHT_LABEL_VERTICAL_ALIGNMENT as a list of string.

Returns: highlight label vertical alignment strings

Definition at line 1446 of file qgswmsparameters.cpp.

◆ highlightLabelWeight()

QStringList QgsWms::QgsWmsParameters::highlightLabelWeight ( ) const

Returns HIGHLIGHT_LABELWEIGHT as a list of string.

Returns: highlight label weight

Definition at line 1396 of file qgswmsparameters.cpp.

◆ highlightLabelWeightAsInt()

QList< int > QgsWms::QgsWmsParameters::highlightLabelWeightAsInt ( ) const

Returns HIGHLIGHT_LABELWEIGHT as a list of int.

An exception is raised if an invalid weight is found.

Returns: highlight label weight

Exceptions

QgsBadRequestException

Definition at line 1401 of file qgswmsparameters.cpp.

◆ highlightLayersParameters()

QList< QgsWmsParametersHighlightLayer > QgsWms::QgsWmsParameters::highlightLayersParameters ( ) const

Returns parameters for each highlight layer.

Returns: parameters for each highlight layer

Definition at line 1711 of file qgswmsparameters.cpp.

◆ highlightSymbol()

QStringList QgsWms::QgsWmsParameters::highlightSymbol ( ) const

Returns HIGHLIGHT_SYMBOL as a list of string.

Returns: highlight sld symbols

Definition at line 708 of file qgswmsparameters.cpp.

◆ htmlInfoOnlyMapTip()

bool QgsWms::QgsWmsParameters::htmlInfoOnlyMapTip ( ) const

Returns true if only maptip information is requested for HTML feature info response.

Returns: htmlInfoOnlyMapTip

Since: QGIS 3.36

Definition at line 2148 of file qgswmsparameters.cpp.

◆ i()

QString QgsWms::QgsWmsParameters::i ( ) const

Returns I parameter or an empty string if not defined.

Returns: i parameter

Definition at line 949 of file qgswmsparameters.cpp.

◆ iAsInt()

int QgsWms::QgsWmsParameters::iAsInt ( ) const

Returns I parameter as an int or its default value if not defined.

An exception is raised if I is defined and cannot be converted.

Returns: i parameter

Exceptions

QgsBadRequestException

Definition at line 959 of file qgswmsparameters.cpp.

◆ iconLabelSpace()

QString QgsWms::QgsWmsParameters::iconLabelSpace ( ) const

Returns ICONLABELSPACE parameter or an empty string if not defined.

Returns: ICONLABELSPACE parameter or an empty string if not defined.

Definition at line 1134 of file qgswmsparameters.cpp.

◆ iconLabelSpaceAsDouble()

double QgsWms::QgsWmsParameters::iconLabelSpaceAsDouble ( ) const

Returns ICONLABELSPACE as a double or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns: iconLabelSpace

Exceptions

QgsBadRequestException

Definition at line 1139 of file qgswmsparameters.cpp.

◆ imageQuality()

QString QgsWms::QgsWmsParameters::imageQuality ( ) const

Returns IMAGE_QUALITY parameter or an empty string if not defined.

Since: QGIS 3.4

Definition at line 1029 of file qgswmsparameters.cpp.

◆ imageQualityAsInt()

int QgsWms::QgsWmsParameters::imageQualityAsInt ( ) const

Returns IMAGE_QUALITY parameter as an integer.

Exceptions

QgsBadRequestException

Since: QGIS 3.4

Definition at line 1034 of file qgswmsparameters.cpp.

◆ infoFormat()

QgsWmsParameters::Format QgsWms::QgsWmsParameters::infoFormat ( ) const

Returns infoFormat.

If the INFO_FORMAT parameter is not used, then the default value is text/plain.

Returns: infoFormat

Definition at line 912 of file qgswmsparameters.cpp.

◆ infoFormatAsString()

QString QgsWms::QgsWmsParameters::infoFormatAsString ( ) const

Returns INFO_FORMAT parameter as a string.

Returns: INFO_FORMAT parameter as string

Definition at line 902 of file qgswmsparameters.cpp.

◆ infoFormatIsImage()

bool QgsWms::QgsWmsParameters::infoFormatIsImage ( ) const

Checks if INFO_FORMAT parameter is one of the image formats (PNG, JPG).

Returns: true if the INFO_FORMAT is an image format

Definition at line 907 of file qgswmsparameters.cpp.

◆ infoFormatVersion()

int QgsWms::QgsWmsParameters::infoFormatVersion ( ) const

Returns the infoFormat version for GML.

If the INFO_FORMAT is not GML, then the default value is -1.

Returns: infoFormat version

Definition at line 937 of file qgswmsparameters.cpp.

◆ isForce2D()

bool QgsWms::QgsWmsParameters::isForce2D ( ) const

Returns: true if the FORCE_2D parameter is set and the DXF should be produced in 2D.

Since: QGIS 3.12

Definition at line 1596 of file qgswmsparameters.cpp.

◆ itemFont()

QFont QgsWms::QgsWmsParameters::itemFont ( ) const

Returns the item font (built thanks to the ITEMFONTFAMILY, ITEMFONTSIZE, ITEMFONTBOLD, ... parameters).

Returns: itemFont

Definition at line 1280 of file qgswmsparameters.cpp.

◆ itemFontBold()

QString QgsWms::QgsWmsParameters::itemFontBold ( ) const

Returns ITEMFONTBOLD parameter or an empty string if not defined.

Returns: ITEMFONTBOLD parameter or an empty string if not defined.

Definition at line 1164 of file qgswmsparameters.cpp.

◆ itemFontBoldAsBool()

bool QgsWms::QgsWmsParameters::itemFontBoldAsBool ( ) const

Returns ITEMFONTBOLD as a boolean or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns: itemFontBold

Exceptions

QgsBadRequestException

Definition at line 1199 of file qgswmsparameters.cpp.

◆ itemFontColor()

QString QgsWms::QgsWmsParameters::itemFontColor ( ) const

Returns ITEMFONTCOLOR parameter or an empty string if not defined.

Returns: ITEMFONTCOLOR parameter or an empty string if not defined.

Definition at line 1254 of file qgswmsparameters.cpp.

◆ itemFontColorAsColor()

QColor QgsWms::QgsWmsParameters::itemFontColorAsColor ( ) const

Returns ITEMFONTCOLOR as a color.

An exception is raised if an invalid parameter is found.

Returns: itemFontColor

Exceptions

QgsBadRequestException

Definition at line 1259 of file qgswmsparameters.cpp.

◆ itemFontFamily()

QString QgsWms::QgsWmsParameters::itemFontFamily ( ) const

Returns ITEMFONTFAMILY parameter or an empty string if not defined.

Returns: ITEMFONTFAMILY parameter or an empty string if not defined.

Definition at line 1149 of file qgswmsparameters.cpp.

◆ itemFontItalic()

QString QgsWms::QgsWmsParameters::itemFontItalic ( ) const

Returns ITEMFONTITALIC parameter or an empty string if not defined.

Returns: ITEMFONTITALIC parameter or an empty string if not defined.

Definition at line 1214 of file qgswmsparameters.cpp.

◆ itemFontItalicAsBool()

bool QgsWms::QgsWmsParameters::itemFontItalicAsBool ( ) const

Returns ITEMFONTITALIC as a boolean or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns: itemFontItalic

Exceptions

QgsBadRequestException

Definition at line 1219 of file qgswmsparameters.cpp.

◆ itemFontSize()

QString QgsWms::QgsWmsParameters::itemFontSize ( ) const

Returns ITEMFONTSIZE parameter or an empty string if not defined.

Returns: ITEMFONTSIZE parameter or an empty string if not defined.

Definition at line 1244 of file qgswmsparameters.cpp.

◆ itemFontSizeAsDouble()

double QgsWms::QgsWmsParameters::itemFontSizeAsDouble ( ) const

Returns ITEMFONTSIZE as a double.

An exception is raised if an invalid parameter is found.

Returns: itemFontSize

Exceptions

QgsBadRequestException

Definition at line 1249 of file qgswmsparameters.cpp.

◆ j()

QString QgsWms::QgsWmsParameters::j ( ) const

Returns J parameter or an empty string if not defined.

Returns: j parameter

Definition at line 954 of file qgswmsparameters.cpp.

◆ jAsInt()

int QgsWms::QgsWmsParameters::jAsInt ( ) const

Returns J parameter as an int or its default value if not defined.

An exception is raised if J is defined and cannot be converted.

Returns: j parameter

Exceptions

QgsBadRequestException

Definition at line 964 of file qgswmsparameters.cpp.

◆ layerFont()

QFont QgsWms::QgsWmsParameters::layerFont ( ) const

Returns the layer font (built thanks to the LAYERFONTFAMILY, LAYERFONTSIZE, LAYERFONTBOLD, ... parameters).

Returns: layerFont

Definition at line 1264 of file qgswmsparameters.cpp.

◆ layerFontBold()

QString QgsWms::QgsWmsParameters::layerFontBold ( ) const

Returns LAYERFONTBOLD parameter or an empty string if not defined.

Returns: LAYERFONTBOLD parameter or an empty string if not defined.

Definition at line 1154 of file qgswmsparameters.cpp.

◆ layerFontBoldAsBool()

bool QgsWms::QgsWmsParameters::layerFontBoldAsBool ( ) const

Returns LAYERFONTBOLD as a boolean or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns: layerFontBold

Exceptions

QgsBadRequestException

Definition at line 1159 of file qgswmsparameters.cpp.

◆ layerFontColor()

QString QgsWms::QgsWmsParameters::layerFontColor ( ) const

Returns LAYERFONTCOLOR parameter or an empty string if not defined.

Returns: LAYERFONTCOLOR parameter or an empty string if not defined.

Definition at line 1234 of file qgswmsparameters.cpp.

◆ layerFontColorAsColor()

QColor QgsWms::QgsWmsParameters::layerFontColorAsColor ( ) const

Returns LAYERFONTCOLOR as a color or its defined value if not defined.

An exception is raised if an invalid parameter is found.

Returns: layerFontColor

Exceptions

QgsBadRequestException

Definition at line 1239 of file qgswmsparameters.cpp.

◆ layerFontFamily()

QString QgsWms::QgsWmsParameters::layerFontFamily ( ) const

Returns LAYERFONTFAMILY parameter or an empty string if not defined.

Returns: LAYERFONTFAMILY parameter or an empty string if not defined.

Definition at line 1144 of file qgswmsparameters.cpp.

◆ layerFontItalic()

QString QgsWms::QgsWmsParameters::layerFontItalic ( ) const

Returns LAYERFONTITALIC parameter or an empty string if not defined.

Returns: LAYERFONTITALIC parameter or an empty string if not defined.

Definition at line 1204 of file qgswmsparameters.cpp.

◆ layerFontItalicAsBool()

bool QgsWms::QgsWmsParameters::layerFontItalicAsBool ( ) const

Returns LAYERFONTITALIC as a boolean or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns: layerFontItalic

Exceptions

QgsBadRequestException

Definition at line 1209 of file qgswmsparameters.cpp.

◆ layerFontSize()

QString QgsWms::QgsWmsParameters::layerFontSize ( ) const

Returns LAYERFONTSIZE parameter or an empty string if not defined.

Returns: LAYERFONTSIZE parameter or an empty string if not defined.

Definition at line 1224 of file qgswmsparameters.cpp.

◆ layerFontSizeAsDouble()

double QgsWms::QgsWmsParameters::layerFontSizeAsDouble ( ) const

Returns LAYERFONTSIZE as a double.

An exception is raised if an invalid parameter is found.

Returns: layerFontSize

Exceptions

QgsBadRequestException

Definition at line 1229 of file qgswmsparameters.cpp.

◆ layerSpace()

QString QgsWms::QgsWmsParameters::layerSpace ( ) const

Returns LAYERSPACE parameter or an empty string if not defined.

Returns: LAYERSPACE parameter or an empty string if not defined.

Definition at line 1084 of file qgswmsparameters.cpp.

◆ layerSpaceAsDouble()

double QgsWms::QgsWmsParameters::layerSpaceAsDouble ( ) const

Returns LAYERSPACE as a double or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns: layerSpace

Exceptions

QgsBadRequestException

Definition at line 1089 of file qgswmsparameters.cpp.

◆ layersParameters()

QList< QgsWmsParametersLayer > QgsWms::QgsWmsParameters::layersParameters ( ) const

Returns parameters for each layer found in LAYER/LAYERS.

Returns: layer parameters

Definition at line 1636 of file qgswmsparameters.cpp.

◆ layerTitle()

QString QgsWms::QgsWmsParameters::layerTitle ( ) const

Returns LAYERTITLE parameter or an empty string if not defined.

Returns: LAYERTITLE parameter or an empty string if not defined.

Definition at line 1297 of file qgswmsparameters.cpp.

◆ layerTitleAsBool()

bool QgsWms::QgsWmsParameters::layerTitleAsBool ( ) const

Returns LAYERTITLE as a bool or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns: layerTitle

Exceptions

QgsBadRequestException

Definition at line 1302 of file qgswmsparameters.cpp.

◆ layerTitleSpace()

QString QgsWms::QgsWmsParameters::layerTitleSpace ( ) const

Returns LAYERTITLESPACE parameter or an empty string if not defined.

Returns: LAYERTITLESPACE parameter or an empty string if not defined.

Definition at line 1094 of file qgswmsparameters.cpp.

◆ layerTitleSpaceAsDouble()

double QgsWms::QgsWmsParameters::layerTitleSpaceAsDouble ( ) const

Returns LAYERTITLESPACE as a double.

An exception is raised if an invalid parameter is found.

Returns: layerTitleSpace

Exceptions

QgsBadRequestException

Definition at line 1099 of file qgswmsparameters.cpp.

◆ layoutParameter()

QString QgsWms::QgsWmsParameters::layoutParameter	(	const QString &	id,
		bool &	ok
	)		const

Returns a layout parameter thanks to its id.

Parameters

id	Parameter id
ok	`true` if the parameter is valid, `false` otherwise

Returns: The layout parameter

Since: QGIS 3.4

Definition at line 1352 of file qgswmsparameters.cpp.

◆ legendSettings()

QgsLegendSettings QgsWms::QgsWmsParameters::legendSettings ( ) const

Returns legend settings.

Returns: legend settings

Definition at line 1307 of file qgswmsparameters.cpp.

◆ lineTolerance()

QString QgsWms::QgsWmsParameters::lineTolerance ( ) const

Returns FI_LINE_TOLERANCE parameter or an empty string if not defined.

Since: QGIS 3.4

Definition at line 1174 of file qgswmsparameters.cpp.

◆ lineToleranceAsInt()

int QgsWms::QgsWmsParameters::lineToleranceAsInt ( ) const

Returns FI_LINE_TOLERANCE parameter as an integer.

Exceptions

QgsBadRequestException

Since: QGIS 3.4

Definition at line 1189 of file qgswmsparameters.cpp.

◆ noMText()

bool QgsWms::QgsWmsParameters::noMText ( ) const

Returns: true if the FORCE_MTEXT parameter is set and the DXF should be produced with MTEXT instead of TEXT.

Since: QGIS 3.12

Definition at line 1622 of file qgswmsparameters.cpp.

◆ opacities()

QStringList QgsWms::QgsWmsParameters::opacities ( ) const

Returns the list of opacities found in OPACITIES parameter.

Returns: the list of opacities in string

Definition at line 1484 of file qgswmsparameters.cpp.

◆ opacitiesAsInt()

QList< int > QgsWms::QgsWmsParameters::opacitiesAsInt ( ) const

Returns the list of opacities found in OPACITIES parameter as integers.

If an opacity cannot be converted into an integer, then an exception is raised

Returns: a list of opacities as integers

Exceptions

QgsBadRequestException

Definition at line 1489 of file qgswmsparameters.cpp.

◆ operator[]()

QgsWmsParameter QgsWms::QgsWmsParameters::operator[] ( QgsWmsParameter::Name name ) const

Returns the parameter corresponding to name.

Since: QGIS 3.8

Definition at line 586 of file qgswmsparameters.cpp.

◆ pdfAppendGeoreference()

bool QgsWms::QgsWmsParameters::pdfAppendGeoreference ( ) const

Returns true if georeference info shall be added to the pdf.

Since: QGIS 3.32

Definition at line 2306 of file qgswmsparameters.cpp.

◆ pdfDisableTiledRasterRendering()

bool QgsWms::QgsWmsParameters::pdfDisableTiledRasterRendering ( ) const

Returns true if rasters shall be untiled in the pdf.

Since: QGIS 3.32

Definition at line 2368 of file qgswmsparameters.cpp.

◆ pdfExportMapThemes()

QStringList QgsWms::QgsWmsParameters::pdfExportMapThemes ( ) const

Returns map themes for geospatial PDF export.

Since: QGIS 3.32

Definition at line 2401 of file qgswmsparameters.cpp.

◆ pdfExportMetadata()

bool QgsWms::QgsWmsParameters::pdfExportMetadata ( ) const

Returns true if metadata shall be added to the pdf.

Since: QGIS 3.32

Definition at line 2328 of file qgswmsparameters.cpp.

◆ pdfForceVectorOutput()

bool QgsWms::QgsWmsParameters::pdfForceVectorOutput ( ) const

Returns if pdf should be exported as vector.

Since: QGIS 3.32

Definition at line 2295 of file qgswmsparameters.cpp.

◆ pdfLosslessImageCompression()

bool QgsWms::QgsWmsParameters::pdfLosslessImageCompression ( ) const

Returns true if images embedded in pdf must be compressed using a lossless algorithm.

Since: QGIS 3.32

Definition at line 2357 of file qgswmsparameters.cpp.

◆ pdfPredefinedMapScales()

QVector< qreal > QgsWms::QgsWmsParameters::pdfPredefinedMapScales ( ) const

Returns list of map scales.

Since: QGIS 3.32

Definition at line 2412 of file qgswmsparameters.cpp.

◆ pdfSimplifyGeometries()

bool QgsWms::QgsWmsParameters::pdfSimplifyGeometries ( ) const

Returns if geometries shall to be simplified.

Since: QGIS 3.32

Definition at line 2317 of file qgswmsparameters.cpp.

◆ pdfTextRenderFormat()

Qgis::TextRenderFormat QgsWms::QgsWmsParameters::pdfTextRenderFormat ( ) const

Returns text render format for pdf export.

Since: QGIS 3.32

Definition at line 2339 of file qgswmsparameters.cpp.

◆ pdfUseIso32000ExtensionFormatGeoreferencing()

bool QgsWms::QgsWmsParameters::pdfUseIso32000ExtensionFormatGeoreferencing ( ) const

Returns true, if Iso32000 georeferencing shall be used.

Since: QGIS 3.32

Definition at line 2379 of file qgswmsparameters.cpp.

◆ pdfUseOgcBestPracticeFormatGeoreferencing()

bool QgsWms::QgsWmsParameters::pdfUseOgcBestPracticeFormatGeoreferencing ( ) const

Returns true if OGC best practice georeferencing shall be used.

Since: QGIS 3.32

Definition at line 2390 of file qgswmsparameters.cpp.

◆ pointTolerance()

QString QgsWms::QgsWmsParameters::pointTolerance ( ) const

Returns FI_POINT_TOLERANCE parameter or an empty string if not defined.

Since: QGIS 3.4

Definition at line 1179 of file qgswmsparameters.cpp.

◆ pointToleranceAsInt()

int QgsWms::QgsWmsParameters::pointToleranceAsInt ( ) const

Returns FI_POINT_TOLERANCE parameter as an integer.

Exceptions

QgsBadRequestException

Since: QGIS 3.4

Definition at line 1194 of file qgswmsparameters.cpp.

◆ polygonTolerance()

QString QgsWms::QgsWmsParameters::polygonTolerance ( ) const

Returns FI_POLYGON_TOLERANCE parameter or an empty string if not defined.

Since: QGIS 3.4

Definition at line 1169 of file qgswmsparameters.cpp.

◆ polygonToleranceAsInt()

int QgsWms::QgsWmsParameters::polygonToleranceAsInt ( ) const

Returns FI_POLYGON_TOLERANCE parameter as an integer.

Exceptions

QgsBadRequestException

Since: QGIS 3.4

Definition at line 1184 of file qgswmsparameters.cpp.

◆ queryLayersNickname()

QStringList QgsWms::QgsWmsParameters::queryLayersNickname ( ) const

Returns nickname of layers found in QUERY_LAYERS parameter.

Returns: nickname of layers

Definition at line 1529 of file qgswmsparameters.cpp.

◆ request()

QString QgsWms::QgsWmsParameters::request ( ) const

overridevirtual

Returns REQUEST parameter as a string or an empty string if not defined.

Returns: request

Reimplemented from QgsServerParameters.

Definition at line 833 of file qgswmsparameters.cpp.

◆ rule()

QString QgsWms::QgsWmsParameters::rule ( ) const

Returns RULE parameter or an empty string if none is defined.

Returns: RULE parameter or an empty string if none is defined

Definition at line 989 of file qgswmsparameters.cpp.

◆ ruleLabel()

QString QgsWms::QgsWmsParameters::ruleLabel ( ) const

Returns RULELABEL parameter or an empty string if none is defined.

Returns: RULELABEL parameter or an empty string if none is defined

Definition at line 999 of file qgswmsparameters.cpp.

◆ ruleLabelAsBool()

bool QgsWms::QgsWmsParameters::ruleLabelAsBool ( ) const

Returns RULELABEL as a bool.

An exception is raised if an invalid parameter is found.

Returns: ruleLabel

Exceptions

QgsBadRequestException

Definition at line 1004 of file qgswmsparameters.cpp.

◆ scale()

QString QgsWms::QgsWmsParameters::scale ( ) const

Returns SCALE parameter or an empty string if none is defined.

Returns: SCALE parameter or an empty string if none is defined

Definition at line 1019 of file qgswmsparameters.cpp.

◆ scaleAsDouble()

double QgsWms::QgsWmsParameters::scaleAsDouble ( ) const

Returns SCALE as a double.

An exception is raised if an invalid parameter is found.

Returns: scale

Exceptions

QgsBadRequestException

Definition at line 1024 of file qgswmsparameters.cpp.

◆ selections()

QStringList QgsWms::QgsWmsParameters::selections ( ) const

Returns the list of feature selection found in SELECTION parameter.

Returns: the list of selection

Definition at line 1479 of file qgswmsparameters.cpp.

◆ set()

void QgsWms::QgsWmsParameters::set	(	QgsWmsParameter::Name	name,
		const QVariant &	value
	)

Sets a parameter value thanks to its name.

Since: QGIS 3.8

Definition at line 591 of file qgswmsparameters.cpp.

◆ showFeatureCount()

QString QgsWms::QgsWmsParameters::showFeatureCount ( ) const

Returns SHOWFEATURECOUNT parameter or an empty string if none is defined.

Returns: SHOWFEATURECOUNT parameter or an empty string if none is defined

Definition at line 1054 of file qgswmsparameters.cpp.

◆ showFeatureCountAsBool()

bool QgsWms::QgsWmsParameters::showFeatureCountAsBool ( ) const

Returns SHOWFEATURECOUNT as a bool.

An exception is raised if an invalid parameter is found.

Returns: showFeatureCount

Exceptions

QgsBadRequestException

Definition at line 1059 of file qgswmsparameters.cpp.

◆ showRuleDetailsAsBool()

bool QgsWms::QgsWmsParameters::showRuleDetailsAsBool ( ) const

Returns SHOWRULEDETAILS as a bool.

An exception is raised if an invalid parameter is found.

Since: QGIS 3.36

Definition at line 994 of file qgswmsparameters.cpp.

◆ sldBody()

QString QgsWms::QgsWmsParameters::sldBody ( ) const

Returns SLD_body if defined or an empty string.

Returns: sld body

Definition at line 1461 of file qgswmsparameters.cpp.

◆ srcHeight()

QString QgsWms::QgsWmsParameters::srcHeight ( ) const

Returns SRCHEIGHT parameter or an empty string if not defined.

Returns: srcHeight parameter

Since: QGIS 3.8

Definition at line 766 of file qgswmsparameters.cpp.

◆ srcHeightAsInt()

int QgsWms::QgsWmsParameters::srcHeightAsInt ( ) const

Returns SRCHEIGHT parameter as an int or its default value if not defined.

An exception is raised if SRCHEIGHT is defined and cannot be converted.

Returns: srcHeight parameter

Exceptions

QgsBadRequestException

Since: QGIS 3.8

Definition at line 776 of file qgswmsparameters.cpp.

◆ srcWidth()

QString QgsWms::QgsWmsParameters::srcWidth ( ) const

Returns SRCWIDTH parameter or an empty string if not defined.

Returns: srcWidth parameter

Since: QGIS 3.8

Definition at line 771 of file qgswmsparameters.cpp.

◆ srcWidthAsInt()

int QgsWms::QgsWmsParameters::srcWidthAsInt ( ) const

Returns SRCWIDTH parameter as an int or its default value if not defined.

An exception is raised if SRCWIDTH is defined and cannot be converted.

Returns: srcWidth parameter

Exceptions

QgsBadRequestException

Since: QGIS 3.8

Definition at line 781 of file qgswmsparameters.cpp.

◆ symbolHeight()

QString QgsWms::QgsWmsParameters::symbolHeight ( ) const

Returns SYMBOLHEIGHT parameter or an empty string if not defined.

Returns: SYMBOLHEIGHT parameter or an empty string if not defined.

Definition at line 1114 of file qgswmsparameters.cpp.

◆ symbolHeightAsDouble()

double QgsWms::QgsWmsParameters::symbolHeightAsDouble ( ) const

Returns SYMBOLHEIGHT as a double or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns: symbolHeight

Exceptions

QgsBadRequestException

Definition at line 1119 of file qgswmsparameters.cpp.

◆ symbolSpace()

QString QgsWms::QgsWmsParameters::symbolSpace ( ) const

Returns SYMBOLSPACE parameter or an empty string if not defined.

Returns: SYMBOLSPACE parameter or an empty string if not defined.

Definition at line 1104 of file qgswmsparameters.cpp.

◆ symbolSpaceAsDouble()

double QgsWms::QgsWmsParameters::symbolSpaceAsDouble ( ) const

Returns SYMBOLSPACE as a double or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns: symbolSpace

Exceptions

QgsBadRequestException

Definition at line 1109 of file qgswmsparameters.cpp.

◆ symbolWidth()

QString QgsWms::QgsWmsParameters::symbolWidth ( ) const

Returns SYMBOLWIDTH parameter or an empty string if not defined.

Returns: SYMBOLWIDTH parameter or an empty string if not defined.

Definition at line 1124 of file qgswmsparameters.cpp.

◆ symbolWidthAsDouble()

double QgsWms::QgsWmsParameters::symbolWidthAsDouble ( ) const

Returns SYMBOLWIDTH as a double or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns: symbolWidth

Exceptions

QgsBadRequestException

Definition at line 1129 of file qgswmsparameters.cpp.

◆ tiled()

QString QgsWms::QgsWmsParameters::tiled ( ) const

Returns TILED parameter or an empty string if not defined.

Since: QGIS 3.10

Definition at line 1039 of file qgswmsparameters.cpp.

◆ tiledAsBool()

bool QgsWms::QgsWmsParameters::tiledAsBool ( ) const

Returns TILED parameter as a boolean.

Exceptions

QgsBadRequestException

Since: QGIS 3.10

Definition at line 1044 of file qgswmsparameters.cpp.

◆ transparent()

QString QgsWms::QgsWmsParameters::transparent ( ) const

Returns TRANSPARENT parameter or an empty string if not defined.

Returns: TRANSPARENT parameter

Definition at line 1009 of file qgswmsparameters.cpp.

◆ transparentAsBool()

bool QgsWms::QgsWmsParameters::transparentAsBool ( ) const

Returns TRANSPARENT parameter as a bool or its default value if not defined.

An exception is raised if TRANSPARENT is defined and cannot be converted.

Returns: transparent parameter

Exceptions

QgsBadRequestException

Definition at line 1014 of file qgswmsparameters.cpp.

◆ version()

QString QgsWms::QgsWmsParameters::version ( ) const

overridevirtual

Returns VERSION parameter as a string or an empty string if not defined.

Returns: version

Reimplemented from QgsServerParameters.

Definition at line 796 of file qgswmsparameters.cpp.

◆ versionAsNumber()

QgsProjectVersion QgsWms::QgsWmsParameters::versionAsNumber ( ) const

Returns VERSION parameter if defined or its default value.

Returns: version

Definition at line 846 of file qgswmsparameters.cpp.

◆ versionIsValid()

bool QgsWms::QgsWmsParameters::versionIsValid ( const QString version ) const

Returns true if version is valid, false otherwise.

Since: QGIS 3.4

Definition at line 851 of file qgswmsparameters.cpp.

◆ width()

QString QgsWms::QgsWmsParameters::width ( ) const

Returns WIDTH parameter or an empty string if not defined.

Returns: width parameter

Definition at line 751 of file qgswmsparameters.cpp.

◆ widthAsInt()

int QgsWms::QgsWmsParameters::widthAsInt ( ) const

Returns WIDTH parameter as an int or its default value if not defined.

An exception is raised if WIDTH is defined and cannot be converted.

Returns: width parameter

Exceptions

QgsBadRequestException

Definition at line 761 of file qgswmsparameters.cpp.

◆ withDisplayName()

bool QgsWms::QgsWmsParameters::withDisplayName ( ) const

withDisplayName

Returns: true if the display name is requested for feature info response

Since: QGIS 3.32

Definition at line 2158 of file qgswmsparameters.cpp.

◆ withGeometry()

bool QgsWms::QgsWmsParameters::withGeometry ( ) const

Returns if the client wants the feature info response with geometry information.

Returns: true if geometry information is requested for feature info response

Definition at line 2125 of file qgswmsparameters.cpp.

◆ withMapTip()

bool QgsWms::QgsWmsParameters::withMapTip ( ) const

withMapTip

Returns: true if maptip information is requested for feature info response

Definition at line 2135 of file qgswmsparameters.cpp.

◆ withMapTipAsString()

QString QgsWms::QgsWmsParameters::withMapTipAsString ( ) const

withMapTipAsString

Returns: WITH_MAPTIP parameter as string

Since: QGIS 3.36

Definition at line 2130 of file qgswmsparameters.cpp.

◆ wmsPrecision()

QString QgsWms::QgsWmsParameters::wmsPrecision ( ) const

Returns WMS_PRECISION parameter or an empty string if not defined.

Returns: wms precision parameter

Definition at line 1451 of file qgswmsparameters.cpp.

◆ wmsPrecisionAsInt()

int QgsWms::QgsWmsParameters::wmsPrecisionAsInt ( ) const

Returns WMS_PRECISION parameter as an int or its default value if not defined.

An exception is raised if WMS_PRECISION is defined and cannot be converted.

Returns: wms precision parameter

Exceptions

QgsBadRequestException

Definition at line 1456 of file qgswmsparameters.cpp.

◆ wmtver()

QString QgsWms::QgsWmsParameters::wmtver ( ) const

Returns WMTVER parameter or an empty string if not defined.

Since: QGIS 3.4

Definition at line 2163 of file qgswmsparameters.cpp.

◆ writeGeospatialPdf()

bool QgsWms::QgsWmsParameters::writeGeospatialPdf ( ) const

Returns if a geospatial PDF shall be exported.

Since: QGIS 3.32

Definition at line 2284 of file qgswmsparameters.cpp.

◆ x()

QString QgsWms::QgsWmsParameters::x ( ) const

Returns X parameter or an empty string if not defined.

Returns: x parameter

Definition at line 969 of file qgswmsparameters.cpp.

◆ xAsInt()

int QgsWms::QgsWmsParameters::xAsInt ( ) const

Returns X parameter as an int or its default value if not defined.

An exception is raised if X is defined and cannot be converted.

Returns: x parameter

Exceptions

QgsBadRequestException

Definition at line 979 of file qgswmsparameters.cpp.

◆ y()

QString QgsWms::QgsWmsParameters::y ( ) const

Returns Y parameter or an empty string if not defined.

Returns: y parameter

Definition at line 974 of file qgswmsparameters.cpp.

◆ yAsInt()

int QgsWms::QgsWmsParameters::yAsInt ( ) const

Returns Y parameter as an int or its default value if not defined.

An exception is raised if Y is defined and cannot be converted.

Returns: j parameter

Exceptions

QgsBadRequestException

Definition at line 984 of file qgswmsparameters.cpp.

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

/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/server/services/wms/qgswmsparameters.h
/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/server/services/wms/qgswmsparameters.cpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ DxfFormatOption

◆ Format

◆ PdfFormatOption

Constructor & Destructor Documentation

◆ QgsWmsParameters() [1/2]

◆ QgsWmsParameters() [2/2]

◆ ~QgsWmsParameters()

Member Function Documentation

◆ addLayerGroups()

◆ allLayersNickname()

◆ allStyles()

◆ atlasPk()

◆ backgroundColor()

◆ backgroundColorAsColor()

◆ bbox()

◆ bboxAsRectangle()

◆ boxSpace()

◆ boxSpaceAsDouble()

◆ composerMapParameters()

◆ composerTemplate()

◆ crs()

◆ dimensionValues()

◆ dpi()

◆ dpiAsDouble()

◆ dump()

◆ dxfCodec()

◆ dxfLayerAttributes()

◆ dxfMode()

◆ dxfScale()

◆ dxfUseLayerTitleAsName()

◆ exportLinesWithZeroWidth()

◆ externalLayersParameters()

◆ externalWMSUri()

◆ featureCount()

◆ featureCountAsInt()

◆ filterGeom()

◆ filters()

◆ format()

◆ formatAsString() [1/2]

◆ formatAsString() [2/2]

◆ formatOptions()

◆ height()

◆ heightAsInt()

◆ highlightGeom()

◆ highlightGeomAsGeom()

◆ highlightLabelBufferColor()

◆ highlightLabelBufferColorAsColor()

◆ highlightLabelBufferSize()

◆ highlightLabelBufferSizeAsFloat()

◆ highlightLabelColor()

◆ highlightLabelColorAsColor()

◆ highlightLabelDistance()

◆ highlightLabelFont()

◆ highlightLabelHorizontalAlignment()

◆ highlightLabelRotation()

◆ highlightLabelSize()

◆ highlightLabelSizeAsInt()

◆ highlightLabelString()

◆ highlightLabelVerticalAlignment()

◆ highlightLabelWeight()

◆ highlightLabelWeightAsInt()

◆ highlightLayersParameters()

◆ highlightSymbol()

◆ htmlInfoOnlyMapTip()

◆ i()

◆ iAsInt()

◆ iconLabelSpace()

◆ iconLabelSpaceAsDouble()

◆ imageQuality()

◆ imageQualityAsInt()

◆ infoFormat()

◆ infoFormatAsString()

◆ infoFormatIsImage()

◆ infoFormatVersion()