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




class QgsVirtualLayerTask : QgsTask
{
%Docstring(signature="appended")
Initializes a virtual layer with postpone mode activated and reloads the
data in a separated thread.

.. versionadded:: 3.2
%End

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

    QgsVirtualLayerTask( const QgsVirtualLayerDefinition &definition );
%Docstring
Constructor.

:param definition: The definition to use for initializing the virtual
                   layer
%End

    QgsVectorLayer *layer();
%Docstring
Returns the underlying virtual layer.
%End

    QgsVectorLayer *takeLayer();
%Docstring
Returns the underlying virtual layer and ownership.
%End

    QgsVirtualLayerDefinition definition() const;
%Docstring
Returns the virtual layer definition.
%End

    virtual bool run();

%Docstring
Reloads the data.

:return: ``True`` if the virtual layer is valid, ``False`` otherwise.
%End

    virtual void cancel();

%Docstring
Cancels the pending query and the parent task.
%End

    QString exceptionText() const;
%Docstring
Returns the exception text or an empty string if no exceptions were
raised

.. versionadded:: 3.4
%End

    void setExceptionText( const QString &exceptionText );
%Docstring
Sets the ``exceptionText``

.. versionadded:: 3.4
%End

};

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