![]() |
![]() |
![]() |
LibAppStream Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#include <appstream.h> struct AsComponent; struct AsComponentClass; enum AsComponentKind; const gchar * as_component_kind_to_string (AsComponentKind kind
); AsComponentKind as_component_kind_from_string (const gchar *kind_str
); AsComponent * as_component_new (void
); AsComponent * as_component_construct (GType object_type
); gboolean as_component_is_valid (AsComponent *self
); gchar * as_component_to_string (AsComponent *self
); gboolean as_component_provides_item (AsComponent *self
,AsProvidesKind kind
,const gchar *value
); AsComponentKind as_component_get_kind (AsComponent *self
); const gchar * as_component_get_pkgname (AsComponent *self
); const gchar * as_component_get_idname (AsComponent *self
); const gchar * as_component_get_name (AsComponent *self
); const gchar * as_component_get_name_original (AsComponent *self
); const gchar * as_component_get_project_license (AsComponent *self
); const gchar * as_component_get_project_group (AsComponent *self
); gchar ** as_component_get_compulsory_for_desktops (AsComponent *self
); const gchar * as_component_get_summary (AsComponent *self
); gchar ** as_component_get_categories (AsComponent *self
); GPtrArray * as_component_get_screenshots (AsComponent *self
); const gchar * as_component_get_description (AsComponent *self
); gchar ** as_component_get_keywords (AsComponent *self
); const gchar * as_component_get_icon (AsComponent *self
); const gchar * as_component_get_icon_url (AsComponent *self
); const gchar * as_component_get_homepage (AsComponent *self
); gchar ** as_component_get_mimetypes (AsComponent *self
); GPtrArray * as_component_get_provided_items (AsComponent *self
); GPtrArray * as_component_get_releases (AsComponent *self
); void as_component_add_screenshot (AsComponent *self
,AsScreenshot *sshot
); void as_component_add_release (AsComponent *self
,AsRelease *release
); void as_component_set_categories_from_str (AsComponent *self
,const gchar *categories_str
); void as_component_set_kind (AsComponent *self
,AsComponentKind value
); void as_component_set_name (AsComponent *self
,const gchar *value
); void as_component_set_keywords (AsComponent *self
,gchar **value
); void as_component_set_mimetypes (AsComponent *self
,gchar **value
); void as_component_set_compulsory_for_desktops (AsComponent *self
,gchar **value
); void as_component_set_pkgname (AsComponent *self
,const gchar *value
); void as_component_set_idname (AsComponent *self
,const gchar *value
); void as_component_set_name_original (AsComponent *self
,const gchar *value
); void as_component_set_summary (AsComponent *self
,const gchar *value
); void as_component_set_description (AsComponent *self
,const gchar *value
); void as_component_set_homepage (AsComponent *self
,const gchar *value
); void as_component_set_icon (AsComponent *self
,const gchar *value
); void as_component_set_icon_url (AsComponent *self
,const gchar *value
); void as_component_set_project_license (AsComponent *self
,const gchar *value
); void as_component_set_project_group (AsComponent *self
,const gchar *value
); void as_component_set_categories (AsComponent *self
,gchar **value
);
"categories" GStrv : Read / Write "description" gchar* : Read / Write "homepage" gchar* : Read / Write "icon" gchar* : Read / Write "icon-url" gchar* : Read / Write "idname" gchar* : Read / Write "keywords" GStrv : Read / Write "kind" AsComponentKind : Read / Write "mimetypes" GStrv : Read / Write "name" gchar* : Read / Write "name-original" gchar* : Read / Write "pkgname" gchar* : Read / Write "project-license" gchar* : Read / Write "screenshots" GPtrArray* : Read "summary" gchar* : Read / Write
This object represents an Appstream software component which is associated to a package in the distribution's repositories. A component can be anything, ranging from an application to a font, a codec or even a non-visual software project providing libraries and python-modules for other applications to use.
The type of the component is stored as AsComponentKind and can be queried to find out which kind of component we're dealing with.
See also: AsProvidesKind, AsDatabase
typedef enum { AS_COMPONENT_KIND_UNKNOWN, AS_COMPONENT_KIND_GENERIC, AS_COMPONENT_KIND_DESKTOP_APP, AS_COMPONENT_KIND_FONT, AS_COMPONENT_KIND_CODEC, AS_COMPONENT_KIND_INPUTMETHOD, AS_COMPONENT_KIND_LAST } AsComponentKind;
const gchar * as_component_kind_to_string (AsComponentKind kind
);
Converts the enumerated value to an text representation.
|
the AsComponentKind. |
Returns : |
string version of kind
|
AsComponentKind as_component_kind_from_string (const gchar *kind_str
);
Converts the text representation to an enumerated value.
|
the string. |
Returns : |
a AsComponentKind or AS_COMPONENT_KIND_UNKNOWN for unknown |
AsComponent * as_component_new (void
);
Creates a new AsComponent.
Returns : |
an AsComponent. [transfer full] |
gboolean as_component_is_valid (AsComponent *self
);
Check if the essential properties of this Component are populated with useful data.
Returns : |
TRUE if the component data was validated successfully. |
gchar * as_component_to_string (AsComponent *self
);
Returns a string identifying this component. (useful for debugging)
Returns : |
A descriptive string. [transfer full] |
gboolean as_component_provides_item (AsComponent *self
,AsProvidesKind kind
,const gchar *value
);
Checks if this component provides an item of the specified type
self
a valid AsComponent
kind
the kind of the provides-item
value
the value of the provides-item
Returns : |
TRUE if an item was found |
const gchar * as_component_get_project_license (AsComponent *self
);
Get the license of the project this component belongs to.
const gchar * as_component_get_project_group (AsComponent *self
);
Get the component's project group.
gchar ** as_component_get_compulsory_for_desktops
(AsComponent *self
);
Returns : |
A list of desktops where this component is compulsory. [transfer none] |
GPtrArray * as_component_get_screenshots (AsComponent *self
);
Get a list of associated screenshots.
Returns : |
an array of AsScreenshot instances. [element-type AsScreenshot][transfer none] |
GPtrArray * as_component_get_provided_items (AsComponent *self
);
Get an array of the provides-items this component is associated with.
Returns : |
A list of desktops where this component is compulsory. [element-type utf8][transfer none] |
GPtrArray * as_component_get_releases (AsComponent *self
);
Get an array of the AsRelease items this component provides.
Returns : |
A list of releases. [element-type AsRelease][transfer none] |
void as_component_add_screenshot (AsComponent *self
,AsScreenshot *sshot
);
Add an AsScreenshot to this component.
|
a AsComponent instance. |
|
The AsScreenshot to add |
void as_component_add_release (AsComponent *self
,AsRelease *release
);
Add an AsRelease to this component.
|
a AsComponent instance. |
|
The AsRelease to add |
void as_component_set_categories_from_str (AsComponent *self
,const gchar *categories_str
);
Set the categories list from a string
self
a valid AsComponent instance
categories_str
Comma-separated list of category-names
void as_component_set_compulsory_for_desktops (AsComponent *self
,gchar **value
);
Set a list of desktops where this component is compulsory.
void as_component_set_name_original (AsComponent *self
,const gchar *value
);
void as_component_set_description (AsComponent *self
,const gchar *value
);
void as_component_set_homepage (AsComponent *self
,const gchar *value
);
void as_component_set_icon_url (AsComponent *self
,const gchar *value
);
void as_component_set_project_license (AsComponent *self
,const gchar *value
);
Set the project license.
void as_component_set_project_group (AsComponent *self
,const gchar *value
);
Set the component's project group.
"kind"
property"kind" AsComponentKind : Read / Write
kind.
Default value: AS_COMPONENT_KIND_UNKNOWN
"name-original"
property"name-original" gchar* : Read / Write
name-original.
Default value: NULL
"project-license"
property"project-license" gchar* : Read / Write
project-license.
Default value: NULL