source: orange/Orange/OrangeCanvas/gui/toolbox.py @ 11366:7f9332b11252

Revision 11366:7f9332b11252, 17.6 KB checked in by Ales Erjavec <ales.erjavec@…>, 14 months ago (diff)

Added rst documentation for the canvas gui package.

Fixing docstrings in the process.

Line 
1"""
2==============
3Tool Box Widget
4==============
5
6A reimplementation of the :class:`QToolBox` widget that keeps all the tabs
7in a single :class:`QScrollArea` instance and can keep multiple open tabs.
8
9"""
10
11from collections import namedtuple
12from operator import eq, attrgetter
13
14from PyQt4.QtGui import (
15    QWidget, QFrame, QSizePolicy, QIcon, QFontMetrics, QPainter, QStyle,
16    QStyleOptionToolButton, QStyleOptionToolBoxV2, QPalette, QBrush, QPen,
17    QLinearGradient, QColor, QScrollArea, QVBoxLayout, QToolButton,
18    QAction, QActionGroup
19)
20
21from PyQt4.QtCore import (
22    Qt, QObject, QSize, QRect, QPoint, QSignalMapper, QEvent
23)
24
25from PyQt4.QtCore import pyqtSignal as Signal, pyqtProperty as Property
26
27from .utils import brush_darker
28
29_ToolBoxPage = namedtuple(
30    "_ToolBoxPage",
31    ["index",
32     "widget",
33     "action",
34     "button"]
35    )
36
37
38FOCUS_OUTLINE_COLOR = "#609ED7"
39
40
41def create_tab_gradient(base_color):
42    """
43    Create a default background gradient for a tab button from a single
44    color.
45
46    """
47    grad = QLinearGradient(0, 0, 0, 1)
48    grad.setStops([(0.0, base_color),
49                   (0.5, base_color),
50                   (0.8, base_color.darker(105)),
51                   (1.0, base_color.darker(110)),
52                   ])
53    grad.setCoordinateMode(QLinearGradient.ObjectBoundingMode)
54    return grad
55
56
57class ToolBoxTabButton(QToolButton):
58    """
59    A tab button for an item in a :class:`ToolBox`.
60    """
61
62    def setNativeStyling(self, state):
63        """
64        Render tab buttons as native :class:`QToolButtons`.
65        If set to `False` (default) the button is pained using a
66        custom routine.
67
68        """
69        self.__nativeStyling = state
70        self.update()
71
72    def nativeStyling(self):
73        """
74        Use :class:`QStyle`'s to paint the class:`QToolButton` look.
75        """
76        return self.__nativeStyling
77
78    nativeStyling_ = Property(bool,
79                              fget=nativeStyling,
80                              fset=setNativeStyling,
81                              designable=True)
82
83    def __init__(self, *args, **kwargs):
84        self.__nativeStyling = False
85        self.position = QStyleOptionToolBoxV2.OnlyOneTab
86        self.selected = QStyleOptionToolBoxV2.NotAdjacent
87
88        QToolButton.__init__(self, *args, **kwargs)
89
90    def paintEvent(self, event):
91        if self.__nativeStyling:
92            QToolButton.paintEvent(self, event)
93        else:
94            self.__paintEventNoStyle()
95
96    def __paintEventNoStyle(self):
97        p = QPainter(self)
98        opt = QStyleOptionToolButton()
99        self.initStyleOption(opt)
100
101        fm = QFontMetrics(opt.font)
102        palette = opt.palette
103
104        # highlight brush is used as the background for the icon and background
105        # when the tab is expanded and as mouse hover color (lighter).
106        brush_highlight = palette.highlight()
107        if opt.state & QStyle.State_Sunken:
108            # State 'down' pressed during a mouse press (slightly darker).
109            background_brush = brush_darker(brush_highlight, 110)
110        elif opt.state & QStyle.State_MouseOver:
111            background_brush = brush_darker(brush_highlight, 95)
112        elif opt.state & QStyle.State_On:
113            background_brush = brush_highlight
114        else:
115            # The default button brush.
116            background_brush = palette.button()
117
118        rect = opt.rect
119        icon = opt.icon
120        icon_size = opt.iconSize
121
122        # TODO: add shift for pressed as set by the style (PM_ButtonShift...)
123
124        pm = None
125        if not icon.isNull():
126            if opt.state & QStyle.State_Enabled:
127                mode = QIcon.Normal
128            else:
129                mode = QIcon.Disabled
130
131            pm = opt.icon.pixmap(
132                    rect.size().boundedTo(icon_size), mode,
133                    QIcon.On if opt.state & QStyle.State_On else QIcon.Off)
134
135        icon_area_rect = QRect(rect)
136        icon_area_rect.setRight(int(icon_area_rect.height() * 1.26))
137
138        text_rect = QRect(rect)
139        text_rect.setLeft(icon_area_rect.right() + 10)
140
141        # Background  (TODO: Should the tab button have native
142        # toolbutton shape, drawn using PE_PanelButtonTool or even
143        # QToolBox tab shape)
144
145        # Default outline pen
146        pen = QPen(palette.color(QPalette.Mid))
147
148        p.save()
149        p.setPen(Qt.NoPen)
150        p.setBrush(QBrush(background_brush))
151        p.drawRect(rect)
152
153        # Draw the background behind the icon if the background_brush
154        # is different.
155        if not opt.state & QStyle.State_On:
156            p.setBrush(brush_highlight)
157            p.drawRect(icon_area_rect)
158            # Line between the icon and text
159            p.setPen(pen)
160            p.drawLine(icon_area_rect.topRight(),
161                       icon_area_rect.bottomRight())
162
163        if opt.state & QStyle.State_HasFocus:
164            # Set the focus frame pen and draw the border
165            pen = QPen(QColor(FOCUS_OUTLINE_COLOR))
166            p.setPen(pen)
167            p.setBrush(Qt.NoBrush)
168            # Adjust for pen
169            rect = rect.adjusted(0, 0, -1, -1)
170            p.drawRect(rect)
171
172        else:
173            p.setPen(pen)
174            # Draw the top/bottom border
175            if self.position == QStyleOptionToolBoxV2.OnlyOneTab or \
176                    self.position == QStyleOptionToolBoxV2.Beginning or \
177                    self.selected & \
178                        QStyleOptionToolBoxV2.PreviousIsSelected:
179
180                p.drawLine(rect.topLeft(), rect.topRight())
181
182            p.drawLine(rect.bottomLeft(), rect.bottomRight())
183
184        p.restore()
185
186        p.save()
187        text = fm.elidedText(opt.text, Qt.ElideRight, text_rect.width())
188        p.setPen(QPen(palette.color(QPalette.ButtonText)))
189        p.setFont(opt.font)
190
191        p.drawText(text_rect,
192                   int(Qt.AlignVCenter | Qt.AlignLeft) | \
193                   int(Qt.TextSingleLine),
194                   text)
195        if pm:
196            pm_rect = QRect(QPoint(0, 0), pm.size())
197            centered_rect = QRect(pm_rect)
198            centered_rect.moveCenter(icon_area_rect.center())
199            p.drawPixmap(centered_rect, pm, pm_rect)
200        p.restore()
201
202
203class _ToolBoxScrollArea(QScrollArea):
204    def eventFilter(self, obj, event):
205        if obj is self.widget() and event.type() == QEvent.Resize:
206            if event.size() == event.oldSize() and self.widgetResizable():
207                # This is driving me insane. This should not have happened.
208                # Before the event is sent QWidget specifically makes sure the
209                # sizes are different, but somehow I still get this, and enter
210                # an infinite recursion if I enter QScrollArea.eventFilter.
211                # I can only duplicate this on one development machine a
212                # Mac OSX using fink and Qt 4.7.3
213                return False
214
215        return QScrollArea.eventFilter(self, obj, event)
216
217
218class ToolBox(QFrame):
219    """
220    A tool box widget.
221    """
222    # Emitted when a tab is toggled.
223    tabToogled = Signal(int, bool)
224
225    def setExclusive(self, exclusive):
226        """
227        Set exclusive tabs (only one tab can be open at a time).
228        """
229        if self.__exclusive != exclusive:
230            self.__exclusive = exclusive
231            self.__tabActionGroup.setExclusive(exclusive)
232
233    def exclusive(self):
234        """
235        Are the tabs in the toolbox exclusive.
236        """
237        return self.__exclusive
238
239    exclusive_ = Property(bool,
240                          fget=exclusive,
241                          fset=setExclusive,
242                          designable=True,
243                          doc="Exclusive tabs")
244
245    def __init__(self, parent=None, **kwargs):
246        QFrame.__init__(self, parent, **kwargs)
247
248        self.__pages = []
249        self.__tabButtonHeight = -1
250        self.__tabIconSize = QSize()
251        self.__exclusive = False
252        self.__setupUi()
253
254    def __setupUi(self):
255        layout = QVBoxLayout()
256        layout.setContentsMargins(0, 0, 0, 0)
257
258        # Scroll area for the contents.
259        self.__scrollArea = \
260                _ToolBoxScrollArea(self, objectName="toolbox-scroll-area")
261
262        self.__scrollArea.setVerticalScrollBarPolicy(Qt.ScrollBarAlwaysOn)
263        self.__scrollArea.setHorizontalScrollBarPolicy(Qt.ScrollBarAlwaysOff)
264        self.__scrollArea.setSizePolicy(QSizePolicy.MinimumExpanding,
265                                        QSizePolicy.MinimumExpanding)
266        self.__scrollArea.setFrameStyle(QScrollArea.NoFrame)
267        self.__scrollArea.setWidgetResizable(True)
268
269        # A widget with all of the contents.
270        # The tabs/contents are placed in the layout inside this widget
271        self.__contents = QWidget(self.__scrollArea,
272                                  objectName="toolbox-contents")
273
274        # The layout where all the tab/pages are placed
275        self.__contentsLayout = QVBoxLayout()
276        self.__contentsLayout.setContentsMargins(0, 0, 0, 0)
277        self.__contentsLayout.setSizeConstraint(QVBoxLayout.SetMinAndMaxSize)
278        self.__contentsLayout.setSpacing(0)
279
280        self.__contents.setLayout(self.__contentsLayout)
281
282        self.__scrollArea.setWidget(self.__contents)
283
284        layout.addWidget(self.__scrollArea)
285
286        self.setLayout(layout)
287        self.setSizePolicy(QSizePolicy.Fixed,
288                           QSizePolicy.MinimumExpanding)
289
290        self.__tabActionGroup = \
291                QActionGroup(self, objectName="toolbox-tab-action-group")
292
293        self.__tabActionGroup.setExclusive(self.__exclusive)
294
295        self.__actionMapper = QSignalMapper(self)
296        self.__actionMapper.mapped[QObject].connect(self.__onTabActionToogled)
297
298    def setTabButtonHeight(self, height):
299        """
300        Set the tab button height.
301        """
302        if self.__tabButtonHeight != height:
303            self.__tabButtonHeight = height
304            for page in self.__pages:
305                page.button.setFixedHeight(height)
306
307    def tabButtonHeight(self):
308        """
309        Return the tab button height.
310        """
311        return self.__tabButtonHeight
312
313    def setTabIconSize(self, size):
314        """
315        Set the tab button icon size.
316        """
317        if self.__tabIconSize != size:
318            self.__tabIconSize = size
319            for page in self.__pages:
320                page.button.setIconSize(size)
321
322    def tabIconSize(self):
323        """
324        Return the tab icon size.
325        """
326        return self.__tabIconSize
327
328    def tabButton(self, index):
329        """
330        Return the tab button at `index`
331        """
332        return self.__pages[index].button
333
334    def tabAction(self, index):
335        """
336        Return open/close action for the tab at `index`.
337        """
338        return self.__pages[index].action
339
340    def addItem(self, widget, text, icon=None, toolTip=None):
341        """
342        Append the `widget` in a new tab and return its index.
343
344        Parameters
345        ----------
346        widget : :class:`QWidget`
347            A widget to be inserted. The toolbox takes ownership
348            of the widget.
349
350        text : str
351            Name/title of the new tab.
352
353        icon : :class:`QIcon`, optional
354            An icon for the tab button.
355
356        toolTip : str, optional
357            Tool tip for the tab button.
358
359        """
360        return self.insertItem(self.count(), widget, text, icon, toolTip)
361
362    def insertItem(self, index, widget, text, icon=None, toolTip=None):
363        """
364        Insert the `widget` in a new tab at position `index`.
365
366        See also
367        --------
368        ToolBox.addItem
369
370        """
371        button = self.createTabButton(widget, text, icon, toolTip)
372
373        self.__contentsLayout.insertWidget(index * 2, button)
374        self.__contentsLayout.insertWidget(index * 2 + 1, widget)
375
376        widget.hide()
377
378        page = _ToolBoxPage(index, widget, button.defaultAction(), button)
379        self.__pages.insert(index, page)
380
381        for i in range(index + 1, self.count()):
382            self.__pages[i] = self.__pages[i]._replace(index=i)
383
384        self.__updatePositions()
385
386        # Show (open) the first tab.
387        if self.count() == 1 and index == 0:
388            page.action.trigger()
389
390        self.__updateSelected()
391
392        self.updateGeometry()
393        return index
394
395    def removeItem(self, index):
396        """
397        Remove the widget at `index`.
398
399        .. note:: The widget hidden but is is not deleted.
400
401        """
402        self.__contentsLayout.takeAt(2 * index + 1)
403        self.__contentsLayout.takeAt(2 * index)
404        page = self.__pages.pop(index)
405
406        # Update the page indexes
407        for i in range(index, self.count()):
408            self.__pages[i] = self.__pages[i]._replace(index=i)
409
410        page.button.deleteLater()
411
412        # Hide the widget and reparent to self
413        # This follows QToolBox.removeItem
414        page.widget.hide()
415        page.widget.setParent(self)
416
417        self.__updatePositions()
418        self.__updateSelected()
419
420        self.updateGeometry()
421
422    def count(self):
423        """
424        Return the number of widgets inserted in the toolbox.
425        """
426        return len(self.__pages)
427
428    def widget(self, index):
429        """
430        Return the widget at `index`.
431        """
432        return self.__pages[index].widget
433
434    def createTabButton(self, widget, text, icon=None, toolTip=None):
435        """
436        Create the tab button for `widget`.
437        """
438        action = QAction(text, self)
439        action.setCheckable(True)
440
441        if icon:
442            action.setIcon(icon)
443
444        if toolTip:
445            action.setToolTip(toolTip)
446        self.__tabActionGroup.addAction(action)
447        self.__actionMapper.setMapping(action, action)
448        action.toggled.connect(self.__actionMapper.map)
449
450        button = ToolBoxTabButton(self, objectName="toolbox-tab-button")
451        button.setDefaultAction(action)
452        button.setToolButtonStyle(Qt.ToolButtonTextBesideIcon)
453        button.setSizePolicy(QSizePolicy.Expanding,
454                             QSizePolicy.Fixed)
455
456        if self.__tabIconSize.isValid():
457            button.setIconSize(self.__tabIconSize)
458
459        if self.__tabButtonHeight > 0:
460            button.setFixedHeight(self.__tabButtonHeight)
461
462        return button
463
464    def ensureWidgetVisible(self, child, xmargin=50, ymargin=50):
465        """
466        Scroll the contents so child widget instance is visible inside
467        the viewport.
468
469        """
470        self.__scrollArea.ensureWidgetVisible(child, xmargin, ymargin)
471
472    def sizeHint(self):
473        hint = self.__contentsLayout.sizeHint()
474
475        if self.count():
476            # Compute max width of hidden widgets also.
477            scroll = self.__scrollArea
478            scroll_w = scroll.verticalScrollBar().sizeHint().width()
479            frame_w = self.frameWidth() * 2 + scroll.frameWidth() * 2
480            max_w = max([p.widget.sizeHint().width() for p in self.__pages])
481            hint = QSize(max(max_w, hint.width()) + scroll_w + frame_w,
482                         hint.height())
483
484        return QSize(200, 200).expandedTo(hint)
485
486    def __onTabActionToogled(self, action):
487        page = find(self.__pages, action, key=attrgetter("action"))
488        on = action.isChecked()
489        page.widget.setVisible(on)
490        index = page.index
491
492        if index > 0:
493            # Update the `previous` tab buttons style hints
494            previous = self.__pages[index - 1].button
495            flag = QStyleOptionToolBoxV2.NextIsSelected
496            if on:
497                previous.selected |= flag
498            else:
499                previous.selected &= ~flag
500
501            previous.update()
502
503        if index < self.count() - 1:
504            next = self.__pages[index + 1].button
505            flag = QStyleOptionToolBoxV2.PreviousIsSelected
506            if on:
507                next.selected |= flag
508            else:
509                next.selected &= ~flag
510
511            next.update()
512
513        self.tabToogled.emit(index, on)
514
515        self.__contentsLayout.invalidate()
516
517    def __updateSelected(self):
518        """Update the tab buttons selected style flags.
519        """
520        if self.count() == 0:
521            return
522
523        opt = QStyleOptionToolBoxV2
524
525        def update(button, next_sel, prev_sel):
526            if next_sel:
527                button.selected |= opt.NextIsSelected
528            else:
529                button.selected &= ~opt.NextIsSelected
530
531            if prev_sel:
532                button.selected |= opt.PreviousIsSelected
533            else:
534                button.selected &= ~ opt.PreviousIsSelected
535
536            button.update()
537
538        if self.count() == 1:
539            update(self.__pages[0].button, False, False)
540        elif self.count() >= 2:
541            pages = self.__pages
542            for i in range(1, self.count() - 1):
543                update(pages[i].button,
544                       pages[i + 1].action.isChecked(),
545                       pages[i - 1].action.isChecked())
546
547    def __updatePositions(self):
548        """Update the tab buttons position style flags.
549        """
550        if self.count() == 0:
551            return
552        elif self.count() == 1:
553            self.__pages[0].button.position = QStyleOptionToolBoxV2.OnlyOneTab
554        else:
555            self.__pages[0].button.position = QStyleOptionToolBoxV2.Beginning
556            self.__pages[-1].button.position = QStyleOptionToolBoxV2.End
557            for p in self.__pages[1:-1]:
558                p.button.position = QStyleOptionToolBoxV2.Middle
559
560        for p in self.__pages:
561            p.button.update()
562
563
564def identity(arg):
565    return arg
566
567
568def find(iterable, *what, **kwargs):
569    """
570    find(iterable, [what, [key=None, [predicate=operator.eq]]])
571    """
572    if what:
573        what = what[0]
574    key, predicate = kwargs.get("key", identity), kwargs.get("predicate", eq)
575    for item in iterable:
576        item_key = key(item)
577        if predicate(item_key, what):
578            return item
579    else:
580        raise ValueError(what)
Note: See TracBrowser for help on using the repository browser.