Gnm.Pane

Subclasses:

None

Methods

Inherited:

Gnm.SimpleCanvas (3), GOffice.Canvas (23), Gtk.Layout (10), Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10), Gtk.Scrollable (9)

Structs:

Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

class	new (scg, col_headers, row_headers, index)
class	object_register (so, view, selectable)
class	widget_register (so, w, view)
	bound_set (start_col, start_row, end_col, end_row)
	compute_visible_region (full_recompute)
	cursor_bound_set (r)
	display_object_menu (so, event)
	edit_start ()
	edit_stop ()
	expr_cursor_bound_set (r, color)
	expr_cursor_stop ()
	find_col (x, col_origin)
	find_row (y, row_origin)
	handle_motion (canvas, x, y, slide_flags, handler, *user_data)
	mouse_cursor_set (c)
	object_autoscroll (context, x, y, time)
	object_group ()
	object_start_resize (button, x, y, so, drag_type, is_creation)
	object_unselect (so)
	object_update_bbox (so)
	objects_drag (so, new_x, new_y, drag_type, symmetric, snap_to_grid)
	rangesel_bound_set (r)
	rangesel_start (r)
	rangesel_stop ()
	redraw_range (r)
	reposition_cursors ()
	set_direction (direction)
	size_guide_motion (vert, guide_pos)
	size_guide_start (vert, colrow, is_colrow_resize)
	size_guide_stop ()
	slide_init ()
	slide_stop ()
	special_cursor_bound_set (r)
	special_cursor_start (style, button)
	special_cursor_stop ()

Virtual Methods

Inherited:

Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10), Gtk.Scrollable (1)

Properties

Inherited:

Gtk.Layout (2), Gtk.Container (3), Gtk.Widget (39), Gtk.Scrollable (4)

Child Properties

Inherited:

Gtk.Layout (2)

Style Properties

Inherited:

Gtk.Widget (17)

Name	Type	Default	Flags	Short Description
comment-indicator-size	int	6	r	Size of Gnm.comment indicator
control-circle-outline	int	1	r	Width of outline of control circle for sizing sheet objects
control-circle-size	int	4	r	Size of control circle for sizing sheet objects
extension-indicator-size	int	100	r	Size of cell extension indicator
function-indicator-size	int	10	r	Size of function indicator
pane-resize-guide-width	int	7	r	With of the guides used for resizing panes
resize-guide-width	int	1	r	With of the guides used for resizing columns and rows

Signals

Inherited:

Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Fields

Inherited:

Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name	Type	Access	Description
action_items	GOffice.CanvasGroup	r
cur_object	Gnm.SheetObject	r
editor	Gnm.ItemEdit	r
first	Gnm.CellPos	r
grid	Gnm.ItemGrid	r
grid_items	GOffice.CanvasGroup	r
im_context	Gtk.IMContext	r
im_preedit_started	int	r
index	int	r
insert_decimal	bool	r
last_full	Gnm.CellPos	r
last_visible	Gnm.CellPos	r
mouse_cursor	Gdk.Cursor	r
object_style	{object: object}	r
object_views	GOffice.CanvasGroup	r
preedit_attrs	Pango.AttrList	r
preedit_length	int	r
simple	Gnm.SimpleCanvas	r
size_tip	Gtk.Widget	r
slide_data	object	r
slide_handler	Gnm.PaneSlideHandler	r
sliding_adjacent_h	bool	r
sliding_adjacent_v	bool	r
sliding_dx	int	r
sliding_dy	int	r
sliding_timer	int	r
sliding_x	int	r
sliding_y	int	r

Class Details

class Gnm.Pane(**kwargs)

Bases:

Gnm.SimpleCanvas

Abstract:

No

classmethod new(scg, col_headers, row_headers, index)

Parameters:

• scg (Gnm.SheetControlGUI) –

• col_headers (bool) –

• row_headers (bool) –

• index (int) –

Return type:

Gnm.Pane

classmethod object_register(so, view, selectable)

Parameters:

• so (Gnm.SheetObject) – A sheet object

• view (GOffice.CanvasItem) – A canvas item acting as a view for so

• selectable (bool) – Add handlers for selecting and editing the object

Returns:

view set to a Gnm.SheetObjectView.

Return type:

Gnm.SheetObjectView

Setup some standard callbacks for manipulating a view of a sheet object.

classmethod widget_register(so, w, view)

Parameters:

• so (Gnm.SheetObject) – A sheet object

• w (Gtk.Widget) – The widget for the sheet object view

• view (GOffice.CanvasItem) – A canvas item acting as a view for so

Setup some standard callbacks for manipulating widgets as views of sheet objects.

bound_set(start_col, start_row, end_col, end_row)

Parameters:

• start_col (int) –

• start_row (int) –

• end_col (int) –

• end_row (int) –

compute_visible_region(full_recompute)

Parameters:

full_recompute (bool) –

cursor_bound_set(r)

Parameters:

r (Gnm.Range) –

Return type:

bool

display_object_menu(so, event)

Parameters:

• so (Gnm.SheetObject) –

• event (Gdk.Event) –

edit_start()

edit_stop()

expr_cursor_bound_set(r, color)

Parameters:

• r (Gnm.Range) –

• color (int) –

expr_cursor_stop()

find_col(x, col_origin)

Parameters:

• x (int) – In canvas GOffice.coords

• col_origin (int) – optionally return the canvas coord of the Gnm.col

Return type:

int

Returns the column containing canvas coord x

find_row(y, row_origin)

Parameters:

• y (int) – In canvas GOffice.coords

• row_origin (int) – optionally return the canvas coord of the Gnm.row

Return type:

int

Returns the column containing canvas coord y

handle_motion(canvas, x, y, slide_flags, handler, *user_data)

Parameters:

• canvas (GOffice.Canvas) – The Canvas the event comes from

• x (int) –

• y (int) –

• slide_flags (Gnm.PaneSlideFlags) –

• handler (Gnm.PaneSlideHandler) – The handler when sliding

• user_data (object or None) – closure data

Return type:

bool

Handle a motion event from a canvas and scroll the self depending on how far outside the bounds of self the event is. Usually canvas == self however as long as the canvases share a basis space they can be different.

mouse_cursor_set(c)

Parameters:

c (Gdk.Cursor) –

object_autoscroll(context, x, y, time)

Parameters:

• context (Gdk.DragContext) –

• x (int) –

• y (int) –

• time (int) –

object_group()

Returns:

the GOffice.CanvasGroup including all Gnm.SheetObjectView instances in self.

Return type:

GOffice.CanvasGroup

object_start_resize(button, x, y, so, drag_type, is_creation)

Parameters:

• button (int) –

• x (int) –

• y (int) –

• so (Gnm.SheetObject) –

• drag_type (int) –

• is_creation (bool) –

object_unselect(so)

Parameters:

so (Gnm.SheetObject) –

object_update_bbox(so)

Parameters:

so (Gnm.SheetObject) – Gnm.SheetObject

Updates the position and potentially creates control points for manipulating the size/position of so.

objects_drag(so, new_x, new_y, drag_type, symmetric, snap_to_grid)

Parameters:

• so (Gnm.SheetObject) –

• new_x (float) –

• new_y (float) –

• drag_type (int) –

• symmetric (bool) –

• snap_to_grid (bool) –

rangesel_bound_set(r)

Parameters:

r (Gnm.Range) –

Return type:

bool

rangesel_start(r)

Parameters:

r (Gnm.Range) –

rangesel_stop()

redraw_range(r)

Parameters:

r (Gnm.Range) –

reposition_cursors()

set_direction(direction)

Parameters:

direction (GOffice.CanvasDirection) –

size_guide_motion(vert, guide_pos)

Parameters:

• vert (bool) – True for a vertical guide, False for horizontal

• guide_pos (int) – in unscaled sheet pixel GOffice.coords

Moves the guide line to guide_pos. NOTE : Gnm.Pane.size_guide_start must be called before any calls to Gnm.Pane.size_guide_motion

size_guide_start(vert, colrow, is_colrow_resize)

Parameters:

• vert (bool) –

• colrow (int) –

• is_colrow_resize (bool) –

size_guide_stop()

slide_init()

slide_stop()

special_cursor_bound_set(r)

Parameters:

r (Gnm.Range) –

Return type:

bool

special_cursor_start(style, button)

Parameters:

• style (int) –

• button (int) –

special_cursor_stop()