File: qgsvaliditycheckcontext.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 (87 lines) | stat: -rw-r--r-- 2,729 bytes parent folder | download | duplicates (7)
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
83
84
85
86
87
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/validity/qgsvaliditycheckcontext.h                          *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/



class QgsValidityCheckContext
{
%Docstring(signature="appended")
Base class for validity check contexts.

:py:class:`QgsAbstractValidityCheck` subclasses are passed a
:py:class:`QgsValidityCheckContext` subclass which encapsulates the
context around that particular check type. For instance, a
:py:class:`QgsAbstractValidityCheck` of the
:py:class:`QgsAbstractValidityCheck`.TypeLayoutCheck type will be passed
a :py:class:`QgsLayoutValidityCheckContext` context, containing a
reference to the :py:class:`QgsLayout` to be checked.

.. versionadded:: 3.6
%End

%TypeHeaderCode
#include "qgsvaliditycheckcontext.h"
%End
%ConvertToSubClassCode
    if ( dynamic_cast<QgsLayoutValidityCheckContext *>( sipCpp ) != NULL )
      sipType = sipType_QgsLayoutValidityCheckContext;
    else
      sipType = 0;
%End
  public:

    enum ContextType /BaseType=IntEnum/
    {
      TypeLayoutContext,
      TypeUserContext,
    };

    virtual int type() const = 0;
%Docstring
Returns the context type.
%End

    virtual ~QgsValidityCheckContext();

};

class QgsLayoutValidityCheckContext : QgsValidityCheckContext
{
%Docstring(signature="appended")
Validity check context for print layout validation.

:py:class:`QgsLayoutValidityCheckContext` are passed to
:py:class:`QgsAbstractValidityCheck` subclasses which indicate they are
of the :py:class:`QgsAbstractValidityCheck`.TypeLayoutCheck type.

.. versionadded:: 3.6
%End

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

    QgsLayoutValidityCheckContext( QgsLayout *layout );
%Docstring
Constructor for QgsLayoutValidityCheckContext for the specified
``layout``.
%End

    virtual int type() const;

    QgsLayout *layout;

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