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	A QWidgetAction with custom hovering.
ToolBarWidgetAction	An action with a tool bar.
ToolBarWidgetBase	A toolbar on the right, with enough space to print a text beneath.
ToolBarWidget	A toolbar on the right, with enough space to print a text beneath.
MenuItemToolBarWidget	A menu item with a toolbar on the right.
_MenuToolBar	A custom tool bar for MenuItemToolBarWidget.
TitleWidgetAction	A titled separator.
WrapLabel	A QLabel that always wraps text.
HyperTextLabel	A QLabel that supports hyperlinks.
QWizardProcessPage	A QWizards page with a log. Useful for pages that need to capture the output of a process.
LabelWithCopyButton	A read only QLabel with a QToolButton that copies the text to clipboard.

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: FilterWidgetBase

Filter widget class.

Init class.

Parameters

parent (QWidget) –

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

Bases: PySide2.QtWidgets.QWidgetAction

A QWidgetAction with custom hovering.

Class constructor.

Parameters

parent (QMenu) – 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.ToolBarWidgetAction(text, parent=None, compact=False)

Bases: CustomWidgetAction

An action with a tool bar.

tool_bar

Type

QToolBar

Class constructor.

Parameters

parent (QMenu) – the widget’s parent

_parent_key_press_event

eventFilter(self, obj, ev)

_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.ToolBarWidgetBase(text, parent=None)

Bases: PySide2.QtWidgets.QWidget

A toolbar on the right, with enough space to print a text beneath.

tool_bar

Type

QToolBar

Class constructor.

Parameters

• text (str) –

• parent (QWidget) – the widget’s parent

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

Bases: ToolBarWidgetBase

A toolbar on the right, with enough space to print a text beneath.

tool_bar

Type

QToolBar

Class constructor.

Parameters

• text (str) –

• parent (QWidget) – the widget’s parent

class spinetoolbox.widgets.custom_qwidgets.MenuItemToolBarWidget(text, parent=None, compact=False)

Bases: ToolBarWidgetBase

A menu item with a toolbar on the right.

tool_bar

Type

QToolBar

Class constructor.

Parameters

• text (str) –

• parent (QWidget) – the widget’s parent

• compact (bool) – if True, the widget uses the minimal space

paintEvent(self, event)

Draws the menu item, then calls the super() method to draw the tool bar.

class spinetoolbox.widgets.custom_qwidgets._MenuToolBar

Bases: PySide2.QtWidgets.QToolBar

A custom tool bar for MenuItemToolBarWidget.

enabled_changed

_enabled = True

_focus_widget

is_enabled(self)

addActions(self, actions)

Overriden method to customize tool buttons.

addAction(self, *args, **kwargs)

Overriden method to customize the tool button.

_setup_action_button(self, action)

Customizes the QToolButton associated with given action:

1. Makes sure that the text honors the action’s mnemonics.

2. Installs this as event filter on the button (see self.eventFilter()).

Must be called everytime an action is added to the tool bar.

Parameters

QAction –

actionEvent(self, ev)

Updates self._enabled: True if at least one non-separator action is enabled, False otherwise. Emits self.enabled_changed accordingly.

eventFilter(self, obj, ev)

Installed on each action’s QToolButton. Ignores Up and Down key press events, so they are handled by the toolbar for custom navigation.

keyPressEvent(self, ev)

Navigates over the tool bar buttons.

hideEvent(self, ev)

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

Bases: CustomWidgetAction

A titled separator.

Class constructor.

Parameters

parent (QMenu) – the widget’s parent

H_MARGIN = 5

V_MARGIN = 2

static _add_line(widget, layout)

isSeparator(self)

class spinetoolbox.widgets.custom_qwidgets.WrapLabel(text='', parent=None)

Bases: PySide2.QtWidgets.QLabel

A QLabel that always wraps text.

class spinetoolbox.widgets.custom_qwidgets.HyperTextLabel(text='', parent=None)

Bases: WrapLabel

A QLabel that supports hyperlinks.

class spinetoolbox.widgets.custom_qwidgets.QWizardProcessPage(parent)

Bases: PySide2.QtWidgets.QWizardPage

A QWizards page with a log. Useful for pages that need to capture the output of a process.

class _ExecutionManager

A descriptor that stores a QProcessExecutionManager. When execution_finished is emitted, it shows the button to copy the process log.

public_name

private_name

__set_name__(self, owner, name)

__get__(self, obj, objtype=None)

__set__(self, obj, value)

msg

msg_warning

msg_error

msg_success

msg_proc

msg_proc_error

_exec_mngr

_connect_signals(self)

_handle_copy_clicked(self, _=False)

_add_msg(self, msg)

_add_msg_warning(self, msg)

_add_msg_error(self, msg)

_add_msg_succes(self, msg)

isComplete(self)

cleanupPage(self)

class spinetoolbox.widgets.custom_qwidgets.LabelWithCopyButton(text='', parent=None)

Bases: PySide2.QtWidgets.QWidget

A read only QLabel with a QToolButton that copies the text to clipboard.