PapersDocument.DocumentText¶

Implementations:: None

Methods¶

	`get_text` (page)
	`get_text_attrs` (page)
	`get_text_in_area` (page, area)
	`get_text_layout` (page)
	`get_text_mapping` (page)

Virtual Methods¶

	`do_get_text` (page)
	`do_get_text_attrs` (page)
	`do_get_text_in_area` (page, area)
	`do_get_text_layout` (page)
	`do_get_text_mapping` (page)

Properties¶

None

Signals¶

None

Fields¶

None

Class Details¶

class PapersDocument.DocumentText¶

Bases:: GObject.GInterface
Structure:: PapersDocument.DocumentTextInterface

get_text(page)¶

Parameters:: page (PapersDocument.Page) –
Return type:: str

get_text_attrs(page)¶

Parameters:: page (PapersDocument.Page) – a PapersDocument.Page
Returns:: a newly created Pango.AttrList
Return type:: Pango.AttrList

FIXME

New in version 3.10.

get_text_in_area(page, area)¶

Parameters:

page (PapersDocument.Page) – a PapersDocument.Page of that document
area (PapersDocument.Rectangle) – a PapersDocument.Rectangle on that page

Returns:

the text inside the area of the specified page or None

Return type:

str or None

New in version 47.

get_text_layout(page)¶

Parameters:

page (PapersDocument.Page) – a PapersDocument.Page

Returns:

whether the text layout is empty, i.e. there is text on the page

areas:: the text areas of the layout

Return type:

(bool, areas: [PapersDocument.Rectangle])

get_text_mapping(page)¶

Parameters:: page (PapersDocument.Page) –
Return type:: cairo.Region

do_get_text(page) virtual¶

Parameters:: page (PapersDocument.Page) –
Return type:: str

do_get_text_attrs(page) virtual¶

Parameters:: page (PapersDocument.Page) – a PapersDocument.Page
Returns:: a newly created Pango.AttrList
Return type:: Pango.AttrList

FIXME

New in version 3.10.

do_get_text_in_area(page, area) virtual¶

Parameters:

page (PapersDocument.Page) – a PapersDocument.Page of that document
area (PapersDocument.Rectangle) – a PapersDocument.Rectangle on that page

Returns:

the text inside the area of the specified page or None

Return type:

str or None

New in version 47.

do_get_text_layout(page) virtual¶

Parameters:

page (PapersDocument.Page) – a PapersDocument.Page

Returns:

whether the text layout is empty, i.e. there is text on the page

areas:: the text areas of the layout

Return type:

(bool, areas: [PapersDocument.Rectangle])

do_get_text_mapping(page) virtual¶

Parameters:: page (PapersDocument.Page) –
Return type:: cairo.Region