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
|
# coding: utf-8
# /*##########################################################################
#
# Copyright (C) 2019 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
from silx.gui import qt
_logger = logging.getLogger(__name__)
class AdvancedComboBox(qt.QComboBox):
"""ComboBox with other features
- Provide a way to custom the displayed when using table view model.
- Allow to disable hardcoded update of `currentIndex`.
"""
def __init__(self, parent=None):
qt.QComboBox.__init__(self, parent=parent)
self.__displayedDataCallback = None
self.currentIndexChanged.connect(self.__currentIndexChanged)
self.__modelWasEmpty = False
self.__updateDefaultIndexUpdate = True
def initStyleOption(self, option):
"""
:param qt.QStyleOptionComboBox option: Option to initialize
"""
qt.QComboBox.initStyleOption(self, option)
dataCallback = self.__displayedDataCallback
if dataCallback is not None:
index = self.currentIndex()
text = dataCallback(self, index, role=qt.Qt.DisplayRole)
if text is None:
text = ""
icon = dataCallback(self, index, role=qt.Qt.DecorationRole)
if icon is None:
icon = qt.QIcon()
option.currentText = text
option.currentIcon = icon
def setUpdateCurrentIndexEnabled(self, enable):
"""
Allow to disable the default behaviour of the QComboBox which update
the current index to 0 when the model crow from an empty state.
"""
if self.__updateDefaultIndexUpdate == enable:
return
self.__updateDefaultIndexUpdate = enable
self.__updateModelConnection(not enable)
if enable:
if self.model() is not None:
self.__modelWasEmpty = self.model().rowCount() == 0
def __updateModelConnection(self, connect):
model = self.model()
if connect:
model.modelReset.connect(self.__modelReset)
model.rowsRemoved.connect(self.__rowsRemoved)
else:
model.modelReset.disconnect(self.__modelReset)
model.rowsRemoved.disconnect(self.__rowsRemoved)
def setModel(self, model):
if not self.__updateDefaultIndexUpdate:
self.__updateModelConnection(False)
super(AdvancedComboBox, self).setModel(model)
if not self.__updateDefaultIndexUpdate:
self.__updateModelConnection(True)
self.__modelWasEmpty = model.rowCount() == 0
def __modelReset(self):
self.__modelWasEmpty = self.model().rowCount() == 0
def __rowsRemoved(self, parent, first, last):
self.__modelWasEmpty = self.model().rowCount() == 0
def __currentIndexChanged(self, index):
"""
Called when currentIndex is updated.
"""
if not self.__updateDefaultIndexUpdate:
# Kind of hack to avoid a hard coded behaviour
if self.__modelWasEmpty:
self.__modelWasEmpty = False
self.setCurrentIndex(-1)
def paintEvent(self, event):
"""
:param qt.QPaintEvent event: Qt event
"""
# Inherite paint event to be able to custom initStyleOption.
# It's a protected function that can't be hinerited by Python.
painter = qt.QStylePainter(self)
painter.setPen(self.palette().color(qt.QPalette.Text))
# draw the combobox frame, focusrect and selected etc.
opt = qt.QStyleOptionComboBox()
self.initStyleOption(opt)
painter.drawComplexControl(qt.QStyle.CC_ComboBox, opt)
# draw the icon and text
painter.drawControl(qt.QStyle.CE_ComboBoxLabel, opt)
def setDisplayedDataCallback(self, callback):
"""
Set a callback to custom the displayed text and icon of the displayed
selected item.
This was designed to be used with `setModel`, in case the cell to
display is not part of the model provided.
Only `qt.Qt.DisplayRole` and `qt.Qt.DecorationRole` are supported.
.. code-block:: python
def displayedData(widget, row, role=qt.Qt.DisplayRole):
if role == qt.Qt.DisplayRole:
model = widget.model()
index0 = model.index(row, 0)
index1 = model.index(row, 1)
text = index0.data() + " " + index1.data()
return text
elif role == qt.Qt.DecorationRole:
return None
return None
comboBox = AdvancedComboBox()
comboBox.setModel(model)
comboBox.setDisplayedDataCallback(displayedData)
:param Callable(int,QVariant) callback: Callback a-la Qt abstract
model `data`. Called with the row index and the role to update the
text and the icon of the displayed item.
"""
self.__displayedDataCallback = callback
|
