File: qgsprojectservervalidator.sip.in

package info (click to toggle)
qgis 3.40.6%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 1,181,336 kB
  • sloc: cpp: 1,593,302; python: 370,494; xml: 23,474; perl: 3,664; sh: 3,482; ansic: 2,257; sql: 2,133; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 157
file content (81 lines) | stat: -rw-r--r-- 2,503 bytes parent folder | download | duplicates (10)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/project/qgsprojectservervalidator.h                         *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/





class QgsProjectServerValidator
{
%Docstring(signature="appended")
Validates the server specific parts of the configuration of a QGIS
project.

.. versionadded:: 3.14
%End

%TypeHeaderCode
#include "qgsprojectservervalidator.h"
%End
  public:

    QgsProjectServerValidator();

    enum ValidationError /BaseType=IntEnum/
    {
      DuplicatedNames,
      LayerShortName,
      LayerEncoding,
      ProjectShortName,
      ProjectRootNameConflict,
    };

    static QString displayValidationError( QgsProjectServerValidator::ValidationError error );
%Docstring
Returns a human readable string for a given error.

:param error: the error.

:return: the human readable error.
%End

    struct ValidationResult
    {

      ValidationResult( const QgsProjectServerValidator::ValidationError error, const QVariant &identifier );
%Docstring
Constructor for ValidationResult.
%End

      QgsProjectServerValidator::ValidationError error;

      QVariant identifier;
    };

    static bool validate( QgsProject *project, QList< QgsProjectServerValidator::ValidationResult > &results /Out/ );
%Docstring
Validates a project to detect problems on QGIS Server, and returns
``True`` if it's considered valid. If validation fails, the ``results``
list will be filled with a list of items describing why the validation
failed and what needs to be rectified

:param project: input project to check

:return: - bool
         - results: results of the validation
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/project/qgsprojectservervalidator.h                         *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/