File: qgsmodelgraphicitem.sip.in

package info (click to toggle)
qgis 3.44.8%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,237,544 kB
  • sloc: cpp: 1,668,420; python: 381,688; xml: 23,474; perl: 4,078; sh: 3,733; ansic: 2,799; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 155
file content (194 lines) | stat: -rw-r--r-- 5,412 bytes parent folder | download | duplicates (4)
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/processing/models/qgsmodelgraphicitem.h                      *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/






class QgsModelDesignerFlatButtonGraphicItem : QGraphicsObject
{
%Docstring(signature="appended")
A flat button graphic item for use in the Processing model designer.

.. warning::

   Not stable API

.. versionadded:: 3.14
%End

%TypeHeaderCode
#include "qgsmodelgraphicitem.h"
%End
  public:
    QgsModelDesignerFlatButtonGraphicItem( QGraphicsItem *parent /TransferThis/, const QPicture &picture, const QPointF &position, const QSizeF &size = QSizeF( 16, 16 ) );
%Docstring
Constructor for QgsModelDesignerFlatButtonGraphicItem, with the
specified ``parent`` item.

The ``picture`` argument specifies a QPicture object containing the
graphic to render for the button. The button will be rendered at the
specified ``position`` and ``size``.
%End

    virtual void paint( QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0 );

    virtual QRectF boundingRect() const;

    virtual void hoverEnterEvent( QGraphicsSceneHoverEvent *event );

    virtual void hoverLeaveEvent( QGraphicsSceneHoverEvent *event );

    virtual void mousePressEvent( QGraphicsSceneMouseEvent *event );



    QPointF position() const;
%Docstring
Returns the button's position.
%End

    void setPosition( const QPointF &position );
%Docstring
Sets the button's ``position``.
%End

    QgsModelGraphicsView *view();
%Docstring
Returns the associated model view.
%End

  signals:

    void clicked();
%Docstring
Emitted when the button is clicked.
%End

  protected:
    void setPicture( const QPicture &picture );
%Docstring
Sets the ``picture`` to render for the button graphics.
%End

};


class QgsModelDesignerFoldButtonGraphicItem : QgsModelDesignerFlatButtonGraphicItem
{
%Docstring(signature="appended")
A button allowing folding or expanding component graphics in the
Processing model designer.

.. warning::

   Not stable API

.. versionadded:: 3.14
%End

%TypeHeaderCode
#include "qgsmodelgraphicitem.h"
%End
  public:
    QgsModelDesignerFoldButtonGraphicItem( QGraphicsItem *parent /TransferThis/, bool folded, const QPointF &position, const QSizeF &size = QSizeF( 11, 11 ) );
%Docstring
Constructor for QgsModelDesignerFoldButtonGraphicItem, with the
specified ``parent`` item.

The ``folded`` argument specifies whether the button should initially
indicate the folded (collapsed) state.

The button will be rendered at the specified ``position`` and ``size``.
%End

    virtual void mousePressEvent( QGraphicsSceneMouseEvent *event );


  signals:

    void folded( bool folded );
%Docstring
Emitted when the button ``folded`` state changes.

If ``folded`` is ``True``, the button represents the collapsed state for
the item.
%End

};


class QgsModelDesignerSocketGraphicItem : QgsModelDesignerFlatButtonGraphicItem
{
%Docstring(signature="appended")
A socket allowing linking component together.

.. warning::

   Not stable API

.. versionadded:: 3.44
%End

%TypeHeaderCode
#include "qgsmodelgraphicitem.h"
%End
  public:
    QgsModelDesignerSocketGraphicItem( QgsModelComponentGraphicItem *parent /TransferThis/, QgsProcessingModelComponent *component, int index, const QPointF &position, Qt::Edge edge, const QSizeF &size = QSizeF( 11, 11 ) );
%Docstring
Constructor for QgsModelDesignerSocketGraphicItem, with the specified
``parent`` item.

The ``index`` argument specifies whether the input or output index of
this socket inside the component And the ``edge`` argument specifies if
it's an input socket( Qt.Edge.TopEdge ) or output ( Qt.Edge.BottomEdge )

The sockets will be rendered at the specified ``position``
%End

    virtual void paint( QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0 );


    int index() const;
%Docstring
Returns the index of this socket in either
QgsModelDesignerSocketGraphicItem.mInSockets or
QgsModelDesignerSocketGraphicItem.mOutSockets array
%End
    Qt::Edge edge() const;
%Docstring
Returns on which edge this socket is:

- Qt.Edge.TopEdge for input socket
- Qt.Edge.BottomEdge for output socket
%End
    bool isInput() const;
%Docstring
Returns whether the socket is an input socket or not.

Convenient function around mEdge member
%End
    QgsProcessingModelComponent *component();
%Docstring
Return the component associated to the socket.
%End
    QgsModelComponentGraphicItem *componentItem();
%Docstring
Return the parent graphic item associated to the socket.
%End
};


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