Skip to content

Commit 9e4c3f2

Browse files
committedJul 23, 2018
Update doc for QgsWmsParameters
1 parent 77af2ca commit 9e4c3f2

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed
 

‎src/server/services/wms/qgswmsparameters.h

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,10 @@ namespace QgsWms
338338
*/
339339
QgsProjectVersion versionAsNumber() const;
340340

341+
/**
342+
* Returns true if \a version is valid, false otherwise.
343+
* \since QGIS 3.4
344+
*/
341345
bool versionIsValid( const QString version ) const;
342346

343347
/**
@@ -417,16 +421,46 @@ namespace QgsWms
417421
*/
418422
QList<QgsWmsParametersLayer> layersParameters() const;
419423

424+
/**
425+
* Returns FI_POLYGON_TOLERANCE parameter or an empty string if not
426+
* defined.
427+
* \since QGIS 3.4
428+
*/
420429
QString polygonTolerance() const;
421430

431+
/**
432+
* Returns FI_LINE_TOLERANCE parameter or an empty string if not
433+
* defined.
434+
* \since QGIS 3.4
435+
*/
422436
QString lineTolerance() const;
423437

438+
/**
439+
* Returns FI_POINT_TOLERANCE parameter or an empty string if not
440+
* defined.
441+
* \since QGIS 3.4
442+
*/
424443
QString pointTolerance() const;
425444

445+
/**
446+
* Returns FI_POLYGON_TOLERANCE parameter as an integer.
447+
* \throws QgsBadRequestException
448+
* \since QGIS 3.4
449+
*/
426450
int polygonToleranceAsInt() const;
427451

452+
/**
453+
* Returns FI_LINE_TOLERANCE parameter as an integer.
454+
* \throws QgsBadRequestException
455+
* \since QGIS 3.4
456+
*/
428457
int lineToleranceAsInt() const;
429458

459+
/**
460+
* Returns FI_POINT_TOLERANCE parameter as an integer.
461+
* \throws QgsBadRequestException
462+
* \since QGIS 3.4
463+
*/
430464
int pointToleranceAsInt() const;
431465

432466
/**
@@ -454,8 +488,18 @@ namespace QgsWms
454488
*/
455489
bool infoFormatIsImage() const;
456490

491+
/**
492+
* Returns IMAGE_QUALITY parameter or an empty string if not
493+
* defined.
494+
* \since QGIS 3.4
495+
*/
457496
QString imageQuality() const;
458497

498+
/**
499+
* Returns IMAGE_QUALITY parameter as an integer.
500+
* \throws QgsBadRequestException
501+
* \since QGIS 3.4
502+
*/
459503
int imageQualityAsInt() const;
460504

461505
/**
@@ -1054,8 +1098,19 @@ namespace QgsWms
10541098
*/
10551099
bool withMapTip() const;
10561100

1101+
/**
1102+
* Returns WMTVER parameter or an empty string if not defined.
1103+
* \since QGIS 3.4
1104+
*/
10571105
QString wmtver() const;
10581106

1107+
/**
1108+
* Returns a layout parameter thanks to its \a id.
1109+
* \param id Parameter id
1110+
* \param ok True if the parameter is valid, false otherwise
1111+
* \returns The layout parameter
1112+
* \since QGIS 3.4
1113+
*/
10591114
QString layoutParameter( const QString &id, bool &ok ) const;
10601115

10611116
private:

0 commit comments

Comments
 (0)
Please sign in to comment.