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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsdockwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsDockWidget : QDockWidget
{
%Docstring(signature="appended")
:py:class:`QgsDockWidget` subclass with more fine-grained control over
how the widget is closed or opened.
%End
%TypeHeaderCode
#include "qgsdockwidget.h"
%End
public:
explicit QgsDockWidget( QWidget *parent /TransferThis/ = 0, Qt::WindowFlags flags = Qt::WindowFlags() );
%Docstring
Constructor for QgsDockWidget.
:param parent: parent widget
:param flags: window flags
%End
explicit QgsDockWidget( const QString &title, QWidget *parent /TransferThis/ = 0, Qt::WindowFlags flags = Qt::WindowFlags() );
%Docstring
Constructor for QgsDockWidget.
:param title: dock title
:param parent: parent widget
:param flags: window flags
%End
bool isUserVisible() const;
%Docstring
Returns ``True`` if the dock is both opened and raised to the front (ie
not hidden by any other tabs.
.. seealso:: :py:func:`setUserVisible`
.. seealso:: :py:func:`toggleUserVisible`
%End
void setToggleVisibilityAction( QAction *action );
%Docstring
Links an ``action`` to the dock, so that toggling the action will
automatically set the dock's visibility to suit (and changing the dock
visibility will update the action's state).
.. seealso:: :py:func:`toggleVisibilityAction`
.. versionadded:: 3.4
%End
QAction *toggleVisibilityAction();
%Docstring
Returns the action linked to the dock.
.. seealso:: :py:func:`setToggleVisibilityAction`
.. versionadded:: 3.4
%End
public slots:
void setUserVisible( bool visible );
%Docstring
Sets the dock widget as visible to a user, ie both shown and raised to
the front.
:param visible: set to ``True`` to show the dock to the user, or
``False`` to hide the dock. When setting a dock as user
visible, the dock will be opened (if it is not already
opened) and raised to the front. When setting as hidden,
the following logic is used:
- hiding a dock which is open but not raised (ie hidden by another tab) will have no
effect, and the dock will still be opened and hidden by the other tab
- hiding a dock which is open and raised (ie, user visible) will cause the dock to
be closed
- hiding a dock which is closed has no effect and raises no signals
.. seealso:: :py:func:`isUserVisible`
.. seealso:: :py:func:`toggleUserVisible`
%End
void toggleUserVisible();
%Docstring
Toggles whether the dock is user visible. If the dock is not currently
user visible (i.e. opened and activated as a tab) then the dock will be
opened and raised. If it is currently user visible it will be closed.
.. seealso:: :py:func:`setUserVisible`
.. seealso:: :py:func:`isUserVisible`
.. versionadded:: 3.2
%End
protected:
virtual void closeEvent( QCloseEvent * );
virtual void showEvent( QShowEvent *event );
signals:
void closed();
%Docstring
Emitted when dock widget is closed.
.. seealso:: :py:func:`closedStateChanged`
.. seealso:: :py:func:`opened`
%End
void closedStateChanged( bool wasClosed );
%Docstring
Emitted when dock widget is closed (or opened).
:param wasClosed: will be ``True`` if dock widget was closed, or
``False`` if dock widget was opened
.. seealso:: :py:func:`closed`
.. seealso:: :py:func:`openedStateChanged`
%End
void opened();
%Docstring
Emitted when dock widget is opened.
.. seealso:: :py:func:`openedStateChanged`
.. seealso:: :py:func:`closed`
%End
void openedStateChanged( bool wasOpened );
%Docstring
Emitted when dock widget is opened (or closed).
:param wasOpened: will be ``True`` if dock widget was opened, or
``False`` if dock widget was closed
.. seealso:: :py:func:`closedStateChanged`
.. seealso:: :py:func:`opened`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsdockwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
