spinetoolbox.widgets.multi_tab_window

Contains the MultiTabWindow and TabBarPlus classes.

author

13. Marin (KTH)

date

12.12.2020

Module Contents

Classes

MultiTabWindow
TabBarPlus	Tab bar that has a plus button floating to the right of the tabs.

class spinetoolbox.widgets.multi_tab_window.MultiTabWindow(qsettings, settings_group, parent=None)

Bases: PySide2.QtWidgets.QMainWindow

_tab_slots

abstract _make_other(self)

abstract others(self)

abstract _make_new_tab(self, *args, **kwargs)

abstract show_plus_button_context_menu(self, global_pos)

property new_tab_title(self)

connect_signals(self)

name(self)

all_tabs(self)

add_new_tab(self, *args, **kwargs)

Creates a new tab and adds it at the end of the tab bar.

insert_new_tab(self, index, *args, **kwargs)

Creates a new tab and inserts it at the given index.

Parameters

index (int) –

_add_connect_tab(self, tab, text)

_insert_connect_tab(self, index, tab, text)

_remove_disconnect_tab(self, index)

_connect_tab(self, index)

_connect_tab_signals(self, tab)

_disconnect_tab_signals(self, index)

_handle_tab_window_title_changed(self, tab, title)

_take_tab(self, index)

move_tab(self, index, other=None)

detach(self, index, hot_spot, offset=0)

Detaches the tab at given index into another MultiTabWindow window and starts dragging it.

Parameters

• index (int) –

• hot_spot (QPoint) –

• offset (int) –

start_drag(self, hot_spot, offset=0)

Starts dragging a detached tab.

Parameters

• hot_spot (QPoint) – The anchor point of the drag in widget coordinates.

• offset (int, optional) – Horizontal offset of the tab in the bar.

_frame_height(self)

timerEvent(self, event)

Performs the drag, i.e., moves the window with the mouse cursor. As soon as the mouse hovers the tab bar of another MultiTabWindow, reattaches it.

mouseReleaseEvent(self, event)

Stops the drag. This only happens when the detached tab is not reattached to another window.

reattach(self, index, db_editor, text)

Reattaches a tab that has been dragged over this window’s tab bar.

Parameters

• index (int) – Index in this widget’s tab bar where the detached tab has been dragged.

• db_editor (SpineDBEditor) – The widget in the tab being dragged.

• text (str) – The title of the tab.

_close_tab(self, index)

Closes the tab at index.

Parameters

index (int) –

set_current_tab(self, tab)

make_context_menu(self, index)

restore_ui(self)

Restore UI state from previous session.

save_window_state(self)

Save window state parameters (size, position, state) via QSettings.

closeEvent(self, event)

class spinetoolbox.widgets.multi_tab_window.TabBarPlus(parent)

Bases: PySide2.QtWidgets.QTabBar

Tab bar that has a plus button floating to the right of the tabs.

Parameters

parent (MultiSpineDBEditor) –

plus_clicked

resizeEvent(self, event)

Sets the dimension of the plus button. Also, makes the tab bar as wide as the parent.

tabLayoutChange(self)

_move_plus_button(self)

Places the plus button at the right of the last tab.

mousePressEvent(self, event)

Registers the position of the press, in case we need to detach the tab.

mouseMoveEvent(self, event)

Detaches a tab either if the user moves beyond the limits of the tab bar, or if it’s the only one.

_send_release_event(self, pos)

Sends a mouse release event at given position in local coordinates. Called just before detaching a tab.

Parameters

pos (QPoint) –

mouseReleaseEvent(self, event)

start_dragging(self, index)

Stars dragging the given index. This happens when a detached tab is reattached to this bar.

Parameters

index (int) –

index_under_mouse(self)

Returns the index under the mouse cursor, or None if the cursor isn’t over the tab bar. Used to check for drop targets.

Returns

int or NoneType

contextMenuEvent(self, event)