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
|
# coding: utf-8
# /*##########################################################################
#
# Copyright (c) 2004-2017 European Synchrotron Radiation Facility
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ###########################################################################*/
"""WaitingPushButton module
"""
__authors__ = ["V. Valls"]
__license__ = "MIT"
__date__ = "26/04/2017"
from .. import qt
from .. import icons
class WaitingPushButton(qt.QPushButton):
"""Button which allows to display a waiting status when, for example,
something is still computing.
The component is graphically disabled when it is in waiting. Then we
overwrite the enabled method to dissociate the 2 concepts:
graphically enabled/disabled, and enabled/disabled
.. image:: img/WaitingPushButton.png
"""
def __init__(self, parent=None, text=None, icon=None):
"""Constructor
:param str text: Text displayed on the button
:param qt.QIcon icon: Icon displayed on the button
:param qt.QWidget parent: Parent of the widget
"""
if icon is not None:
qt.QPushButton.__init__(self, icon, text, parent)
elif text is not None:
qt.QPushButton.__init__(self, text, parent)
else:
qt.QPushButton.__init__(self, parent)
self.__waiting = False
self.__enabled = True
self.__icon = icon
self.__disabled_when_waiting = True
self.__waitingIcon = icons.getWaitIcon()
def sizeHint(self):
"""Returns the recommended size for the widget.
This implementation of the recommended size always consider there is an
icon. In this way it avoid to update the layout when the waiting icon
is displayed.
"""
self.ensurePolished()
w = 0
h = 0
opt = qt.QStyleOptionButton()
self.initStyleOption(opt)
# Content with icon
# no condition, assume that there is an icon to avoid blinking
# when the widget switch to waiting state
ih = opt.iconSize.height()
iw = opt.iconSize.width() + 4
w += iw
h = max(h, ih)
# Content with text
text = self.text()
isEmpty = text == ""
if isEmpty:
text = "XXXX"
fm = self.fontMetrics()
textSize = fm.size(qt.Qt.TextShowMnemonic, text)
if not isEmpty or w == 0:
w += textSize.width()
if not isEmpty or h == 0:
h = max(h, textSize.height())
# Content with menu indicator
opt.rect.setSize(qt.QSize(w, h)) # PM_MenuButtonIndicator depends on the height
if self.menu() is not None:
w += self.style().pixelMetric(qt.QStyle.PM_MenuButtonIndicator, opt, self)
contentSize = qt.QSize(w, h)
if qt.qVersion().startswith("4.8."):
# On PyQt4/PySide the method QCommonStyle sizeFromContents returns
# different size when the widget provides an icon or not.
# In Qt5 there is not this problem.
opt.icon = qt.QIcon()
sizeHint = self.style().sizeFromContents(qt.QStyle.CT_PushButton, opt, contentSize, self)
sizeHint = sizeHint.expandedTo(qt.QApplication.globalStrut())
return sizeHint
def setDisabledWhenWaiting(self, isDisabled):
"""Enable or disable the auto disable behaviour when the button is waiting.
:param bool isDisabled: Enable the auto-disable behaviour
"""
if self.__disabled_when_waiting == isDisabled:
return
self.__disabled_when_waiting = isDisabled
self.__updateVisibleEnabled()
def isDisabledWhenWaiting(self):
"""Returns true if the button is auto disabled when it is waiting.
:rtype: bool
"""
return self.__disabled_when_waiting
disabledWhenWaiting = qt.Property(bool, isDisabledWhenWaiting, setDisabledWhenWaiting)
"""Property to enable/disable the auto disabled state when the button is waiting."""
def __setWaitingIcon(self, icon):
"""Called when the waiting icon is updated. It is called every frames
of the animation.
:param qt.QIcon icon: The new waiting icon
"""
qt.QPushButton.setIcon(self, icon)
def setIcon(self, icon):
"""Set the button icon. If the button is waiting, the icon is not
visible directly, but will be visible when the waiting state will be
removed.
:param qt.QIcon icon: An icon
"""
self.__icon = icon
self.__updateVisibleIcon()
def getIcon(self):
"""Returns the icon set to the button. If the widget is waiting
it is not returning the visible icon, but the one requested by
the application (the one displayed when the widget is not in
waiting state).
:rtype: qt.QIcon
"""
return self.__icon
icon = qt.Property(qt.QIcon, getIcon, setIcon)
"""Property providing access to the icon."""
def __updateVisibleIcon(self):
"""Update the visible icon according to the state of the widget."""
if not self.isWaiting():
icon = self.__icon
else:
icon = self.__waitingIcon.currentIcon()
if icon is None:
icon = qt.QIcon()
qt.QPushButton.setIcon(self, icon)
def setEnabled(self, enabled):
"""Set the enabled state of the widget.
:param bool enabled: The enabled state
"""
if self.__enabled == enabled:
return
self.__enabled = enabled
self.__updateVisibleEnabled()
def isEnabled(self):
"""Returns the enabled state of the widget.
:rtype: bool
"""
return self.__enabled
enabled = qt.Property(bool, isEnabled, setEnabled)
"""Property providing access to the enabled state of the widget"""
def __updateVisibleEnabled(self):
"""Update the visible enabled state according to the state of the
widget."""
if self.__disabled_when_waiting:
enabled = not self.isWaiting() and self.__enabled
else:
enabled = self.__enabled
qt.QPushButton.setEnabled(self, enabled)
def setWaiting(self, waiting):
"""Set the waiting state of the widget.
:param bool waiting: Requested state"""
if self.__waiting == waiting:
return
self.__waiting = waiting
if self.__waiting:
self.__waitingIcon.register(self)
self.__waitingIcon.iconChanged.connect(self.__setWaitingIcon)
else:
# unregister only if the object is registred
self.__waitingIcon.unregister(self)
self.__waitingIcon.iconChanged.disconnect(self.__setWaitingIcon)
self.__updateVisibleEnabled()
self.__updateVisibleIcon()
def isWaiting(self):
"""Returns true if the widget is in waiting state.
:rtype: bool"""
return self.__waiting
@qt.Slot()
def wait(self):
"""Enable the waiting state."""
self.setWaiting(True)
@qt.Slot()
def stopWaiting(self):
"""Disable the waiting state."""
self.setWaiting(False)
@qt.Slot()
def swapWaiting(self):
"""Swap the waiting state."""
self.setWaiting(not self.isWaiting())
|
