Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Table widget updates #301

Merged
merged 14 commits into from
Oct 19, 2021
55 changes: 48 additions & 7 deletions magicgui/backends/_qtpy/widgets.py
Original file line number Diff line number Diff line change
Expand Up @@ -976,6 +976,10 @@ def _maybefloat(item):
class _QTableExtended(QtW.QTableWidget):
_read_only: bool = False

def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.setItemDelegate(_ItemDelegate(parent=self))

def _copy_to_clipboard(self):
selranges = self.selectedRanges()
if not selranges:
Expand Down Expand Up @@ -1057,8 +1061,8 @@ def keyPressEvent(self, e: QKeyEvent):
class Table(QBaseWidget, _protocols.TableWidgetProtocol):
_qwidget: _QTableExtended
_DATA_ROLE: int = 255
_RO_FLAGS = Qt.ItemIsSelectable | Qt.ItemIsEnabled
_DEFAULT_FLAGS = Qt.ItemIsSelectable | Qt.ItemIsEditable | Qt.ItemIsEnabled
_EDITABLE = QtW.QTableWidget.EditKeyPressed | QtW.QTableWidget.DoubleClicked
_READ_ONLY = QtW.QTableWidget.NoEditTriggers

def __init__(self):
super().__init__(_QTableExtended)
Expand All @@ -1067,14 +1071,16 @@ def __init__(self):
if hasattr(header, "setSectionResizeMode"):
header.setSectionResizeMode(QtW.QHeaderView.Stretch)
# self._qwidget.horizontalHeader().setSectionsMovable(True) # tricky!!
header.setSectionResizeMode(QtW.QHeaderView.Interactive)
self._qwidget.itemChanged.connect(self._update_item_data_with_text)

def _mgui_set_read_only(self, value: bool) -> None:
self._qwidget._read_only = bool(value)
flags = Table._RO_FLAGS if value else Table._DEFAULT_FLAGS
for row in range(self._qwidget.rowCount()):
for col in range(self._qwidget.columnCount()):
self._qwidget.item(row, col).setFlags(flags)
value = bool(value)
self._qwidget._read_only = value
if value:
self._qwidget.setEditTriggers(self._READ_ONLY)
else:
self._qwidget.setEditTriggers(self._EDITABLE)

def _mgui_get_read_only(self) -> bool:
return self._qwidget._read_only
Expand Down Expand Up @@ -1180,3 +1186,38 @@ def _item_callback(item, callback=callback):
callback(data)

self._qwidget.itemChanged.connect(_item_callback)


class _ItemDelegate(QtW.QStyledItemDelegate):
"""Displays table widget items with properly formatted numbers."""

def __init__(self, *args, ndigits: int = 4, **kwargs):
super().__init__(*args, **kwargs)
self.ndigits = ndigits

def displayText(self, value, locale):
# convert to int or float if possible
value = self._format_number(value)

return super().displayText(value, locale)

def _format_number(self, text: str) -> str:
try:
value = int(text)
except ValueError:
try:
value = float(text) # type: ignore
except ValueError:
pass

if isinstance(value, (int, float)):
if 0.1 <= abs(value) < 10 ** (self.ndigits + 1) or value == 0:
if isinstance(value, int):
text = str(value)
else:
text = float(value)
text = f"{text:.{self.ndigits}f}"
else:
text = f"{value:.{self.ndigits-1}e}"

return text
9 changes: 9 additions & 0 deletions tests/test_table.py
Original file line number Diff line number Diff line change
Expand Up @@ -388,3 +388,12 @@ def test_delete(qapp):
assert not table.read_only
table.native._delete_selection()
assert table.data.to_list() == [[None, None, 3], [None, None, 6]]


def test_item_delegate(qapp):
from magicgui.backends._qtpy.widgets import _ItemDelegate

data = ["1.2", "1.23456789", "0.000123", "1234567", "0.0"]
idel = _ItemDelegate()
results = [idel._format_number(v) for v in data]
assert results == ["1.2000", "1.2346", "1.230e-04", "1.235e+06", "0.0000"]