spinetoolbox.widgets.toolbars

Functions to make and handle QToolBars.

Module Contents

Classes

_TitleWidget

ToolBar

Base class for Toolbox toolbars.

PluginToolBar

A plugin toolbar.

SpecToolBar

Base class for Toolbox toolbars.

ItemsToolBar

The base items

ExecuteToolBar

Base class for Toolbox toolbars.
class spinetoolbox.widgets.toolbars._TitleWidget(title, toolbar)[source]

Bases: PySide6.QtWidgets.QWidget

sizeHint()[source]
paintEvent(ev)[source]
do_paint(painter, x=None)[source]
class spinetoolbox.widgets.toolbars.ToolBar(name, toolbox)[source]

Bases: PySide6.QtWidgets.QToolBar

Base class for Toolbox toolbars.

Parameters

  • name (str) – toolbar’s name

  • toolbox (ToolboxUI) – Toolbox main window

name()[source]
paintEvent(ev)[source]
set_colored_icons(colored)[source]
set_color(color)[source]

Sets toolbar’s background color.

Parameters

color (QColor) – background color

set_project_actions_enabled(enabled)[source]

Enables or disables project related actions.

Parameters

enabled (bool) – True to enable actions, False to disable

_process_tool_button(button)[source]
_insert_tool_button(before, button)[source]

Inserts button into the toolbar.

Parameters

  • before (QWidget) – insert before this widget

  • button (QToolButton) – button to add

Returns

QAction

_add_tool_button(button)[source]

Adds a button to the toolbar.

Parameters

button (QToolButton) – button to add

Returns

QAction

_make_tool_button(icon, text, slot=None, tip=None)[source]

Makes a new tool button and adds it to the toolbar.

Parameters

  • icon (QIcon) – button’s icon

  • text (str) – button’s text

  • slot (Callable) – slot where to connect button’s clicked signal

  • tip (str) – button’s tooltip

Returns

created button

Return type

QToolButton

_icon_from_factory(factory)[source]
class spinetoolbox.widgets.toolbars.PluginToolBar(name, parent)[source]

Bases: ToolBar

A plugin toolbar.

Parameters

parent (ToolboxUI) – QMainWindow instance

name()[source]
buttons()[source]
setup(plugin_specs, disabled_names)[source]

Sets up the toolbar.

Parameters

  • plugin_specs (dict) – mapping from specification name to specification

  • disabled_names (Iterable of str) – specifications that should be disabled

_update_spec_button_name(old_name, new_name)[source]
class spinetoolbox.widgets.toolbars.SpecToolBar(parent)[source]

Bases: ToolBar

Base class for Toolbox toolbars.

Parameters

  • name (str) – toolbar’s name

  • toolbox (ToolboxUI) – Toolbox main window

buttons()[source]
_insert_specs(parent, first, last)[source]
_add_spec(row)[source]
_remove_specs(parent, first, last)[source]
_remove_spec(row)[source]
_reset_specs()[source]
setup()[source]
class spinetoolbox.widgets.toolbars.ItemsToolBar(parent)[source]

Bases: ToolBar

The base items

Parameters

parent (ToolboxUI) – QMainWindow instance

_SEPARATOR = ';;'[source]
buttons()[source]
setup()[source]
add_project_item_buttons()[source]
_add_project_item_button(item_type, factory)[source]
dragLeaveEvent(event)[source]
dragEnterEvent(event)[source]
dragMoveEvent(event)[source]
dropEvent(event)[source]
_update_drop_actions(event)[source]

Updates source and target actions for drop operation:

Parameters

event (QDragMoveEvent) –

paintEvent(ev)[source]

Draw a line as drop indicator.

_drop_line()[source]
icon_ordering()[source]
class spinetoolbox.widgets.toolbars.ExecuteToolBar(parent)[source]

Bases: ToolBar

Base class for Toolbox toolbars.

Parameters

parent (ToolboxUI) – QMainWindow instance

setup()[source]
_add_button_from_action(action)[source]
_add_buttons()[source]

Adds buttons to the toolbar.