File: qgsrelationshipsitem.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 (134 lines) | stat: -rw-r--r-- 3,879 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
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/browser/qgsrelationshipsitem.h                              *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/



class QgsRelationshipsItem : QgsDataItem
{
%Docstring(signature="appended")
Contains a collection of relationship items.

.. versionadded:: 3.28
%End

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

    QgsRelationshipsItem( QgsDataItem *parent /TransferThis/,
                          const QString &path,
                          const QString &connectionUri,
                          const QString &providerKey,
                          const QString &schema = QString(),
                          const QString &tableName = QString() );
%Docstring
Constructor for QgsRelationshipsItem, with the specified ``parent``
item.

The ``path`` argument gives the item path in the browser tree. The
``path`` string can take any form, but :py:class:`QgsDataItem` items
pointing to different logical locations should always use a different
item ``path``. The ``connectionUri`` argument is the connection part of
the layer URI that it is used internally to create a connection and
retrieve fields information. The ``providerKey`` string can be used to
specify the key for the :py:class:`QgsDataItemProvider` that created
this item.

The optional ``schema`` and ``tableName`` arguments can be used to
restrict the visible relationships to those with a matching parent
table.
%End

    ~QgsRelationshipsItem();

    SIP_PYOBJECT __repr__();
%MethodCode
    QString str = QStringLiteral( "<QgsRelationshipsItem: %1>" ).arg( sipCpp->path() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End

    virtual QVector<QgsDataItem *> createChildren();


    virtual QIcon icon();


    QString connectionUri() const;
%Docstring
Returns the connection URI
%End

    QString schema() const;
%Docstring
Returns the schema for filtering relationships, if set.

.. seealso:: :py:func:`tableName`
%End

    QString tableName() const;
%Docstring
Returns the table name for filtering relationships, if set.

.. seealso:: :py:func:`schema`
%End

};


class QgsRelationshipItem : QgsDataItem
{
%Docstring(signature="appended")
A browser item representing a relationship.

.. versionadded:: 3.28
%End

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

    QgsRelationshipItem( QgsDataItem *parent /TransferThis/,
                         const QgsWeakRelation &relation );
%Docstring
Constructor for QgsRelationshipItem, with the specified ``parent`` item
and ``relation``.

.. note::

   parent item must be a :py:class:`QgsRelationshipsItem`.
%End

    ~QgsRelationshipItem();

    SIP_PYOBJECT __repr__();
%MethodCode
    QString str = QStringLiteral( "<QgsRelationshipItem: %1>" ).arg( sipCpp->name() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End

    virtual QIcon icon();


    const QgsWeakRelation &relation() const;
%Docstring
Returns the associated relationship.
%End

};



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