spinetoolbox.mvcmodels.filter_checkbox_list_model

Provides FilterCheckboxListModel for FilterWidget.

Module Contents

Classes

SimpleFilterCheckboxListModel	param parent: parent widget
LazyFilterCheckboxListModel	Extends SimpleFilterCheckboxListModel to allow for lazy loading in synch with another model.
DataToValueFilterCheckboxListModel	Extends SimpleFilterCheckboxListModel to allow for translating internal data to a value for display role.

class spinetoolbox.mvcmodels.filter_checkbox_list_model.SimpleFilterCheckboxListModel(parent, show_empty=True)

Bases: PySide6.QtCore.QAbstractListModel

Parameters:

• parent (QWidget) – parent widget

• show_empty (bool) – if True, adds an empty row to the end of the list

property _show_empty

property _show_add_to_selection

_SELECT_ALL_STR = '(Select all)'

_SELECT_ALL_FILTERED_STR = '(Select all filtered)'

_EMPTY_STR = '(Empty)'

_ADD_TO_SELECTION_STR = 'Add current selection to filter'

reset_selection()

_handle_select_all_clicked()

_check_all_selected()

rowCount(parent=QModelIndex())

data(index, role=Qt.ItemDataRole.DisplayRole)

_handle_index_clicked(index)

set_list(data, all_selected=True)

filter_by_condition(condition)

Updates selected items by applying a condition.

Parameters:

condition (function) – Filter acceptance condition.

set_selected(selected, select_empty=None)

get_selected()

get_not_selected()

set_filter(filter_expression)

search_filter_expression(item)

apply_filter()

_remove_and_add_filtered()

_remove_and_replace_filtered()

remove_filter()

_do_add_items(data)

add_items(data, selected=None)

remove_items(data)

class spinetoolbox.mvcmodels.filter_checkbox_list_model.LazyFilterCheckboxListModel(parent, db_mngr, db_maps, fetch_parent, show_empty=True)

Bases: SimpleFilterCheckboxListModel

Extends SimpleFilterCheckboxListModel to allow for lazy loading in synch with another model.

Parameters:

• parent (SpineDBEditor) – parent widget

• db_mngr (SpineDBManager) – database manager

• db_maps (Sequence of DatabaseMapping) – database maps

• fetch_parent (FetchParent) – fetch parent

• show_empty (bool) – if True, show an empty row at the end of the list

canFetchMore(_parent)

fetchMore(_parent)

_do_add_items(data)

Adds items so the list is always sorted, while assuming that both existing and new items are sorted.

class spinetoolbox.mvcmodels.filter_checkbox_list_model.DataToValueFilterCheckboxListModel(parent, data_to_value, show_empty=True)

Bases: SimpleFilterCheckboxListModel

Extends SimpleFilterCheckboxListModel to allow for translating internal data to a value for display role.

Parameters:

• parent (SpineDBEditor) – parent widget

• data_to_value (method) – a method to translate item data to a value for display role

• show_empty (bool) – if True, add an empty row to the end of the list

data(index, role=Qt.ItemDataRole.DisplayRole)

search_filter_expression(item)