Skip to content

Commit

Permalink
Apply suggestions and update browser preview image
Browse files Browse the repository at this point in the history
  • Loading branch information
@dalthviz
dalthviz committed Nov 23, 2023
1 parent 0f41ce5 commit e736f8a
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 93 deletions.
Binary file modified qtawesome-browser.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
160 changes: 74 additions & 86 deletions qtawesome/icon_browser.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
# TODO: Set icon colour and copy code with color kwarg

DEFAULT_VIEW_COLUMNS = 5
VIEW_COLUMNS_OPTIONS = [5, 8, 10, 15, 20, 25, 30]
AUTO_SEARCH_TIMEOUT = 500
ALL_COLLECTIONS = 'All'

Expand Down Expand Up @@ -47,82 +48,90 @@ def __init__(self):
self._proxyModel.setSourceModel(model)
self._proxyModel.setFilterCaseSensitivity(QtCore.Qt.CaseInsensitive)

self._listView = IconListView(self, DEFAULT_VIEW_COLUMNS)
self._listView = IconListView(DEFAULT_VIEW_COLUMNS, parent=self)
self._listView.setUniformItemSizes(True)
self._listView.setViewMode(QtWidgets.QListView.IconMode)
self._listView.setModel(self._proxyModel)
self._listView.setContextMenuPolicy(QtCore.Qt.CustomContextMenu)
self._listView.doubleClicked.connect(self._copyIconText)
self._listView.selectionModel().selectionChanged.connect(self._updateNameField)
self._listView.selectionModel().selectionChanged.connect(
self._updateNameField
)

toolbar = QtWidgets.QHBoxLayout()

# filter group
tbgFont = ToolBarGroup("Filter")
toolbar.addWidget(tbgFont)
# Filter section
self._comboFont = QtWidgets.QComboBox(self)
self._comboFont.setFixedWidth(75)
self._comboFont.setToolTip(
"Select the fonts prefix which icons will "
"be included in the filtering"
)
self._comboFont.setMaximumWidth(75)
self._comboFont.addItems([ALL_COLLECTIONS] + sorted(fontMaps.keys()))
self._comboFont.currentIndexChanged.connect(self._triggerImmediateUpdate)
tbgFont.addWidget(self._comboFont)
self._comboFont.currentIndexChanged.connect(
self._triggerImmediateUpdate
)
toolbar.addWidget(self._comboFont)

self._lineEditFilter = QtWidgets.QLineEdit(self)
self._lineEditFilter.setFixedWidth(200)
self._lineEditFilter.setToolTip("Filter icons by name")
self._lineEditFilter.setMaximumWidth(200)
self._lineEditFilter.setToolTip("Filter icons by name")
self._lineEditFilter.setAlignment(QtCore.Qt.AlignLeft)
self._lineEditFilter.textChanged.connect(self._triggerDelayedUpdate)
self._lineEditFilter.returnPressed.connect(self._triggerImmediateUpdate)
tbgFont.addWidget(self._lineEditFilter)

buttClear = QtWidgets.QToolButton()
buttClear.setAutoRaise(True)
buttClear.setToolButtonStyle(QtCore.Qt.ToolButtonIconOnly)
buttClear.setIcon(qtawesome.icon("mdi.alpha-x"))
buttClear.clicked.connect(self._clearClicked)
tbgFont.addWidget(buttClear)

# selected group
tbgSelected = ToolBarGroup("Selected")
toolbar.addWidget(tbgSelected)
self._lineEditFilter.returnPressed.connect(
self._triggerImmediateUpdate
)
self._lineEditFilter.setClearButtonEnabled(True)
toolbar.addWidget(self._lineEditFilter, stretch=10)

# Icon name section
self._nameField = QtWidgets.QLineEdit(self)
self._nameField.setToolTip(
"Full identifier of the currently selected icon"
)
self._nameField.setAlignment(QtCore.Qt.AlignCenter)
self._nameField.setReadOnly(True)
self._nameField.setFixedWidth(250)
self._nameField.setMaximumWidth(250)
fnt = self._nameField.font()
fnt.setFamily("monospace")
fnt.setBold(True)
self._nameField.setFont(fnt)
tbgSelected.addWidget(self._nameField)
toolbar.addWidget(self._nameField, stretch=10)

self._copyButton = QtWidgets.QPushButton('Copy Name', self)
self._copyButton.setToolTip(
"Copy selected icon full identifier to the clipboard"
)
self._copyButton.clicked.connect(self._copyIconText)
self._copyButton.setDisabled(True)
tbgSelected.addWidget(self._copyButton)
toolbar.addWidget(self._copyButton)
toolbar.addStretch(1)

# Style section
self._comboStyle = QtWidgets.QComboBox(self)
self._comboStyle.setToolTip(
"Select color palette for the icons and the icon browser"
)
self._comboStyle.addItem(qtawesome.styles.DEFAULT_DARK_PALETTE, 0)
self._comboStyle.addItem(qtawesome.styles.DEFAULT_LIGHT_PALETTE, 1)
self._comboStyle.currentTextChanged.connect(self._updateStyle)
toolbar.addWidget(self._comboStyle)

# Display (columns number) section
self._comboColumns = QtWidgets.QComboBox(self)
self._comboColumns.setToolTip(
"Select number of columns the icons list is showing"
)
for num_columns in VIEW_COLUMNS_OPTIONS:
self._comboColumns.addItem(str(num_columns), num_columns)
self._comboColumns.setCurrentIndex(
self._comboColumns.findData(DEFAULT_VIEW_COLUMNS)
)
self._comboColumns.currentTextChanged.connect(self._updateColumns)
toolbar.addWidget(self._comboColumns)

toolbar.addStretch(100)

# Style
tbgroup = ToolBarGroup("Style")
toolbar.addWidget(tbgroup)

self._combo_style = QtWidgets.QComboBox(self)
self._combo_style.addItem(qtawesome.styles.DEFAULT_DARK_PALETTE, 0)
self._combo_style.addItem(qtawesome.styles.DEFAULT_LIGHT_PALETTE, 1)
self._combo_style.currentTextChanged.connect(self._updateStyle)
tbgroup.addWidget(self._combo_style)


# Cols across
tbcols = ToolBarGroup("Columns")
toolbar.addWidget(tbcols)
self._combo_cols = QtWidgets.QComboBox(self)
for idx, no in enumerate([5, 8, 10, 15, 20, 25, 30]):
self._combo_cols.addItem(str(no), no)
self._combo_cols.setCurrentIndex(self._combo_cols.findData(DEFAULT_VIEW_COLUMNS))
tbcols.addWidget(self._combo_cols)
self._combo_cols.currentTextChanged.connect(self._updateColumns)

# Layout
lyt = QtWidgets.QVBoxLayout()
lyt.addLayout(toolbar)
lyt.addWidget(self._listView)
Expand All @@ -133,12 +142,13 @@ def __init__(self):
self.setCentralWidget(frame)

self.setTabOrder(self._comboFont, self._lineEditFilter)
self.setTabOrder(self._lineEditFilter, self._combo_style)
self.setTabOrder(self._combo_style, self._listView)
self.setTabOrder(self._lineEditFilter, self._comboStyle)
self.setTabOrder(self._comboStyle, self._listView)
self.setTabOrder(self._listView, self._nameField)
self.setTabOrder(self._nameField, self._copyButton)
self.setTabOrder(self._copyButton, self._comboFont)

# Shortcuts
QtWidgets.QShortcut(
QtGui.QKeySequence(QtCore.Qt.Key_Return),
self,
Expand Down Expand Up @@ -167,7 +177,7 @@ def __init__(self):

geo.moveCenter(centerPoint)
self.setGeometry(geo)
self._updateStyle(self._combo_style.currentText())
self._updateStyle(self._comboStyle.currentText())

def _updateStyle(self, text: str):
_app = QtWidgets.QApplication.instance()
Expand All @@ -179,7 +189,7 @@ def _updateStyle(self, text: str):
qtawesome.light(_app)

def _updateColumns(self):
self._listView.set_cols(self._combo_cols.currentData())
self._listView.setColumns(self._comboColumns.currentData())

def _updateFilter(self):
"""
Expand Down Expand Up @@ -219,9 +229,6 @@ def _triggerImmediateUpdate(self):
self._filterTimer.stop()
self._updateFilter()

def _clearClicked(self):
self._lineEditFilter.clear()

def _copyIconText(self):
"""
Copy the name of the currently selected icon to the clipboard.
Expand Down Expand Up @@ -253,18 +260,21 @@ class IconListView(QtWidgets.QListView):
columns are always drawn.
"""

def __init__(self, parent, columns):
def __init__(self, columns, parent=None):
super().__init__(parent)
self._columns = columns
self.setVerticalScrollBarPolicy(QtCore.Qt.ScrollBarAlwaysOn)

def set_cols(self, cols):
def setColumns(self, cols):
"""
Set columns number and resize.
"""
self._columns = cols
self._calc_cols()
self._resize()

def _calc_cols(self):
def _resize(self):
"""
re-calculate the grid size to provide scaling icons
Set grid and icon size taking into account the number of columns.
"""

width = self.viewport().width() - 30
Expand All @@ -280,7 +290,10 @@ def _calc_cols(self):
self.setIconSize(QtCore.QSize(iconWidth, iconWidth))

def resizeEvent(self, event):
self._calc_cols()
"""
Re-implemented to resize view following number of columns available.
"""
self._resize()
return super().resizeEvent(event)


Expand Down Expand Up @@ -311,31 +324,6 @@ def data(self, index, role):
return super().data(index, role)


class ToolBarGroup(QtWidgets.QWidget):
def __init__(self, title):
super().__init__()

vlay = QtWidgets.QVBoxLayout()
vlay.setContentsMargins(0,0,0,0)
vlay.setSpacing(2)
self.setLayout(vlay)

lbl = QtWidgets.QLabel(title)
lbl.setFrameShape(QtWidgets.QFrame.Panel)
lbl.setFrameShadow(QtWidgets.QFrame.Raised)
vlay.addWidget(lbl)

self.tbar = QtWidgets.QHBoxLayout()
self.tbar.setContentsMargins(0, 0, 0, 0)
self.tbar.setSpacing(2)
vlay.addLayout(self.tbar)

def addWidget(self, widget):
self.tbar.addWidget(widget)




def run():
"""
Start the IconBrowser and block until the process exits.
Expand Down
19 changes: 12 additions & 7 deletions qtawesome/tests/test_icon_browser.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,24 +58,29 @@ def test_copy(qtbot, browser):

assert "penguin" in clipboard.text()

def test_filter_success(qtbot, browser):

def test_filter(qtbot, browser):
"""
What happens if a `penguin`
Ensure the filter UX works when searching for `penguin`
"""
#initRowCount = browser._listView.model().rowCount()
#assert initRowCount > 0
initRowCount = browser._listView.model().rowCount()
assert initRowCount > 0

# Enter a search term and click
qtbot.keyClicks(browser._lineEditFilter, 'penguin')
qtbot.keyPress(browser._lineEditFilter, QtCore.Qt.Key_Enter)

filteredRowCount = browser._listView.model().rowCount()
assert filteredRowCount > 1
assert initRowCount > filteredRowCount


def test_filter_fail(qtbot, browser):
def test_filter_no_results(qtbot, browser):
"""
What happens if a `not a penguin-penguin`
Ensure the filter doesn't show results (the text doesn't match any icon)
"""
initRowCount = browser._listView.model().rowCount()
assert initRowCount > 0

# Enter a search term
qtbot.keyClicks(browser._lineEditFilter, 'I-AM-NOT-penguin-A-penguin')

Expand Down

0 comments on commit e736f8a

Please sign in to comment.