Foundry.SearchProvider

g Foundry.Contextual Foundry.Contextual Foundry.SearchProvider Foundry.SearchProvider Foundry.Contextual->Foundry.SearchProvider GObject.GInterface GObject.GInterface Json.Serializable Json.Serializable GObject.GInterface->Json.Serializable GObject.Object GObject.Object GObject.Object->Foundry.Contextual Json.Serializable->Foundry.Contextual

Subclasses:

Foundry.MenuSearchProvider

Methods

Inherited:

Foundry.Contextual (4), GObject.Object (37), Json.Serializable (8)

Structs:

GObject.ObjectClass (5)

dup_name ()

dup_plugin_info ()

search (request)

Virtual Methods

Inherited:

GObject.Object (7), Json.Serializable (5)

do_dup_name ()

do_search (request)

Properties

Inherited:

Foundry.Contextual (1)

Name

Type

Flags

Short Description

plugin-info

Peas.PluginInfo

r/w/co

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

parent_instance

Foundry.Contextual

r

Class Details

class Foundry.SearchProvider(**kwargs)
Bases:

Foundry.Contextual

Abstract:

Yes

Structure:

Foundry.SearchProviderClass

Abstract base class allowing plugins to provide search capabilities.

dup_name()
Returns:

the name of the provider

Return type:

str

Gets a name for the provider that is expected to be displayed to users such as “Flatpak”.

dup_plugin_info()
Returns:

a [class`Peas`.PluginInfo]

Return type:

Peas.PluginInfo or None

New in version 1.1.

search(request)
Parameters:

request (Foundry.SearchRequest) –

Returns:

a [class`Dex`.Future] that resolves to a [iface`Gio`.ListModel] of [class`Foundry`.SearchResult] or rejects with error.

Return type:

Dex.Future

do_dup_name() virtual
Returns:

the name of the provider

Return type:

str

Gets a name for the provider that is expected to be displayed to users such as “Flatpak”.

Parameters:

request (Foundry.SearchRequest) –

Returns:

a [class`Dex`.Future] that resolves to a [iface`Gio`.ListModel] of [class`Foundry`.SearchResult] or rejects with error.

Return type:

Dex.Future

Property Details

Foundry.SearchProvider.props.plugin_info
Name:

plugin-info

Type:

Peas.PluginInfo

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY