commands.*

Pyspread undoable commands

Provides

• SetGridSize

• SetCellCode

• SetCellFormat

• SetCellMerge

• SetCellRenderer

• SetCellTextAlignment

• SetColumnWidth

• SetRowHeight

class commands.DeleteColumns(grid, model, index, column, count, description)

Bases: PyQt5.QtWidgets.QUndoCommand

Deletes grid columns

Parameters

• grid (QTableView) – The main grid object

• model (QAbstractTableModel) – Model of the grid object

• index (QModelIndex) – Parent from which the new columns are deleted

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

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

• description (str) – Command description

redo()

Redo column deletion, updates screen

undo()

Undo column deletion, updates screen

class commands.DeleteRows(grid, model, index, row, count, description)

Bases: PyQt5.QtWidgets.QUndoCommand

Deletes grid rows

Parameters

• grid (QTableView) – The main grid object

• model (QAbstractTableModel) – Model of the grid object

• index (QModelIndex) – Parent from which the new rows are deleted

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

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

• description (str) – Command description

redo()

Redo row deletion, updates screen

undo()

Undo row deletion, updates screen

class commands.DeleteTable(grid, model, table, description)

Bases: PyQt5.QtWidgets.QUndoCommand

Deletes table

Parameters

• grid (QTableView) – The main grid object

• model (QAbstractTableModel) – Model of the grid object

• table (int) – Table number for deletion

• description (str) – Command description

redo()

Redo table deletion, updates row and column sizes and screen

undo()

Undo table deletion, updates row and column sizes and screen

class commands.FreezeCell(model, cells, description)

Bases: PyQt5.QtWidgets.QUndoCommand

Freezes cell in grid

Parameters

• model (QAbstractTableModel) – Model of the grid object

• cells (List[Tuple[int, int, int]]) – List of indices of cells to be frozen

• description (str) – Command description

redo()

Redo cell freezing

undo()

Undo cell freezing

class commands.InsertColumns(grid, model, index, column, count, description)

Bases: PyQt5.QtWidgets.QUndoCommand

Inserts grid columns

Parameters

• grid (QTableView) – The main grid object

• model (QAbstractTableModel) – Model of the grid object

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

• column (int) – Column number of the first column after insertion

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

• description (str) – Command description

redo()

Redo column insertion, updates screen

undo()

Undo column insertion, updates screen

class commands.InsertRows(grid, model, index, row, count, description)

Bases: PyQt5.QtWidgets.QUndoCommand

Inserts grid rows

Parameters

• grid (QTableView) – The main grid object

• model (QAbstractTableModel) – Model of the grid object

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

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

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

• description (str) – Command description

redo()

Redo row insertion, updates screen

undo()

Undo row insertion, updates screen

class commands.InsertTable(grid, model, table, description)

Bases: PyQt5.QtWidgets.QUndoCommand

Inserts table

Parameters

• grid (QTableView) – The main grid object

• model (QAbstractTableModel) – Model of the grid object

• table (int) – Table number for insertion

• description (str) – Command description

redo()

Redo table insertion, updates row and column sizes and screen

undo()

Undo table insertion, updates row and column sizes and screen

class commands.MakeButtonCell(grid, text, index, description)

Bases: PyQt5.QtWidgets.QUndoCommand

Makes a button cell

Parameters

• grid (QTableView) – Main grid object

• text (str) – Button cell text

• index (QModelIndex) – Index of the cell which becomes a button cell

• description (str) – Command description

redo()

Redo button cell making

undo()

Undo button cell making

class commands.RemoveButtonCell(grid, index, description)

Bases: PyQt5.QtWidgets.QUndoCommand

Removes a button cell

Parameters

• grid (QTableView) – Main grid object

• index (QModelIndex) – Index of the cell where a button cell is removed

• description (str) – Command description

redo()

Redo button cell removal

undo()

Undo button cell removal

class commands.SetCellCode(code, model, index, description)

Bases: PyQt5.QtWidgets.QUndoCommand

Sets cell code in grid

Parameters

• code (str) – The main grid object

• model (QAbstractTableModel) – Model of the grid object

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

• description (str) – Command description

id(self) → int

mergeWith(other)

Consecutive commands are merged if descriptions match

Parameters

other (QUndoCommand) – Command to be merged

Return type

bool

redo()

Redo cell code setting

During update, cell highlighting is disabled.

undo()

Undo cell code setting.

During update, cell highlighting is disabled.

class commands.SetCellFormat(attr, model, index, selected_idx, description)

Bases: PyQt5.QtWidgets.QUndoCommand

Sets cell format in grid

Format is set for one given cell and a selection.

Parameters

• attr (CellAttribute) – Cell format to be set

• model (QAbstractTableModel) – Model of the grid object

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

• selected_idx (Iterable[QModelIndex]) – Indexes of cells for which the format is set

• description (str) – Command description

redo()

Redo cell formatting

undo()

Undo cell formatting

class commands.SetCellMerge(attr, model, index, selected_idx, description)

Bases: commands.SetCellFormat

Sets cell merges in grid

Parameters

• attr (CellAttribute) – Cell format to be set

• model (QAbstractTableModel) – Model of the grid object

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

• selected_idx (Iterable[QModelIndex]) – Indexes of cells for which the format is set

• description (str) – Command description

redo()

Redo cell merging

undo()

Undo cell merging

class commands.SetCellRenderer(attr, model, entry_line, highlighter_document, index, selected_idx, description)

Bases: PyQt5.QtWidgets.QUndoCommand

Sets cell renderer in grid

Adjusts syntax highlighting in entry line.

Parameters

• attr (CellAttribute) – Cell format that cointains traget renderer information

• model (QAbstractTableModel) – Model of the grid object

• entry_line (QPlainTextEdit) – Entry line in main window

• highlighter_document (QTextDocument) – Document for entry line

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

• selected_idx (Iterable[QModelIndex]) – Indexes of cells for which the renderer is set

• description (str) – Command description

redo()

Redo cell renderer setting, adjusts syntax highlighting

undo()

Undo cell renderer setting, adjusts syntax highlighting

class commands.SetCellTextAlignment(attr, model, index, selected_idx, description)

Bases: commands.SetCellFormat

Sets cell text alignment in grid

Parameters

• attr (CellAttribute) – Cell format to be set

• model (QAbstractTableModel) – Model of the grid object

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

• selected_idx (Iterable[QModelIndex]) – Indexes of cells for which the format is set

• description (str) – Command description

redo()

Redo cell text alignment

class commands.SetColumnsWidth(grid, columns, table, old_width, new_width, description)

Bases: PyQt5.QtWidgets.QUndoCommand

Sets column width in grid

Parameters

• grid (QTableView) – The main grid object

• columns (List[int]) – Columns for which widths are set

• table (int) – Table for which column widths are set

• old_width (float) – Column width before setting

• new_width (float) – Target column width for setting

• description (str) – Command description

id()

Command id that enables command merging

Return type

int

mergeWith(other)

Consecutive commands are merged if descriptions match

Parameters

other (QUndoCommand) – Command to be merged

Return type

bool

redo()

Redo column width setting

undo()

Undo column width setting

class commands.SetGridSize(grid, old_shape, new_shape, description)

Bases: PyQt5.QtWidgets.QUndoCommand

Sets size of grid

Parameters

• grid (QTableView) – The main grid object

• old_shape (Tuple[int, int, int]) – Shape of the grid before command

• new_shape (Tuple[int, int, int]) – Shape of the grid to be set

• description (str) – Command description

redo()

Redo grid size change and deletion of cell code outside new shape

Cell formats are not deleted.

undo()

Undo grid size change and deletion of cell code outside new shape

Cell formats are not deleted.

class commands.SetRowsHeight(grid, rows, table, old_height, new_height, description)

Bases: PyQt5.QtWidgets.QUndoCommand

Sets rows height in grid

Parameters

• grid (QTableView) – The main grid object

• rows (List[int]) – Rows for which height are set

• table (int) – Table for which row heights are set

• old_height (float) – Row height before setting

• new_height (float) – Target row height for setting

• description (str) – Command description

id()

Command id that enables command merging

Return type

int

mergeWith(other)

Consecutive commands are merged if descriptions match

Parameters

other (QUndoCommand) – Command to be merged

Return type

bool

redo()

Redo row height setting

undo()

Undo row height setting

class commands.ThawCell(model, cells, description)

Bases: commands.FreezeCell

Thaw (unfreezes) cell in grid

Parameters

• model (QAbstractTableModel) – Model of the grid object

• cells (List[Tuple[int, int, int]]) – List of indices of cells to be frozen

• description (str) – Command description

redo()

Redo cell thawing

undo()

Undo cell thawing