spinetoolbox.spine_db_editor.widgets.add_items_dialogs

Classes for custom QDialogs to add items to databases.

Module Contents

Classes

AddReadyEntitiesDialog	A dialog to let the user add new 'ready' multidimensional entities.
AddItemsDialog	A dialog to query user's preferences for new db items.
AddEntityClassesDialog	A dialog to query user's preferences for new entity classes.
AddEntitiesOrManageElementsDialog	A dialog to query user's preferences for new entities.
AddEntitiesDialog	A dialog to query user's preferences for new entities.
ManageElementsDialog	A dialog to query user's preferences for managing entity dimensions.
EntityGroupDialogBase	param parent data store widget
AddEntityGroupDialog	param parent data store widget
ManageMembersDialog	param parent data store widget

class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.AddReadyEntitiesDialog(parent, entity_class, entities, db_mngr, *db_maps, commit_data=True)

Bases: spinetoolbox.spine_db_editor.widgets.manage_items_dialogs.DialogWithTableAndButtons

A dialog to let the user add new ‘ready’ multidimensional entities.

Parameters

• parent (SpineDBEditor) –

• entity_class (dict) –

• entities (list(list(str)) –

• db_mngr (SpineDBManager) –

• *db_maps – DatabaseMapping instances

_populate_layout()

make_table_view()

populate_table_view()

connect_signals()

Connect signals to slots.

_handle_table_view_cell_clicked(row, column)

_handle_table_view_current_changed(current, _previous)

accept()

Collect info from dialog and try to add items.

get_db_map_data()

class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.AddItemsDialog(parent, db_mngr, *db_maps)

Bases: spinetoolbox.spine_db_editor.widgets.manage_items_dialogs.ManageItemsDialog

A dialog to query user’s preferences for new db items.

Parameters

• parent (SpineDBEditor) –

• db_mngr (SpineDBManager) –

• *db_maps – DiffDatabaseMapping instances

_populate_layout()

connect_signals()

Connect signals to slots.

remove_selected_rows(checked=True)

all_databases(row)

Returns a list of db names available for a given row. Used by delegates.

class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.AddEntityClassesDialog(parent, item, db_mngr, *db_maps, force_default=False)

Bases: spinetoolbox.spine_db_editor.widgets.manage_items_dialogs.ShowIconColorEditorMixin, spinetoolbox.spine_db_editor.widgets.manage_items_dialogs.GetEntityClassesMixin, AddItemsDialog

A dialog to query user’s preferences for new entity classes.

Parameters

• parent (SpineDBEditor) –

• item (MultiDBTreeItem) –

• db_mngr (SpineDBManager) –

• *db_maps – DatabaseMapping instances

• force_default (bool) – if True, defaults are non-editable

_populate_layout()

connect_signals()

Connect signals to slots.

_handle_spin_box_value_changed(i)

insert_column()

remove_column()

_handle_model_data_changed(top_left, bottom_right, roles)

Reimplement in subclasses to handle changes in model data.

accept()

Collect info from dialog and try to add items.

class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.AddEntitiesOrManageElementsDialog(parent, db_mngr, *db_maps)

Bases: spinetoolbox.spine_db_editor.widgets.manage_items_dialogs.GetEntityClassesMixin, spinetoolbox.spine_db_editor.widgets.manage_items_dialogs.GetEntitiesMixin, AddItemsDialog

A dialog to query user’s preferences for new entities.

Parameters

• parent (SpineDBEditor) –

• db_mngr (SpineDBManager) –

• *db_maps – DatabaseMapping instances

abstract _class_key_to_str(key, *db_maps)

abstract _accepts_class(ent_cls)

Returns whether the widget should handle the given entity class.

Parameters

ent_cls (MappedItem) –

Returns

bool

abstract make_model()

abstract _do_reset_model()

reset_model(index)

Setup model according to current entity class selected in combobox.

_populate_layout()

connect_signals()

Connect signals to slots.

_handle_model_data_changed(top_left, bottom_right, roles)

Reimplement in subclasses to handle changes in model data.

class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.AddEntitiesDialog(parent, item, db_mngr, *db_maps, force_default=False, commit_data=True)

Bases: AddEntitiesOrManageElementsDialog

A dialog to query user’s preferences for new entities.

Parameters

• parent (SpineDBEditor) –

• item (MultiDBTreeItem) –

• db_mngr (SpineDBManager) –

• *db_maps – DatabaseMapping instances

• force_default (bool) – if True, defaults are non-editable

_class_key_to_str(key, *db_maps)

_accepts_class(ent_cls)

Returns whether the widget should handle the given entity class.

Parameters

ent_cls (MappedItem) –

Returns

bool

make_model()

_do_reset_model()

get_db_map_data()

accept()

Collect info from dialog and try to add items.

class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.ManageElementsDialog(parent, item, db_mngr, *db_maps)

Bases: AddEntitiesOrManageElementsDialog

A dialog to query user’s preferences for managing entity dimensions.

Parameters

• parent (SpineDBEditor) – data store widget

• item (MultiDBTreeItem) –

• db_mngr (SpineDBManager) – the manager to do the removal

• *db_maps – DatabaseMapping instances

_populate_layout()

make_model()

splitter_widgets()

connect_signals()

Connect signals to slots.

_accepts_class(ent_cls)

Returns whether the widget should handle the given entity class.

Parameters

ent_cls (MappedItem) –

Returns

bool

_class_key_to_str(key, *_db_maps)

reset_entity_class_combo_box(database)

add_entities(checked=True)

_do_reset_model()

resize_window_to_columns(height=None)

accept()

Collect info from dialog and try to add items.

class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.EntityGroupDialogBase(parent, entity_class_item, db_mngr, *db_maps)

Bases: PySide6.QtWidgets.QDialog

Parameters

• parent (SpineDBEditor) – data store widget

• entity_class_item (EntityClassItem) –

• db_mngr (SpineDBManager) –

• *db_maps – database mappings

connect_signals()

Connect signals to slots.

reset_list_widgets(database)

abstract initial_member_ids()

abstract initial_entity_id()

add_members(checked=False)

remove_members(checked=False)

_check_validity()

class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.AddEntityGroupDialog(parent, entity_class_item, db_mngr, *db_maps)

Bases: EntityGroupDialogBase

Parameters

• parent (SpineDBEditor) – data store widget

• entity_class_item (EntityClassItem) –

• db_mngr (SpineDBManager) –

• *db_maps – database mappings

initial_member_ids()

initial_entity_id()

_check_validity()

accept()

class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.ManageMembersDialog(parent, entity_item, db_mngr, *db_maps)

Bases: EntityGroupDialogBase

Parameters

• parent (SpineDBEditor) – data store widget

• entity_item (entity_tree_item.EntityItem) –

• db_mngr (SpineDBManager) –

• *db_maps – database mappings

_entity_groups()

initial_member_ids()

initial_entity_id()

accept()