Foundry.DocumentationManager¶
- Subclasses:
None
Methods¶
- Inherited:
Foundry.Service (8), Foundry.Contextual (4), GObject.Object (37), Json.Serializable (8)
- Structs:
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
|---|---|---|---|
r |
Signals¶
- Inherited:
Name |
Short Description |
|---|---|
Fields¶
- Inherited:
Class Details¶
- class Foundry.DocumentationManager(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
Service that manages documentation plugins.
- find_by_uri(uri)¶
- Parameters:
uri (
str) –- Returns:
a [class`Dex`.Future] that resolves to a [class`Foundry`.Documentation] or rejects with error.
- Return type:
- index()¶
- Return type:
Ensures the documentation manager has indexed.
This happens on demand but can be forced to start earlier by applications which may want to delay operations until this part has completed. Such an example is to now show a window until the initial indexing has completed.
- list_bundles()¶
- Returns:
a [class`Dex`.Future] that resolves to a [iface`Gio`.ListModel] of [class`Foundry`.DocumentationBundle] or rejects with error.
- Return type:
- list_children(parent)¶
- Parameters:
parent (
Foundry.Documentation) –- Returns:
a [class`Dex`.Future] that resolves to a [iface`Gio`.ListModel] or rejects with error.
- Return type:
- query(query)¶
- Parameters:
query (
Foundry.DocumentationQuery) – a [class`Foundry`.DocumentationQuery]- Returns:
a [class`Dex`.Future] that resolves to [Foundry.DocumentationMatches].
- Return type:
Consumers can call [method`Foundry`.DocumentationMatches.await] to get a future that will complete when all matches have been populated.
Signal Details¶
- Foundry.DocumentationManager.signals.changed(documentation_manager)¶
- Signal Name:
changed- Flags:
- Parameters:
documentation_manager (
Foundry.DocumentationManager) – The object which received the signal