'
+ )
+
+ def get_info_repr(self, element: Element) -> str:
+ if element.get('additional_info'):
+ additional_info = f' {element["additional_info"]}'
+ else:
+ return ''
+
+ return (
+ f''
+ f'{additional_info}'
+ f''
+ )
+
+
+class ElementsTable(HoverRowsTableView):
+
+ def __init__(self, parent: Optional[QWidget], elements: List[Element]):
+ HoverRowsTableView.__init__(self, parent)
+ self.elements = elements
+
+ # Check for additional features
+ with_icons = self._with_feature('icon')
+ with_addtional_info = self._with_feature('additional_info')
+ with_widgets = self._with_feature('widget')
+
+ # To keep track of the current row widget (e.g. a checkbox) in order to
+ # change its background color when its row is hovered.
+ self._current_row = -1
+ self._current_row_widget = None
+
+ # To do adjustments when the widget is shown only once
+ self._is_shown = False
+
+ # This is used to paint the entire row's background color when its
+ # hovered.
+ self.sig_hover_index_changed.connect(self._on_hover_index_changed)
+
+ # Set model
+ self.model = ElementsModel(
+ self, self.elements, with_icons, with_addtional_info, with_widgets
+ )
+ self.setModel(self.model)
+
+ # Adjustments for the title column
+ title_delegate = HTMLDelegate(self, margin=9, wrap_text=True)
+ self.setItemDelegateForColumn(
+ self.model.columns['title'], title_delegate)
+ self.sig_hover_index_changed.connect(
+ title_delegate.on_hover_index_changed)
+
+ # Adjustments for the additional info column
+ self._info_column_width = 0
+ if with_addtional_info:
+ info_delegate = HTMLDelegate(self, margin=10, align_vcenter=True)
+ self.setItemDelegateForColumn(
+ self.model.columns['additional_info'], info_delegate)
+ self.sig_hover_index_changed.connect(
+ info_delegate.on_hover_index_changed)
+
+ # This is necessary to get this column's width below
+ self.resizeColumnsToContents()
+
+ self._info_column_width = self.horizontalHeader().sectionSize(
+ self.model.columns['additional_info'])
+
+ # Adjustments for the widgets column
+ self._widgets_column_width = 0
+ if with_widgets:
+ widgets_delegate = HTMLDelegate(self, margin=0)
+ self.setItemDelegateForColumn(
+ self.model.columns['widgets'], widgets_delegate)
+ self.sig_hover_index_changed.connect(
+ widgets_delegate.on_hover_index_changed)
+
+ # This is necessary to get this column's width below
+ self.resizeColumnsToContents()
+
+ # Note: We add 15 pixels to the Qt width so that the widgets are
+ # not so close to the right border of the table, which doesn't look
+ # good.
+ self._widgets_column_width = self.horizontalHeader().sectionSize(
+ self.model.columns['widgets']) + 15
+
+ # Add widgets
+ for i in range(len(self.elements)):
+ layout = QHBoxLayout()
+ layout.addWidget(self.elements[i]['widget'])
+ layout.setAlignment(Qt.AlignHCenter)
+
+ container_widget = QWidget(self)
+ container_widget.setLayout(layout)
+
+ # This key is not accounted for in Element because it's only
+ # used internally, so it doesn't need to provided in a list of
+ # Element's.
+ self.elements[i]['row_widget'] = container_widget
+
+ self.setIndexWidget(
+ self.model.index(i, self.model.columns['widgets']),
+ container_widget
+ )
+
+ # Make last column take the available space to the right
+ self.horizontalHeader().setStretchLastSection(True)
+
+ # Hide headers
+ self.horizontalHeader().hide()
+ self.verticalHeader().hide()
+
+ # Set icons size
+ if with_icons:
+ self.setIconSize(QSize(32, 32))
+
+ # Hide grid to only paint horizontal lines with css
+ self.setShowGrid(False)
+
+ # Set selection behavior
+ self.setSelectionMode(QAbstractItemView.NoSelection)
+
+ # Set stylesheet
+ self._set_stylesheet()
+
+ # ---- Private API
+ # -------------------------------------------------------------------------
+ def _on_hover_index_changed(self, index):
+ """Actions to take when the index that is hovered has changed."""
+ row = index.row()
+
+ if row != self._current_row:
+ self._current_row = row
+
+ # Remove background color of previous row widget
+ if self._current_row_widget is not None:
+ self._current_row_widget.setStyleSheet("")
+
+ # Set background for the new row widget
+ new_row_widget = self.elements[row]["row_widget"]
+ new_row_widget.setStyleSheet(
+ f"background-color: {QStylePalette.COLOR_BACKGROUND_3}"
+ )
+
+ # Set new current row widget
+ self._current_row_widget = new_row_widget
+
+ def _set_stylesheet(self, leave=False):
+ """Set stylesheet when entering or leaving the widget."""
+ css = qstylizer.style.StyleSheet()
+ bgcolor = QStylePalette.COLOR_BACKGROUND_1 if leave else "transparent"
+
+ css["QTableView::item"].setValues(
+ borderBottom=f"1px solid {QStylePalette.COLOR_BACKGROUND_4}",
+ paddingLeft="5px",
+ backgroundColor=bgcolor
+ )
+
+ self.setStyleSheet(css.toString())
+
+ def _set_layout(self):
+ """
+ Set rows and columns layout.
+
+ This is necessary to make the table look good at different sizes.
+ """
+ # Resize title column so that the table fits into the available
+ # horizontal space.
+ if self._info_column_width > 0 or self._widgets_column_width > 0:
+ title_column_width = (
+ self.horizontalHeader().size().width() -
+ (self._info_column_width + self._widgets_column_width)
+ )
+
+ self.horizontalHeader().resizeSection(
+ self.model.columns['title'], title_column_width
+ )
+
+ # Resize rows. This is done because wrapping text in HTMLDelegate's
+ # changes row heights in unpredictable ways.
+ self.resizeRowsToContents()
+
+ def _with_feature(self, feature_name: str) -> bool:
+ """Check if it's necessary to build the table with `feature_name`."""
+ return len([e for e in self.elements if e.get(feature_name)]) > 0
+
+ # ---- Qt methods
+ # -------------------------------------------------------------------------
+ def showEvent(self, event):
+ if not self._is_shown:
+ self._set_layout()
+
+ # To not run the adjustments above every time the widget is shown
+ self._is_shown = True
+
+ super().showEvent(event)
+
+ def leaveEvent(self, event):
+ super().leaveEvent(event)
+
+ # Clear background color painted on hovered row widget
+ if self._current_row_widget is not None:
+ self._current_row_widget.setStyleSheet('')
+ self._set_stylesheet(leave=True)
+
+ def enterEvent(self, event):
+ super().enterEvent(event)
+
+ # Restore background color that's going to be painted on hovered row
+ if self._current_row_widget is not None:
+ self._current_row_widget.setStyleSheet(
+ f"background-color: {QStylePalette.COLOR_BACKGROUND_3}"
+ )
+ self._set_stylesheet()
+
+ def resizeEvent(self, event):
+ # This is necessary to readjust the layout when the parent widget is
+ # resized.
+ self._set_layout()
+ super().resizeEvent(event)
+
+ def event(self, event):
+ # This is necessary to readjust the layout when the parent widget is
+ # maximized.
+ if event.type() == QEvent.LayoutRequest:
+ self._set_layout()
+ return super().event(event)
+
+
+def test_elements_table():
+ from spyder.utils.qthelpers import qapplication
+ app = qapplication() # noqa
+
+ elements_with_title = [
+ {'title': 'IPython console', 'description': 'Execute code'},
+ {'title': 'Help', 'description': 'Look for help'}
+ ]
+
+ table = ElementsTable(None, elements_with_title)
+ table.show()
+
+ elements_with_icons = [
+ {'title': 'IPython console', 'description': 'Execute code',
+ 'icon': ima.icon('ipython_console')},
+ {'title': 'Help', 'description': 'Look for help',
+ 'icon': ima.icon('help')}
+ ]
+
+ table_with_icons = ElementsTable(None, elements_with_icons)
+ table_with_icons.show()
+
+ elements_with_widgets = [
+ {'title': 'IPython console', 'description': 'Execute code',
+ 'icon': ima.icon('ipython_console'), 'widget': QCheckBox()},
+ {'title': 'Help', 'description': 'Look for help',
+ 'icon': ima.icon('help'), 'widget': QCheckBox()}
+ ]
+
+ table_with_widgets = ElementsTable(None, elements_with_widgets)
+ table_with_widgets.show()
+
+ elements_with_info = [
+ {'title': 'IPython console', 'description': 'Execute code',
+ 'icon': ima.icon('ipython_console'), 'widget': QCheckBox(),
+ 'additional_info': 'Core plugin'},
+ {'title': 'Help', 'description': 'Look for help',
+ 'icon': ima.icon('help'), 'widget': QCheckBox()}
+ ]
+
+ table_with_widgets_and_icons = ElementsTable(None, elements_with_info)
+ table_with_widgets_and_icons.show()
+
+ app.exec_()
+
+
+if __name__ == '__main__':
+ test_elements_table()
diff --git a/spyder/widgets/helperwidgets.py b/spyder/widgets/helperwidgets.py
index 91e6fbd3731..d48f27e9faa 100644
--- a/spyder/widgets/helperwidgets.py
+++ b/spyder/widgets/helperwidgets.py
@@ -21,7 +21,7 @@
from qtpy.QtWidgets import (QApplication, QCheckBox, QLineEdit, QMessageBox,
QSpacerItem, QStyle, QStyledItemDelegate,
QStyleOptionFrame, QStyleOptionViewItem,
- QToolButton, QToolTip, QVBoxLayout,
+ QTableView, QToolButton, QToolTip, QVBoxLayout,
QWidget, QHBoxLayout, QLabel, QFrame)
# Local imports
@@ -32,6 +32,7 @@
from spyder.utils.image_path_manager import get_image_path
from spyder.utils.stylesheet import DialogStyle
+
# Valid finder chars. To be improved
VALID_ACCENT_CHARS = "ÁÉÍOÚáéíúóàèìòùÀÈÌÒÙâêîôûÂÊÎÔÛäëïöüÄËÏÖÜñÑ"
VALID_FINDER_CHARS = r"[A-Za-z\s{0}]".format(VALID_ACCENT_CHARS)
@@ -112,14 +113,18 @@ def set_checkbox_text(self, text):
class HTMLDelegate(QStyledItemDelegate):
- """With this delegate, a QListWidgetItem or a QTableItem can render HTML.
+ """
+ With this delegate, a QListWidgetItem or a QTableItem can render HTML.
Taken from https://stackoverflow.com/a/5443112/2399799
"""
- def __init__(self, parent, margin=0):
+ def __init__(self, parent, margin=0, wrap_text=False, align_vcenter=False):
super(HTMLDelegate, self).__init__(parent)
self._margin = margin
+ self._wrap_text = wrap_text
+ self._hovered_row = -1
+ self._align_vcenter = align_vcenter
def _prepare_text_document(self, option, index):
# This logic must be shared between paint and sizeHint for consistency
@@ -129,8 +134,22 @@ def _prepare_text_document(self, option, index):
doc = QTextDocument()
doc.setDocumentMargin(self._margin)
doc.setHtml(options.text)
+ if self._wrap_text:
+ # The -25 here is used to avoid the text to go totally up to the
+ # right border of the widget that contains the delegate, which
+ # doesn't look good.
+ doc.setTextWidth(option.rect.width() - 25)
+
return options, doc
+ def on_hover_index_changed(self, index):
+ """
+ This can be used by a widget that inherits from HoverRowsTableView to
+ connect its sig_hover_index_changed signal to this method to paint an
+ entire row when it's hovered.
+ """
+ self._hovered_row = index.row()
+
def paint(self, painter, option, index):
options, doc = self._prepare_text_document(option, index)
@@ -138,6 +157,14 @@ def paint(self, painter, option, index):
else options.widget.style())
options.text = ""
+ # This paints the entire row associated to the delegate when it's
+ # hovered and the table that holds it informs it what's the current
+ # row (see HoverRowsTableView for an example).
+ if index.row() == self._hovered_row:
+ painter.fillRect(
+ options.rect, QColor(QStylePalette.COLOR_BACKGROUND_3)
+ )
+
# Note: We need to pass the options widget as an argument of
# drawCrontol to make sure the delegate is painted with a style
# consistent with the widget in which it is used.
@@ -153,18 +180,21 @@ def paint(self, painter, option, index):
# Adjustments for the file switcher
if hasattr(options.widget, 'files_list'):
- if style.objectName() in ['oxygen', 'qtcurve', 'breeze']:
- if options.widget.files_list:
- painter.translate(textRect.topLeft() + QPoint(4, -9))
- else:
- painter.translate(textRect.topLeft())
+ if options.widget.files_list:
+ painter.translate(textRect.topLeft() + QPoint(4, 4))
else:
- if options.widget.files_list:
- painter.translate(textRect.topLeft() + QPoint(4, 4))
- else:
- painter.translate(textRect.topLeft() + QPoint(2, 4))
+ painter.translate(textRect.topLeft() + QPoint(2, 4))
else:
- painter.translate(textRect.topLeft() + QPoint(0, -3))
+ if not self._align_vcenter:
+ painter.translate(textRect.topLeft() + QPoint(0, -3))
+
+ # Center text vertically if requested.
+ # Take from https://stackoverflow.com/a/32911270/438386
+ if self._align_vcenter:
+ doc.setTextWidth(option.rect.width())
+ offset_y = (option.rect.height() - doc.size().height()) / 2
+ painter.translate(options.rect.x(), options.rect.y() + offset_y)
+ doc.drawContents(painter)
# Type check: Prevent error in PySide where using
# doc.documentLayout().draw() may fail because doc.documentLayout()
@@ -529,9 +559,67 @@ def _apply_stylesheet(self, focus):
self.setStyleSheet(qss.toString())
+class HoverRowsTableView(QTableView):
+ """
+ QTableView subclass that can highlight an entire row when hovered.
+
+ Notes
+ -----
+ * Classes that inherit from this one need to connect a slot to
+ sig_hover_index_changed that handles how the row is painted.
+ """
+
+ sig_hover_index_changed = Signal(object)
+ """
+ This is emitted when the index that is currently hovered has changed.
+
+ Parameters
+ ----------
+ index: object
+ QModelIndex that has changed on hover.
+ """
+
+ def __init__(self, parent):
+ QTableView.__init__(self, parent)
+
+ # For mouseMoveEvent
+ self.setMouseTracking(True)
+
+ # To remove background color for the hovered row when the mouse is not
+ # over the widget.
+ css = qstylizer.style.StyleSheet()
+ css["QTableView::item"].setValues(
+ backgroundColor=f"{QStylePalette.COLOR_BACKGROUND_1}"
+ )
+ self._stylesheet = css.toString()
+
+ # ---- Qt methods
+ def mouseMoveEvent(self, event):
+ self._inform_hover_index_changed(event)
+
+ def wheelEvent(self, event):
+ super().wheelEvent(event)
+ self._inform_hover_index_changed(event)
+
+ def leaveEvent(self, event):
+ super().leaveEvent(event)
+ self.setStyleSheet(self._stylesheet)
+
+ def enterEvent(self, event):
+ super().enterEvent(event)
+ self.setStyleSheet("")
+
+ # ---- Private methods
+ def _inform_hover_index_changed(self, event):
+ index = self.indexAt(event.pos())
+ if index.isValid():
+ self.sig_hover_index_changed.emit(index)
+ self.viewport().update()
+
+
def test_msgcheckbox():
from spyder.utils.qthelpers import qapplication
- app = qapplication()
+ app = qapplication() # noqa
box = MessageCheckBox()
box.setWindowTitle(_("Spyder updates"))
box.setText("Testing checkbox")