Class
FoundryDocumentationProvider
Instance methods
foundry_documentation_provider_index
This method is called when the documentation provider should rescan the provided roots for changes.
foundry_documentation_provider_list_roots
Returns a list of FoundryDocumentationRoot that may contain
documentation to be discovered and ingested. This allows plugins for
SDKs to provide information about where documentation is located.
Methods inherited from FoundryContextual (3)
foundry_contextual_dup_context
Gets the FoundryContext that self is a part of while safely increasing
the reference count of the resulting FoundryContext by 1.
foundry_contextual_inhibit
Creates a new FoundryInhibitor that will keep the
FoundryContext alive and prevent shutdown until
foundry_inhibitor_uninhibit() is called or the
FoundryInhibitor is finalized, whichever comes first.
foundry_contextual_log
Methods inherited from JsonSerializable (8)
json_serializable_default_deserialize_property
Calls the default implementation of the Json.SerializableIface.deserialize_property
virtual function.
json_serializable_default_serialize_property
Calls the default implementation of the Json.SerializableIface.serialize_property
virtual function.
json_serializable_deserialize_property
Asks a JsonSerializable implementation to deserialize the
property contained inside property_node and place its value
into value.
json_serializable_find_property
Calls the Json.SerializableIface.find_property implementation on
the JsonSerializable instance, which will return the property
description for the given name.
json_serializable_get_property
Calls the Json.SerializableIface.get_property implementation
on the JsonSerializable instance, which will get the value of
the given property.
json_serializable_list_properties
Calls the Json.SerializableIface.list_properties implementation on
the JsonSerializable instance, which will return the list of serializable properties.
json_serializable_serialize_property
Asks a JsonSerializable implementation to serialize an object
property into a JSON node.
json_serializable_set_property
Calls the Json.SerializableIface.set_property implementation
on the JsonSerializable instance, which will set the property
with the given value.
Signals
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Class structure
struct FoundryDocumentationProviderClass {
FoundryContextualClass parent_class;
DexFuture* (* load) (
FoundryDocumentationProvider* self
);
DexFuture* (* unload) (
FoundryDocumentationProvider* self
);
GListModel* (* list_roots) (
FoundryDocumentationProvider* self
);
DexFuture* (* index) (
FoundryDocumentationProvider* self,
GListModel* roots
);
DexFuture* (* query) (
FoundryDocumentationProvider* self,
FoundryDocumentationQuery* query
);
}No description available.
Class members
parent_class: FoundryContextualClassNo description available.
load: DexFuture* (* load) ( FoundryDocumentationProvider* self )No description available.
unload: DexFuture* (* unload) ( FoundryDocumentationProvider* self )No description available.
list_roots: GListModel* (* list_roots) ( FoundryDocumentationProvider* self )No description available.
index: DexFuture* (* index) ( FoundryDocumentationProvider* self, GListModel* roots )No description available.
query: DexFuture* (* query) ( FoundryDocumentationProvider* self, FoundryDocumentationQuery* query )No description available.
Virtual methods
Foundry.DocumentationProviderClass.index
This method is called when the documentation provider should rescan the provided roots for changes.
Foundry.DocumentationProviderClass.list_roots
Returns a list of FoundryDocumentationRoot that may contain
documentation to be discovered and ingested. This allows plugins for
SDKs to provide information about where documentation is located.