Class
FoundryDocumentationBundle
Description [src]
abstract class Foundry.DocumentationBundle : Foundry.Contextual
implements Json.Serializable {
/* No available fields */
}Abstract base class for plugins to provide installable documentation.
A bundle represents a group of documentation that may be installed such as the docs for a specific SDK.
Instance methods
foundry_documentation_bundle_dup_tags
Gets tags for the documentation which may be useful to show the user to help them make better selections.
foundry_documentation_bundle_get_eol
Gets whether the documentation bundle has reached end of life.
unstable since: 1.1
Methods inherited from FoundryContextual (4)
foundry_contextual_acquire
This method provides a checked way to get a context for the contextual.
unstable since: 1.1
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.
Properties
Foundry.DocumentationBundle:eol
Whether the documentation bundle has reached end of life.
unstable since: 1.1
Properties inherited from FoundryContextual (1)
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 FoundryDocumentationBundleClass {
FoundryContextualClass parent_class;
gboolean (* get_installed) (
FoundryDocumentationBundle* self
);
gboolean (* get_eol) (
FoundryDocumentationBundle* self
);
char* (* dup_id) (
FoundryDocumentationBundle* self
);
char* (* dup_title) (
FoundryDocumentationBundle* self
);
char* (* dup_subtitle) (
FoundryDocumentationBundle* self
);
char** (* dup_tags) (
FoundryDocumentationBundle* self
);
DexFuture* (* install) (
FoundryDocumentationBundle* self,
FoundryOperation* operation,
DexCancellable* cancellable
);
}No description available.
Class members
parent_class: FoundryContextualClassNo description available.
get_installed: gboolean (* get_installed) ( FoundryDocumentationBundle* self )No description available.
get_eol: gboolean (* get_eol) ( FoundryDocumentationBundle* self )No description available.
dup_id: char* (* dup_id) ( FoundryDocumentationBundle* self )No description available.
dup_title: char* (* dup_title) ( FoundryDocumentationBundle* self )No description available.
dup_subtitle: char* (* dup_subtitle) ( FoundryDocumentationBundle* self )No description available.
dup_tags: char** (* dup_tags) ( FoundryDocumentationBundle* self )No description available.
install: DexFuture* (* install) ( FoundryDocumentationBundle* self, FoundryOperation* operation, DexCancellable* cancellable )No description available.
Virtual methods
Foundry.DocumentationBundleClass.dup_tags
Gets tags for the documentation which may be useful to show the user to help them make better selections.
Foundry.DocumentationBundleClass.get_eol
Gets whether the documentation bundle has reached end of life.
unstable since: 1.1