GOffice.CanvasGroup¶

Subclasses:: None

Methods¶

Inherited:: GOffice.CanvasItem (22), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`add_child` (item)
	`adjust_bounds` (x0, y0, x1, y1)
	`adjust_coords` (x, y)
	`clear` ()
	`find_child` (item)
	`freeze` (freeze)
	`get_child` (n)
	`get_children` ()
	`new` ()
	`remove_child` (item)

Virtual Methods¶

Inherited:: GOffice.CanvasItem (17), GObject.Object (7)

Properties¶

Inherited:: GOffice.CanvasItem (2)

Name	Type	Flags	Short Description
`x`	`float`	r/w	The group horizontal offset
`y`	`float`	r/w	The group vertical offset

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access
Xchildren	[`object`]	r
base	`GOffice.CanvasItem`	r
clip_path	`GOffice.Path`	r
clip_rule	`cairo.FillRule`	r
priv	`object`	r
x	`float`	r
y	`float`	r

Class Details¶

class GOffice.CanvasGroup(**kwargs)¶

Bases:: GOffice.CanvasItem
Abstract:: No
Structure:: GOffice.CanvasGroupClass

add_child(item)¶

Parameters:: item (GOffice.CanvasItem) – GOffice.CanvasItem

Adds item as a new child to self.

adjust_bounds(x0, y0, x1, y1)¶

Parameters:

x0 (float) – first horizontal coordinate
y0 (float) – first vertical coordinate
x1 (float) – last horizontal coordinate
y1 (float) – last vertical coordinate

Adds self horizontal offset to x0 and x1, and vertical offset to y0 and y1. This function is called recursively so that when returning x0, y0, x1, and y1 are absolute coordinates in canvas space,

adjust_coords(x, y)¶

Parameters:

x (float) – horizontal coordinate
y (float) – vertical coordinate

Adds self horizontal offset to x0, and vertical offset to y0. This function is called recursively so that when returning x0 and y0 are absolute coordinates in canvas space,

clear()¶: Destroys all self children.

find_child(item)¶

Parameters:: item (GOffice.CanvasItem) – GOffice.CanvasItem
Returns:: The index of item in self, or -1 if item is not in self.
Return type:: int

freeze(freeze)¶

Parameters:: freeze (bool) –

get_child(n)¶

Parameters:: n (int) – number
Returns:: The n'th item, zero-bases, in the group or None if n is too big.
Return type:: GOffice.CanvasItem or None

get_children()¶

Returns:: An array of the items in self.
Return type:: [GOffice.CanvasItem]

new()¶

Returns:: the newly created GOffice.CanvasGroup.
Return type:: GOffice.CanvasGroup

Creates a new GOffice.CanvasGroup as a child of self.

remove_child(item)¶

Parameters:: item (GOffice.CanvasItem) – GOffice.CanvasItem

Removes item from self. This function will fail if item is not a child of self.

Property Details¶

GOffice.CanvasGroup.props.x¶

Name:: x
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE

The group horizontal offset

GOffice.CanvasGroup.props.y¶

Name:: y
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE

The group vertical offset