spinetoolbox.widgets.custom_qwidgets

Custom QWidgets for Filtering and Zooming.

author:

16. Vennström (VTT)

date:

4.12.2018

Module Contents

Classes

FilterWidgetBase	Filter widget class.
SimpleFilterWidget	Filter widget class.
CustomWidgetAction	Class constructor.
TitleWidgetAction	A widget action for adding titled sections to menus.
ZoomWidgetAction	A widget action with plus, minus, and reset buttons.
RotateWidgetAction	A widget action with rotate left and right buttons.
ActionToolbarWidget	Class constructor.

class spinetoolbox.widgets.custom_qwidgets.FilterWidgetBase(parent)

Bases: PySide2.QtWidgets.QWidget

Filter widget class.

Init class.

Parameters:parent (QWidget) –

okPressed

cancelPressed

connect_signals(self)

save_state(self)

Saves the state of the FilterCheckboxListModel.

reset_state(self)

Sets the state of the FilterCheckboxListModel to saved state.

clear_filter(self)

Selects all items in FilterCheckBoxListModel.

has_filter(self)

Returns true if any item is filtered in FilterCheckboxListModel false otherwise.

set_filter_list(self, data)

Sets the list of items to filter.

_apply_filter(self)

Apply current filter and save state.

_cancel_filter(self)

Cancel current edit of filter and set the state to the stored state.

_filter_list(self)

Filter list with current text.

_text_edited(self, new_text)

Callback for edit text, starts/restarts timer. Start timer after text is edited, restart timer if text is edited before last time out.

class spinetoolbox.widgets.custom_qwidgets.SimpleFilterWidget(parent, show_empty=True)

Bases: spinetoolbox.widgets.custom_qwidgets.FilterWidgetBase

Filter widget class.

Init class.

Parameters:parent (QWidget) –

class spinetoolbox.widgets.custom_qwidgets.CustomWidgetAction(parent=None)

Bases: PySide2.QtWidgets.QWidgetAction

Class constructor.

Parameters:parent (QWidget) – the widget’s parent

_handle_hovered(self)

Hides other menus that might be shown in the parent widget and repaints it. This is to emulate the behavior of QAction.

class spinetoolbox.widgets.custom_qwidgets.TitleWidgetAction(title, parent=None)

Bases: spinetoolbox.widgets.custom_qwidgets.CustomWidgetAction

A widget action for adding titled sections to menus.

Class constructor.

Parameters:parent (QWidget) – the widget’s parent

H_MARGIN = 6

V_MARGIN = 2

class spinetoolbox.widgets.custom_qwidgets.ZoomWidgetAction(parent=None)

Bases: spinetoolbox.widgets.custom_qwidgets.CustomWidgetAction

A widget action with plus, minus, and reset buttons. Used to create zoom actions for menus.

Class constructor.

Parameters:parent (QWidget) – the widget’s parent

minus_pressed

plus_pressed

reset_pressed

_handle_action_triggered(self, name)

class spinetoolbox.widgets.custom_qwidgets.RotateWidgetAction(parent=None)

Bases: spinetoolbox.widgets.custom_qwidgets.CustomWidgetAction

A widget action with rotate left and right buttons. Used to create rotate actions for menus.

Class constructor.

Parameters:parent (QWidget) – the widget’s parent

clockwise_pressed

anticlockwise_pressed

_handle_action_triggered(self, name)

class spinetoolbox.widgets.custom_qwidgets.ActionToolbarWidget(text, actions, parent=None)

Bases: PySide2.QtWidgets.QWidget

Class constructor.

Parameters:parent (QWidget) – the widget’s parent

action_triggered

paintEvent(self, event)

Overridden method.