PapersView.SearchContext¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (model)
	`activate` ()
	`autoselect_result` (result)
	`get_active` ()
	`get_options` ()
	`get_result_model` ()
	`get_results_on_page` (page)
	`get_search_term` ()
	`has_results_on_page` (page)
	`release` ()
	`restart` ()
	`set_options` (options)
	`set_search_term` (search_term)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`active`	`bool`	r/en	search is actively ongoing
`document-model`	`PapersView.DocumentModel`	w/co	The document model
`search-term`	`str`	r/w/en	search term for the current context

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`cleared`
`finished`
`result-activated`
`started`

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class PapersView.SearchContext(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: PapersView.SearchContextClass

classmethod new(model)¶

Parameters:: model (PapersView.DocumentModel) –
Return type:: PapersView.SearchContext

activate()¶: New in version 48.0.

autoselect_result(result)¶

Parameters:: result (PapersView.SearchResult) – a PapersView.SearchResult to be the auto-selected one

New in version 48.0.

get_active()¶

Returns:: whether search is actively ongoing
Return type:: bool

New in version 48.0.

get_options()¶

Return type:: PapersDocument.FindOptions

get_result_model()¶

Returns:: the returned Gtk.SingleSelection
Return type:: Gtk.SingleSelection

get_results_on_page(page)¶

Parameters:: page (int) –
Returns:: GLib.PtrArray of PapersView.SearchResult on the current page
Return type:: [PapersView.SearchResult]

New in version 48.0.

get_search_term()¶

Return type:: str

has_results_on_page(page)¶

Parameters:: page (int) –
Return type:: bool

release()¶: New in version 48.0.

restart()¶

set_options(options)¶

Parameters:: options (PapersDocument.FindOptions) –

set_search_term(search_term)¶

Parameters:: search_term (str) –

Signal Details¶

PapersView.SearchContext.signals.cleared(search_context)¶

Signal Name:: cleared
Flags:: RUN_LAST
Parameters:: search_context (PapersView.SearchContext) – The object which received the signal

PapersView.SearchContext.signals.finished(search_context, object)¶

Signal Name:

finished

Flags:

RUN_LAST

Parameters:

search_context (PapersView.SearchContext) – The object which received the signal
object (int) –

PapersView.SearchContext.signals.result_activated(search_context, object)¶

Signal Name:

result-activated

Flags:

RUN_LAST

Parameters:

search_context (PapersView.SearchContext) – The object which received the signal
object (PapersView.SearchResult) –

PapersView.SearchContext.signals.started(search_context)¶

Signal Name:: started
Flags:: RUN_LAST
Parameters:: search_context (PapersView.SearchContext) – The object which received the signal

Property Details¶

PapersView.SearchContext.props.active¶

Name:: active
Type:: bool
Default Value:: False
Flags:: READABLE, EXPLICIT_NOTIFY

search is actively ongoing

PapersView.SearchContext.props.document_model¶

Name:: document-model
Type:: PapersView.DocumentModel
Default Value:: None
Flags:: WRITABLE, CONSTRUCT_ONLY

The document model

PapersView.SearchContext.props.search_term¶

Name:: search-term
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

search term for the current context