spinetoolbox.spine_io.io_models

Classes for handling models in PySide2’s model/view framework.

author:

16. Vennström (VTT)

date:

1.6.2019

Module Contents

spinetoolbox.spine_io.io_models.Margin

spinetoolbox.spine_io.io_models._MAPPING_COLORS

spinetoolbox.spine_io.io_models._ERROR_COLOR

spinetoolbox.spine_io.io_models._COLUMN_TYPE_ROLE

spinetoolbox.spine_io.io_models._COLUMN_NUMBER_ROLE

spinetoolbox.spine_io.io_models._ALLOWED_TYPES

spinetoolbox.spine_io.io_models._TYPE_TO_FONT_AWESOME_ICON

spinetoolbox.spine_io.io_models._MAPTYPE_DISPLAY_NAME

spinetoolbox.spine_io.io_models._DISPLAY_TYPE_TO_TYPE

spinetoolbox.spine_io.io_models._TYPE_TO_DISPLAY_TYPE

class spinetoolbox.spine_io.io_models.MappingPreviewModel(parent=None)

Bases: spinetoolbox.mvcmodels.minimal_table_model.MinimalTableModel

A model for highlighting columns, rows, and so on, depending on Mapping specification. Used by ImportPreviewWidget.

columnTypesUpdated

rowTypesUpdated

mappingChanged

mapping(self)

clear(self)

reset_model(self, main_data=None)

set_mapping(self, mapping)

Set mapping to display colors from

Parameters:{MappingSpecModel} -- mapping model (mapping) –

validate(self, section, orientation=Qt.Horizontal)

get_type(self, section, orientation=Qt.Horizontal)

get_types(self, orientation=Qt.Horizontal)

set_type(self, section, section_type, orientation=Qt.Horizontal)

_mapping_data_changed(self)

update_colors(self)

data_error(self, index, role=Qt.DisplayRole, orientation=Qt.Horizontal)

data(self, index, role=Qt.DisplayRole)

data_color(self, index)

returns background color for index depending on mapping

Parameters:{PySide2.QtCore.QModelIndex} -- index (index) – Returns:[QColor] – QColor of index

index_in_mapping(self, mapping, index)

Checks if index is in mapping

Parameters:

• {Mapping} -- mapping (mapping) –
• {QModelIndex} -- index (index) –

Returns:

[bool] – returns True if mapping is in index

mapping_column_ref_int_list(self)

Returns a list of column indexes that are not pivoted

Returns:[List[int]] – list of ints

class spinetoolbox.spine_io.io_models.MappingSpecModel(model, parent=None)

Bases: PySide2.QtCore.QAbstractTableModel

A model to hold a Mapping specification.

skip_columns

map_type

last_pivot_row

dimension

import_objects

parameter_type

is_pivoted

read_start_row

set_read_start_row(self, row)

set_import_objects(self, flag)

set_mapping(self, mapping)

set_dimension(self, dim)

change_model_class(self, new_class)

Change model between Relationship and Object class

change_parameter_type(self, new_type)

Change parameter type

update_display_table(self)

get_map_type_display(self, mapping, name)

get_map_value_display(self, mapping, name)

get_map_append_display(self, mapping, name)

get_map_prepend_display(self, mapping, name)

data(self, index, role)

data_color(self, display_name)

rowCount(self, index=None)

columnCount(self, index=None)

headerData(self, section, orientation, role)

flags(self, index)

setData(self, index, value, role)

set_type(self, name, value)

set_value(self, name, value)

set_append_str(self, name, value)

set_prepend_str(self, name, value)

get_mapping_from_name(self, name)

set_mapping_from_name(self, name, mapping)

set_skip_columns(self, columns=None)

set_time_series_repeat(self, repeat)

Toggles the repeat flag in the parameter’s options.

model_parameters(self)

Returns the mapping’s parameters.

class spinetoolbox.spine_io.io_models.MappingListModel(mapping_list, parent=None)

Bases: PySide2.QtCore.QAbstractListModel

A model to hold a list of Mappings.

set_model(self, model)

get_mappings(self)

rowCount(self, index=None)

data_mapping(self, index)

data(self, index, role=Qt.DisplayRole)

add_mapping(self)

remove_mapping(self, row)

spinetoolbox.spine_io.io_models._create_allowed_types_menu(parent, trigger_slot)

Returns a menu which contains actions for each allowed data type.

Parameters:

• parent (QWidget) – a parent widget
• trigger_slot (Slot) – a slot which is connected to QMenu’s ‘triggered’ signal

Returns:

a menu

Return type:

QMenu

class spinetoolbox.spine_io.io_models.HeaderWithButton(orientation, parent=None)

Bases: PySide2.QtWidgets.QHeaderView

Class that reimplements the QHeaderView section paint event to draw a button that is used to display and change the type of that column or row.

display_all

sections_with_buttons

_menu_pressed(self, action)

Sets the data type of a row or column according to menu action.

set_data_types(self, sections, type_str, update_viewport=True)

Sets the data types of given sections (rows, columns).

Parameters:

• sections (Iterable or int or NoneType) – row/column index
• type_str (str) – data type name
• update_viewport (bool) – True if the buttons need repaint

widget_width(self)

Width of widget

Returns:[int] – Width of widget

widget_height(self)

Height of widget

Returns:[int] – Height of widget

mouseMoveEvent(self, mouse_event)

Moves the button to the correct section so that interacting with the button works.

mousePressEvent(self, mouse_event)

Move the button to the pressed location and show or hide it if button should not be shown.

leaveEvent(self, event)

Hide button

_set_button_geometry(self, button, index)

Sets a buttons geometry depending on the index.

Parameters:

• {QWidget} -- QWidget that geometry should be set (button) –
• {int} -- logical_index to set position and geometry to. (index) –

_section_resize(self, i)

When a section is resized.

Parameters:{int} -- logical index to section being resized (i) –

paintSection(self, painter, rect, logical_index)

Paints a section of the QHeader view.

Works by drawing a pixmap of the button to the left of the original paint rectangle. Then shifts the original rect to the right so these two doesn’t paint over each other.

sectionSizeFromContents(self, logical_index)

Add the button width to the section so it displays right.

Parameters:{int} -- logical index of section (logical_index) – Returns:[QSize] – Size of section

_section_move(self, logical, old_visual_index, new_visual_index)

Section beeing moved.

Parameters:

• {int} -- logical index of section beeing moved. (logical) –
• {int} -- old visual index of section (old_visual_index) –
• {int} -- new visual index of section (new_visual_index) –

fix_widget_positions(self)

Update position of interaction button

set_margins(self, margins)

Sets the header margins.

class spinetoolbox.spine_io.io_models.TableViewWithButtonHeader(parent=None)

Bases: PySide2.QtWidgets.QTableView

Customized table with data type buttons on horizontal and vertical headers

Parameters:parent (QWidget) – a parent widget

scrollContentsBy(self, dx, dy)

Scrolls the table’s contents by given delta.

_create_horizontal_header_menu(self)

Returns a new menu for the horizontal header

_create_vertical_header_menu(self)

Returns a new menu for the vertical header.

_show_horizontal_header_menu(self, pos)

Opens the context menu of the horizontal header.

_show_vertical_header_menu(self, pos)

Opens the context menu of the vertical header.

_set_all_column_data_types(self, action)

Sets all columns data types to the type given by action’s text.

_set_all_row_data_types(self, action)

Sets all rows data types to the type given by action’s text.