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
|
# coding: utf-8
# /*##########################################################################
#
# Copyright (C) 2016-2018 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.
#
# ###########################################################################*/
__authors__ = ["V. Valls"]
__license__ = "MIT"
__date__ = "16/10/2020"
import logging
import weakref
from silx.gui import qt
from silx.gui import icons
_logger = logging.getLogger(__name__)
class ChoiceToolButton(qt.QToolButton):
"""ToolButton providing a set of actions to select.
The action is only triggered when the button is clicked.
The method :meth:`addDefaultAction` is used to define new actions that can
be selected.
"""
def __init__(self, parent=None):
qt.QToolButton.__init__(self, parent=parent)
self.__isWaiting = False
self.__waitingIcon = None
self.__defaultAction = None
self.clicked.connect(self.__clicked)
def __clicked(self):
default = self.defaultAction()
if default is not None:
default.trigger()
def __updateWaitingIcon(self, icon):
self.setIcon(icon)
def __updateIcon(self):
if self.__isWaiting:
self.setIcon(self.__waitingIcon.currentIcon())
else:
default = self.defaultAction()
if default is not None:
self.setIcon(default.icon())
def setWaiting(self, isWaiting):
"""Enable a waiting state.
:param bool isWaiting: If true switch the widget to waiting state
"""
if self.__isWaiting == isWaiting:
return
self.__isWaiting = isWaiting
if isWaiting:
self.__waitingIcon = icons.getWaitIcon()
self.__waitingIcon.register(self)
self.__waitingIcon.iconChanged.connect(self.__updateWaitingIcon)
else:
self.__waitingIcon.iconChanged.disconnect(self.__updateWaitingIcon)
self.__waitingIcon.unregister(self)
self.__waitingIcon = None
self.__updateIcon()
def defaultAction(self):
"""Returns the default selected action.
"""
return self.__defaultAction
def setDefaultAction(self, action):
"""Set the default action.
Reimplement the default behaviour to avoid to add this action to the
list of available actions.
"""
if self.__defaultAction is action:
return
self.__defaultAction = action
if not self.__isWaiting:
self.setIcon(action.icon())
self.setText(action.text())
self.setToolTip(action.toolTip())
def __selectActionTriggered(self, selectActionRef):
selectAction = selectActionRef()
if selectAction is None:
return
action = selectAction._action()
if action is None:
return
self.setDefaultAction(action)
def addDefaultAction(self, action):
"""Add an action that can be selected to set the default action
displayed by the tool button.
:param qt.QAction action: An action to execute when selected on the
menu and then clicked.
:rtype: qt.QAction
:returns: An action triggered when the provided action is selected.
"""
default = self.defaultAction()
if default is None:
self.setDefaultAction(action)
selectAction = qt.QAction(self)
selectAction.setIcon(action.icon())
selectAction.setToolTip(action.toolTip())
selectAction.setText(action.text())
action.setVisible(False)
selectAction._action = weakref.ref(action)
selectActionRef = weakref.ref(selectAction)
selectAction.triggered.connect(lambda: self.__selectActionTriggered(selectActionRef))
self.addAction(selectAction)
return selectAction
|
