EvinceDocument.MappingList¶

Fields¶

None

Methods¶

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

Details¶

class EvinceDocument.MappingList¶

classmethod new(page, list, data_destroy_func)¶

Parameters:

page (int) – page index for this mapping
list ([EvinceDocument.Mapping]) – a GLib.List of data for the page
data_destroy_func (GLib.DestroyNotify) – function to free a list element

Returns:

an EvinceDocument.MappingList

Return type:

EvinceDocument.MappingList

find(data)¶

Parameters:: data (object or None) – mapping data to find
Returns:: an EvinceDocument.Mapping
Return type:: EvinceDocument.Mapping

find_custom(data, func)¶

Parameters:

data (object or None) – mapping data to find
func (GLib.CompareFunc) – function to use for equality check

Returns:

an EvinceDocument.Mapping

Return type:

EvinceDocument.Mapping

get(x, y)¶

Parameters:

x (float) – X coordinate
y (float) – Y coordinate

Returns:

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

Return type:

EvinceDocument.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:: [EvinceDocument.Mapping]

get_page()¶

Return type:: int

length()¶

Return type:: int

nth(n)¶

Parameters:: n (int) – the position to retrieve
Returns:: the #Evmapping at position n in self
Return type:: EvinceDocument.Mapping

ref()¶

Return type:: EvinceDocument.MappingList

remove(mapping)¶

Parameters:: mapping (EvinceDocument.Mapping) – EvinceDocument.Mapping to remove

New in version 3.14.

unref()¶