Changeset View
Changeset View
Standalone View
Standalone View
src/ksanewidget.h
Show First 20 Lines • Show All 205 Lines • ▼ Show 20 Line(s) | 52 | public: | |||
---|---|---|---|---|---|
206 | 206 | | |||
207 | /** This method reads the available parameters and their values and | 207 | /** This method reads the available parameters and their values and | ||
208 | * returns them in a QMap (Name, value) | 208 | * returns them in a QMap (Name, value) | ||
209 | * @param opts is a QMap with the parameter names and values. */ | 209 | * @param opts is a QMap with the parameter names and values. */ | ||
210 | void getOptVals(QMap <QString, QString> &opts); | 210 | void getOptVals(QMap <QString, QString> &opts); | ||
211 | 211 | | |||
212 | /** This method can be used to write many parameter values at once. | 212 | /** This method can be used to write many parameter values at once. | ||
213 | * @param opts is a QMap with the parameter names and values. | 213 | * @param opts is a QMap with the parameter names and values. | ||
214 | * @return This function returns the number of successful writes. */ | 214 | * @return This function returns the number of successful writes | ||
215 | * or -1 if scanning is in progress. */ | ||||
215 | int setOptVals(const QMap <QString, QString> &opts); | 216 | int setOptVals(const QMap <QString, QString> &opts); | ||
216 | 217 | | |||
217 | /** This function reads one parameter value into a string. | 218 | /** This function reads one parameter value into a string. | ||
218 | * @param optname is the name of the parameter to read. | 219 | * @param optname is the name of the parameter to read. | ||
219 | * @param value is the string representation of the value. | 220 | * @param value is the string representation of the value. | ||
220 | * @return this function returns true if the read was successful. */ | 221 | * @return this function returns true if the read was successful. */ | ||
221 | bool getOptVal(const QString &optname, QString &value); | 222 | bool getOptVal(const QString &optname, QString &value); | ||
222 | 223 | | |||
223 | /** This function writes one parameter value into a string. | 224 | /** This function writes one parameter value into a string. | ||
224 | * @param optname is the name of the parameter to write. | 225 | * @param optname is the name of the parameter to write. | ||
225 | * @param value is the string representation of the value. | 226 | * @param value is the string representation of the value. | ||
226 | * @return this function returns true if the write was successful. */ | 227 | * @return this function returns true if the write was successful and | ||
228 | * false if it was unsuccessful or scanning is in progress. */ | ||||
227 | bool setOptVal(const QString &optname, const QString &value); | 229 | bool setOptVal(const QString &optname, const QString &value); | ||
228 | 230 | | |||
229 | /** This function sets the label on the final scan button | 231 | /** This function sets the label on the final scan button | ||
230 | * @param scanLabel is the new label for the button. */ | 232 | * @param scanLabel is the new label for the button. */ | ||
231 | void setScanButtonText(const QString &scanLabel); | 233 | void setScanButtonText(const QString &scanLabel); | ||
232 | 234 | | |||
233 | /** This function sets the label on the preview button | 235 | /** This function sets the label on the preview button | ||
234 | * @param previewLabel is the new label for the button. */ | 236 | * @param previewLabel is the new label for the button. */ | ||
▲ Show 20 Lines • Show All 91 Lines • Show Last 20 Lines |