PapersView.SearchResult

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	new (markup, label, page, index, global_index, rect)
	append_rectangle (rect)
	get_global_index ()
	get_index ()
	get_label ()
	get_markup ()
	get_page ()
	get_rectangle_list ()

Virtual Methods

Inherited:

GObject.Object (7)

Properties

None

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent_instance	GObject.Object	r

Class Details

class PapersView.SearchResult(**kwargs)

Bases:

GObject.Object

Abstract:

No

Structure:

PapersView.SearchResultClass

classmethod new(markup, label, page, index, global_index, rect)

Parameters:

• markup (str) –

• label (str) –

• page (int) –

• index (int) –

• global_index (int) –

• rect (PapersDocument.FindRectangle) –

Return type:

PapersView.SearchResult

append_rectangle(rect)

Parameters:

rect (PapersDocument.FindRectangle) – the PapersDocument.FindRectangle to append

Appends a rectangle to the search result. This should not be used outside the creation of the search result.

get_global_index()

Returns:

the index of this result relative the complete result model.

Return type:

int

New in version 48.0.

get_index()

Return type:

int

get_label()

Return type:

str

get_markup()

Return type:

str

get_page()

Return type:

int

get_rectangle_list()

Returns:

the list of rectangles for this result.

Return type:

[PapersDocument.FindRectangle] or None