Search code examples
pythonpyqt4pyqt5pysidepyside2

How to add “Select item…” to QComboBox when using sorted QAbstractTableModel?

I wish to set a sorted QAbstractListModel to a QComboBox and always display "Select item..." as the very first value in the combo box.

Whenever I use sorting, the "Select item..." item is undesirably sorted along with all other items:

import sys

from PySide2 import QtCore  # or PyQt5
from PySide2 import QtWidgets  # or PyQt5

import natsort  # pip install natsort


class NatSort(QtCore.QSortFilterProxyModel):

    def __init__(self, parent=None):
        super(NatSort, self).__init__(parent)

    def lessThan(self, left, right):
        left_data = self.sourceModel().data(left, role=QtCore.Qt.DisplayRole)
        right_data = self.sourceModel().data(right, role=QtCore.Qt.DisplayRole)

        sorted_data = natsort.natsorted([left_data, right_data])

        if left_data == sorted_data[0]:
            return True
        return False


class ListModel(QtCore.QAbstractListModel):

    def __init__(self, items=[], parent=None):
        QtCore.QAbstractListModel.__init__(self, parent)
        self._items = items

    def rowCount(self, parent=QtCore.QModelIndex()):
        return len(self._items) + 1  # adjust row count

    def data(self, index, role):

        row = index.row() - 1  # adjust row count

        if role == QtCore.Qt.DisplayRole:
            if row >= 0:
                obj = self._items[row]
                return obj
            else:
                return 'Select item...'


if __name__ == '__main__':

    app = QtWidgets.QApplication(sys.argv)
    button = QtWidgets.QComboBox()

    data = ['m', '?', 'A', 'X', '1', 'b']

    model = ListModel(items=data)
    proxy_model = NatSort()
    # proxy_model = QtCore.QSortFilterProxyModel()  # same results
    proxy_model.setSourceModel(model)
    proxy_model.sort(0, QtCore.Qt.AscendingOrder)
    button.setModel(proxy_model)

    button.show()
    app.exec_()

enter image description here

Since the model is not aware of the proxy, how can I reliably insert the "Select item..." to always appear as the first item in the combo box?

Solution

  • This should do what you want...

    class NatSort(QtCore.QSortFilterProxyModel):
    SPECIAL_ITEM = 'Select item...'

    def lessThan(self, left, right):
        """Custom natural sorting"""
        left_data = self.sourceModel().data(left, role=QtCore.Qt.DisplayRole)
        right_data = self.sourceModel().data(right, role=QtCore.Qt.DisplayRole)

        sorted_data = natsort.natsorted([left_data, right_data])

        if left_data == NatSort.SPECIAL_ITEM:
            return True
        if right_data == NatSort.SPECIAL_ITEM:
            return False
        if left_data == sorted_data[0]:
            return True
        return False