PapersView.JobFind¶

Subclasses:: None

Methods¶

Inherited:: PapersView.Job (12), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (document, start_page, n_pages, text, options)
	`get_n_main_results` (page)
	`get_options` ()
	`has_results` ()

Virtual Methods¶

Inherited:: PapersView.Job (3), GObject.Object (7)

do_updated (page)

Properties¶

Inherited:: PapersView.Job (1)

Signals¶

Inherited:: PapersView.Job (2), GObject.Object (1)

Name	Short Description
`updated`

Fields¶

Inherited:: PapersView.Job (2), GObject.Object (1)

Name	Type	Access	Description
n_pages	`int`	r
options	`PapersDocument.FindOptions`	r
pages	[`object`]	r
parent	`PapersView.Job`	r
start_page	`int`	r
text	`str`	r

Class Details¶

class PapersView.JobFind(**kwargs)¶

Bases:: PapersView.Job
Abstract:: No
Structure:: PapersView.JobFindClass

classmethod new(document, start_page, n_pages, text, options)¶

Parameters:

document (PapersDocument.Document) –
start_page (int) –
n_pages (int) –
text (str) –
options (PapersDocument.FindOptions) –

Return type:

PapersView.Job

get_n_main_results(page)¶

Parameters:: page (int) – number of the page we want to count its match results.
Returns:: total number of match results in page
Return type:: int

This is similar to pps_job_find_get_n_results() but it takes care to treat any multi-line matches as being only one result.

get_options()¶

Returns:: the job’s find options
Return type:: PapersDocument.FindOptions

has_results()¶

Return type:: bool

do_updated(page) virtual¶

Parameters:: page (int) –

Signal Details¶

PapersView.JobFind.signals.updated(job_find, object)¶

Signal Name:

updated

Flags:

Parameters:

job_find (PapersView.JobFind) – The object which received the signal
object (int) –