Skip to content

Commit 66c78f7

Browse files
committedJul 13, 2018
Update doc for QgsWmsParameters
1 parent 1286320 commit 66c78f7

File tree

1 file changed

+73
-73
lines changed

1 file changed

+73
-73
lines changed
 

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

Lines changed: 73 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -78,84 +78,86 @@ namespace QgsWms
7878
Q_GADGET
7979

8080
public:
81+
//! Available parameters for WMS requests
8182
enum ParameterName
8283
{
83-
BOXSPACE,
84-
CRS, // instead of SRS for WMS 1.3.0
85-
SRS, // for WMS 1.1.1
86-
WIDTH,
87-
HEIGHT,
88-
BBOX,
89-
ICONLABELSPACE,
90-
ITEMFONTFAMILY,
91-
ITEMFONTBOLD,
92-
ITEMFONTITALIC,
93-
ITEMFONTSIZE,
94-
ITEMFONTCOLOR,
95-
LAYER,
96-
LAYERFONTFAMILY,
97-
LAYERFONTBOLD,
98-
LAYERFONTITALIC,
99-
LAYERFONTSIZE,
100-
LAYERFONTCOLOR,
101-
LAYERTITLE,
102-
LAYERS,
103-
LAYERSPACE,
104-
LAYERTITLESPACE,
105-
QUERY_LAYERS,
106-
FEATURE_COUNT,
107-
SHOWFEATURECOUNT,
108-
STYLE,
109-
STYLES,
110-
SYMBOLSPACE,
111-
SYMBOLHEIGHT,
112-
SYMBOLWIDTH,
113-
OPACITIES,
114-
SLD,
115-
FILTER,
116-
FILTER_GEOM,
117-
FORMAT,
118-
INFO_FORMAT,
119-
I,
120-
J,
121-
X,
122-
Y,
123-
RULE,
124-
RULELABEL,
125-
SCALE,
126-
SELECTION,
127-
HIGHLIGHT_GEOM,
128-
HIGHLIGHT_SYMBOL,
129-
HIGHLIGHT_LABELSTRING,
130-
HIGHLIGHT_LABELFONT,
131-
HIGHLIGHT_LABELSIZE,
132-
HIGHLIGHT_LABELWEIGHT,
133-
HIGHLIGHT_LABELCOLOR,
134-
HIGHLIGHT_LABELBUFFERCOLOR,
135-
HIGHLIGHT_LABELBUFFERSIZE,
136-
WMS_PRECISION,
137-
TRANSPARENT,
138-
BGCOLOR,
139-
DPI,
140-
TEMPLATE,
141-
EXTENT,
142-
ROTATION,
143-
GRID_INTERVAL_X,
144-
GRID_INTERVAL_Y,
145-
WITH_GEOMETRY,
146-
WITH_MAPTIP
84+
BOXSPACE, //!< BOXSPACE parameter
85+
CRS, //!< Instead of SRS for WMS 1.3.0
86+
SRS, //!< For WMS 1.1.1
87+
WIDTH, //!< With of the resulting image
88+
HEIGHT, //!< Height of the resulting image
89+
BBOX, //!< BBOX parameter
90+
ICONLABELSPACE, //!< ICONLABELSPACE parameter
91+
ITEMFONTFAMILY, //!< ITEMFONTFAMILY parameter
92+
ITEMFONTBOLD, //!< ITEMFONTBOLD parameter
93+
ITEMFONTITALIC, //!< ITEMFONTITALIC parameter
94+
ITEMFONTSIZE, //!< Parameter
95+
ITEMFONTCOLOR, //!< Parameter
96+
LAYER, //!< Parameter
97+
LAYERFONTFAMILY, //!< LAYERFONTFAMILY parameter
98+
LAYERFONTBOLD, //!< LAYERFONTBOLD parameter
99+
LAYERFONTITALIC, //!< LAYERFONTITALIC parameter
100+
LAYERFONTSIZE, //!< LAYERFONTSIZE parameter
101+
LAYERFONTCOLOR, //!< LAYERFONTCOLOR parameter
102+
LAYERTITLE, //!< LAYERTITLE parameter
103+
LAYERS, //!< LAYERS parameter
104+
LAYERSPACE, //!< LAYERSPACE parameter
105+
LAYERTITLESPACE, //!< LAYERTITLESPACE parameter
106+
QUERY_LAYERS, //!< QUERY_LAYERS parameter
107+
FEATURE_COUNT, //!< FEATURE_COUNT parameter
108+
SHOWFEATURECOUNT, //!< SHOWFEATURECOUNT parameter
109+
STYLE, //!< STYLE parameter
110+
STYLES, //!< STYLES parameter
111+
SYMBOLSPACE, //!< SYMBOLSPACE parameter
112+
SYMBOLHEIGHT, //!< SYMBOLHEIGHT parameter
113+
SYMBOLWIDTH, //!< SYMBOLWIDTH parameter
114+
OPACITIES, //!< OPACITIES parameter
115+
SLD, //!< SLD parameter
116+
FILTER, //!< FILTER parameter
117+
FILTER_GEOM, //!< FILTER_GEOM parameter
118+
FORMAT, //!< FORMAT parameter
119+
INFO_FORMAT, //!< INFO_FORMAT parameter
120+
I, //!< I parameter
121+
J, //!< J parameter
122+
X, //!< X parameter
123+
Y, //!< Y parameter
124+
RULE, //!< RULE parameter
125+
RULELABEL, //!< RULELABEL parameter
126+
SCALE, //!< SCALE parameter
127+
SELECTION, //!< SELECTION parameter
128+
HIGHLIGHT_GEOM, //!< HIGHLIGHT_GEOM parameter
129+
HIGHLIGHT_SYMBOL, //!< HIGHLIGHT_SYMBOL parameter
130+
HIGHLIGHT_LABELSTRING, //!< HIGHLIGHT_LABELSTRING parameter
131+
HIGHLIGHT_LABELFONT, //!< HIGHLIGHT_LABELFONT parameter
132+
HIGHLIGHT_LABELSIZE, //!< HIGHLIGHT_LABELSIZE parameter
133+
HIGHLIGHT_LABELWEIGHT, //!< HIGHLIGHT_LABELWEIGHT parameter
134+
HIGHLIGHT_LABELCOLOR, //!< HIGHLIGHT_LABELCOLOR parameter
135+
HIGHLIGHT_LABELBUFFERCOLOR, //!< HIGHLIGHT_LABELBUFFERCOLOR parameter
136+
HIGHLIGHT_LABELBUFFERSIZE, //!< HIGHLIGHT_LABELBUFFERSIZE parameter
137+
WMS_PRECISION, //!< WMS_PRECISION parameter
138+
TRANSPARENT, //!< TRANSPARENT parameter
139+
BGCOLOR, //!< BGCOLOR parameter
140+
DPI, //!< DPI parameter
141+
TEMPLATE, //!< TEMPLATE parameter
142+
EXTENT, //!< EXTENT parameter
143+
ROTATION, //!< ROTATION parameter
144+
GRID_INTERVAL_X, //!< GRID_INTERVAL_X parameter
145+
GRID_INTERVAL_Y, //!< GRID_INTERVAL_Y parameter
146+
WITH_GEOMETRY, //!< WITH_GEOMETRY parameter
147+
WITH_MAPTIP //!< WITH_MAPTIP parameter
147148
};
148149
Q_ENUM( ParameterName )
149150

151+
//! Output format
150152
enum Format
151153
{
152-
NONE,
153-
JPG,
154-
PNG,
155-
TEXT,
156-
XML,
157-
HTML,
158-
GML
154+
NONE, //!< NONE
155+
JPG, //!< JPEG format
156+
PNG, //!< PNG format
157+
TEXT, //!< TEXT format
158+
XML, //!< XML format
159+
HTML, //!< HTML format
160+
GML //!< GML format
159161
};
160162

161163
struct Parameter
@@ -224,8 +226,6 @@ namespace QgsWms
224226
*/
225227
int heightAsInt() const;
226228

227-
bool fake() { return true; }
228-
229229
/**
230230
* Returns VERSION parameter as a string or an empty string if not
231231
* defined.

0 commit comments

Comments
 (0)
Please sign in to comment.