|
| 1 | +/************************************************************************ |
| 2 | + * This file has been generated automatically from * |
| 3 | + * * |
| 4 | + * src/server/qgsserverparameters.h * |
| 5 | + * * |
| 6 | + * Do not edit manually ! Edit header and run scripts/sipify.pl again * |
| 7 | + ************************************************************************/ |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | + |
| 12 | +class QgsServerParameters |
| 13 | +{ |
| 14 | +%Docstring |
| 15 | +QgsServerParameters provides an interface to retrieve and manipulate |
| 16 | +global parameters received from the client. |
| 17 | + |
| 18 | +.. versionadded:: 3.4 |
| 19 | +%End |
| 20 | + |
| 21 | +%TypeHeaderCode |
| 22 | +#include "qgsserverparameters.h" |
| 23 | +%End |
| 24 | + public: |
| 25 | + static const QMetaObject staticMetaObject; |
| 26 | + |
| 27 | + public: |
| 28 | + enum ParameterName |
| 29 | + { |
| 30 | + SERVICE, |
| 31 | + VERSION_SERVICE, |
| 32 | + REQUEST, |
| 33 | + MAP, |
| 34 | + FILE_NAME |
| 35 | + }; |
| 36 | + |
| 37 | + struct Parameter |
| 38 | + { |
| 39 | + ParameterName mName; |
| 40 | + QVariant::Type mType; |
| 41 | + QVariant mDefaultValue; |
| 42 | + QVariant mValue; |
| 43 | + bool mDefined; |
| 44 | + }; |
| 45 | + |
| 46 | + QgsServerParameters(); |
| 47 | +%Docstring |
| 48 | +Constructor. |
| 49 | +%End |
| 50 | + |
| 51 | + QgsServerParameters( const QUrlQuery &query ); |
| 52 | +%Docstring |
| 53 | +Constructor. |
| 54 | +%End |
| 55 | + |
| 56 | + void load( const QUrlQuery &query ); |
| 57 | +%Docstring |
| 58 | +Loads new parameters. |
| 59 | + |
| 60 | +:param query: url query |
| 61 | +%End |
| 62 | + |
| 63 | + void clear(); |
| 64 | +%Docstring |
| 65 | +Removes all parameters. |
| 66 | +%End |
| 67 | + |
| 68 | + void add( const QString &key, const QString &value ); |
| 69 | +%Docstring |
| 70 | +Adds a parameter. |
| 71 | + |
| 72 | +:param key: the name of the parameter |
| 73 | +:param value: the value of the parameter |
| 74 | +%End |
| 75 | + |
| 76 | + void remove( const QString &key ); |
| 77 | +%Docstring |
| 78 | +Removes a parameter. |
| 79 | + |
| 80 | +:param key: the name of the parameter |
| 81 | +%End |
| 82 | + |
| 83 | + QString value( const QString &key ) const; |
| 84 | +%Docstring |
| 85 | +Returns the value of a parameter. |
| 86 | + |
| 87 | +:param key: the name of the parameter |
| 88 | +%End |
| 89 | + |
| 90 | + QUrlQuery urlQuery() const; |
| 91 | +%Docstring |
| 92 | +Returns a url query with underlying parameters. |
| 93 | +%End |
| 94 | + |
| 95 | + QMap<QString, QString> toMap() const; |
| 96 | +%Docstring |
| 97 | +Returns all parameters in a map. |
| 98 | +%End |
| 99 | + |
| 100 | + QString service() const; |
| 101 | +%Docstring |
| 102 | +Returns SERVICE parameter as a string or an empty string if not |
| 103 | +defined. |
| 104 | + |
| 105 | +:return: service |
| 106 | +%End |
| 107 | + |
| 108 | + QString request() const; |
| 109 | +%Docstring |
| 110 | +Returns REQUEST parameter as a string or an empty string if not |
| 111 | +defined. |
| 112 | + |
| 113 | +:return: request |
| 114 | +%End |
| 115 | + |
| 116 | + QString map() const; |
| 117 | +%Docstring |
| 118 | +Returns MAP parameter as a string or an empty string if not |
| 119 | +defined. |
| 120 | + |
| 121 | +:return: map |
| 122 | +%End |
| 123 | + |
| 124 | + QString fileName() const; |
| 125 | +%Docstring |
| 126 | +Returns FILE_NAME parameter as a string or an empty string if not |
| 127 | +defined. |
| 128 | + |
| 129 | +:return: filename |
| 130 | +%End |
| 131 | + |
| 132 | + QString version() const; |
| 133 | +%Docstring |
| 134 | +Returns VERSION parameter as a string or an empty string if not |
| 135 | +defined. |
| 136 | + |
| 137 | +:return: version |
| 138 | +%End |
| 139 | + |
| 140 | +}; |
| 141 | + |
| 142 | +/************************************************************************ |
| 143 | + * This file has been generated automatically from * |
| 144 | + * * |
| 145 | + * src/server/qgsserverparameters.h * |
| 146 | + * * |
| 147 | + * Do not edit manually ! Edit header and run scripts/sipify.pl again * |
| 148 | + ************************************************************************/ |
0 commit comments