Gnm.SheetView

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	new (sheet, wbv)
class	weak_unref (ptr)
	ant (ranges)
	attach_control (sc)
	cursor_set (edit, base_col, base_row, move_col, move_row, bound)
	detach_control (sc)
	dispose ()
	editpos_in_filter ()
	editpos_in_slicer ()
	flag_selection_change ()
	flag_status_update_pos (pos)
	flag_status_update_range (range)
	flag_style_update_range (range)
	freeze_panes (frozen_top_left, unfrozen_top_left)
	is_frozen ()
	make_cell_visible (col, row, couple_panes)
	panes_insdel_colrow (is_cols, is_insert, start, count)
	redraw_headers (col, row, r)
	redraw_range (r)
	resize (force_scroll)
	selection_copy (wbc)
	selection_cut (wbc)
	selection_extends_filter (f)
	selection_intersects_filter_rows ()
	set_edit_pos (pos)
	set_initial_top_left (col, row)
	unant ()
	update ()
	weak_ref (ptr)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

None

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
ants	[object]	r
auto_expr_timer	int	r
base	GObject.Object	r
controls	[object]	r
edit_pos	Gnm.CellPos	r
edit_pos_real	Gnm.CellPos	r
enable_insert_cells	int	r
enable_insert_cols	int	r
enable_insert_rows	int	r
first_tab_col	int	r
frozen_top_left	Gnm.CellPos	r
initial_top_left	Gnm.CellPos	r
reposition_selection	int	r
selection_content_changed	int	r
selection_mode	int	r
selections	[object]	r
selections_simplified	[object]	r
sheet	Gnm.Sheet	r
sv_wbv	Gnm.WorkbookView	r
unfrozen_top_left	Gnm.CellPos	r
view_mode	Gnm.SheetViewMode	r

Class Details

class Gnm.SheetView(**kwargs)

Bases:

GObject.Object

Abstract:

No

Structure:

Gnm.SheetViewClass

classmethod new(sheet, wbv)

Parameters:

• sheet (Gnm.Sheet) –

• wbv (Gnm.WorkbookView) –

Return type:

Gnm.SheetView

classmethod weak_unref(ptr)

Parameters:

ptr (Gnm.SheetView) –

ant(ranges)

Parameters:

ranges ([Gnm.Range]) – The ranges to ant.

attach_control(sc)

Parameters:

sc (Gnm.SheetControl) –

cursor_set(edit, base_col, base_row, move_col, move_row, bound)

Parameters:

• edit (Gnm.CellPos) –

• base_col (int) –

• base_row (int) –

• move_col (int) –

• move_row (int) –

• bound (Gnm.Range or None) – A range that should contain all the supplied points

detach_control(sc)

Parameters:

sc (Gnm.SheetControl) –

dispose()

editpos_in_filter()

Returns:

Gnm.Filter that overlaps the sv::edit_pos

Return type:

Gnm.Filter or None

editpos_in_slicer()

Returns:

Gnm.SheetSlicer that overlaps the sv::edit_pos

Return type:

Gnm.SheetSlicer or None

flag_selection_change()

flag the sheet as requiring an update to the status display

Will cause auto expressions to be updated

flag_status_update_pos(pos)

Parameters:

pos (Gnm.CellPos) –

flag the view as requiring an update to the status display if the supplied cell location is the edit Gnm.cursor, or part of the selected region.

Will cause the format Gnm.toolbar, the edit area, and the auto expressions to be updated if appropriate.

flag_status_update_range(range)

Parameters:

range (Gnm.Range or None) – If None then force an update.

flag the sheet as requiring an update to the status display if the supplied cell location contains the edit Gnm.cursor, or intersects of the selected region.

Will cause the format Gnm.toolbar, the edit area, and the auto expressions to be updated if appropriate.

flag_style_update_range(range)

Parameters:

range (Gnm.Range) – the range that is changing.

Flag style changes that will require updating the style indicators.

freeze_panes(frozen_top_left, unfrozen_top_left)

Parameters:

• frozen_top_left (Gnm.CellPos or None) – top left corner of the frozen region

• unfrozen_top_left (Gnm.CellPos or None) – top left corner of the unfrozen region

By definition the unfrozen region must be below the frozen. If frozen_top_left == unfrozen_top_left or frozen_top_left == None unfreeze

is_frozen()

Return type:

bool

make_cell_visible(col, row, couple_panes)

Parameters:

• col (int) –

• row (int) –

• couple_panes (bool) –

panes_insdel_colrow(is_cols, is_insert, start, count)

Parameters:

• is_cols (bool) – True for columns, False for rows.

• is_insert (bool) –

• start (int) –

• count (int) –

Adjust the positions of frozen panes as necessary to handle Gnm.col/Gnm.row insertions and deletions. note this assumes that the ins/del operations have already set the flags that will force a resize.

redraw_headers(col, row, r)

Parameters:

• col (bool) –

• row (bool) –

• r (Gnm.Range) –

redraw_range(r)

Parameters:

r (Gnm.Range) –

resize(force_scroll)

Parameters:

force_scroll (bool) –

selection_copy(wbc)

Parameters:

wbc (Gnm.WorkbookControl) –

Return type:

bool

selection_cut(wbc)

Parameters:

wbc (Gnm.WorkbookControl) –

Return type:

bool

selection_extends_filter(f)

Parameters:

f (Gnm.Filter) –

Returns:

Gnm.Filter whose rows intersect the rows of the current selection range to which the filter can be extended.

Return type:

Gnm.Range or None

selection_intersects_filter_rows()

Returns:

Gnm.Filter whose rows intersect the rows of the current selection.

Return type:

Gnm.Filter or None

set_edit_pos(pos)

Parameters:

pos (Gnm.CellPos) –

set_initial_top_left(col, row)

Parameters:

• col (int) –

• row (int) –

Sets the top left cell that a newly created sheet control should display. This corresponds to the top left cell visible in pane 0 (frozen or not). NOTE : the unfrozen_top_left != initial_top_left. Unfrozen is the first unfrozen cell, and corresponds to the _minimum_ cell in pane 0. However, the pane can scroll and may have something else currently visible as the top left.

unant()

update()

weak_ref(ptr)

Parameters:

ptr (Gnm.SheetView) –