grid.*

Pyspread’s main grid

Provides

• Grid: QTableView of the main grid

• GridHeaderView: QHeaderView for the main grids headers

• GridTableModel: QAbstractTableModel linking the view to code_array backend

• GridCellDelegate: QStyledItemDelegate handling custom painting and editors

• TableChoice: The TabBar below the main grid

class grid.Grid(main_window, model=None)

Bases: QTableView

The main grid of pyspread

Parameters:

• main_window (QMainWindow) – Application main window

• model – GridTableModel for grid

_refresh_frozen_cell(key)

Refreshes the frozen cell key

Does neither emit dataChanged nor clear _attr_cache or _table_cache.

Parameters:

key (Tuple[int, int, int]) – Key of cell to be refreshed

_selected_idx_to_str(selected_idx)

Converts selected_idx to string with cell indices

Parameters:

selected_idx (Iterable[QModelIndex]) – Indices of selected cells

Return type:

str

adjust_size()

Adjusts size to header maxima

closeEditor(editor, hint)

Overrides QTableView.closeEditor

Changes to overridden behavior:

• Data is submitted when a cell is changed without pressing <Enter> e.g. by mouse click or arrow keys.

Parameters:

• editor (QWidget) – Editor to be closed

• hint (EndEditHint) – Hint to be overridden if == QAbstractItemDelegate.NoHint

property column: int

Current column

property column_widths: List[Tuple[int, float]]

Returns list of tuples (col_index, col_width) for current table

contextMenuEvent(event)

Overrides contextMenuEvent to install GridContextMenu

Parameters:

event (QContextMenuEvent) – Context menu event

property current: Tuple[int, int, int]

Tuple of row, column, table of the current index

focusInEvent(event)

Overrides focusInEvent storing last focused grid in main_window

gui_update()

Emits gui update signal

has_selection()

Returns True if more than one cell is selected, else False

This method handles spanned/merged cells. One single cell that is selected is considered as no cell being selected.

Return type:

bool

is_column_data_discarded(count)

True if column data is to be discarded on column insertion

Parameters:

count (int) – Columns to be inserted

Return type:

bool

is_row_data_discarded(count)

True if row data is to be discarded on row insertion

Parameters:

count (int) – Rows to be inserted

Return type:

bool

is_table_data_discarded(count)

True if table data is to be discarded on table insertion

Parameters:

count (int) – Tables to be inserted

Return type:

bool

keyPressEvent(event)

Overrides QTableView.keyPressEvent

Changes to overridden behavior:

• If Shift is pressed, the cell in the next column is selected.

• If Shift is not pressed, the cell in the next row is selected.

Parameters:

event (QKeyEvent) – Key event

on_align_bottom()

Align bottom button pressed event handler

on_align_middle()

Align centere button pressed event handler

on_align_top()

Align top button pressed event handler

on_background_color()

Background color change event handler

on_bold_pressed(toggled)

Bold button pressed event handler

Parameters:

toggled (bool) – Toggle state

on_border_choice()

Border choice style event handler

on_borderwidth()

Border width change event handler

on_button_cell_pressed(toggled)

Button cell event handler

Parameters:

toggled (bool) – Toggle state

on_column_resized(column, old_width, new_width)

Column resized event handler

Parameters:

• row – Column that is resized

• old_width (float) – Column width before resizing

• new_width (float) – Column width after resizing

on_current_changed(*_)

Event handler for change of current cell

on_data_changed()

Event handler for data changes

on_delete_columns()

Delete columns event handler

on_delete_rows()

Delete rows event handler

on_delete_table()

Delete table event handler

on_font()

Font change event handler

on_font_dialog()

Font dialog event handler

on_font_size()

Font size change event handler

on_freeze_pressed(toggled)

Freeze cell event handler

Parameters:

toggled (bool) – Toggle state

on_image_renderer_pressed()

Image renderer button pressed event handler

on_insert_columns()

Insert columns event handler

on_insert_rows()

Insert rows event handler

on_insert_table()

Insert table event handler

on_italics_pressed(toggled)

Italics button pressed event handler

Parameters:

toggled (bool) – Toggle state

on_justify_center()

Justify center button pressed event handler

on_justify_fill()

Justify fill button pressed event handler

on_justify_left()

Justify left button pressed event handler

on_justify_right()

Justify right button pressed event handler

on_line_color()

Line color change event handler

on_lock_pressed(toggled)

Lock button pressed event handler

Parameters:

toggled (bool) – Toggle state

on_markup_renderer_pressed()

Markup renderer button pressed event handler

on_matplotlib_renderer_pressed()

Matplotlib renderer button pressed event handler

on_merge_pressed()

Merge cells button pressed event handler

on_quote()

Quote cells event handler

on_rotate_0()

Set cell rotation to 0° left button pressed event handler

on_rotate_180()

Set cell rotation to 180° left button pressed event handler

on_rotate_270()

Set cell rotation to 270° left button pressed event handler

on_rotate_90()

Set cell rotation to 90° left button pressed event handler

on_row_resized(row, old_height, new_height)

Row resized event handler

Parameters:

• row (int) – Row that is resized

• old_height (float) – Row height before resizing

• new_height (float) – Row height after resizing

on_selection_changed()

Selection changed event handler

on_show_frozen_pressed(toggled)

Show frozen cells event handler

Parameters:

toggled (bool) – Toggle state

on_strikethrough_pressed(toggled)

Strikethrough button pressed event handler

Parameters:

toggled (bool) – Toggle state

on_text_color()

Text color change event handler

on_text_renderer_pressed()

Text renderer button pressed event handler

on_underline_pressed(toggled)

Underline button pressed event handler

Parameters:

toggled (bool) – Toggle state

on_zoom_1()

Sets zoom level ot 1.0

on_zoom_in()

Zoom in event handler

on_zoom_out()

Zoom out event handler

refresh_frozen_cells()

Refreshes all frozen cells

refresh_selected_frozen_cells()

Refreshes selected frozen cells

reset_selection()

Select upper left cell

property row: int

Current row

property row_heights: List[Tuple[int, float]]

Returns list of tuples (row_index, row height) for current table

property selected_idx: List[QModelIndex]

Currently selected indices

property selection: Selection

Pyspread selection based on self’s QSelectionModel

property selection_mode: bool

In selection mode, cells cannot be edited

set_selection_mode(value=True)

Setter for selection mode for all grids

Parameters:

value – If True, selection mode is set, if False unset

property table: int

Current table

toggle_selection_mode()

Toggle selection mode for all grids

This method is required for accessing selection mode from QActions.

undo_resizing_column()

Sets self.__undo_resizing_column to True for context

undo_resizing_row()

Sets self.__undo_resizing_row to True for context

update_cell_spans()

Update cell spans from model data

update_index_widgets()

Remove old index widgets from model data

update_zoom()

Updates the zoom level visualization to the current zoom factor

wheelEvent(event)

Overrides mouse wheel event handler

Parameters:

event (QWheelEvent) – Mouse wheel event

property zoom: float

Returns zoom level

class grid.GridCellDelegate(main_window, grid, code_array)

Bases: QStyledItemDelegate

QStyledItemDelegate for main grid QTableView

Parameters:

• main_window (QMainWindow) – Application main window

• grid (Grid) – Grid, i.e. QTableView instance

• code_array (CodeArray) – Main backend model instance

_get_aligned_image_rect(rect, index, image_width, image_height)

Returns image rect dependent on alignment and justification

Parameters:

• rect (QRectF) – Rect to be aligned

• image_width (Union[int, float]) – Width of image [px]

• image_height (Union[int, float]) – Height of image [px]

Return type:

QRectF

_get_render_text_document(rect, option, index)

Returns styled QTextDocument that is ready for setting content

Parameters:

• rect (QRectF) – Cell rect of the cell to be painted

• option (QStyleOptionViewItem) – Style option for rendering

• index (QModelIndex) – Index of cell for which markup is rendered

Return type:

QTextDocument

_render_markup(painter, rect, option, index)

HTML markup renderer

Parameters:

• painter (QPainter) – Painter with which markup is rendered

• rect (QRectF) – Cell rect of the cell to be painted

• option (QStyleOptionViewItem) – Style option for rendering

• index (QModelIndex) – Index of cell for which markup is rendered

_render_matplotlib(painter, rect, index)

Matplotlib renderer

Parameters:

• painter (QPainter) – Painter with which the matplotlib image is rendered

• rect (QRectF) – Cell rect of the cell to be painted

• index (QModelIndex) – Index of cell for which the matplotlib image is rendered

_render_qimage(painter, rect, index, qimage=None)

QImage renderer

Parameters:

• painter (QPainter) – Painter with which qimage is rendered

• rect (QRectF) – Cell rect of the cell to be painted

• index (QModelIndex) – Index of cell for which qimage is rendered

• qimage (QImage) – Image to be rendered, decoration drawn if not provided

_render_svg(painter, rect, index, svg_str=None)

SVG renderer

Parameters:

• painter (QPainter) – Painter with which qimage is rendered

• rect (QRectF) – Cell rect of the cell to be painted

• index (QModelIndex) – Index of cell for which qimage is rendered

• svg_str (str) – SVG string

_render_text(painter, rect, option, index)

Text renderer

Parameters:

• painter (QPainter) – Painter with which markup is rendered

• rect (QRectF) – Cell rect of the cell to be painted

• option (QStyleOptionViewItem) – Style option for rendering

• index (QModelIndex) – Index of cell for which markup is rendered

_render_text_document(doc, painter, rect, option, index)

QTextDocument renderer

Parameters:

• doc (QTextDocument) – Text document to be painted

• painter (QPainter) – Painter with which markup is rendered

• rect (QRectF) – Cell rect of the cell to be painted

• option (QStyleOptionViewItem) – Style option for rendering

• index (QModelIndex) – Index of cell for which markup is rendered

createEditor(parent, option, index)

Overloads QStyledItemDelegate

Disables editor in locked cells Switches to chart dialog in chart cells

Parameters:

• parent (QWidget) – Parent widget for the cell editor to be returned

• option (QStyleOptionViewItem) – Style option for the cell editor

• index (QModelIndex) – Index of cell for which a cell editor is created

Return type:

QWidget

eventFilter(source, event)

Overloads eventFilter. Overrides QLineEdit default shortcut.

Quotes cell editor content for <Ctrl>+<Enter> and <Ctrl>+<Return>. Counts as undoable action.

Parameters:

• source (QObject) – Source widget of event

• event (QEvent) – Any QEvent

Return type:

bool

paint(painter, option, index)

Overloads QStyledItemDelegate to add cell border painting

Parameters:

• painter (QPainter) – Painter with which borders are drawn

• option (QStyleOptionViewItem) – Style option for rendering

• index (QModelIndex) – Index of cell to be rendered

paint_(painter, rect, option, index)

Calls the overloaded paint function or creates html delegate

Parameters:

• painter (QPainter) – Painter with which borders are drawn

• rect (QRectF) – Cell rect of the cell to be painted

• option (QStyleOptionViewItem) – Style option for rendering

• index (QModelIndex) – Index of cell for which borders are drawn

setEditorData(editor, index)

Overloads setEditorData to use code_array data

Parameters:

• editor (QWidget) – Cell editor, in which data is set

• index (QModelIndex) – Index of cell from which the cell editor data is set

setModelData(editor, model, index)

Overloads setModelData to use code_array data

Parameters:

• editor (QWidget) – Cell editor, from which data is retrieved

• model (QAbstractItemModel) – GridTableModel

• index (QModelIndex) – Index of cell for which data is set

sizeHint(option, index)

Overloads SizeHint

Parameters:

• option (QStyleOptionViewItem) – Style option for rendering

• index (QModelIndex) – Index of the cell for the size hint

Return type:

QSize

updateEditorGeometry(editor, option, _)

Overloads updateEditorGeometry to update editor geometry to cell

Parameters:

• editor (QWidget) – Cell editor, for which geometry is retrieved

• option (QStyleOptionViewItem) – Style option of the editor

class grid.GridHeaderView(orientation, grid)

Bases: QHeaderView

QHeaderView with zoom support

Parameters:

• orientation (Orientation) – Orientation of the QHeaderView

• grid (Grid) – The main grid widget

contextMenuEvent(event)

Overrides contextMenuEvent

Installs HorizontalHeaderContextMenu or VerticalHeaderContextMenu depending on self.orientation().

Parameters:

event (QContextMenuEvent) – The triggering event

paintSection(painter, rect, logicalIndex)

Overrides paintSection, which supports zoom

Parameters:

• painter (QPainter) – Painter with which the section is drawn

• rect (QRect) – Outer rectangle of the section to be drawn

• logicalIndex (int) – Index of the section to be drawn

sectionSizeHint(logicalIndex)

Overrides sectionSizeHint, which supports zoom

Parameters:

logicalIndex (int) – Index of the section for the size hint

Return type:

int

sizeHint()

Overrides sizeHint, which supports zoom

Return type:

QSize

update_zoom()

Updates zoom for the section sizes

class grid.GridTableModel(main_window, shape)

Bases: QAbstractTableModel

QAbstractTableModel for Grid

Parameters:

• main_window (QMainWindow) – Application main window

• shape (Tuple[int, int, int]) – Grid shape (rows, columns, tables)

cell_to_update

int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Type:

pyqtSignal(*types, name

Type:

str = …, revision

code(index)

Code in cell index

Parameters:

index (QModelIndex) – Index of the cell for which the code is returned

Return type:

str

columnCount(_=<PyQt6.QtCore.QModelIndex object>)

Overloaded QAbstractItemModel.columnCount for code_array backend

Return type:

int

current(index)

Tuple of row, column, table of given index

Parameters:

index (QModelIndex) – Index of the cell to be made the current cell

Return type:

Tuple[int, int, int]

data(index, role=ItemDataRole.DisplayRole)

Overloaded data for code_array backend

Parameters:

• index (QModelIndex) – Index of the cell, for which data is returned

• role (ItemDataRole) – Role of data to be returned

Return type:

Any

flags(index)

Overloaded, makes items editable

Parameters:

index (QModelIndex) – Index of cell for which flags are returned

Return type:

ItemFlag

font(key)

Returns font for given key

Parameters:

key (Tuple[int, int, int]) – Key of cell, for which font is returned

Return type:

QFont

property grid: Grid

The main grid

headerData(idx, _, role)

Overloaded for displaying numbers in header

Parameters:

• idx (QModelIndex) – Index of header for which data is returned

• role (ItemDataRole) – Role of data to be returned

Return type:

str

insertColumns(column, count)

Overloaded QAbstractItemModel.insertColumns for code_array backend

Parameters:

• column (int) – Column at which columns are inserted

• count (int) – Number of columns to be inserted

Return type:

bool

insertRows(row, count)

Overloaded QAbstractItemModel.insertRows for code_array backend

Parameters:

• row (int) – Row at which rows are inserted

• count (int) – Number of rows to be inserted

Return type:

bool

insertTable(table, count=1)

Inserts tables

Parameters:

• table (int) – Table at which tables are inserted

• count (int) – Number of tables to be inserted

inserting_columns(index, first, last)

Context manager for inserting columns

see QAbstractItemModel.beginInsertColumns

Parameters:

• index (QModelIndex) – Parent into which the new columns are inserted

• first (int) – Column number that first column will have after insertion

• last (int) – Column number that last column will have after insertion

inserting_rows(index, first, last)

Context manager for inserting rows

see QAbstractItemModel.beginInsertRows

Parameters:

• index (QModelIndex) – Parent into which the new rows are inserted

• first (int) – Row number that first row will have after insertion

• last (int) – Row number that last row will have after insertion

model_reset()

Context manager for handle changing/resetting model data

removeColumns(column, count)

Overloaded QAbstractItemModel.removeColumns for code_array backend

Parameters:

• column (int) – Column at which columns are removed

• count (int) – Number of columns to be removed

Return type:

bool

removeRows(row, count)

Overloaded QAbstractItemModel.removeRows for code_array backend

Parameters:

• row (int) – Row at which rows are removed

• count (int) – Number of rows to be removed

Return type:

bool

removeTable(table, count=1)

Removes tables

Parameters:

• table (int) – Table at which tables are removed

• count (int) – Number of tables to be removed

removing_columns(index, first, last)

Context manager for removing columns

see QAbstractItemModel.beginRemoveColumns

Parameters:

• index (QModelIndex) – Parent from which columns are removed

• first (int) – Column number of the first column to be removed

• last (int) – Column number of the last column to be removed

removing_rows(index, first, last)

Context manager for removing rows

see QAbstractItemModel.beginRemoveRows

Parameters:

• index (QModelIndex) – Parent from which rows are removed

• first (int) – Row number of the first row to be removed

• last (int) – Row number of the last row to be removed

reset()

Deletes all grid data including undo data

rowCount(_=<PyQt6.QtCore.QModelIndex object>)

Overloaded QAbstractItemModel.rowCount for code_array backend

Return type:

int

setData(index, value, role, raw=False, table=None)

Overloaded setData for code_array backend

Parameters:

• index (QModelIndex) – Index of the cell, for which data is set

• value (Any) – Value of data to be set

• role (ItemDataRole) – Role of data to be set

• raw (bool) – Sets raw data without string formatting in EditRole

• table (int) – Table for which data shall is set

Return type:

bool

property shape: Tuple[int, int, int]

Returns 3-tuple of rows, columns and tables

class grid.TableChoice(main_window, no_tables)

Bases: QTabBar

The TabBar below the main grid

Parameters:

• main_window (QMainWindow) – Application main window

• no_tables (int) – Number of tables to be initially created

contextMenuEvent(event)

Overrides contextMenuEvent to install GridContextMenu

Parameters:

event (QContextMenuEvent) – Triggering event

property no_tables: int

Returns the number of tables in the table_choice

on_table_changed(current)

Event handler for table changes

Parameters:

current (int) – The current table to be displayed

property table: int

Returns current table from table_choice that is displayed