spinetoolbox.widgets.custom_qwidgets

Custom QWidgets for Filtering and Zooming.

Module Contents

Classes

ElidedTextMixin
UndoRedoMixin
FilterWidget	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.
ElidedLabel	A QLabel with elided text.
HorizontalSpinBox
PropertyQSpinBox	A spinbox where undo and redo key strokes apply to the project.
SelectDatabaseItemsDialog	Dialog that lets selecting database items.
PurgeSettingsDialog	Dialog that lets selecting database items.

class spinetoolbox.widgets.custom_qwidgets.ElidedTextMixin(*args, **kwargs)

setText(text)

_update_text(text)

_set_text_elided(width=None)

_elided_offset()

text()

resizeEvent(event)

class spinetoolbox.widgets.custom_qwidgets.UndoRedoMixin

keyPressEvent(e)

Overridden to catch and pass on the Undo and Redo commands when this line edit has the focus.

Parameters

e (QKeyEvent) – Event

class spinetoolbox.widgets.custom_qwidgets.FilterWidget(parent, make_filter_model, *args, **kwargs)

Bases: PySide6.QtWidgets.QWidget

Filter widget class.

Init class.

Parameters

• parent (QWidget, optional) – parent widget

• make_filter_model (Callable) – callable that constructs the filter model

• *args – arguments forwarded to make_filter_model

• **kwargs – keyword arguments forwarded to make_filter_model

okPressed

cancelPressed

set_filter_list(items)

connect_signals()

save_state()

Saves the state of the FilterCheckboxListModel.

reset_state()

Sets the state of the FilterCheckboxListModel to saved state.

clear_filter()

Selects all items in FilterCheckBoxListModel.

has_filter()

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

_apply_filter()

Apply current filter and save state.

_cancel_filter()

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

_filter_list()

Filter list with current text.

_text_edited(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.CustomWidgetAction(parent=None)

Bases: PySide6.QtWidgets.QWidgetAction

A QWidgetAction with custom hovering.

Class constructor.

Parameters

parent (QMenu) – the widget’s parent

_handle_hovered()

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

eventFilter(obj, ev)

_handle_hovered()

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, io_files=None)

Bases: PySide6.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, io_files=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.

Class constructor.

Parameters

• text (str) –

• parent (QWidget) – the widget’s parent

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

paintEvent(event)

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

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

Bases: PySide6.QtWidgets.QToolBar

A custom tool bar for MenuItemToolBarWidget.

enabled_changed

_align_buttons()

Align all buttons to bottom so frames look good.

add_frame(left, right, title)

Add frame around given actions, with given title.

Parameters

• left (QAction) –

• right (QAction) –

• title (str) –

is_enabled()

addActions(actions)

Overriden method to customize tool buttons.

addAction(*args, **kwargs)

Overriden method to customize the tool button.

sizeHint()

Make room for frames if needed.

paintEvent(ev)

Paint the frames.

_setup_action_button(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

action (QAction) – Action to set up

actionEvent(ev)

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

eventFilter(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(ev)

Navigates over the tool bar buttons.

hideEvent(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()

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

Bases: PySide6.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: PySide6.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__(owner, name)

__get__(obj, objtype=None)

__set__(obj, value)

msg

msg_warning

msg_error

msg_success

msg_proc

msg_proc_error

_exec_mngr

_connect_signals()

_handle_copy_clicked(_=False)

_add_msg(msg)

_add_msg_warning(msg)

_add_msg_error(msg)

_add_msg_success(msg)

isComplete()

cleanupPage()

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

Bases: PySide6.QtWidgets.QWidget

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

class spinetoolbox.widgets.custom_qwidgets.ElidedLabel(*args, **kwargs)

Bases: ElidedTextMixin, PySide6.QtWidgets.QLabel

A QLabel with elided text.

class spinetoolbox.widgets.custom_qwidgets.HorizontalSpinBox(*args, **kwargs)

Bases: PySide6.QtWidgets.QToolBar

valueChanged

value()

setMinimum(minimum)

setMaximum(maximum)

setValue(value, strict=False)

_dec_value()

_inc_value()

_focus_line_edit()

class spinetoolbox.widgets.custom_qwidgets.PropertyQSpinBox

Bases: UndoRedoMixin, PySide6.QtWidgets.QSpinBox

A spinbox where undo and redo key strokes apply to the project.

class spinetoolbox.widgets.custom_qwidgets.SelectDatabaseItemsDialog(checked_states, ok_button_text=None, parent=None)

Bases: PySide6.QtWidgets.QDialog

Dialog that lets selecting database items.

Parameters

• checked_states (dict, optional) – checked states for each item

• ok_button_text (str, optional) – alternative label for the OK button

• parent (QWidget, optional) – parent widget

_warn_checked_non_data_items = True

_ok_button_can_be_disabled = True

show()

Sets the OK button enabled before showing the dialog

get_checked_states()

Returns current item checked states.

Returns

mapping from database item name to checked flag

Return type

dict

_handle_check_box_state_changed(_checked)

class spinetoolbox.widgets.custom_qwidgets.PurgeSettingsDialog(checked_states, ok_button_text=None, parent=None)

Bases: SelectDatabaseItemsDialog

Dialog that lets selecting database items.

Parameters

• checked_states (dict, optional) – checked states for each item

• ok_button_text (str, optional) – alternative label for the OK button

• parent (QWidget, optional) – parent widget

_ok_button_can_be_disabled = False