56a34085eac3757c915b81a83afcb850e6d4abed
[gonvert] / src / util / qui_utils.py
1 import sys
2 import contextlib
3 import datetime
4 import logging
5
6 from PyQt4 import QtCore
7 from PyQt4 import QtGui
8
9 import misc
10
11
12 _moduleLogger = logging.getLogger(__name__)
13
14
15 @contextlib.contextmanager
16 def notify_error(log):
17         try:
18                 yield
19         except:
20                 log.push_exception()
21
22
23 @contextlib.contextmanager
24 def notify_busy(log, message):
25         log.push_busy(message)
26         try:
27                 yield
28         finally:
29                 log.pop(message)
30
31
32 class ErrorMessage(object):
33
34         LEVEL_ERROR = 0
35         LEVEL_BUSY = 1
36         LEVEL_INFO = 2
37
38         def __init__(self, message, level):
39                 self._message = message
40                 self._level = level
41                 self._time = datetime.datetime.now()
42
43         @property
44         def level(self):
45                 return self._level
46
47         @property
48         def message(self):
49                 return self._message
50
51         def __repr__(self):
52                 return "%s.%s(%r, %r)" % (__name__, self.__class__.__name__, self._message, self._level)
53
54
55 class QErrorLog(QtCore.QObject):
56
57         messagePushed = QtCore.pyqtSignal()
58         messagePopped = QtCore.pyqtSignal()
59
60         def __init__(self):
61                 QtCore.QObject.__init__(self)
62                 self._messages = []
63
64         def push_busy(self, message):
65                 _moduleLogger.info("Entering state: %s" % message)
66                 self._push_message(message, ErrorMessage.LEVEL_BUSY)
67
68         def push_message(self, message):
69                 self._push_message(message, ErrorMessage.LEVEL_INFO)
70
71         def push_error(self, message):
72                 self._push_message(message, ErrorMessage.LEVEL_ERROR)
73
74         def push_exception(self):
75                 userMessage = str(sys.exc_info()[1])
76                 _moduleLogger.exception(userMessage)
77                 self.push_error(userMessage)
78
79         def pop(self, message = None):
80                 if message is None:
81                         del self._messages[0]
82                 else:
83                         _moduleLogger.info("Exiting state: %s" % message)
84                         messageIndex = [
85                                 i
86                                 for (i, error) in enumerate(self._messages)
87                                 if error.message == message
88                         ]
89                         # Might be removed out of order
90                         if messageIndex:
91                                 del self._messages[messageIndex[0]]
92                 self.messagePopped.emit()
93
94         def peek_message(self):
95                 return self._messages[0]
96
97         def _push_message(self, message, level):
98                 self._messages.append(ErrorMessage(message, level))
99                 # Sort is defined as stable, so this should be fine
100                 self._messages.sort(key=lambda x: x.level)
101                 self.messagePushed.emit()
102
103         def __len__(self):
104                 return len(self._messages)
105
106
107 class ErrorDisplay(object):
108
109         _SENTINEL_ICON = QtGui.QIcon()
110
111         def __init__(self, errorLog):
112                 self._errorLog = errorLog
113                 self._errorLog.messagePushed.connect(self._on_message_pushed)
114                 self._errorLog.messagePopped.connect(self._on_message_popped)
115
116                 self._icons = {
117                         ErrorMessage.LEVEL_BUSY:
118                                 get_theme_icon(
119                                         #("process-working", "view-refresh", "general_refresh", "gtk-refresh")
120                                         ("view-refresh", "general_refresh", "gtk-refresh", )
121                                 ).pixmap(32, 32),
122                         ErrorMessage.LEVEL_INFO:
123                                 get_theme_icon(
124                                         ("dialog-information", "general_notes", "gtk-info")
125                                 ).pixmap(32, 32),
126                         ErrorMessage.LEVEL_ERROR:
127                                 get_theme_icon(
128                                         ("dialog-error", "app_install_error", "gtk-dialog-error")
129                                 ).pixmap(32, 32),
130                 }
131                 self._severityLabel = QtGui.QLabel()
132                 self._severityLabel.setAlignment(QtCore.Qt.AlignLeft | QtCore.Qt.AlignVCenter)
133
134                 self._message = QtGui.QLabel()
135                 self._message.setText("Boo")
136                 self._message.setAlignment(QtCore.Qt.AlignLeft | QtCore.Qt.AlignVCenter)
137                 self._message.setWordWrap(True)
138
139                 closeIcon = get_theme_icon(("window-close", "general_close", "gtk-close"), self._SENTINEL_ICON)
140                 if closeIcon is not self._SENTINEL_ICON:
141                         self._closeLabel = QtGui.QPushButton(closeIcon, "")
142                 else:
143                         self._closeLabel = QtGui.QPushButton("X")
144                 self._closeLabel.clicked.connect(self._on_close)
145
146                 self._controlLayout = QtGui.QHBoxLayout()
147                 self._controlLayout.addWidget(self._severityLabel, 1, QtCore.Qt.AlignCenter)
148                 self._controlLayout.addWidget(self._message, 1000)
149                 self._controlLayout.addWidget(self._closeLabel, 1, QtCore.Qt.AlignCenter)
150
151                 self._widget = QtGui.QWidget()
152                 self._widget.setLayout(self._controlLayout)
153                 self._widget.hide()
154
155         @property
156         def toplevel(self):
157                 return self._widget
158
159         def _show_error(self):
160                 error = self._errorLog.peek_message()
161                 self._message.setText(error.message)
162                 self._severityLabel.setPixmap(self._icons[error.level])
163                 self._widget.show()
164
165         @QtCore.pyqtSlot()
166         @QtCore.pyqtSlot(bool)
167         @misc.log_exception(_moduleLogger)
168         def _on_close(self, checked = False):
169                 self._errorLog.pop()
170
171         @QtCore.pyqtSlot()
172         @misc.log_exception(_moduleLogger)
173         def _on_message_pushed(self):
174                 self._show_error()
175
176         @QtCore.pyqtSlot()
177         @misc.log_exception(_moduleLogger)
178         def _on_message_popped(self):
179                 if len(self._errorLog) == 0:
180                         self._message.setText("")
181                         self._widget.hide()
182                 else:
183                         self._show_error()
184
185
186 class QHtmlDelegate(QtGui.QStyledItemDelegate):
187
188         UNDEFINED_SIZE = -1
189
190         def __init__(self, *args, **kwd):
191                 QtGui.QStyledItemDelegate.__init__(*((self, ) + args), **kwd)
192                 self._width = self.UNDEFINED_SIZE
193
194         def paint(self, painter, option, index):
195                 newOption = QtGui.QStyleOptionViewItemV4(option)
196                 self.initStyleOption(newOption, index)
197                 if newOption.widget is not None:
198                         style = newOption.widget.style()
199                 else:
200                         style = QtGui.QApplication.style()
201
202                 doc = QtGui.QTextDocument()
203                 doc.setHtml(newOption.text)
204                 doc.setTextWidth(newOption.rect.width())
205
206                 newOption.text = ""
207                 style.drawControl(QtGui.QStyle.CE_ItemViewItem, newOption, painter)
208
209                 ctx = QtGui.QAbstractTextDocumentLayout.PaintContext()
210                 if newOption.state & QtGui.QStyle.State_Selected:
211                         ctx.palette.setColor(
212                                 QtGui.QPalette.Text,
213                                 newOption.palette.color(
214                                         QtGui.QPalette.Active,
215                                         QtGui.QPalette.HighlightedText
216                                 )
217                         )
218                 else:
219                         ctx.palette.setColor(
220                                 QtGui.QPalette.Text,
221                                 newOption.palette.color(
222                                         QtGui.QPalette.Active,
223                                         QtGui.QPalette.Text
224                                 )
225                         )
226
227                 textRect = style.subElementRect(QtGui.QStyle.SE_ItemViewItemText, newOption)
228                 painter.save()
229                 painter.translate(textRect.topLeft())
230                 painter.setClipRect(textRect.translated(-textRect.topLeft()))
231                 doc.documentLayout().draw(painter, ctx)
232                 painter.restore()
233
234         def setWidth(self, width):
235                 # @bug we need to be emitting sizeHintChanged but it requires an index
236                 self._width = width
237
238         def sizeHint(self, option, index):
239                 newOption = QtGui.QStyleOptionViewItemV4(option)
240                 self.initStyleOption(newOption, index)
241
242                 doc = QtGui.QTextDocument()
243                 doc.setHtml(newOption.text)
244                 if self._width != self.UNDEFINED_SIZE:
245                         width = self._width
246                 else:
247                         width = newOption.rect.width()
248                 doc.setTextWidth(width)
249                 size = QtCore.QSize(doc.idealWidth(), doc.size().height())
250                 return size
251
252
253 def _null_set_stackable(window, isStackable):
254         pass
255
256
257 def _maemo_set_stackable(window, isStackable):
258         window.setAttribute(QtCore.Qt.WA_Maemo5StackedWindow, isStackable)
259
260
261 try:
262         QtCore.Qt.WA_Maemo5StackedWindow
263         set_stackable = _maemo_set_stackable
264 except AttributeError:
265         set_stackable = _null_set_stackable
266
267
268 def _null_set_autorient(window, isStackable):
269         pass
270
271
272 def _maemo_set_autorient(window, isStackable):
273         window.setAttribute(QtCore.Qt.WA_Maemo5AutoOrientation, isStackable)
274
275
276 try:
277         QtCore.Qt.WA_Maemo5AutoOrientation
278         set_autorient = _maemo_set_autorient
279 except AttributeError:
280         set_autorient = _null_set_autorient
281
282
283 def screen_orientation():
284         geom = QtGui.QApplication.desktop().screenGeometry()
285         if geom.width() <= geom.height():
286                 return QtCore.Qt.Vertical
287         else:
288                 return QtCore.Qt.Horizontal
289
290
291 def _null_set_window_orientation(window, orientation):
292         pass
293
294
295 def _maemo_set_window_orientation(window, orientation):
296         if orientation == QtCore.Qt.Vertical:
297                 oldHint = QtCore.Qt.WA_Maemo5LandscapeOrientation
298                 newHint = QtCore.Qt.WA_Maemo5PortraitOrientation
299         elif orientation == QtCore.Qt.Horizontal:
300                 oldHint = QtCore.Qt.WA_Maemo5PortraitOrientation
301                 newHint = QtCore.Qt.WA_Maemo5LandscapeOrientation
302         window.setAttribute(oldHint, False)
303         window.setAttribute(newHint, True)
304
305
306 try:
307         QtCore.Qt.WA_Maemo5LandscapeOrientation
308         QtCore.Qt.WA_Maemo5PortraitOrientation
309         set_window_orientation = _maemo_set_window_orientation
310 except AttributeError:
311         set_window_orientation = _null_set_window_orientation
312
313
314 def _null_show_progress_indicator(window, isStackable):
315         pass
316
317
318 def _maemo_show_progress_indicator(window, isStackable):
319         window.setAttribute(QtCore.Qt.WA_Maemo5ShowProgressIndicator, isStackable)
320
321
322 try:
323         QtCore.Qt.WA_Maemo5ShowProgressIndicator
324         show_progress_indicator = _maemo_show_progress_indicator
325 except AttributeError:
326         show_progress_indicator = _null_show_progress_indicator
327
328
329 def _null_mark_numbers_preferred(widget):
330         pass
331
332
333 def _newqt_mark_numbers_preferred(widget):
334         widget.setInputMethodHints(QtCore.Qt.ImhPreferNumbers)
335
336
337 try:
338         QtCore.Qt.ImhPreferNumbers
339         mark_numbers_preferred = _newqt_mark_numbers_preferred
340 except AttributeError:
341         mark_numbers_preferred = _null_mark_numbers_preferred
342
343
344 def _null_get_theme_icon(iconNames, fallback = None):
345         icon = fallback if fallback is not None else QtGui.QIcon()
346         return icon
347
348
349 def _newqt_get_theme_icon(iconNames, fallback = None):
350         for iconName in iconNames:
351                 if QtGui.QIcon.hasThemeIcon(iconName):
352                         icon = QtGui.QIcon.fromTheme(iconName)
353                         break
354         else:
355                 icon = fallback if fallback is not None else QtGui.QIcon()
356         return icon
357
358
359 try:
360         QtGui.QIcon.fromTheme
361         get_theme_icon = _newqt_get_theme_icon
362 except AttributeError:
363         get_theme_icon = _null_get_theme_icon
364