File: qgspanelwidget.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 (251 lines) | stat: -rw-r--r-- 7,009 bytes parent folder | download | duplicates (5)
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgspanelwidget.h                                             *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/



class QgsPanelWidget : QWidget
{
%Docstring(signature="appended")
Base class for any widget that can be shown as a inline panel
%End

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

    QgsPanelWidget( QWidget *parent = 0 );
%Docstring
Base class for any widget that can be shown as a inline panel

:param parent: Parent widget.
%End

    void setPanelTitle( const QString &panelTitle );
%Docstring
Set the title of the panel when shown in the interface.

:param panelTitle: The panel title.
%End

    QString panelTitle();
%Docstring
The title of the panel.

:return: The title pf the panel.
%End

    void connectChildPanels( const QList<QgsPanelWidget *> &panels );
%Docstring
Connect the given sub panel widgets showPanel signals to this current panels
main showPanel event to bubble up to the user.

Use this method if you have children widgets that need to show a panel to the user.

:param panels: A list of panel widgets to connect.
%End

    void connectChildPanel( QgsPanelWidget *panel );
%Docstring
Connect the given sub panel widgets showPanel signals to this current panels
main showPanel event to bubble up to the user.

Use this method if you have children widgets that need to show a panel to the user.

:param panel: The panel to connect.
%End

    virtual void setDockMode( bool dockMode );
%Docstring
Set the widget in dock mode which tells the widget to emit panel
widgets and not open dialogs

:param dockMode: ``True`` to enable dock mode.
%End

    virtual bool applySizeConstraintsToStack() const;
%Docstring
Returns ``True`` if the size constraints and hints for the panel widget should be
applied to the parent :py:class:`QgsPanelWidgetStack` which this panel is shown in.

The default behavior is to return ``False``.

.. versionadded:: 3.20
%End

    bool dockMode();
%Docstring
Returns the dock mode state.

:return: ``True`` if in dock mode.  If in dock mode the widget
         will emit the showPanel signal to handle panel opening
         If ``False`` it will open dialogs when openPanel is called.
%End

    void setAutoDelete( bool autoDelete );
%Docstring
The the auto delete property on the widget. ``True`` by default.
When auto delete is enabled when a panel is removed from the stack
it will be deleted.

:param autoDelete: Enable or disable auto delete on the panel.
%End

    bool autoDelete();
%Docstring
The the auto delete property on the widget. ``True`` by default.
When auto delete is enabled when a panel is removed from the stack
it will be deleted.

:return: The auto delete value for the widget.
%End

    static QgsPanelWidget *findParentPanel( QWidget *widget );
%Docstring
Traces through the parents of a widget to find if it is contained within a QgsPanelWidget
widget.

:param widget: widget which may be contained within a panel widget

:return: parent panel widget if found, otherwise ``None``

.. versionadded:: 3.0
%End

    virtual QString menuButtonTooltip() const;
%Docstring
Returns the (translated) tooltip text to use for the menu button for this panel.

This is only used when the panel returns a :py:func:`~QgsPanelWidget.menuButtonMenu`.

.. versionadded:: 3.12
%End

    virtual QMenu *menuButtonMenu();
%Docstring
Returns the menu to use for the menu button for this panel, or ``None`` if
no menu button is required.

.. versionadded:: 3.12
%End

  signals:

    void panelAccepted( QgsPanelWidget *panel );
%Docstring
Emitted when the panel is accepted by the user.

:param panel: The panel widget that was accepted.

.. note::

   This argument is normally raised with emit panelAccepted(this)
   so that callers can retrieve the widget easier in calling code.

.. note::

   this is emitted only when this panel is accepted, and is not emitted for
   child panels. For example, if this panel opens a second stacked panel, then this panel
   will not emit panelAccepted when the second panel is accepted.
%End

    void showPanel( QgsPanelWidget *panel );
%Docstring
Emit when you require a panel to be show in the interface.

:param panel: The panel widget to show.

.. note::

   If you are connected to this signal you should also connect
   given panels showPanel signal as they can be nested.
%End

    void widgetChanged();
%Docstring
Emitted when the widget state changes.
Connect to this to pull any changes off the widget when needed.
As panels are non blocking "dialogs" you should listen to this signal
to give the user feedback when something changes.
%End

  public slots:

    void openPanel( QgsPanelWidget *panel );
%Docstring
Open a panel or dialog depending on dock mode setting
If dock mode is ``True`` this method will emit the showPanel signal
for connected slots to handle the open event.

If dock mode is ``False`` this method will open a dialog
and block the user.

:param panel: The panel widget to open.
%End

    void acceptPanel();
%Docstring
Accept the panel. Causes panelAccepted to be emitted.
Widgets are normally removed form the interface using the panel manager or the caller.
%End

  protected:

    virtual void keyPressEvent( QKeyEvent *event );

%Docstring
Overridden key press event to handle the esc event on the widget.

:param event: The key event
%End

};


class QgsPanelWidgetWrapper: QgsPanelWidget
{
%Docstring(signature="appended")
Wrapper widget for existing widgets which can't have
the inheritance tree changed, e.g dialogs.

.. note::

   Generally you should use the QgsPanelWidget class if you can
   and only use this wrapper if you can't update your code.
%End

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

    QgsPanelWidgetWrapper( QWidget *widget, QWidget *parent = 0 );
%Docstring
Wrapper widget for existing widgets which can't have
the inheritance tree changed, e.g dialogs.

:param widget: The widget to wrap.
:param parent: The parent widget.
%End

    QWidget *widget();
%Docstring
Returns the internal widget that is wrapped in this panel.

:return: The internal widget. Can be ``None``.
%End

};

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