spinetoolbox.spine_db_editor.widgets.add_items_dialogs

Classes for custom QDialogs to add items to databases.

author

  1. Marin (KTH)

date

13.5.2018

Module Contents

Classes

AddReadyRelationshipsDialog

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

AddItemsDialog

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

AddObjectClassesDialog

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

AddObjectsDialog

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

AddRelationshipClassesDialog

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

AddOrManageRelationshipsDialog

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

AddRelationshipsDialog

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

ManageRelationshipsDialog

A dialog to query user’s preferences for managing relationships.

ObjectGroupDialogBase

param parent

data store widget

AddObjectGroupDialog

param parent

data store widget

ManageMembersDialog

param parent

data store widget
class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.AddReadyRelationshipsDialog(parent, relationships_class, relationships, db_mngr, *db_maps)[source]

Bases: spinetoolbox.spine_db_editor.widgets.manage_items_dialogs.ManageItemsDialogBase

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

Parameters

  • parent (SpineDBEditor) –

  • relationships_class (dict) –

  • relationships (list(list(str)) –

  • db_mngr (SpineDBManager) –

  • *db_maps – DiffDatabaseMapping instances

make_table_view(self)[source]
populate_table_view(self)[source]
connect_signals(self)[source]

Connect signals to slots.

_handle_table_view_cell_clicked(self, row, column)[source]
_handle_table_view_current_changed(self, current, _previous)[source]
accept(self)[source]
class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.AddItemsDialog(parent, db_mngr, *db_maps)[source]

Bases: spinetoolbox.spine_db_editor.widgets.manage_items_dialogs.ManageItemsDialog

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

Parameters
connect_signals(self)[source]

Connect signals to slots.

remove_selected_rows(self, checked=True)[source]
all_databases(self, row)[source]

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

class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.AddObjectClassesDialog(parent, db_mngr, *db_maps)[source]

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

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

Parameters
connect_signals(self)[source]

Connect signals to slots.

all_db_maps(self, row)[source]

Returns a list of db maps available for a given row. Used by ShowIconColorEditorMixin.

accept(self)[source]

Collect info from dialog and try to add items.

class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.AddObjectsDialog(parent, db_mngr, *db_maps, class_name=None, force_default=False)[source]

Bases: spinetoolbox.spine_db_editor.widgets.manage_items_dialogs.GetObjectClassesMixin, AddItemsDialog

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

Parameters

  • parent (SpineDBEditor) –

  • db_mngr (SpineDBManager) –

  • *db_maps – DiffDatabaseMapping instances

  • class_name (str) – default object_class name

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

accept(self)[source]

Collect info from dialog and try to add items.

class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.AddRelationshipClassesDialog(parent, db_mngr, *db_maps, object_class_one_name=None, force_default=False)[source]

Bases: spinetoolbox.spine_db_editor.widgets.manage_items_dialogs.GetObjectClassesMixin, AddItemsDialog

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

Parameters

  • parent (SpineDBEditor) –

  • db_mngr (SpineDBManager) –

  • *db_maps – DiffDatabaseMapping instances

  • object_class_one_name (str) – default object_class name

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

connect_signals(self)[source]

Connect signals to slots.

_handle_spin_box_value_changed(self, i)[source]
insert_column(self)[source]
remove_column(self)[source]
_handle_model_data_changed(self, top_left, bottom_right, roles)[source]

Reimplement in subclasses to handle changes in model data.

accept(self)[source]

Collect info from dialog and try to add items.

class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.AddOrManageRelationshipsDialog(parent, db_mngr, *db_maps)[source]

Bases: spinetoolbox.spine_db_editor.widgets.manage_items_dialogs.GetRelationshipClassesMixin, spinetoolbox.spine_db_editor.widgets.manage_items_dialogs.GetObjectsMixin, AddItemsDialog

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

Parameters
abstract make_model(self)[source]
connect_signals(self)[source]

Connect signals to slots.

abstract reset_model(self, index)[source]

Called when relationship_class’s combobox’s index changes. Update relationship_class attribute accordingly and reset model.

class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.AddRelationshipsDialog(parent, db_mngr, *db_maps, relationship_class_key=(), object_names_by_class_name=None, force_default=False)[source]

Bases: AddOrManageRelationshipsDialog

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

Parameters

  • parent (SpineDBEditor) –

  • db_mngr (SpineDBManager) –

  • *db_maps – DiffDatabaseMapping instances

  • relationship_class_key (tuple(str,str)) – relationships class name, object_class name list string

  • object_names_by_class_name (dict) – mapping object_class names to default object names

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

make_model(self)[source]
reset_model(self, index)[source]

Setup model according to current relationship_class selected in combobox.

_handle_model_data_changed(self, top_left, bottom_right, roles)[source]

Reimplement in subclasses to handle changes in model data.

accept(self)[source]

Collect info from dialog and try to add items.

class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.ManageRelationshipsDialog(parent, db_mngr, *db_maps, relationship_class_key=None)[source]

Bases: AddOrManageRelationshipsDialog

A dialog to query user’s preferences for managing relationships.

Parameters

  • parent (SpineDBEditor) – data store widget

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

  • *db_maps – DiffDatabaseMapping instances

  • relationship_class_key (str, optional) – relationships class name, object_class name list string.

make_model(self)[source]
splitter_widgets(self)[source]
connect_signals(self)[source]

Connect signals to slots.

reset_relationship_class_combo_box(self, database, relationship_class_key=None)[source]
add_relationships(self, checked=True)[source]
reset_model(self, index)[source]

Setup model according to current relationship_class selected in combobox.

resize_window_to_columns(self, height=None)[source]
accept(self)[source]

Collect info from dialog and try to add items.

class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.ObjectGroupDialogBase(parent, object_class_item, db_mngr, *db_maps, object_item=None)[source]

Bases: PySide2.QtWidgets.QDialog

Parameters
connect_signals(self)[source]

Connect signals to slots.

reset_list_widgets(self, database)[source]
abstract initial_member_ids(self)[source]
abstract initial_entity_id(self)[source]
add_members(self, checked=False)[source]
remove_members(self, checked=False)[source]
_check_validity(self)[source]
class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.AddObjectGroupDialog(parent, object_class_item, db_mngr, *db_maps)[source]

Bases: ObjectGroupDialogBase

Parameters
initial_member_ids(self)[source]
initial_entity_id(self)[source]
_check_validity(self)[source]
accept(self)[source]
class spinetoolbox.spine_db_editor.widgets.add_items_dialogs.ManageMembersDialog(parent, object_item, db_mngr, *db_maps)[source]

Bases: ObjectGroupDialogBase

Parameters
initial_member_ids(self)[source]
initial_entity_id(self)[source]
accept(self)[source]