Foundry.FileSearchProvider¶
- Subclasses:
None
Methods¶
- Inherited:
Foundry.Contextual (4), GObject.Object (37), Json.Serializable (8)
- Structs:
|
Virtual Methods¶
- Inherited:
|
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
|---|---|---|---|
r/w/co |
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
|---|---|---|---|
parent_instance |
r |
Class Details¶
- class Foundry.FileSearchProvider(**kwargs)¶
- Bases:
- Abstract:
Yes
- Structure:
A pluggable file search provider.
The
FoundryFileSearchProviderclass allows precise implementation over how file searches are performed. Plugins can provide an alternate implementation to the defaultgrepbased search provider by implementing this class at a higher priority than thegrepprovider.New in version 1.1.
- dup_plugin_info()¶
- Return type:
New in version 1.1.
- search(options, operation)¶
- Parameters:
options (
Foundry.FileSearchOptions) – a [class`Foundry`.FileSearchOptions]operation (
Foundry.Operation) – a [class`Foundry`.Operation]
- Returns:
a [class`Dex`.Future] that resolves to a [iface`Gio`.ListModel] of [class`Foundry`.FileSearchMatch] or rejects with error.
- Return type:
Performs the requested search.
It is expected that the implementation returns a [iface`Gio`.ListModel] as early as convenient and asynchronously populate the results after that.
Callers should use [func`Foundry`.list_model_await] to wait for completion of the entire result set.
If the provider is missing dependencies (such as a missing search tool in the users path) this method should reject with
G_IO_ERROR_NOT_SUPPORTEDso that the next implementation may be used.New in version 1.1.
- do_search(options, operation) virtual¶
- Parameters:
options (
Foundry.FileSearchOptions) – a [class`Foundry`.FileSearchOptions]operation (
Foundry.Operation) – a [class`Foundry`.Operation]
- Returns:
a [class`Dex`.Future] that resolves to a [iface`Gio`.ListModel] of [class`Foundry`.FileSearchMatch] or rejects with error.
- Return type:
Performs the requested search.
It is expected that the implementation returns a [iface`Gio`.ListModel] as early as convenient and asynchronously populate the results after that.
Callers should use [func`Foundry`.list_model_await] to wait for completion of the entire result set.
If the provider is missing dependencies (such as a missing search tool in the users path) this method should reject with
G_IO_ERROR_NOT_SUPPORTEDso that the next implementation may be used.New in version 1.1.
Property Details¶
- Foundry.FileSearchProvider.props.plugin_info¶
- Name:
plugin-info- Type:
- Default Value:
- Flags:
New in version 1.1.