File: qgsquerybuilder.sip.in

package info (click to toggle)
qgis 3.22.16%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,186,020 kB
  • sloc: cpp: 1,275,562; python: 194,091; xml: 15,597; perl: 3,471; sh: 3,368; sql: 2,485; ansic: 2,219; yacc: 1,056; lex: 574; javascript: 504; lisp: 411; makefile: 227
file content (112 lines) | stat: -rw-r--r-- 3,198 bytes parent folder | download
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsquerybuilder.h                                            *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/


class QgsQueryBuilder : QgsSubsetStringEditorInterface
{
%Docstring(signature="appended")
Query Builder for layers.

The query builder allows interactive creation of a SQL for limiting the
features displayed in a vector layer.  The fields in the table are
displayed and sample values (or all values) can be viewed to aid in
constructing the query. A test function returns the number of features that
will be returned.
%End

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

    QgsQueryBuilder( QgsVectorLayer *layer, QWidget *parent /TransferThis/ = 0,
                     Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags );
%Docstring
This constructor is used when the query builder is called from the
vector layer properties dialog

:param layer: existing vector layer
:param parent: Parent widget
:param fl: dialog flags
%End

    virtual void showEvent( QShowEvent *event );


    QString sql() const;
%Docstring
Returns the sql statement entered in the dialog.
%End

    void setSql( const QString &sqlStatement );
%Docstring
Set the sql statement to display in the dialog.
%End

    virtual QString subsetString() const;
    virtual void setSubsetString( const QString &subsetString );

%If (HAVE_QSCI_SIP)

    QgsCodeEditor *codeEditorWidget() const;
%Docstring
Returns the code editor widget for the SQL.

.. versionadded:: 3.18
%End
%End
%If (!HAVE_QSCI_SIP)

    QWidget *codeEditorWidget() const;
%Docstring
Returns the code editor widget for the SQL.

.. versionadded:: 3.18
%End
%End

  public slots:
    virtual void accept();

    virtual void reject();

    void clear();

    virtual void test();
%Docstring
The default implementation tests that the constructed sql statement to
see if the vector layer data provider likes it.
The number of rows that would be returned is displayed in a message box.
The test uses a "select count(*) from ..." query to test the SQL
statement.
%End

    void saveQuery();
%Docstring
Save query to the XML file

.. versionadded:: 3.16
%End

    void loadQuery();
%Docstring
Load query from the XML file

.. versionadded:: 3.16
%End

    void setDatasourceDescription( const QString &uri );

};
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsquerybuilder.h                                            *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/