PapersDocument.MappingList

Fields

None

Methods

class	new (page, list, data_destroy_func)
	find (data)
	get (x, y)
	get_data (x, y)
	get_list ()
	get_page ()
	length ()
	nth (n)
	ref ()
	remove (mapping)
	unref ()

Details

class PapersDocument.MappingList

classmethod new(page, list, data_destroy_func)

Parameters:

• page (int) – page index for this mapping

• list ([PapersDocument.Mapping]) – a GLib.List of data for the page

• data_destroy_func (GLib.DestroyNotify) – function to free a list element

Returns:

an PapersDocument.MappingList

Return type:

PapersDocument.MappingList

find(data)

Parameters:

data (object or None) – mapping data to find

Returns:

an PapersDocument.Mapping

Return type:

PapersDocument.Mapping

get(x, y)

Parameters:

• x (float) – X coordinate

• y (float) – Y coordinate

Returns:

the PapersDocument.Mapping in the list at coordinates (x, y)

Return type:

PapersDocument.Mapping

New in version 3.12.

get_data(x, y)

Parameters:

• x (float) – X coordinate

• y (float) – Y coordinate

Returns:

the data of a mapping in the list at coordinates (x, y)

Return type:

object or None

get_list()

Returns:

the data for this mapping list

Return type:

[PapersDocument.Mapping]

get_page()

Return type:

int

length()

Return type:

int

nth(n)

Parameters:

n (int) – the position to retrieve

Returns:

the #Ppsmapping at position n in self

Return type:

PapersDocument.Mapping

ref()

Return type:

PapersDocument.MappingList

remove(mapping)

Parameters:

mapping (PapersDocument.Mapping) – PapersDocument.Mapping to remove

New in version 3.14.

unref()