widgets.custom_editors

Custom editors for model/view programming.

author:

13. Marin (KTH)

date:

2.9.2018

Module Contents

class widgets.custom_editors.CustomLineEditor

Bases: PySide2.QtWidgets.QLineEdit

A custom QLineEdit to handle data from models.

parent

the widget that wants to edit the data

Type:QWidget

set_data(self, data)

data(self)

keyPressEvent(self, event)

Don’t allow shift key to clear the contents.

class widgets.custom_editors.CustomComboEditor

Bases: PySide2.QtWidgets.QComboBox

A custom QComboBox to handle data from models.

parent

the widget that wants to edit the data

Type:QWidget

data_committed

set_data(self, current_text, items)

data(self)

class widgets.custom_editors.CustomLineEditDelegate(parent)

Bases: PySide2.QtWidgets.QItemDelegate

A delegate for placing a CustomLineEditor on the first row of SearchBarEditor.

parent

search bar editor

Type:SearchBarEditor

text_edited

setModelData(self, editor, model, index)

createEditor(self, parent, option, index)

Create editor and ‘forward’ textEdited signal.

eventFilter(self, editor, event)

Handle all sort of special cases.

class widgets.custom_editors.SearchBarEditor(parent, elder_sibling=None, is_json=False)

Bases: PySide2.QtWidgets.QTableView

A Google-like search bar, implemented as a QTableView with a CustomLineEditDelegate in the first row.

parent

the parent for this widget

Type:QWidget

elder_sibling

another widget which is used to find this widget’s position.

Type:QWidget or NoneType

data_committed

set_data(self, current, all_data)

Populate model and initialize first index.

set_base_size(self, size)

update_geometry(self)

Update geometry. Resize the widget to optimal size, then adjust its position.

refit(self)

Resize to optimal size.

data(self)

_handle_delegate_text_edited(self, text)

Filter model as the first row is being edited.

_proxy_model_filter_accepts_row(self, source_row, source_parent)

Overridden method to always accept first row.

keyPressEvent(self, event)

Set data from current index into first index as the user navigates through the table using the up and down keys.

currentChanged(self, current, previous)

edit_first_index(self)

Edit first index if valid and not already being edited.

mouseMoveEvent(self, event)

Make hovered index the current index.

mousePressEvent(self, event)

Commit data.

class widgets.custom_editors.SearchBarDelegate(parent)

Bases: PySide2.QtWidgets.QItemDelegate

A custom delegate to place a SearchBarEditor on each cell of a MultiSearchBarEditor.

parent

multi search bar editor

Type:MultiSearchBarEditor

data_committed

setModelData(self, editor, model, index)

createEditor(self, parent, option, index)

updateEditorGeometry(self, editor, option, index)

close_editor(self, editor, index, model)

eventFilter(self, editor, event)

class widgets.custom_editors.MultiSearchBarEditor(parent, elder_sibling=None)

Bases: PySide2.QtWidgets.QTableView

A table view made of several Google-like search bars.

set_data(self, header, currents, alls)

data(self)

set_base_size(self, size)

update_geometry(self)

Update geometry.

start_editing(self)

Start editing first item.

class widgets.custom_editors.CheckListEditor(parent, elder_sibling=None)

Bases: PySide2.QtWidgets.QTableView

A check list editor.

keyPressEvent(self, event)

Toggle checked state.

toggle_checked_state(self, index)

mouseMoveEvent(self, event)

Highlight current row.

mousePressEvent(self, event)

Toggle checked state.

set_data(self, item_names, current_item_names)

Set data and update geometry.

data(self)

set_base_size(self, size)

update_geometry(self)

Update geometry.

class widgets.custom_editors.JSONEditor(parent, elder_sibling, popup=False)

Bases: PySide2.QtWidgets.QTabWidget

A double JSON editor, featuring: - A QTextEdit for editing arbitrary json. - A QTableView for editing json array.

data_committed

_view_key_press_event(self, event)

Accept key events on the view to avoid weird behaviour, when trying to navigate outside of its limits.

eventFilter(self, widget, event)

Intercept events to text_edit and table_view to enable consistent behavior.

check_focus(self)

Called when either the text edit or the table view lose focus. Check if the focus is still on this widget (which would mean it was a tab change) otherwise emit signal so this is closed.

_handle_current_changed(self, index)

Update json data on text edit or table view, and set focus.

set_data(self, data, current_index)

Set data on text edit or table view (model) depending on current index.

start_editing(self)

Start editing.

set_base_size(self, size)

update_geometry(self)

Update geometry.

data(self)

class widgets.custom_editors.IconPainterDelegate

Bases: PySide2.QtWidgets.QItemDelegate

A delegate to highlight decorations in a QListWidget.

paint(self, painter, option, index)

Highlight selected items.

class widgets.custom_editors.IconColorEditor(parent)

Bases: PySide2.QtWidgets.QDialog

An editor to let the user select an icon and a color for an object class.

_proxy_model_filter_accepts_row(self, source_row, source_parent)

Overridden method to filter icons according to search terms.

connect_signals(self)

Connect signals to slots.

set_data(self, data)

data(self)

class widgets.custom_editors.NumberParameterInlineEditor(parent)

Bases: PySide2.QtWidgets.QDoubleSpinBox

An editor widget for numeric (datatype double) parameter values.

set_data(self, data)

data(self)