string array of categories
the description
the developer name
hash map of icon urls and sizes
the unique identifier
string array of keywords
the #AsComponentKind of this component
the name
string array of packages name
the project group
the project license
An array of #AsScreenshot instances
the summary
the urls associated with this component
Add a category.
the categories name to add.
Adds a content rating to this component.
a #AsContentRating instance.
Add a reference to the extended component
The id of a component which is extended by this component
Adds a language to the component.
the locale, or %NULL. e.g. "en_GB"
the percentage completion of the translation, 0 for locales with unknown amount of translation
Adds a #AsLaunchable containing launchables entries for this component.
a #AsLaunchable instance.
Add a set of provided items to this component.
a #AsProvided instance.
Adds a provided item to the component with the given kind, creating a new
AsProvided for this kind internally if necessary.
the kind of the provided item (e.g. %AS_PROVIDED_KIND_MEDIATYPE)
the item to add.
Add an #AsScreenshot to this component.
The #AsScreenshot to add
Add an #AsSuggested to this component.
The #AsSuggested
Add a tag to this component.
The namespace the tag belongs to
The tag name
Assign an #AsTranslation object describing the translation system used by this component.
an #AsTranslation instance.
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
#GBinding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A #GObject can have multiple bindings.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default
a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default
Remove all registered language translation information.
Remove all tags associated with this component.
This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
#GObject::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Get the current active locale for this component, which is used to get localized messages.
Gets an agreement the component has specified for the particular kind.
an agreement kind, e.g. %AS_AGREEMENT_KIND_EULA
Gets the branch for the application.
Get the branding associated with this component, or %NULL in case this component has no special branding.
Gets a bundle identifier string.
the bundle kind, e.g. %AS_BUNDLE_KIND_LIMBA.
Gets a content ratings of a specific type that are defined for this component.
a ratings kind, e.g. "oars-1.0"
Gets all content ratings defined for this software.
Retrieve value for a custom data entry with the given key.
Field name.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Get a unique identifier for this metadata set. This unique ID is only valid for the current session, as opposed to the AppStream ID which uniquely identifies a software component.
The format of the unique id usually is: %{scope}/%{origin}/%{distribution_system}/%{appstream_id}
For example: system/os/package/org.example.FooBar
Gets the end-of-life date for the entire component.
Get the localized long description of this component.
Get the Desktop Entry ID for this component, if it is of type "desktop-application". For most desktop-application components, this is the name of the .desktop file.
Refer to https://specifications.freedesktop.org/desktop-entry-spec/latest/ape.html for more information.
Get the component's developer or development team name.
Returns a string list of IDs of components which are extended by this addon.
See %as_component_get_extends() for the reverse.
Gets an icon matching the size constraints. The icons are not filtered by type, and the first icon which matches the size is returned. If you want more control over which icons you use for displaying, use the %as_component_get_icons() function to get a list of all icons.
Note that this function is not HiDPI aware! It will never return an icon with a scaling factor > 1.
The icon width in pixels.
the icon height in pixels.
Get the unique AppStream identifier for this component. This ID is unique for the described component, but does not uniquely identify the metadata set.
For a unique ID for this metadata set in the current session, use %as_component_get_data_id()
Retrieve the internal hash table mapping languages to keword arrays.
Returns the #AsComponentKind of this component.
Gets the translation coverage in percent for a specific locale
the locale, or %NULL. e.g. "en_GB"
Get a list of all languages.
Gets a #AsLaunchable of a specific type that contains launchable entries for this component.
a launch kind, e.g. %AS_LAUNCHABLE_KIND_DESKTOP_ID
Get the merge method which should apply to duplicate components with this ID.
The license the metadata iself is subjected to.
A human-readable name for this component.
Get the internal locale to component name mapping table.
Get variant suffix for the component name (only to be displayed if two components have the same name).
Get the first package name of the list of packages that need to be installed for this component to be present on the system. Since most components consist of only one package, this is safe to use for about 90% of all cases.
However, to support a component fully, please use %as_component_get_pkgnames() for getting all packages that need to be installed, and use this method only to e.g. get the main package to perform a quick "is it installed?" check.
Get a list of package names which this component consists of. This usually is just one package name.
Returns the priority of this component. This method is used internally.
Get the component's project group.
Get the license of the project this component belongs to.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
Get a list of #AsProvided objects associated with this component.
Get an #AsProvided object for the given interface type, containing information about the public interfaces (mimetypes, firmware, DBus services, ...) this component provides.
kind of the provided item, e.g. %AS_PROVIDED_KIND_MIMETYPE
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Get a list of associated screenshots.
Returns all search tokens for this component.
Returns the sorting priority of this component.
This will only return a valid value if this component was the result of or involved in a search operation which returned sorted results. In most cases you will not need to access this value explicitly, as all results of search operations in AppStream are already sorted from best match to worst.
The returned value is an arbitrary integer value, valid only for the search terms involved in the search operation that yielded this component as a result.
Get a list of associated suggestions.
Get a short description of this component.
Get the internal locale to component summary mapping table.
Gets the UNIX timestamp for the date when this component is out of support (end-of-life) and will receive no more updates, not even security fixes.
Get a #GPtrArray of #AsTranslation objects describing the translation systems and translation-ids (e.g. Gettext domains) used by this software component.
Only set for metainfo files.
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Check if component is in the specified category.
the specified category to check
Test if the component is tagged with the selected tag.
The namespace the tag belongs to
The tag name
Add a key and value pair to the custom data table.
Key name.
A string value.
Check if this component is compulsory for the given desktop.
the desktop-id to test for
Checks whether object has a [floating][floating-ref] reference.
Check if the essential properties of this Component are populated with useful data.
Load metadata for this component from an XML string. You normally do not want to use this method directly and instead use the more convenient API of #AsMetadata to create and update components.
If this function returns %TRUE, a valid component is returned unless the selected format was %AS_FORMAT_KIND_DESKTOP_ENTRY, in which case a component ID will have to be set explicitly by the caller in order to make the component valid.
an #AsContext instance.
the format of the data to load, e.g. %AS_FORMAT_KIND_XML
the data to load.
Load metadata for this component from an XML string. You normally do not want to use this method directly and instead use the more convenient API of #AsMetadata to create and update components.
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object.
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
Remove a tag from this component
The namespace the tag belongs to
The tag name
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Searches component data for a specific keyword.
the search term.
Searches component data for all the specific keywords.
the search terms.
Set the current active locale for this component, which is used to get localized messages. If the #AsComponent was fetched from a localized database, usually only one locale is available.
the locale, or %NULL. e.g. "en_GB"
Set the branch that the component instance was sourced from.
the branch, e.g. "master" or "3-16".
Set branding for this component.
an #AsBranding instance.
Mark this component to be compulsory for the specified desktop environment.
The name of the desktop.
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a #GQuark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the #GQuark storage growing unbounded.
name of the key
data to associate with that key
Set the session-specific unique metadata identifier for this component. If two components have a different data_id but the same ID, they will be treated as independent sets of metadata describing the same component type.
the unique session-specific identifier.
Sets an end-of-life date for this component.
the EOL date in ISO8601 format.
Set long description for this component.
The long description
The locale the used for this value, or %NULL to use the current active one.
Set the the component's developer or development team name.
the developer or developer team name
the locale, or %NULL. e.g. "en_GB"
Set the AppStream identifier for this component.
the unique identifier.
Set keywords for this component.
String-array of keywords
Locale of the values, or %NULL to use current locale.
Sets the #AsComponentKind of this component.
the #AsComponentKind.
Sets the #AsMergeKind for this component.
the #AsMergeKind.
Set the license this metadata is licensed under.
the metadata license.
Set a human-readable name for this component.
The name
The locale the used for this value, or %NULL to use the current active one.
Set a variant suffix for the component name (only to be displayed if components have the same name).
the developer or developer team name
the locale, or %NULL. e.g. "en_GB"
Set the package name that provides this component.
the package name
Set a list of package names this component consists of. (This should usually be just one package name)
Sets the priority of this component. This method is used internally.
the given priority
Set the component's project group.
the project group.
Set the project license.
the project license.
Sets a property on an object.
the name of the property to set
the value
Sets the #AsComponentScope of this component.
the #AsComponentKind.
Sets the sorting score of this component.
the given sorting score
Set a short description for this component.
The summary
The locale the used for this value, or %NULL to use the current active one.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Returns a string identifying this component. (useful for debugging)
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
#GClosure to watch
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
#GTypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
Creates a new #AsComponent.