File: qgsvaliditycheckregistry.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (82 lines) | stat: -rw-r--r-- 2,861 bytes parent folder | download | duplicates (14)
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
82
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/validity/qgsvaliditycheckregistry.h                         *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/


class QgsValidityCheckRegistry
{
%Docstring(signature="appended")
This class keeps a list of :py:class:`QgsAbstractValidityCheck` checks
which can be used when performing validity checks.

:py:class:`QgsValidityCheckRegistry` is not usually directly created,
but rather accessed through
:py:func:`QgsApplication.validityCheckRegistry()`.

.. versionadded:: 3.6
%End

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

    QgsValidityCheckRegistry();

    ~QgsValidityCheckRegistry();


    QList<const QgsAbstractValidityCheck *> checks() const;
%Docstring
Returns the list of available checks.
%End

    QList<const QgsAbstractValidityCheck *> checks( int type ) const;
%Docstring
Returns the list of all available checks of the matching ``type``.
%End

    void addCheck( QgsAbstractValidityCheck *check /Transfer/ );
%Docstring
Adds a ``check`` to the registry. Ownership of the check is transferred
to the registry.
%End

    void removeCheck( QgsAbstractValidityCheck *check );
%Docstring
Removes a ``check`` from the registry. The check object is automatically
deleted.
%End

    QList< QgsValidityCheckResult > runChecks( int type, const QgsValidityCheckContext *context, QgsFeedback *feedback ) const;
%Docstring
Runs all checks of the specified ``type`` and returns a list of results.

If all checks are "passed" and no warnings or errors are generated, then
an empty list will be returned.

The ``context`` argument gives the wider in which the check is being
run.

The ``feedback`` argument is used to give progress reports and to
support cancellation of long-running checks.

This is a blocking call, which will run all matching checks in the main
thread and only return when they have all completed.
%End

  private:
    QgsValidityCheckRegistry( const QgsValidityCheckRegistry &rh );
};

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