|
QGIS API Documentation
3.4.15-Madeira (e83d02e274)
|
|
QGIS API Documentation
3.4.15-Madeira (e83d02e274)
|
Provides an interface to retrieve and manipulate WMS parameters received from the client. More...
#include <qgswmsparameters.h>
Public Types | |
| enum | Format { NONE, JPG, PNG, TEXT, XML, HTML, GML } |
| Output format for the response. More... | |
Public Member Functions | |
| QgsWmsParameters (const QgsServerParameters ¶meters) | |
| Constructor for WMS parameters with specific values. More... | |
| QgsWmsParameters () | |
| Constructor for WMS parameters with default values only. More... | |
| virtual | ~QgsWmsParameters () override=default |
| QStringList | allLayersNickname () const |
| Returns nickname of layers found in LAYER and LAYERS parameters. More... | |
| QStringList | allStyles () const |
| Returns styles found in STYLE and STYLES parameters. More... | |
| QString | backgroundColor () const |
| Returns BGCOLOR parameter or an empty string if not defined. More... | |
| QColor | backgroundColorAsColor () const |
| Returns BGCOLOR parameter as a QColor or its default value if not defined. More... | |
| QString | bbox () const |
| Returns BBOX if defined or an empty string. More... | |
| QgsRectangle | bboxAsRectangle () const |
| Returns BBOX as a rectangle if defined and valid. More... | |
| QString | boxSpace () const |
| Returns BOXSPACE parameter or an empty string if not defined. More... | |
| double | boxSpaceAsDouble () const |
| Returns BOXSPACE as a double or its default value if not defined. More... | |
| QgsWmsParametersComposerMap | composerMapParameters (int mapId) const |
| Returns the requested parameters for a composer map parameter. More... | |
| QString | composerTemplate () const |
| Returns TEMPLATE parameter or an empty string if not defined. More... | |
| QString | crs () const |
| Returns CRS or an empty string if none is defined. More... | |
| QString | dpi () const |
| Returns DPI parameter or an empty string if not defined. More... | |
| double | dpiAsDouble () const |
| Returns DPI parameter as an int or its default value if not defined. More... | |
| void | dump () const |
| Dumps parameters. More... | |
| QString | externalWMSUri (const QString &id) const |
| Returns the external WMS uri. More... | |
| QString | featureCount () const |
| Returns FEATURE_COUNT parameter or an empty string if none is defined. More... | |
| int | featureCountAsInt () const |
| Returns FEATURE_COUNT as an integer. More... | |
| QString | filterGeom () const |
| Returns the filter geometry found in FILTER_GEOM parameter. More... | |
| QStringList | filters () const |
| Returns the list of filters found in FILTER parameter. More... | |
| Format | format () const |
| Returns format. More... | |
| QString | formatAsString () const |
| Returns FORMAT parameter as a string. More... | |
| QString | height () const |
| Returns HEIGHT parameter or an empty string if not defined. More... | |
| int | heightAsInt () const |
| Returns HEIGHT parameter as an int or its default value if not defined. More... | |
| QStringList | highlightGeom () const |
| Returns HIGHLIGHT_GEOM as a list of string in WKT. More... | |
| QList< QgsGeometry > | highlightGeomAsGeom () const |
| Returns HIGHLIGHT_GEOM as a list of geometries. More... | |
| QStringList | highlightLabelBufferColor () const |
| Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of string. More... | |
| QList< QColor > | highlightLabelBufferColorAsColor () const |
| Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of colors. More... | |
| QStringList | highlightLabelBufferSize () const |
| Returns HIGHLIGHT_LABELBUFFERSIZE. More... | |
| QList< double > | highlightLabelBufferSizeAsFloat () const |
| Returns HIGHLIGHT_LABELBUFFERSIZE as a list of float. More... | |
| QStringList | highlightLabelColor () const |
| Returns HIGHLIGHT_LABELCOLOR as a list of string. More... | |
| QList< QColor > | highlightLabelColorAsColor () const |
| Returns HIGHLIGHT_LABELCOLOR as a list of color. More... | |
| QStringList | highlightLabelFont () const |
| Returns HIGHLIGHT_LABELFONT. More... | |
| QStringList | highlightLabelSize () const |
| Returns HIGHLIGHT_LABELSIZE as a list of string. More... | |
| QList< int > | highlightLabelSizeAsInt () const |
| Returns HIGHLIGHT_LABELSIZE as a list of int An exception is raised if an invalid size is found. More... | |
| QStringList | highlightLabelString () const |
| Returns HIGHLIGHT_LABELSTRING as a list of string. More... | |
| QStringList | highlightLabelWeight () const |
| Returns HIGHLIGHT_LABELWEIGHT as a list of string. More... | |
| QList< int > | highlightLabelWeightAsInt () const |
| Returns HIGHLIGHT_LABELWEIGHT as a list of int. More... | |
| QList< QgsWmsParametersHighlightLayer > | highlightLayersParameters () const |
| Returns parameters for each highlight layer. More... | |
| QStringList | highlightSymbol () const |
| Returns HIGHLIGHT_SYMBOL as a list of string. More... | |
| QString | i () const |
| Returns I parameter or an empty string if not defined. More... | |
| int | iAsInt () const |
| Returns I parameter as an int or its default value if not defined. More... | |
| QString | iconLabelSpace () const |
| Returns ICONLABELSPACE parameter or an empty string if not defined. More... | |
| double | iconLabelSpaceAsDouble () const |
| Returns ICONLABELSPACE as a double or its default value if not defined. More... | |
| QString | imageQuality () const |
| Returns IMAGE_QUALITY parameter or an empty string if not defined. More... | |
| int | imageQualityAsInt () const |
| Returns IMAGE_QUALITY parameter as an integer. More... | |
| Format | infoFormat () const |
| Returns infoFormat. More... | |
| QString | infoFormatAsString () const |
| Returns INFO_FORMAT parameter as a string. More... | |
| bool | infoFormatIsImage () const |
| Checks if INFO_FORMAT parameter is one of the image formats (PNG, JPG). More... | |
| int | infoFormatVersion () const |
| Returns the infoFormat version for GML. More... | |
| QFont | itemFont () const |
| Returns the item font (built thanks to the ITEMFONTFAMILY, ITEMFONTSIZE, ITEMFONTBOLD, ... More... | |
| QString | itemFontBold () const |
| Returns ITEMFONTBOLD parameter or an empty string if not defined. More... | |
| bool | itemFontBoldAsBool () const |
| Returns ITEMFONTBOLD as a boolean or its default value if not defined. More... | |
| QString | itemFontColor () const |
| Returns ITEMFONTCOLOR parameter or an empty string if not defined. More... | |
| QColor | itemFontColorAsColor () const |
| Returns ITEMFONTCOLOR as a color. More... | |
| QString | itemFontFamily () const |
| Returns ITEMFONTFAMILY parameter or an empty string if not defined. More... | |
| QString | itemFontItalic () const |
| Returns ITEMFONTITALIC parameter or an empty string if not defined. More... | |
| bool | itemFontItalicAsBool () const |
| Returns ITEMFONTITALIC as a boolean or its default value if not defined. More... | |
| QString | itemFontSize () const |
| Returns ITEMFONTSIZE parameter or an empty string if not defined. More... | |
| double | itemFontSizeAsDouble () const |
| Returns ITEMFONTSIZE as a double. More... | |
| QString | j () const |
| Returns J parameter or an empty string if not defined. More... | |
| int | jAsInt () const |
| Returns J parameter as an int or its default value if not defined. More... | |
| QFont | layerFont () const |
| Returns the layer font (built thanks to the LAYERFONTFAMILY, LAYERFONTSIZE, LAYERFONTBOLD, ... More... | |
| QString | layerFontBold () const |
| Returns LAYERFONTBOLD parameter or an empty string if not defined. More... | |
| bool | layerFontBoldAsBool () const |
| Returns LAYERFONTBOLD as a boolean or its default value if not defined. More... | |
| QString | layerFontColor () const |
| Returns LAYERFONTCOLOR parameter or an empty string if not defined. More... | |
| QColor | layerFontColorAsColor () const |
| Returns LAYERFONTCOLOR as a color or its defined value if not defined. More... | |
| QString | layerFontFamily () const |
| Returns LAYERFONTFAMILY parameter or an empty string if not defined. More... | |
| QString | layerFontItalic () const |
| Returns LAYERFONTITALIC parameter or an empty string if not defined. More... | |
| bool | layerFontItalicAsBool () const |
| Returns LAYERFONTITALIC as a boolean or its default value if not defined. More... | |
| QString | layerFontSize () const |
| Returns LAYERFONTSIZE parameter or an empty string if not defined. More... | |
| double | layerFontSizeAsDouble () const |
| Returns LAYERFONTSIZE as a double. More... | |
| QString | layerSpace () const |
| Returns LAYERSPACE parameter or an empty string if not defined. More... | |
| double | layerSpaceAsDouble () const |
| Returns LAYERSPACE as a double or its default value if not defined. More... | |
| QList< QgsWmsParametersLayer > | layersParameters () const |
| Returns parameters for each layer found in LAYER/LAYERS. More... | |
| QString | layerTitle () const |
| Returns LAYERTITLE parameter or an empty string if not defined. More... | |
| bool | layerTitleAsBool () const |
| Returns LAYERTITLE as a bool or its default value if not defined. More... | |
| QString | layerTitleSpace () const |
| Returns LAYERTITLESPACE parameter or an empty string if not defined. More... | |
| double | layerTitleSpaceAsDouble () const |
| Returns LAYERTITLESPACE as a double. More... | |
| QString | layoutParameter (const QString &id, bool &ok) const |
| Returns a layout parameter thanks to its id. More... | |
| QgsLegendSettings | legendSettings () const |
| Returns legend settings. More... | |
| QString | lineTolerance () const |
| Returns FI_LINE_TOLERANCE parameter or an empty string if not defined. More... | |
| int | lineToleranceAsInt () const |
| Returns FI_LINE_TOLERANCE parameter as an integer. More... | |
| QStringList | opacities () const |
| Returns the list of opacities found in OPACITIES parameter. More... | |
| QList< int > | opacitiesAsInt () const |
| Returns the list of opacities found in OPACITIES parameter as integers. More... | |
| QString | pointTolerance () const |
| Returns FI_POINT_TOLERANCE parameter or an empty string if not defined. More... | |
| int | pointToleranceAsInt () const |
| Returns FI_POINT_TOLERANCE parameter as an integer. More... | |
| QString | polygonTolerance () const |
| Returns FI_POLYGON_TOLERANCE parameter or an empty string if not defined. More... | |
| int | polygonToleranceAsInt () const |
| Returns FI_POLYGON_TOLERANCE parameter as an integer. More... | |
| QStringList | queryLayersNickname () const |
| Returns nickname of layers found in QUERY_LAYERS parameter. More... | |
| QString | rule () const |
| Returns RULE parameter or an empty string if none is defined. More... | |
| QString | ruleLabel () const |
| Returns RULELABEL parameter or an empty string if none is defined. More... | |
| bool | ruleLabelAsBool () const |
| Returns RULELABEL as a bool. More... | |
| QString | scale () const |
| Returns SCALE parameter or an empty string if none is defined. More... | |
| double | scaleAsDouble () const |
| Returns SCALE as a double. More... | |
| QStringList | selections () const |
| Returns the list of feature selection found in SELECTION parameter. More... | |
| QString | showFeatureCount () const |
| Returns SHOWFEATURECOUNT parameter or an empty string if none is defined. More... | |
| bool | showFeatureCountAsBool () const |
| Returns SHOWFEATURECOUNT as a bool. More... | |
| QString | sldBody () const |
| Returns SLD_body if defined or an empty string. More... | |
| QString | srcHeight () const |
| Returns SRCHEIGHT parameter or an empty string if not defined. More... | |
| int | srcHeightAsInt () const |
| Returns SRCHEIGHT parameter as an int or its default value if not defined. More... | |
| QString | srcWidth () const |
| Returns SRCWIDTH parameter or an empty string if not defined. More... | |
| int | srcWidthAsInt () const |
| Returns SRCWIDTH parameter as an int or its default value if not defined. More... | |
| QString | symbolHeight () const |
| Returns SYMBOLHEIGHT parameter or an empty string if not defined. More... | |
| double | symbolHeightAsDouble () const |
| Returns SYMBOLHEIGHT as a double or its default value if not defined. More... | |
| QString | symbolSpace () const |
| Returns SYMBOLSPACE parameter or an empty string if not defined. More... | |
| double | symbolSpaceAsDouble () const |
| Returns SYMBOLSPACE as a double or its default value if not defined. More... | |
| QString | symbolWidth () const |
| Returns SYMBOLWIDTH parameter or an empty string if not defined. More... | |
| double | symbolWidthAsDouble () const |
| Returns SYMBOLWIDTH as a double or its default value if not defined. More... | |
| QString | transparent () const |
| Returns TRANSPARENT parameter or an empty string if not defined. More... | |
| bool | transparentAsBool () const |
| Returns TRANSPARENT parameter as a bool or its default value if not defined. More... | |
| QgsProjectVersion | versionAsNumber () const |
| Returns VERSION parameter if defined or its default value. More... | |
| bool | versionIsValid (const QString version) const |
| Returns true if version is valid, false otherwise. More... | |
| QString | width () const |
| Returns WIDTH parameter or an empty string if not defined. More... | |
| int | widthAsInt () const |
| Returns WIDTH parameter as an int or its default value if not defined. More... | |
| bool | withGeometry () const |
| Returns if the client wants the feature info response with geometry information. More... | |
| bool | withMapTip () const |
| withMapTip More... | |
| QString | wmsPrecision () const |
| Returns WMS_PRECISION parameter or an empty string if not defined. More... | |
| int | wmsPrecisionAsInt () const |
| Returns WMS_PRECISION parameter as an int or its default value if not defined. More... | |
| QString | wmtver () const |
| Returns WMTVER parameter or an empty string if not defined. More... | |
| QString | x () const |
| Returns X parameter or an empty string if not defined. More... | |
| int | xAsInt () const |
| Returns X parameter as an int or its default value if not defined. More... | |
| QString | y () const |
| Returns Y parameter or an empty string if not defined. More... | |
| int | yAsInt () const |
| Returns Y parameter as an int or its default value if not defined. More... | |
 Public Member Functions inherited from QgsServerParameters | |
| QgsServerParameters () | |
| Constructor. More... | |
| QgsServerParameters (const QUrlQuery &query) | |
| Constructor. More... | |
| virtual | ~QgsServerParameters ()=default |
| void | add (const QString &key, const QString &value) |
| Adds a parameter. More... | |
| void | clear () |
| Removes all parameters. More... | |
| QString | fileName () const |
| Returns FILE_NAME parameter as a string or an empty string if not defined. More... | |
| void | load (const QUrlQuery &query) |
| Loads new parameters. More... | |
| QString | map () const |
| Returns MAP parameter as a string or an empty string if not defined. More... | |
| void | remove (const QString &key) |
| Removes a parameter. More... | |
| void | remove (QgsServerParameter::Name name) |
| Removes a parameter. More... | |
| QString | request () const |
| Returns REQUEST parameter as a string or an empty string if not defined. More... | |
| QString | service () const |
| Returns SERVICE parameter as a string or an empty string if not defined. More... | |
| QMap< QString, QString > | toMap () const |
| Returns all parameters in a map. More... | |
| QUrlQuery | urlQuery () const |
| Returns a url query with underlying parameters. More... | |
| QString | value (const QString &key) const |
| Returns the value of a parameter. More... | |
| QString | version () const |
| Returns VERSION parameter as a string or an empty string if not defined. More... | |
Friends | |
| class | QgsRenderer |
Additional Inherited Members | |
| Protected Attributes inherited from QgsServerParameters | |
| QMap< QString, QString > | mUnmanagedParameters |
Provides an interface to retrieve and manipulate WMS parameters received from the client.
Definition at line 309 of file qgswmsparameters.h.
Output format for the response.
| Enumerator | |
|---|---|
| NONE | |
| JPG | |
| PNG | |
| TEXT | |
| XML | |
| HTML | |
| GML | |
Definition at line 316 of file qgswmsparameters.h.
| QgsWms::QgsWmsParameters::QgsWmsParameters | ( | const QgsServerParameters & | parameters | ) |
Constructor for WMS parameters with specific values.
| parameters | Map of parameters where keys are parameters' names. |
Definition at line 518 of file qgswmsparameters.cpp.
| QgsWms::QgsWmsParameters::QgsWmsParameters | ( | ) |
Constructor for WMS parameters with default values only.
Definition at line 207 of file qgswmsparameters.cpp.
|
overridevirtualdefault |
| QStringList QgsWms::QgsWmsParameters::allLayersNickname | ( | ) | const |
Returns nickname of layers found in LAYER and LAYERS parameters.
Definition at line 1333 of file qgswmsparameters.cpp.
| QStringList QgsWms::QgsWmsParameters::allStyles | ( | ) | const |
Returns styles found in STYLE and STYLES parameters.
Definition at line 1345 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::backgroundColor | ( | ) | const |
Returns BGCOLOR parameter or an empty string if not defined.
Definition at line 1516 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 1521 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::bbox | ( | ) | const |
Returns BBOX if defined or an empty string.
Definition at line 664 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 669 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::boxSpace | ( | ) | const |
Returns BOXSPACE parameter or an empty string if not defined.
Definition at line 917 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 922 of file qgswmsparameters.cpp.
| 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.
| mapId | the composer map id. |
| QgsBadRequestException |
Definition at line 1531 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::composerTemplate | ( | ) | const |
Returns TEMPLATE parameter or an empty string if not defined.
Definition at line 1526 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::crs | ( | ) | const |
Returns CRS or an empty string if none is defined.
Definition at line 641 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::dpi | ( | ) | const |
Returns DPI parameter or an empty string if not defined.
Definition at line 714 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 719 of file qgswmsparameters.cpp.
| void QgsWms::QgsWmsParameters::dump | ( | ) | const |
Dumps parameters.
Definition at line 590 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::externalWMSUri | ( | const QString & | id | ) | const |
Returns the external WMS uri.
| id | the id of the external wms |
Definition at line 1731 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::featureCount | ( | ) | const |
Returns FEATURE_COUNT parameter or an empty string if none is defined.
Definition at line 907 of file qgswmsparameters.cpp.
| int QgsWms::QgsWmsParameters::featureCountAsInt | ( | ) | const |
Returns FEATURE_COUNT as an integer.
An exception is raised if an invalid parameter is found.
| QgsBadRequestException |
Definition at line 912 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::filterGeom | ( | ) | const |
Returns the filter geometry found in FILTER_GEOM parameter.
Definition at line 1313 of file qgswmsparameters.cpp.
| QStringList QgsWms::QgsWmsParameters::filters | ( | ) | const |
Returns the list of filters found in FILTER parameter.
Definition at line 1268 of file qgswmsparameters.cpp.
| QgsWmsParameters::Format QgsWms::QgsWmsParameters::format | ( | ) | const |
Returns format.
If the FORMAT parameter is not used, then the default value is PNG.
Definition at line 752 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::formatAsString | ( | ) | const |
Returns FORMAT parameter as a string.
Definition at line 747 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::height | ( | ) | const |
Returns HEIGHT parameter or an empty string if not defined.
Definition at line 674 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 684 of file qgswmsparameters.cpp.
| QStringList QgsWms::QgsWmsParameters::highlightGeom | ( | ) | const |
Returns HIGHLIGHT_GEOM as a list of string in WKT.
Definition at line 626 of file qgswmsparameters.cpp.
| QList< QgsGeometry > QgsWms::QgsWmsParameters::highlightGeomAsGeom | ( | ) | const |
Returns HIGHLIGHT_GEOM as a list of geometries.
An exception is raised if an invalid geometry is found.
| QgsBadRequestException |
Definition at line 631 of file qgswmsparameters.cpp.
| QStringList QgsWms::QgsWmsParameters::highlightLabelBufferColor | ( | ) | const |
Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of string.
Definition at line 1233 of file qgswmsparameters.cpp.
| QList< QColor > QgsWms::QgsWmsParameters::highlightLabelBufferColorAsColor | ( | ) | const |
Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of colors.
An axception is raised if an invalid color is found.
| QgsBadRequestException |
Definition at line 1238 of file qgswmsparameters.cpp.
| QStringList QgsWms::QgsWmsParameters::highlightLabelBufferSize | ( | ) | const |
Returns HIGHLIGHT_LABELBUFFERSIZE.
Definition at line 1243 of file qgswmsparameters.cpp.
| QList< double > QgsWms::QgsWmsParameters::highlightLabelBufferSizeAsFloat | ( | ) | const |
Returns HIGHLIGHT_LABELBUFFERSIZE as a list of float.
An exception is raised if an invalid size is found.
| QgsBadRequestException |
Definition at line 1248 of file qgswmsparameters.cpp.
| QStringList QgsWms::QgsWmsParameters::highlightLabelColor | ( | ) | const |
Returns HIGHLIGHT_LABELCOLOR as a list of string.
Definition at line 1208 of file qgswmsparameters.cpp.
| QList< QColor > QgsWms::QgsWmsParameters::highlightLabelColorAsColor | ( | ) | const |
Returns HIGHLIGHT_LABELCOLOR as a list of color.
An exception is raised if an invalid color is found.
| QgsBadRequestException |
Definition at line 1213 of file qgswmsparameters.cpp.
| QStringList QgsWms::QgsWmsParameters::highlightLabelFont | ( | ) | const |
Returns HIGHLIGHT_LABELFONT.
Definition at line 1228 of file qgswmsparameters.cpp.
| QStringList QgsWms::QgsWmsParameters::highlightLabelSize | ( | ) | const |
Returns HIGHLIGHT_LABELSIZE as a list of string.
Definition at line 1198 of file qgswmsparameters.cpp.
| QList< int > QgsWms::QgsWmsParameters::highlightLabelSizeAsInt | ( | ) | const |
Returns HIGHLIGHT_LABELSIZE as a list of int An exception is raised if an invalid size is found.
| QgsBadRequestException |
Definition at line 1203 of file qgswmsparameters.cpp.
| QStringList QgsWms::QgsWmsParameters::highlightLabelString | ( | ) | const |
Returns HIGHLIGHT_LABELSTRING as a list of string.
Definition at line 1193 of file qgswmsparameters.cpp.
| QStringList QgsWms::QgsWmsParameters::highlightLabelWeight | ( | ) | const |
Returns HIGHLIGHT_LABELWEIGHT as a list of string.
Definition at line 1218 of file qgswmsparameters.cpp.
| QList< int > QgsWms::QgsWmsParameters::highlightLabelWeightAsInt | ( | ) | const |
Returns HIGHLIGHT_LABELWEIGHT as a list of int.
An exception is raised if an invalid weight is found.
| QgsBadRequestException |
Definition at line 1223 of file qgswmsparameters.cpp.
| QList< QgsWmsParametersHighlightLayer > QgsWms::QgsWmsParameters::highlightLayersParameters | ( | ) | const |
Returns parameters for each highlight layer.
Definition at line 1468 of file qgswmsparameters.cpp.
| QStringList QgsWms::QgsWmsParameters::highlightSymbol | ( | ) | const |
Returns HIGHLIGHT_SYMBOL as a list of string.
Definition at line 636 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::i | ( | ) | const |
Returns I parameter or an empty string if not defined.
Definition at line 812 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 822 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::iconLabelSpace | ( | ) | const |
Returns ICONLABELSPACE parameter or an empty string if not defined.
Definition at line 977 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 982 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::imageQuality | ( | ) | const |
Returns IMAGE_QUALITY parameter or an empty string if not defined.
Definition at line 887 of file qgswmsparameters.cpp.
| int QgsWms::QgsWmsParameters::imageQualityAsInt | ( | ) | const |
Returns IMAGE_QUALITY parameter as an integer.
| QgsBadRequestException |
Definition at line 892 of file qgswmsparameters.cpp.
| QgsWmsParameters::Format QgsWms::QgsWmsParameters::infoFormat | ( | ) | const |
Returns infoFormat.
If the INFO_FORMAT parameter is not used, then the default value is text/plain.
Definition at line 778 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::infoFormatAsString | ( | ) | const |
Returns INFO_FORMAT parameter as a string.
Definition at line 768 of file qgswmsparameters.cpp.
| bool QgsWms::QgsWmsParameters::infoFormatIsImage | ( | ) | const |
Checks if INFO_FORMAT parameter is one of the image formats (PNG, JPG).
Definition at line 773 of file qgswmsparameters.cpp.
| int QgsWms::QgsWmsParameters::infoFormatVersion | ( | ) | const |
Returns the infoFormat version for GML.
If the INFO_FORMAT is not GML, then the default value is -1.
Definition at line 800 of file qgswmsparameters.cpp.
| QFont QgsWms::QgsWmsParameters::itemFont | ( | ) | const |
Returns the item font (built thanks to the ITEMFONTFAMILY, ITEMFONTSIZE, ITEMFONTBOLD, ...
parameters).
Definition at line 1123 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::itemFontBold | ( | ) | const |
Returns ITEMFONTBOLD parameter or an empty string if not defined.
Definition at line 1007 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 1042 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::itemFontColor | ( | ) | const |
Returns ITEMFONTCOLOR parameter or an empty string if not defined.
Definition at line 1097 of file qgswmsparameters.cpp.
| QColor QgsWms::QgsWmsParameters::itemFontColorAsColor | ( | ) | const |
Returns ITEMFONTCOLOR as a color.
An exception is raised if an invalid parameter is found.
| QgsBadRequestException |
Definition at line 1102 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::itemFontFamily | ( | ) | const |
Returns ITEMFONTFAMILY parameter or an empty string if not defined.
Definition at line 992 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::itemFontItalic | ( | ) | const |
Returns ITEMFONTITALIC parameter or an empty string if not defined.
Definition at line 1057 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 1062 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::itemFontSize | ( | ) | const |
Returns ITEMFONTSIZE parameter or an empty string if not defined.
Definition at line 1087 of file qgswmsparameters.cpp.
| double QgsWms::QgsWmsParameters::itemFontSizeAsDouble | ( | ) | const |
Returns ITEMFONTSIZE as a double.
An exception is raised if an invalid parameter is found.
| QgsBadRequestException |
Definition at line 1092 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::j | ( | ) | const |
Returns J parameter or an empty string if not defined.
Definition at line 817 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 827 of file qgswmsparameters.cpp.
| QFont QgsWms::QgsWmsParameters::layerFont | ( | ) | const |
Returns the layer font (built thanks to the LAYERFONTFAMILY, LAYERFONTSIZE, LAYERFONTBOLD, ...
parameters).
Definition at line 1107 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::layerFontBold | ( | ) | const |
Returns LAYERFONTBOLD parameter or an empty string if not defined.
Definition at line 997 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 1002 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::layerFontColor | ( | ) | const |
Returns LAYERFONTCOLOR parameter or an empty string if not defined.
Definition at line 1077 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 1082 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::layerFontFamily | ( | ) | const |
Returns LAYERFONTFAMILY parameter or an empty string if not defined.
Definition at line 987 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::layerFontItalic | ( | ) | const |
Returns LAYERFONTITALIC parameter or an empty string if not defined.
Definition at line 1047 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 1052 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::layerFontSize | ( | ) | const |
Returns LAYERFONTSIZE parameter or an empty string if not defined.
Definition at line 1067 of file qgswmsparameters.cpp.
| double QgsWms::QgsWmsParameters::layerFontSizeAsDouble | ( | ) | const |
Returns LAYERFONTSIZE as a double.
An exception is raised if an invalid parameter is found.
| QgsBadRequestException |
Definition at line 1072 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::layerSpace | ( | ) | const |
Returns LAYERSPACE parameter or an empty string if not defined.
Definition at line 927 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 932 of file qgswmsparameters.cpp.
| QList< QgsWmsParametersLayer > QgsWms::QgsWmsParameters::layersParameters | ( | ) | const |
Returns parameters for each layer found in LAYER/LAYERS.
Definition at line 1403 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::layerTitle | ( | ) | const |
Returns LAYERTITLE parameter or an empty string if not defined.
Definition at line 1140 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 1145 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::layerTitleSpace | ( | ) | const |
Returns LAYERTITLESPACE parameter or an empty string if not defined.
Definition at line 937 of file qgswmsparameters.cpp.
| double QgsWms::QgsWmsParameters::layerTitleSpaceAsDouble | ( | ) | const |
Returns LAYERTITLESPACE as a double.
An exception is raised if an invalid parameter is found.
| QgsBadRequestException |
Definition at line 942 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::layoutParameter | ( | const QString & | id, |
| bool & | ok | ||
| ) | const |
Returns a layout parameter thanks to its id.
| id | Parameter id |
| ok | True if the parameter is valid, false otherwise |
Definition at line 1179 of file qgswmsparameters.cpp.
| QgsLegendSettings QgsWms::QgsWmsParameters::legendSettings | ( | ) | const |
Returns legend settings.
Definition at line 1150 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::lineTolerance | ( | ) | const |
Returns FI_LINE_TOLERANCE parameter or an empty string if not defined.
Definition at line 1017 of file qgswmsparameters.cpp.
| int QgsWms::QgsWmsParameters::lineToleranceAsInt | ( | ) | const |
Returns FI_LINE_TOLERANCE parameter as an integer.
| QgsBadRequestException |
Definition at line 1032 of file qgswmsparameters.cpp.
| QStringList QgsWms::QgsWmsParameters::opacities | ( | ) | const |
Returns the list of opacities found in OPACITIES parameter.
Definition at line 1323 of file qgswmsparameters.cpp.
| 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
| QgsBadRequestException |
Definition at line 1328 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::pointTolerance | ( | ) | const |
Returns FI_POINT_TOLERANCE parameter or an empty string if not defined.
Definition at line 1022 of file qgswmsparameters.cpp.
| int QgsWms::QgsWmsParameters::pointToleranceAsInt | ( | ) | const |
Returns FI_POINT_TOLERANCE parameter as an integer.
| QgsBadRequestException |
Definition at line 1037 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::polygonTolerance | ( | ) | const |
Returns FI_POLYGON_TOLERANCE parameter or an empty string if not defined.
Definition at line 1012 of file qgswmsparameters.cpp.
| int QgsWms::QgsWmsParameters::polygonToleranceAsInt | ( | ) | const |
Returns FI_POLYGON_TOLERANCE parameter as an integer.
| QgsBadRequestException |
Definition at line 1027 of file qgswmsparameters.cpp.
| QStringList QgsWms::QgsWmsParameters::queryLayersNickname | ( | ) | const |
Returns nickname of layers found in QUERY_LAYERS parameter.
Definition at line 1340 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::rule | ( | ) | const |
Returns RULE parameter or an empty string if none is defined.
Definition at line 852 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::ruleLabel | ( | ) | const |
Returns RULELABEL parameter or an empty string if none is defined.
Definition at line 857 of file qgswmsparameters.cpp.
| bool QgsWms::QgsWmsParameters::ruleLabelAsBool | ( | ) | const |
Returns RULELABEL as a bool.
An exception is raised if an invalid parameter is found.
| QgsBadRequestException |
Definition at line 862 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::scale | ( | ) | const |
Returns SCALE parameter or an empty string if none is defined.
Definition at line 877 of file qgswmsparameters.cpp.
| double QgsWms::QgsWmsParameters::scaleAsDouble | ( | ) | const |
Returns SCALE as a double.
An exception is raised if an invalid parameter is found.
| QgsBadRequestException |
Definition at line 882 of file qgswmsparameters.cpp.
| QStringList QgsWms::QgsWmsParameters::selections | ( | ) | const |
Returns the list of feature selection found in SELECTION parameter.
Definition at line 1318 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::showFeatureCount | ( | ) | const |
Returns SHOWFEATURECOUNT parameter or an empty string if none is defined.
Definition at line 897 of file qgswmsparameters.cpp.
| bool QgsWms::QgsWmsParameters::showFeatureCountAsBool | ( | ) | const |
Returns SHOWFEATURECOUNT as a bool.
An exception is raised if an invalid parameter is found.
| QgsBadRequestException |
Definition at line 902 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::sldBody | ( | ) | const |
Returns SLD_body if defined or an empty string.
Definition at line 1263 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::srcHeight | ( | ) | const |
Returns SRCHEIGHT parameter or an empty string if not defined.
Definition at line 694 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 704 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::srcWidth | ( | ) | const |
Returns SRCWIDTH parameter or an empty string if not defined.
Definition at line 699 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 709 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::symbolHeight | ( | ) | const |
Returns SYMBOLHEIGHT parameter or an empty string if not defined.
Definition at line 957 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 962 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::symbolSpace | ( | ) | const |
Returns SYMBOLSPACE parameter or an empty string if not defined.
Definition at line 947 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 952 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::symbolWidth | ( | ) | const |
Returns SYMBOLWIDTH parameter or an empty string if not defined.
Definition at line 967 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 972 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::transparent | ( | ) | const |
Returns TRANSPARENT parameter or an empty string if not defined.
Definition at line 867 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 872 of file qgswmsparameters.cpp.
| QgsProjectVersion QgsWms::QgsWmsParameters::versionAsNumber | ( | ) | const |
Returns VERSION parameter if defined or its default value.
Definition at line 724 of file qgswmsparameters.cpp.
| bool QgsWms::QgsWmsParameters::versionIsValid | ( | const QString | version | ) | const |
Returns true if version is valid, false otherwise.
Definition at line 742 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::width | ( | ) | const |
Returns WIDTH parameter or an empty string if not defined.
Definition at line 679 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 689 of file qgswmsparameters.cpp.
| bool QgsWms::QgsWmsParameters::withGeometry | ( | ) | const |
Returns if the client wants the feature info response with geometry information.
Definition at line 1748 of file qgswmsparameters.cpp.
| bool QgsWms::QgsWmsParameters::withMapTip | ( | ) | const |
withMapTip
Definition at line 1753 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::wmsPrecision | ( | ) | const |
Returns WMS_PRECISION parameter or an empty string if not defined.
Definition at line 1253 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 1258 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::wmtver | ( | ) | const |
Returns WMTVER parameter or an empty string if not defined.
Definition at line 1758 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::x | ( | ) | const |
Returns X parameter or an empty string if not defined.
Definition at line 832 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 842 of file qgswmsparameters.cpp.
| QString QgsWms::QgsWmsParameters::y | ( | ) | const |
Returns Y parameter or an empty string if not defined.
Definition at line 837 of file qgswmsparameters.cpp.
| 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.
| QgsBadRequestException |
Definition at line 847 of file qgswmsparameters.cpp.
|
friend |
Definition at line 1214 of file qgswmsparameters.h.
1.8.11
