diff -Nru appstream-0.9.4/CMakeLists.txt appstream-0.12.0/CMakeLists.txt
--- appstream-0.9.4/CMakeLists.txt 2016-04-18 14:19:38.000000000 +0000
+++ appstream-0.12.0/CMakeLists.txt 1970-01-01 00:00:00.000000000 +0000
@@ -1,106 +0,0 @@
-# CMakeLists for the AppStream Project
-project(appstream)
-cmake_minimum_required(VERSION 3.1.0 FATAL_ERROR)
-
-set(CMAKE_BUILD_TYPE "Debug")
-
-set(AS_VERSION_MAJOR "0")
-set(AS_VERSION_MINOR "9")
-set(AS_VERSION_PATCH "4")
-set(AS_VERSION "${AS_VERSION_MAJOR}.${AS_VERSION_MINOR}.${AS_VERSION_PATCH}")
-set(APPSTREAM_LIB_API_LEVEL "3")
-
-# Don't allow in-tree building
-if(${CMAKE_SOURCE_DIR} MATCHES ${CMAKE_BINARY_DIR})
- message(STATUS "Please do an out-of-tree build:")
- message(STATUS "rm -f CMakeCache.txt && mkdir build && cd build; cmake .. && make")
- message(FATAL_ERROR "In-tree-build detected!")
-endif(${CMAKE_SOURCE_DIR} MATCHES ${CMAKE_BINARY_DIR})
-
-#
-# Options
-#
-option(L18N "Enable localization" ON)
-option(VAPI "Create and install a Vala API file" OFF)
-option(QT "Build libappstream-qt" OFF)
-option(MAINTAINER "Enable maintainer mode" OFF)
-option(DOCUMENTATION "Enable target to build documentation" OFF)
-option(APT_SUPPORT "Enable integration with APT on Debian" OFF)
-
-if(APT_SUPPORT)
- add_definitions ("-DAPT_SUPPORT")
-endif()
-
-#
-# Default paths
-#
-if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
- set(CMAKE_INSTALL_PREFIX
- "/usr" CACHE PATH "Default install prefix" FORCE)
-endif(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
-
-# Special case for /etc and /var when prefix is /usr
-if(${CMAKE_INSTALL_PREFIX} STREQUAL "/usr")
- set(CMAKE_INSTALL_SYSCONFDIR "/etc" CACHE PATH "read-only single-machine data (etc)")
- set(CMAKE_INSTALL_LOCALSTATEDIR "/var" CACHE PATH "modifiable single-machine data (var)")
-endif(${CMAKE_INSTALL_PREFIX} STREQUAL "/usr")
-include(GNUInstallDirs)
-set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_SOURCE_DIR}/data/cmake/)
-
-message(STATUS "Compiling AppStream version ${AS_VERSION}")
-
-add_custom_target(distclean
- "make clean"
-)
-
-#
-# l18n
-#
-find_package (Gettext REQUIRED)
-
-#
-# Configure files
-#
-set (GETTEXT_PACKAGE "appstream")
-set (VERSION "${AS_VERSION}")
-configure_file(config.h.in ${CMAKE_BINARY_DIR}/config.h)
-
-#
-# Enable testing
-#
-enable_testing()
-
-#
-# Custom C flags
-#
-set(MAINTAINER_CFLAGS "")
-if(MAINTAINER)
- set(MAINTAINER_CFLAGS "-Werror -Wall -Wcast-align -Wno-uninitialized -Wempty-body -Wformat-security -Winit-self")
- if (CMAKE_COMPILER_IS_GNUCC)
- execute_process(COMMAND ${CMAKE_C_COMPILER} -dumpversion
- OUTPUT_VARIABLE GCC_VERSION)
- if (GCC_VERSION VERSION_GREATER 4.9 OR GCC_VERSION VERSION_EQUAL 4.9)
- set(MAINTAINER_CFLAGS ${MAINTAINER_CFLAGS} "-fdiagnostics-color=auto")
- endif()
- endif()
-endif(MAINTAINER)
-add_definitions(${MAINTAINER_CFLAGS})
-
-# we do always enable this to never run into the missing-include-trap again
-add_definitions("-Werror=implicit-function-declaration")
-
-# enable C++11
-set(CMAKE_CXX_STANDARD "11")
-
-find_package(PkgConfig REQUIRED)
-
-add_subdirectory(src)
-add_subdirectory(tools)
-add_subdirectory(data)
-add_subdirectory(contrib)
-add_subdirectory(po)
-add_subdirectory(docs)
-add_subdirectory(tests)
-if(QT)
- add_subdirectory(qt)
-endif()
diff -Nru appstream-0.9.4/config.h.in appstream-0.12.0/config.h.in
--- appstream-0.9.4/config.h.in 2016-04-18 14:19:38.000000000 +0000
+++ appstream-0.12.0/config.h.in 2018-04-04 15:53:56.000000000 +0000
@@ -33,4 +33,10 @@
/* Version number of package */
#define VERSION "@VERSION@"
-#endif /*CONFIG_H*/
+/* Set if we have APT support */
+#cmakedefine HAVE_APT_SUPPORT
+
+/* Set if we have stemming support */
+#cmakedefine HAVE_STEMMING
+
+#endif /* CONFIG_H */
diff -Nru appstream-0.9.4/contrib/apt-conf/50appstream appstream-0.12.0/contrib/apt-conf/50appstream
--- appstream-0.9.4/contrib/apt-conf/50appstream 2016-04-18 14:19:38.000000000 +0000
+++ appstream-0.12.0/contrib/apt-conf/50appstream 2018-04-04 15:53:56.000000000 +0000
@@ -12,6 +12,18 @@
KeepCompressedAs "gz";
};
+ # Small icons for GUI components described in the DEP-11
+ # YAML metadata.
+ deb::DEP-11-icons-small {
+ MetaKey "$(COMPONENT)/dep11/icons-48x48.tar";
+ ShortDescription "icons-48x48";
+ Description "$(RELEASE)/$(COMPONENT) DEP-11 48x48 Icons";
+
+ KeepCompressed "true";
+ KeepCompressedAs "gz";
+ DefaultEnabled "false";
+ };
+
# Normal-sized icons for GUI components described in the DEP-11
# YAML metadata.
deb::DEP-11-icons {
@@ -21,11 +33,23 @@
KeepCompressed "true";
KeepCompressedAs "gz";
+ DefaultEnabled "false";
};
# Icons suitable for HiDPI displays, for GUI components described in
# the DEP-11 YAML metadata.
deb::DEP-11-icons-hidpi {
+ MetaKey "$(COMPONENT)/dep11/icons-64x64@2.tar";
+ ShortDescription "icons-64x64@2";
+ Description "$(RELEASE)/$(COMPONENT) DEP-11 64x64@2 Icons";
+
+ KeepCompressed "true";
+ KeepCompressedAs "gz";
+ DefaultEnabled "false";
+ };
+
+ # Larger icons that are often used on HiDPI displays as fallback.
+ deb::DEP-11-icons-large {
MetaKey "$(COMPONENT)/dep11/icons-128x128.tar";
ShortDescription "icons-128x128";
Description "$(RELEASE)/$(COMPONENT) DEP-11 128x128 Icons";
@@ -34,9 +58,20 @@
KeepCompressedAs "gz";
DefaultEnabled "false";
};
+
+ # Even larger icons that are used on HiDPI displays.
+ deb::DEP-11-icons-large-hidpi {
+ MetaKey "$(COMPONENT)/dep11/icons-128x128@2.tar";
+ ShortDescription "icons-128x128@2";
+ Description "$(RELEASE)/$(COMPONENT) DEP-11 128x128@2 Icons";
+
+ KeepCompressed "true";
+ KeepCompressedAs "gz";
+ DefaultEnabled "false";
+ };
};
# Refresh AppStream cache when APT's cache is updated (i.e. apt update)
APT::Update::Post-Invoke-Success {
- "if /usr/bin/test -w /var/cache/app-info -a -e /usr/bin/appstreamcli; then appstreamcli refresh > /dev/null; fi";
+ "if /usr/bin/test -w /var/cache/app-info -a -e /usr/bin/appstreamcli; then appstreamcli refresh-cache > /dev/null; fi";
};
diff -Nru appstream-0.9.4/contrib/apt-conf/60icons appstream-0.12.0/contrib/apt-conf/60icons
--- appstream-0.9.4/contrib/apt-conf/60icons 1970-01-01 00:00:00.000000000 +0000
+++ appstream-0.12.0/contrib/apt-conf/60icons 2018-04-04 15:53:56.000000000 +0000
@@ -0,0 +1,16 @@
+## This file enables the download of small-size 64x64px
+## icons for use in software centers like GNOME Software
+## and Plasma Discover.
+##
+## The icons are required for software centers to function
+## correctly. Applications without an icon will not be
+## displayed at all.
+
+Acquire::IndexTargets {
+ deb::DEP-11-icons-small {
+ DefaultEnabled "true";
+ };
+ deb::DEP-11-icons {
+ DefaultEnabled "true";
+ };
+};
diff -Nru appstream-0.9.4/contrib/apt-conf/60icons-hidpi appstream-0.12.0/contrib/apt-conf/60icons-hidpi
--- appstream-0.9.4/contrib/apt-conf/60icons-hidpi 1970-01-01 00:00:00.000000000 +0000
+++ appstream-0.12.0/contrib/apt-conf/60icons-hidpi 2018-04-04 15:53:56.000000000 +0000
@@ -0,0 +1,9 @@
+## This file enables the download of 64x64px icons
+## suitable for HiDPI displays for use in software
+## centers like GNOME Software and Plasma Discover.
+
+Acquire::IndexTargets {
+ deb::DEP-11-icons-hidpi {
+ DefaultEnabled "true";
+ };
+};
diff -Nru appstream-0.9.4/contrib/apt-conf/60icons-large appstream-0.12.0/contrib/apt-conf/60icons-large
--- appstream-0.9.4/contrib/apt-conf/60icons-large 1970-01-01 00:00:00.000000000 +0000
+++ appstream-0.12.0/contrib/apt-conf/60icons-large 2018-04-04 15:53:56.000000000 +0000
@@ -0,0 +1,12 @@
+## This file enables the download of large 128x128px
+## icons for use in software centers like GNOME Software
+## and Plasma Discover.
+##
+## The icons speed up usage of the software centers,
+## and would otherwise be downloaded on-deman for each user.
+
+Acquire::IndexTargets {
+ deb::DEP-11-icons-large {
+ DefaultEnabled "true";
+ };
+};
diff -Nru appstream-0.9.4/contrib/apt-conf/60icons-large-hidpi appstream-0.12.0/contrib/apt-conf/60icons-large-hidpi
--- appstream-0.9.4/contrib/apt-conf/60icons-large-hidpi 1970-01-01 00:00:00.000000000 +0000
+++ appstream-0.12.0/contrib/apt-conf/60icons-large-hidpi 2018-04-04 15:53:56.000000000 +0000
@@ -0,0 +1,9 @@
+## This file enables the download of 128x128px icons
+## suitable for HiDPI displays for use in software
+## centers like GNOME Software and Plasma Discover.
+
+Acquire::IndexTargets {
+ deb::DEP-11-icons-hidpi {
+ DefaultEnabled "true";
+ };
+};
diff -Nru appstream-0.9.4/contrib/apt-conf/CMakeLists.txt appstream-0.12.0/contrib/apt-conf/CMakeLists.txt
--- appstream-0.9.4/contrib/apt-conf/CMakeLists.txt 2016-04-18 14:19:38.000000000 +0000
+++ appstream-0.12.0/contrib/apt-conf/CMakeLists.txt 1970-01-01 00:00:00.000000000 +0000
@@ -1,2 +0,0 @@
-
-install(FILES 50appstream DESTINATION ${CMAKE_INSTALL_SYSCONFDIR}/apt/apt.conf.d/)
diff -Nru appstream-0.9.4/contrib/apt-conf/meson.build appstream-0.12.0/contrib/apt-conf/meson.build
--- appstream-0.9.4/contrib/apt-conf/meson.build 1970-01-01 00:00:00.000000000 +0000
+++ appstream-0.12.0/contrib/apt-conf/meson.build 2018-04-04 15:53:56.000000000 +0000
@@ -0,0 +1,3 @@
+# Meson definition for apt-conf
+
+install_data ('50appstream', install_dir: '/etc/apt/apt.conf.d/')
diff -Nru appstream-0.9.4/contrib/CMakeLists.txt appstream-0.12.0/contrib/CMakeLists.txt
--- appstream-0.9.4/contrib/CMakeLists.txt 2016-04-18 14:19:38.000000000 +0000
+++ appstream-0.12.0/contrib/CMakeLists.txt 1970-01-01 00:00:00.000000000 +0000
@@ -1,8 +0,0 @@
-
-add_subdirectory(its)
-if(VAPI)
- add_subdirectory(vapi)
-endif()
-if(APT_SUPPORT)
- add_subdirectory(apt-conf)
-endif()
diff -Nru appstream-0.9.4/contrib/its/CMakeLists.txt appstream-0.12.0/contrib/its/CMakeLists.txt
--- appstream-0.9.4/contrib/its/CMakeLists.txt 2016-04-18 14:19:38.000000000 +0000
+++ appstream-0.12.0/contrib/its/CMakeLists.txt 1970-01-01 00:00:00.000000000 +0000
@@ -1,3 +0,0 @@
-# Gettext ITS information for MetaInfo files
-
-install(FILES metainfo.its metainfo.loc DESTINATION share/gettext/its)
diff -Nru appstream-0.9.4/contrib/its/metainfo.its appstream-0.12.0/contrib/its/metainfo.its
--- appstream-0.9.4/contrib/its/metainfo.its 2016-04-18 14:19:38.000000000 +0000
+++ appstream-0.12.0/contrib/its/metainfo.its 1970-01-01 00:00:00.000000000 +0000
@@ -1,11 +0,0 @@
-
-
+ AppStream is a cross-distribution specification to provide metadata about software components. +
++ This tool allows for reading, writing, validating and transformation of AppStream XML or YAML metadata. + It also gives access to the system metadata pool, for example to query for software that provides a + specific MIME-type, and installing it by its software component identifier. +
+- | - | - | - | - |
Parameter points to an array of items.
Default parameter value (for in case the shadows-to function has less parameters).
Generics and defining elements of containers and arrays.
NULL may be passed as the value in, out, in-out; or as a return value.
Free data container after the code is done.
Free data after the code is done.
Don't free data after the code is done.
Override the parsed C type with given type.
- | - | - | - | - |
-Top - | -- | - | - | - |
const gchar * - | --as_url_kind_to_string () - | -
-AsUrlKind - | --as_url_kind_from_string () - | -
const gchar * - | --as_bundle_kind_to_string () - | -
-AsBundleKind - | --as_bundle_kind_from_string () - | -
const gchar * - | --as_urgency_kind_to_string () - | -
-AsUrgencyKind - | --as_urgency_kind_from_string () - | -
enum | -AsUrlKind | -
enum | -AsBundleKind | -
enum | -AsUrgencyKind | -
const gchar *
-as_url_kind_to_string (AsUrlKind url_kind
);
-Converts the enumerated value to an text representation.
- - -AsUrlKind
-as_url_kind_from_string (const gchar *url_kind
);
-Converts the text representation to an enumerated value.
- - -const gchar *
-as_bundle_kind_to_string (AsBundleKind bundle_kind
);
-Converts the enumerated value to an text representation.
- - -Since: 0.8.0
-AsBundleKind
-as_bundle_kind_from_string (const gchar *bundle_kind
);
-Converts the text representation to an enumerated value.
- - -const gchar *
-as_urgency_kind_to_string (AsUrgencyKind urgency_kind
);
-Converts the enumerated value to an text representation.
- - -Since: 0.6.5
-AsUrgencyKind
-as_urgency_kind_from_string (const gchar *urgency_kind
);
-Converts the text representation to an enumerated value.
- - -Since: 0.6.5
-The URL type.
- --Top - | -- | - | - | - |
-AsCategory * - | --as_category_new () - | -
-void - | --as_category_complete () - | -
const gchar * - | --as_category_get_directory () - | -
-void - | --as_category_set_directory () - | -
const gchar * - | --as_category_get_name () - | -
-void - | --as_category_set_name () - | -
const gchar * - | --as_category_get_summary () - | -
-void - | --as_category_set_summary () - | -
const gchar * - | --as_category_get_icon () - | -
-void - | --as_category_set_icon () - | -
-gboolean - | --as_category_has_subcategory () - | -
-void - | --as_category_add_subcategory () - | -
-void - | --as_category_remove_subcategory () - | -
-GList * - | --as_category_get_included () - | -
-GList * - | --as_category_get_excluded () - | -
-GList * - | --as_category_get_subcategories () - | -
-gint - | --as_category_get_level () - | -
-void - | --as_category_set_level () - | -
#define | -AS_TYPE_CATEGORY | -
struct | -AsCategoryClass | -
- | AsCategory | -
This object represents an XDG category, as defined at: -http://standards.freedesktop.org/menu-spec/menu-spec-1.0.htmlcategory-registry
-The AsCategory object does not support all aspects of a menu. It's main purpose -is to be used in software-centers to show information about application-groups, -which are use to thematically group applications.
-You can use AsMenuParser to get a set of supported default categories.
-See also: AsMenuParser
-void
-as_category_complete (AsCategory *cat
);
-Update incomplete category data with information from -"/usr/share/desktop-directories".
-const gchar *
-as_category_get_directory (AsCategory *cat
);
-Get associated XDG directory name for this category, -in case one exists in "/usr/share/desktop-directories/".
- -void -as_category_set_directory (-AsCategory *cat
, -const gchar *value
);
Set associated XDG directory name for this category.
- -const gchar *
-as_category_get_name (AsCategory *cat
);
-Get the name of this category.
- -void -as_category_set_name (-AsCategory *cat
, -const gchar *value
);
Set the name of this category.
- -const gchar *
-as_category_get_summary (AsCategory *cat
);
-Get the summary (short description) of this category.
- -void -as_category_set_summary (-AsCategory *cat
, -const gchar *value
);
Get the summary (short description) of this category.
-cat |
-An instance of AsCategory. |
-- |
value |
-A new short summary of this category. |
-- |
const gchar *
-as_category_get_icon (AsCategory *cat
);
-Get the stock icon name for this category.
- -void -as_category_set_icon (-AsCategory *cat
, -const gchar *value
);
Set the stock icon name for this category.
- -gboolean
-as_category_has_subcategory (AsCategory *cat
);
-Test for sub-categories.
- - -void -as_category_add_subcategory (-AsCategory *cat
, -AsCategory *subcat
);
Add a subcategory to this category.
-cat |
-An instance of AsCategory. |
-- |
subcat |
-A subcategory to add. |
-- |
void -as_category_remove_subcategory (-AsCategory *cat
, -AsCategory *subcat
);
Drop a subcategory from this AsCategory.
-cat |
-An instance of AsCategory. |
-- |
subcat |
-A subcategory to remove. |
-- |
-Top - | -- | - | - | - |
GStrv | -categories | -Read / Write | -
-gchar * | -description | -Read / Write | -
-gchar * | -developer-name | -Read / Write | -
gpointer | -icons | -Read | -
-gchar * | -id | -Read / Write | -
GStrv | -keywords | -Read / Write | -
AsComponentKind | -kind | -Read / Write | -
-gchar * | -name | -Read / Write | -
GStrv | -pkgnames | -Read / Write | -
-gchar * | -project-group | -Read / Write | -
-gchar * | -project-license | -Read / Write | -
-GPtrArray * | -screenshots | -Read | -
-gchar * | -summary | -Read / Write | -
-GHashTable * | -urls | -Read | -
#define | -AS_TYPE_COMPONENT | -
struct | -AsComponentClass | -
enum | -AsComponentKind | -
- | AsComponent | -
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
-const gchar *
-as_component_kind_to_string (AsComponentKind kind
);
-Converts the enumerated value to an text representation.
- - -AsComponentKind
-as_component_kind_from_string (const gchar *kind_str
);
-Converts the text representation to an enumerated value.
- - -gboolean
-as_component_is_valid (AsComponent *cpt
);
-Check if the essential properties of this Component are -populated with useful data.
- - -gchar *
-as_component_to_string (AsComponent *cpt
);
-Returns a string identifying this component. -(useful for debugging)
- - -gchar *
-as_component_get_active_locale (AsComponent *cpt
);
-Get the current active locale for this component, which -is used to get localized messages.
- - -void -as_component_set_active_locale (-AsComponent *cpt
, -const gchar *locale
);
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.
-cpt |
-a AsComponent instance. |
-- |
locale |
- the locale, or |
-[nullable] | -
AsComponentKind
-as_component_get_kind (AsComponent *cpt
);
-Returns the AsComponentKind of this component.
- - -void -as_component_set_kind (-AsComponent *cpt
, -AsComponentKind value
);
Sets the AsComponentKind of this component.
-cpt |
-a AsComponent instance. |
-- |
value |
-the AsComponentKind. |
-- |
const gchar *
-as_component_get_id (AsComponent *cpt
);
-Set the unique identifier for this component.
- - -void -as_component_set_id (-AsComponent *cpt
, -const gchar *value
);
Set the unique identifier for this component.
-cpt |
-a AsComponent instance. |
-- |
value |
-the unique identifier. |
-- |
void -as_component_set_origin (- -AsComponent *cpt
, -const gchar *origin
);
gchar **
-as_component_get_pkgnames (AsComponent *cpt
);
-Get a list of package names which this component consists of. -This usually is just one package name.
- - -void -as_component_set_pkgnames (-AsComponent *cpt
, -gchar **value
);
Set a list of package names this component consists of. -(This should usually be just one package name)
-cpt |
-a AsComponent instance. |
-- |
value |
-. |
-[array zero-terminated=1] | -
const gchar *
-as_component_get_source_pkgname (AsComponent *cpt
);
-
-
-void -as_component_set_source_pkgname (-AsComponent *cpt
, -const gchar *spkgname
);
cpt |
-a AsComponent instance. |
-- |
spkgname |
-the source package name. |
-- |
const gchar *
-as_component_get_name (AsComponent *cpt
);
-A human-readable name for this component.
- - -void -as_component_set_name (-AsComponent *cpt
, -const gchar *value
, -const gchar *locale
);
Set a human-readable name for this component.
-cpt |
-A valid AsComponent |
-- |
value |
-The name |
-- |
locale |
- The locale the used for this value, or |
-[nullable] | -
const gchar *
-as_component_get_summary (AsComponent *cpt
);
-Get a short description of this component.
- - -void -as_component_set_summary (-AsComponent *cpt
, -const gchar *value
, -const gchar *locale
);
Set a short description for this component.
-cpt |
-A valid AsComponent |
-- |
value |
-The summary |
-- |
locale |
- The locale the used for this value, or |
-[nullable] | -
const gchar *
-as_component_get_description (AsComponent *cpt
);
-Get the localized long description of this component.
- - -void -as_component_set_description (-AsComponent *cpt
, -const gchar *value
, -const gchar *locale
);
Set long description for this component.
-cpt |
-A valid AsComponent |
-- |
value |
-The long description |
-- |
locale |
- The locale the used for this value, or |
-[nullable] | -
const gchar *
-as_component_get_project_license (AsComponent *cpt
);
-Get the license of the project this component belongs to.
- - -void -as_component_set_project_license (-AsComponent *cpt
, -const gchar *value
);
Set the project license.
-cpt |
-a AsComponent instance. |
-- |
value |
-the project license. |
-- |
const gchar *
-as_component_get_project_group (AsComponent *cpt
);
-Get the component's project group.
- - -void -as_component_set_project_group (-AsComponent *cpt
, -const gchar *value
);
Set the component's project group.
-cpt |
-a AsComponent instance. |
-- |
value |
-the project group. |
-- |
const gchar *
-as_component_get_developer_name (AsComponent *cpt
);
-Get the component's developer or development team name.
- - -void -as_component_set_developer_name (-AsComponent *cpt
, -const gchar *value
, -const gchar *locale
);
Set the the component's developer or development team name.
-cpt |
-a AsComponent instance. |
-- |
value |
-the developer or developer team name |
-- |
locale |
- the locale, or |
-[nullable] | -
gchar **
-as_component_get_compulsory_for_desktops
- (AsComponent *cpt
);
-
-
-void -as_component_set_compulsory_for_desktops - (-AsComponent *cpt
, -gchar **value
);
Set a list of desktops where this component is compulsory.
-cpt |
-a AsComponent instance. |
-- |
value |
-the array of desktop ids. |
-[array zero-terminated=1] | -
gboolean -as_component_is_compulsory_for_desktop - (-AsComponent *cpt
, -const gchar *desktop
);
Check if this component is compulsory for the given desktop.
-cpt |
-an AsComponent object |
-- |
desktop |
-the desktop-id to test for |
-- |
void -as_component_set_categories (-AsComponent *cpt
, -gchar **value
);
cpt |
-a AsComponent instance. |
-- |
value |
-the categories name. |
-[array zero-terminated=1] | -
gboolean -as_component_has_category (-AsComponent *cpt
, -const gchar *category
);
Check if component is in the specified category.
-cpt |
-an AsComponent object |
-- |
category |
-the specified category to check |
-- |
GPtrArray *
-as_component_get_screenshots (AsComponent *cpt
);
-Get a list of associated screenshots.
- - -void -as_component_add_screenshot (-AsComponent *cpt
, -AsScreenshot *sshot
);
Add an AsScreenshot to this component.
-cpt |
-a AsComponent instance. |
-- |
sshot |
-The AsScreenshot to add |
-- |
void -as_component_set_keywords (-AsComponent *cpt
, -gchar **value
, -const gchar *locale
);
Set keywords for this component.
-cpt |
-a AsComponent instance. |
-- |
value |
-String-array of keywords. |
-[array zero-terminated=1] | -
locale |
- Locale of the values, or |
-[nullable] | -
AsIcon * -as_component_get_icon_by_size (-AsComponent *cpt
, -guint width
, -guint height
);
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.
cpt |
-an AsComponent instance |
-- |
width |
-The icon width in pixels. |
-- |
height |
-the icon height in pixels. |
-- |
void -as_component_add_icon (-AsComponent *cpt
, -AsIcon *icon
);
Add an icon to this component.
-cpt |
-an AsComponent instance |
-- |
icon |
-the valid AsIcon instance to add. |
-- |
void -as_component_add_provided (-AsComponent *cpt
, -AsProvided *prov
);
Add a set of provided items to this component.
-cpt |
-a AsComponent instance. |
-- |
prov |
-a AsProvided instance. |
-- |
Since: 0.6.2
-AsProvided * -as_component_get_provided_for_kind (-AsComponent *cpt
, -AsProvidedKind kind
);
Get an AsProvided object for the given interface type, -containing information about the public interfaces (mimetypes, firmware, DBus services, ...) -this component provides.
-cpt |
-a AsComponent instance. |
-- |
kind |
-kind of the provided item, e.g. |
-- |
GList *
-as_component_get_provided (AsComponent *cpt
);
-Get a list of AsProvided objects associated with this component.
- - -const gchar * -as_component_get_url (-AsComponent *cpt
, -AsUrlKind url_kind
);
Gets a URL.
-cpt |
-a AsComponent instance. |
-- |
url_kind |
-the URL kind, e.g. |
-- |
Since: 0.6.2
-void -as_component_add_url (-AsComponent *cpt
, -AsUrlKind url_kind
, -const gchar *url
);
Adds some URL data to the component.
-cpt |
-a AsComponent instance. |
-- |
url_kind |
-the URL kind, e.g. |
-- |
url |
-the full URL. |
-- |
Since: 0.6.2
-GPtrArray *
-as_component_get_releases (AsComponent *cpt
);
-Get an array of the AsRelease items this component -provides.
- - -void -as_component_add_release (-AsComponent *cpt
, -AsRelease *release
);
Add an AsRelease to this component.
-cpt |
-a AsComponent instance. |
-- |
release |
-The AsRelease to add |
-- |
GPtrArray *
-as_component_get_extends (AsComponent *cpt
);
-Returns a string list of IDs of components which -are extended by this addon.
-See as_component_get_extends
() for the reverse.
Since: 0.7.0
-void -as_component_add_extends (-AsComponent *cpt
, -const gchar *cpt_id
);
Add a reference to the extended component
-cpt |
-a AsComponent instance. |
-- |
cpt_id |
-The id of a component which is extended by this component |
-- |
Since: 0.7.0
-GPtrArray *
-as_component_get_extensions (AsComponent *cpt
);
-Returns a string list of IDs of components which -are addons extending this component in functionality.
-This is the reverse of as_component_get_extends
()
Since: 0.9.2
-void -as_component_add_extension (-AsComponent *cpt
, -const gchar *cpt_id
);
Add a reference to the extension enhancing this component.
-cpt |
-a AsComponent instance. |
-- |
cpt_id |
-The id of a component extending this component. |
-- |
Since: 0.9.2
-GList *
-as_component_get_languages (AsComponent *cpt
);
-Get a list of all languages.
- - -Since: 0.7.0
-gint -as_component_get_language (-AsComponent *cpt
, -const gchar *locale
);
Gets the translation coverage in percent for a specific locale
-cpt |
-an AsComponent instance. |
-- |
locale |
- the locale, or |
-[nullable] | -
Since: 0.7.0
-void -as_component_add_language (-AsComponent *cpt
, -const gchar *locale
, -gint percentage
);
Adds a language to the component.
-cpt |
-an AsComponent instance. |
-- |
locale |
- the locale, or |
-[nullable] | -
percentage |
-the percentage completion of the translation, 0 for locales with unknown amount of translation |
-- |
Since: 0.7.0
-GPtrArray *
-as_component_get_translations (AsComponent *cpt
);
-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.
- - -Since: 0.9.2
-void -as_component_add_translation (-AsComponent *cpt
, -AsTranslation *tr
);
Assign an AsTranslation object describing the translation system used -by this component.
-cpt |
-an AsComponent instance. |
-- |
tr |
-an AsTranslation instance. |
-- |
Since: 0.9.2
-const gchar * -as_component_get_bundle_id (-AsComponent *cpt
, -AsBundleKind bundle_kind
);
Gets a bundle identifier string.
-cpt |
-a AsComponent instance. |
-- |
bundle_kind |
-the bundle kind, e.g. |
-- |
Since: 0.8.0
-void -as_component_add_bundle_id (-AsComponent *cpt
, -AsBundleKind bundle_kind
, -const gchar *id
);
Adds a bundle identifier to the component.
-cpt |
-a AsComponent instance. |
-- |
bundle_kind |
-the URL kind, e.g. |
-- |
id |
-The bundle identification string |
-- |
Since: 0.8.0
-The type of an AsComponent.
-- |
- Type invalid or not known - |
-- |
- |
- A generic (= without specialized type) component - |
-- |
- |
- An application with a .desktop-file - |
-- |
- |
- A font - |
-- |
- |
- A multimedia codec - |
-- |
- |
- An input-method provider - |
-- |
- |
- An extension of existing software, which does not run standalone - |
-- |
- |
- Firmware - |
-- |
“description”
property “description” gchar *
-the description
-Flags: Read / Write
-Default value: NULL
-“developer-name”
property “developer-name” gchar *
-the developer name
-Flags: Read / Write
-Default value: NULL
-“icons”
property “icons” gpointer
-hash map of icon urls and sizes
-[type GList(AsIcon)]
-Flags: Read
-“id”
property “id” gchar *
-the unique identifier
-Flags: Read / Write
-Default value: NULL
-“kind”
property“kind” AsComponentKind-
the AsComponentKind of this component
-Flags: Read / Write
-Default value: AS_COMPONENT_KIND_UNKNOWN
-“project-group”
property “project-group” gchar *
-the project group
-Flags: Read / Write
-Default value: NULL
-“project-license”
property “project-license” gchar *
-the project license
-Flags: Read / Write
-Default value: NULL
-“summary”
property “summary” gchar *
-the summary
-Flags: Read / Write
-Default value: NULL
--Top - | -- | - | - | - |
-AsDatabase * - | --as_database_new () - | -
-GQuark - | --as_database_error_quark () - | -
-gboolean - | --as_database_open () - | -
const gchar * - | --as_database_get_location () - | -
-void - | --as_database_set_location () - | -
-GPtrArray * - | --as_database_find_components () - | -
-GPtrArray * - | --as_database_get_all_components () - | -
-AsComponent * - | --as_database_get_component_by_id () - | -
-GPtrArray * - | --as_database_get_components_by_provided_item () - | -
-GPtrArray * - | --as_database_get_components_by_kind () - | -
#define | -AS_TYPE_DATABASE | -
struct | -AsDatabaseClass | -
enum | -AsDatabaseError | -
#define | -AS_DATABASE_ERROR | -
- | AsDatabase | -
This object provides access to the Appstream Xapian database of available software components. -You can search for components using various criteria, as well as getting some information -about the data provided by this AppStream database.
-By default, the global software component cache is used as datasource, unless a different database
-is explicitly defined via as_database_set_location
().
A new cache can be created using the appstreamcli(1) utility.
-See also: AsComponent, AsDataPool
-gboolean -as_database_open (-AsDatabase *db
, -GError **error
);
Open the current AppStream metadata cache for reading.
-db |
-An instance of AsDatabase. |
-- |
error |
-A GError or |
-- |
const gchar *
-as_database_get_location (AsDatabase *db
);
-Get the current path of the AppStream database we use.
- -void -as_database_set_location (-AsDatabase *db
, -const gchar *dir
);
Set the location of the AppStream database we use.
-db |
-An instance of AsDatabase. |
-- |
dir |
-The directory of the Xapian database. |
-- |
GPtrArray * -as_database_find_components (-AsDatabase *db
, -const gchar *term
, -const gchar *cats_str
, -GError **error
);
Find components in the AppStream database, which match a given term. -You can limit the search to a specific set of categories by setting the categories string to -a semicolon-separated list of lower-cased category names.
-db |
-An instance of AsDatabase. |
-- |
term |
-a search-term to look for. |
-[nullable] | -
cats_str |
-A semicolon-delimited list of lower-cased category names, e.g. "science;development". |
-[nullable] | -
error |
-A GError or |
-- |
an array of AsComponent objects which have been found.
-[element-type AsComponent][transfer full]
-GPtrArray * -as_database_get_all_components (-AsDatabase *db
, -GError **error
);
Dump a list of all software components found in the database.
-db |
-An instance of AsDatabase. |
-- |
error |
-A GError or |
-- |
AsComponent * -as_database_get_component_by_id (-AsDatabase *db
, -const gchar *cid
, -GError **error
);
Get a component by its AppStream-ID.
-db |
-An instance of AsDatabase. |
-- |
cid |
-the ID of the component, e.g. "org.kde.gwenview.desktop" |
-- |
error |
-A GError or |
-- |
GPtrArray * -as_database_get_components_by_provided_item - (-AsDatabase *db
, -AsProvidedKind kind
, -const gchar *item
, -GError **error
);
Find components in the Appstream database.
-db |
-An instance of AsDatabase. |
-- |
kind |
-an AsProvidesKind |
-- |
item |
-the name of the provided item. |
-- |
error |
-A GError or |
-- |
an array of AsComponent objects which have been found, NULL on error.
-[element-type AsComponent][transfer full]
-GPtrArray * -as_database_get_components_by_kind (-AsDatabase *db
, -AsComponentKind kind
, -GError **error
);
Return a list of all components in the database which match a certain kind.
-db |
-An instance of AsDatabase. |
-- |
kind |
-an AsComponentKind. |
-- |
error |
-A GError or |
-- |
an array of AsComponent objects which have been found, NULL
on error.
[element-type AsComponent][transfer full]
--Top - | -- | - | - | - |
-GQuark - | --as_data_pool_error_quark () - | -
-AsDataPool * - | --as_data_pool_new () - | -
const gchar * - | --as_data_pool_get_locale () - | -
-void - | --as_data_pool_set_locale () - | -
-gboolean - | --as_data_pool_update () - | -
-GList * - | --as_data_pool_get_components () - | -
-AsComponent * - | --as_data_pool_get_component_by_id () - | -
-GPtrArray * - | --as_data_pool_get_metadata_locations () - | -
-void - | --as_data_pool_set_metadata_locations () - | -
#define | -AS_TYPE_DATA_POOL | -
struct | -AsDataPoolClass | -
enum | -AsDataPoolError | -
#define | -AS_DATA_POOL_ERROR | -
- | AsDataPool | -
This class contains a temporary pool of metadata which has been collected from different -sources on the system. -It can directly be used, but usually it is accessed through a AsDatabase instance. -This class is used by internally by the cache builder, but might be useful for others.
-See also: AsDatabase
-const gchar *
-as_data_pool_get_locale (AsDataPool *dpool
);
-Gets the currently used locale.
- - -void -as_data_pool_set_locale (-AsDataPool *dpool
, -const gchar *locale
);
Sets the current locale which should be used when parsing metadata.
- -gboolean -as_data_pool_update (-AsDataPool *dpool
, -GError **error
);
Builds an index of all found components in the watched locations.
-The function will try to get as much data into the pool as possible, so even if
-the updates completes with FALSE
, it might still add components to the pool.
dpool |
-An instance of AsDataPool. |
-- |
error |
-A GError or |
-- |
GList *
-as_data_pool_get_components (AsDataPool *dpool
);
-Get a list of found components.
- - a list of AsComponent instances, free with g_list_free()
.
[element-type AsComponent][transfer container]
-AsComponent * -as_data_pool_get_component_by_id (-AsDataPool *dpool
, -const gchar *id
);
Get a specific component by its ID.
-dpool |
-An instance of AsDataPool. |
-- |
id |
-The AppStream-ID to look for. |
-- |
GPtrArray *
-as_data_pool_get_metadata_locations (AsDataPool *dpool
);
-Return a list of all locations which are searched for metadata.
- - -void -as_data_pool_set_metadata_locations (-AsDataPool *dpool
, -gchar **dirs
);
Set locations for the data pool to read it's data from. -This is mainly used for testing purposes. Each location should have an -"xmls" and/or "yaml" subdirectory with the actual data as (compressed) -AppStream XML or DEP-11 YAML in it.
-dpool |
-An instance of AsDataPool. |
-- |
dirs |
-a zero-terminated array of data input directories. |
-[array zero-terminated=1] | -
-Top - | -- | - | - | - |
-AsDistroDetails * - | --as_distro_details_new () - | -
const gchar * - | --as_distro_details_get_id () - | -
const gchar * - | --as_distro_details_get_name () - | -
const gchar * - | --as_distro_details_get_version () - | -
-gchar * - | --as_distro_details_get_str () - | -
-gboolean - | --as_distro_details_get_bool () - | -
-gchar ** - | --as_get_icon_repository_paths () - | -
#define | -AS_TYPE_DISTRO_DETAILS | -
struct | -AsDistroDetailsClass | -
- | AsDistroDetails | -
This object abstracts various distribution-specific settings and provides information -about the (Linux) distribution which is currently in use. -It is used internalls to get information about the icon-store or the 3rd-party screenshot -service distributors may want to provide.
-See also: AsDatabase
-AsDistroDetails *
-as_distro_details_new (void
);
-Creates a new instance of AsDistroDetails.
- -const gchar *
-as_distro_details_get_name (AsDistroDetails *distro
);
-const gchar *
-as_distro_details_get_version (AsDistroDetails *distro
);
-gchar * -as_distro_details_get_str (-AsDistroDetails *distro
, -const gchar *key
);
gboolean -as_distro_details_get_bool (-AsDistroDetails *distro
, -const gchar *key
);
-Top - | -- | - | - | - |
-AsIconKind - | --as_icon_kind_from_string () - | -
const gchar * - | --as_icon_kind_to_string () - | -
-AsIcon * - | --as_icon_new () - | -
-AsIconKind - | --as_icon_get_kind () - | -
-void - | --as_icon_set_kind () - | -
const gchar * - | --as_icon_get_name () - | -
-void - | --as_icon_set_name () - | -
const gchar * - | --as_icon_get_url () - | -
-void - | --as_icon_set_url () - | -
const gchar * - | --as_icon_get_filename () - | -
-void - | --as_icon_set_filename () - | -
-guint - | --as_icon_get_width () - | -
-void - | --as_icon_set_width () - | -
-guint - | --as_icon_get_height () - | -
-void - | --as_icon_set_height () - | -
#define | -AS_TYPE_ICON | -
struct | -AsIconClass | -
enum | -AsIconKind | -
- | AsIcon | -
AsIconKind
-as_icon_kind_from_string (const gchar *kind_str
);
-Converts the text representation to an enumerated value.
- - -const gchar *
-as_icon_kind_to_string (AsIconKind kind
);
-Converts the enumerated value to an text representation.
- - -void -as_icon_set_kind (-AsIcon *icon
, -AsIconKind kind
);
Sets the icon kind.
-icon |
-a AsIcon instance. |
-- |
kind |
-the AsIconKind, e.g. |
-- |
void -as_icon_set_name (-AsIcon *icon
, -const gchar *name
);
Sets the stock name or basename to use for the icon.
-icon |
-a AsIcon instance. |
-- |
name |
-the icon stock name, e.g. "gwenview" |
-- |
const gchar *
-as_icon_get_url (AsIcon *icon
);
-Gets the icon URL, pointing at a remote location. HTTPS and FTP urls are allowed.
-This property is only set for icons of type AS_ICON_KIND_REMOTE
void -as_icon_set_url (-AsIcon *icon
, -const gchar *url
);
Sets the icon URL.
- -const gchar *
-as_icon_get_filename (AsIcon *icon
);
-
- The absolute path for the icon on disk.
-This is only set for icons of kind AS_ICON_KIND_LOCAL
or
-AS_ICON_KIND_CACHED
.
void -as_icon_set_filename (-AsIcon *icon
, -const gchar *filename
);
Sets the icon absolute filename.
- -void -as_icon_set_width (-AsIcon *icon
, -guint width
);
Sets the icon width.
- --Top - | -- | - | - | - |
-AsImageKind - | --as_image_kind_from_string () - | -
const gchar * - | --as_image_kind_to_string () - | -
-AsImage * - | --as_image_new () - | -
const gchar * - | --as_image_get_url () - | -
-void - | --as_image_set_url () - | -
-guint - | --as_image_get_width () - | -
-void - | --as_image_set_width () - | -
-guint - | --as_image_get_height () - | -
-void - | --as_image_set_height () - | -
-AsImageKind - | --as_image_get_kind () - | -
-void - | --as_image_set_kind () - | -
#define | -AS_TYPE_IMAGE | -
struct | -AsImageClass | -
enum | -AsImageKind | -
- | AsImage | -
Screenshot may have multiple versions of an image in different resolutions -or aspect ratios. This object allows access to the location and size of a -single image.
-See also: AsScreenshot
-AsImageKind
-as_image_kind_from_string (const gchar *kind
);
-Converts the text representation to an enumerated value.
- - -const gchar *
-as_image_kind_to_string (AsImageKind kind
);
-Converts the enumerated value to an text representation.
- - -const gchar *
-as_image_get_url (AsImage *image
);
-Gets the full qualified URL for the image, usually pointing at some mirror.
- - -void -as_image_set_url (-AsImage *image
, -const gchar *url
);
Sets the fully-qualified mirror URL to use for the image.
- -void -as_image_set_width (-AsImage *image
, -guint width
);
Sets the image width.
-image |
-a AsImage instance. |
-- |
width |
-the width in pixels. |
-- |
void -as_image_set_height (-AsImage *image
, -guint height
);
Sets the image height.
-image |
-a AsImage instance. |
-- |
height |
-the height in pixels. |
-- |
void -as_image_set_kind (-AsImage *image
, -AsImageKind kind
);
Sets the image kind.
-image |
-a AsImage instance. |
-- |
kind |
-the AsImageKind, e.g. |
-- |
-Top - | -- | - | - | - |
-AsMenuParser * - | --as_menu_parser_new () - | -
-AsMenuParser * - | --as_menu_parser_new_from_file () - | -
-GList * - | --as_menu_parser_parse () - | -
-gboolean - | --as_menu_parser_get_update_category_data () - | -
-void - | --as_menu_parser_set_update_category_data () - | -
-GList * - | --as_get_system_categories () - | -
#define | -AS_TYPE_MENU_PARSER | -
struct | -AsMenuParserClass | -
- | AsMenuParser | -
This object parses an XDG menu file and returns a set of AsCategory objects which -can be used by software-centers to group the applications they show. -By default, it loads a common set of categories from an internal menu file. -A custom menu file may be specified using the alternative class constructor.
-See also: AsCategory
-AsMenuParser *
-as_menu_parser_new_from_file (const gchar *menu_file
);
-Creates a new AsMenuParser using a custom XDG menu XML file.
- - -GList *
-as_menu_parser_parse (AsMenuParser *mp
);
-Parse the menu file
- -GList of AsCategory objects found in the menu, or NULL if there was an error.
-[element-type AsCategory][transfer full]
-gboolean
-as_menu_parser_get_update_category_data
- (AsMenuParser *mp
);
-
-void -as_menu_parser_set_update_category_data - (- -AsMenuParser *mp
, -gboolean value
);
-Top - | -- | - | - | - |
#define | -AS_TYPE_METADATA | -
struct | -AsMetadataClass | -
enum | -AsParserMode | -
enum | -AsMetadataError | -
#define | -AS_METADATA_ERROR | -
- | AsMetadata | -
This object parses AppStream metadata, including AppStream -upstream metadata, which is defined by upstream projects. -It returns an AsComponent of the data.
-See also: AsComponent, AsDatabase
-void -as_metadata_parse_file (-AsMetadata *metad
, -GFile *file
, -GError **error
);
Parses an AppStream upstream metadata file.
-metad |
-A valid AsMetadata instance |
-- |
file |
-GFile for the upstream metadata |
-- |
error |
-A GError or |
-- |
void -as_metadata_parse_xml (-AsMetadata *metad
, -const gchar *data
, -GError **error
);
Parses AppStream XML metadata.
-metad |
-A valid AsMetadata instance |
-- |
data |
-XML data describing one or more software components. |
-- |
void -as_metadata_parse_yaml (-AsMetadata *metad
, -const gchar *data
, -GError **error
);
Parses AppStream YAML metadata.
-metad |
-A valid AsMetadata instance |
-- |
data |
-YAML data describing one or more software components. |
-- |
error |
-A GError or |
-- |
AsComponent *
-as_metadata_get_component (AsMetadata *metad
);
-Gets the AsComponent which has been parsed from the XML. -If the AppStream XML contained multiple components, return the first -component that has been parsed.
- - -void -as_metadata_add_component (-AsMetadata *metad
, -AsComponent *cpt
);
Add an AsComponent to the list of components. -This can be used to add multiple components in order to -produce a distro-XML AppStream metadata file.
-gchar *
-as_metadata_component_to_upstream_xml (AsMetadata *metad
);
-Convert an AsComponent to upstream XML. -(The amount of localization included in the metadata depends on how the AsComponent -was initially loaded)
-The first AsComponent added to the internal list will be transformed.
-In case no component is present, NULL
is returned.
void -as_metadata_save_upstream_xml (-AsMetadata *metad
, -const gchar *fname
, -GError **error
);
Serialize AsComponent instance to XML and save it to file. -An existing file at the same location will be overridden.
- -gchar *
-as_metadata_components_to_distro_xml (AsMetadata *metad
);
-Serialize all AsComponent instances into AppStream
-distro-XML data.
-NULL
is returned if there is nothing to serialize.
void -as_metadata_save_distro_xml (-AsMetadata *metad
, -const gchar *fname
, -GError **error
);
Serialize all AsComponent instances to XML and save the data to a file. -An existing file at the same location will be overridden.
- -gchar *
-as_metadata_components_to_distro_yaml (AsMetadata *metad
);
-Serialize all AsComponent instances into AppStream DEP-11
-distro-YAML data.
-NULL
is returned if there is nothing to serialize.
void -as_metadata_save_distro_yaml (-AsMetadata *metad
, -const gchar *fname
, -GError **error
);
Serialize all AsComponent instances to XML and save the data to a file. -An existing file at the same location will be overridden.
- -void -as_metadata_set_locale (-AsMetadata *metad
, -const gchar *locale
);
Sets the locale which should be read when processing metadata. -All other locales are ignored, which increases parsing speed and -reduces memory usage. -If you set the locale to "ALL", all locales will be read.
- -const gchar *
-as_metadata_get_locale (AsMetadata *metad
);
-Gets the current active locale for parsing metadata, -or "ALL" if all locales are read.
- - -void -as_metadata_set_origin (-AsMetadata *metad
, -const gchar *origin
);
Set the origin of AppStream distro metadata
-metad |
-an AsMetadata instance. |
-- |
origin |
-the origin of AppStream distro metadata. |
-- |
gboolean
-as_metadata_get_update_existing (AsMetadata *metad
);
-
-
-void -as_metadata_set_update_existing (-AsMetadata *metad
, -gboolean update
);
If set to TRUE
, the parser will not create new components but
-instead update existing components in the pool with new metadata.
NOTE: Right now, this feature is only implemented for metainfo XML parsing!
-metad |
-an AsMetadata instance. |
-- |
update |
-A boolean value. |
-- |
void -as_metadata_set_write_header (-AsMetadata *metad
, -gboolean wheader
);
If set to TRUE
, tehe metadata writer will omit writing a DEP-11
-header document when in YAML mode, and will not write a root components node
-when writing XML data.
-Please keep in mind that this will create an invalid DEP-11 YAML AppStream
-distro metadata file, and an invalid XML file.
-This parameter should only be changed e.g. by the appstream-generator tool.
NOTE: Right now, this feature is only implemented for YAML!
-metad |
-an AsMetadata instance. |
-- |
wheader |
-A boolean value. |
-- |
void -as_metadata_set_parser_mode (-AsMetadata *metad
, -AsParserMode mode
);
Sets the current metadata parsing mode.
- -AsParserMode
-as_metadata_get_parser_mode (AsMetadata *metad
);
-Gets the current parser mode
- - -const gchar *
-as_metadata_get_architecture (AsMetadata *metad
);
-
-
-void -as_metadata_set_architecture (-AsMetadata *metad
, -const gchar *arch
);
Set the architecture the components in this metadata belong to.
-metad |
-an AsMetadata instance. |
-- |
arch |
-an architecture string. |
-- |
There are a few differences between Appstream's upstream metadata -and the distribution metadata. -The parser mode indicates which style we should process. -Usually you don't want to change this.
- --Top - | -- | - | - | - |
const gchar * - | --as_provided_kind_to_string () - | -
-AsProvidedKind - | --as_provided_kind_from_string () - | -
const gchar * - | --as_provided_kind_to_l10n_string () - | -
-AsProvided * - | --as_provided_new () - | -
-AsProvidedKind - | --as_provided_get_kind () - | -
-void - | --as_provided_set_kind () - | -
-gchar ** - | --as_provided_get_items () - | -
-void - | --as_provided_add_item () - | -
-gboolean - | --as_provided_has_item () - | -
#define | -AS_TYPE_PROVIDED | -
struct | -AsProvidedClass | -
enum | -AsProvidedKind | -
- | AsProvided | -
Components can provide various items, like libraries, Python-modules, -firmware, binaries, etc. -Functions to work with these items are provided here.
-See also: AsComponent
-const gchar *
-as_provided_kind_to_string (AsProvidedKind kind
);
-Converts the enumerated value to a text representation.
- - -AsProvidedKind
-as_provided_kind_from_string (const gchar *kind_str
);
-Converts the text representation to an enumerated value.
- - -const gchar *
-as_provided_kind_to_l10n_string (AsProvidedKind kind
);
-Converts the enumerated value to a localized text representation, -using the plural forms (e.g. "Libraries" instead of "Library").
-This can be useful when displaying provided items in GUI dialogs.
- - -AsProvidedKind
-as_provided_get_kind (AsProvided *prov
);
-The kind of items this AsProvided object stores.
- - -void -as_provided_set_kind (-AsProvided *prov
, -AsProvidedKind kind
);
Set the kind of items this AsProvided object stores.
-prov |
-a AsProvided instance. |
-- |
kind |
-the new AsProvidedKind |
-- |
gchar **
-as_provided_get_items (AsProvided *prov
);
-Get an array of provided data.
- - -void -as_provided_add_item (-AsProvided *prov
, -const gchar *item
);
Add a new provided item.
- -gboolean -as_provided_has_item (-AsProvided *prov
, -const gchar *item
);
Check if the current AsProvided contains an item -of the given name.
-prov |
-a AsProvided instance. |
-- |
item |
-the name of a provided item, e.g. "audio/x-vorbis" (in case the provided kind is a mimetype) |
-- |
Type of the public interface components can provide.
-- |
- Unknown kind - |
-- |
- |
- A shared library - |
-- |
- |
- A binary installed into a directory in PATH - |
-- |
- |
- Provides a handler for a mimetype - |
-- |
- |
- A font - |
-- |
- |
- A modalias - |
-- |
- |
- A Python2 module - |
-- |
- |
- A Python3 module - |
-- |
- |
- A DBus service name on the system bus. - |
-- |
- |
- A DBus service name on the user/session bus. - |
-- |
- |
- Firmware flashed at runtime. - |
-- |
- |
- Firmware flashed permanently to the device. - |
-- |
-Top - | -- | - | - | - |
#define | -AS_TYPE_RELEASE | -
struct | -AsReleaseClass | -
enum | -AsChecksumKind | -
enum | -AsSizeKind | -
- | AsRelease | -
This object represents a single upstream release, typically a minor update. -Releases can contain a localized description of paragraph and list elements -and also have a version number and timestamp.
-Releases can be automatically generated by parsing upstream ChangeLogs or -.spec files, or can be populated using MetaInfo files.
-See also: AsComponent
-const gchar *
-as_checksum_kind_to_string (AsChecksumKind kind
);
-Converts the enumerated value to an text representation.
- - -AsChecksumKind
-as_checksum_kind_from_string (const gchar *kind_str
);
-Converts the text representation to an enumerated value.
- - -const gchar *
-as_size_kind_to_string (AsSizeKind size_kind
);
-Converts the enumerated value to an text representation.
- - -Since: 0.8.6
-AsSizeKind
-as_size_kind_from_string (const gchar *size_kind
);
-Converts the text representation to an enumerated value.
- - -Since: 0.8.6
-const gchar *
-as_release_get_version (AsRelease *release
);
-Gets the release version.
- - -void -as_release_set_version (-AsRelease *release
, -const gchar *version
);
Sets the release version.
-release |
-a AsRelease instance. |
-- |
version |
-the version string. |
-- |
guint64
-as_release_get_timestamp (AsRelease *release
);
-Gets the release timestamp.
- - -void -as_release_set_timestamp (-AsRelease *release
, -guint64 timestamp
);
Sets the release timestamp.
-release |
-a AsRelease instance. |
-- |
timestamp |
-the timestamp value. |
-- |
const gchar *
-as_release_get_description (AsRelease *release
);
-Gets the release description markup for a given locale.
- - -void -as_release_set_description (-AsRelease *release
, -const gchar *description
, -const gchar *locale
);
Sets the description release markup.
-release |
-a AsRelease instance. |
-- |
description |
-the description markup. |
-- |
gchar *
-as_release_get_active_locale (AsRelease *release
);
-Get the current active locale, which -is used to get localized messages.
-void -as_release_set_active_locale (-AsRelease *release
, -const gchar *locale
);
Set the current active locale, which -is used to get localized messages. -If the AsComponent linking this AsRelease was fetched -from a localized database, usually only -one locale is available.
-GPtrArray *
-as_release_get_locations (AsRelease *release
);
-Gets the release locations, typically URLs.
- -Since: 0.8.1
-void -as_release_add_location (-AsRelease *release
, -const gchar *location
);
Adds a release location.
- -Since: 0.8.1
-const gchar * -as_release_get_checksum (-AsRelease *release
, -AsChecksumKind kind
);
Gets the release checksum
- -Since: 0.8.2
-void -as_release_set_checksum (-AsRelease *release
, -const gchar *checksum
, -AsChecksumKind kind
);
Set the release checksum.
-release |
-An instance of AsRelease. |
-- |
checksum |
-The checksum as string. |
-- |
kind |
-The kind of this checksum, e.g. |
-- |
Since: 0.8.2
-AsUrgencyKind
-as_release_get_urgency (AsRelease *release
);
-Gets the urgency of the release -(showing how important it is to update to a more recent release)
- - -Since: 0.6.5
-void -as_release_set_urgency (-AsRelease *release
, -AsUrgencyKind urgency
);
Sets the release urgency.
-release |
-a AsRelease instance. |
-- |
urgency |
-the urgency of this release/update (as AsUrgencyKind) |
-- |
Since: 0.6.5
-guint64 -as_release_get_size (-AsRelease *release
, -AsSizeKind kind
);
Gets the release size.
- - -Since: 0.8.6
-void -as_release_set_size (-AsRelease *release
, -guint64 size
, -AsSizeKind kind
);
Sets the release size for the given kind.
-release |
-a AsRelease instance |
-- |
size |
-a size in bytes, or 0 for unknown |
-- |
kind |
-- | - |
Since: 0.8.6
--Top - | -- | - | - | - |
-AsScreenshotKind - | --as_screenshot_kind_from_string () - | -
const gchar * - | --as_screenshot_kind_to_string () - | -
-gboolean - | --as_screenshot_is_valid () - | -
-AsScreenshot * - | --as_screenshot_new () - | -
-AsScreenshotKind - | --as_screenshot_get_kind () - | -
-void - | --as_screenshot_set_kind () - | -
const gchar * - | --as_screenshot_get_caption () - | -
-void - | --as_screenshot_set_caption () - | -
-GPtrArray * - | --as_screenshot_get_images () - | -
-void - | --as_screenshot_add_image () - | -
-gchar * - | --as_screenshot_get_active_locale () - | -
-void - | --as_screenshot_set_active_locale () - | -
#define | -AS_TYPE_SCREENSHOT | -
struct | -AsScreenshotClass | -
enum | -AsScreenshotKind | -
- | AsScreenshot | -
Screenshots have a localized caption and also contain a number of images -of different resolution.
-See also: AsImage
-AsScreenshotKind
-as_screenshot_kind_from_string (const gchar *kind
);
-Converts the text representation to an enumerated value.
- - -const gchar *
-as_screenshot_kind_to_string (AsScreenshotKind kind
);
-Converts the enumerated value to an text representation.
- - -gboolean
-as_screenshot_is_valid (AsScreenshot *screenshot
);
-Performs a quick validation on this screenshot
- - -AsScreenshotKind
-as_screenshot_get_kind (AsScreenshot *screenshot
);
-Gets the screenshot kind.
- - -void -as_screenshot_set_kind (-AsScreenshot *screenshot
, -AsScreenshotKind kind
);
Sets the screenshot kind.
-screenshot |
-a AsScreenshot instance. |
-- |
kind |
-the AsScreenshotKind. |
-- |
const gchar *
-as_screenshot_get_caption (AsScreenshot *screenshot
);
-Gets the image caption
- - -void -as_screenshot_set_caption (-AsScreenshot *screenshot
, -const gchar *caption
, -const gchar *locale
);
Sets a caption on the screenshot
-screenshot |
-a AsScreenshot instance. |
-- |
caption |
-the caption text. |
-- |
GPtrArray *
-as_screenshot_get_images (AsScreenshot *screenshot
);
-Gets the image sizes included in the screenshot.
- - -void -as_screenshot_add_image (-AsScreenshot *screenshot
, -AsImage *image
);
Adds an image to the screenshot.
-screenshot |
-a AsScreenshot instance. |
-- |
image |
-a AsImage instance. |
-- |
gchar *
-as_screenshot_get_active_locale (AsScreenshot *screenshot
);
-Get the current active locale, which -is used to get localized messages.
-void -as_screenshot_set_active_locale (-AsScreenshot *screenshot
, -const gchar *locale
);
Set the current active locale, which -is used to get localized messages. -If the AsComponent linking this AsScreenshot was fetched -from a localized database, usually only -one locale is available.
--Top - | -- | - | - | - |
-AsValidator * - | --as_validator_new () - | -
-void - | --as_validator_clear_issues () - | -
-gboolean - | --as_validator_validate_file () - | -
-gboolean - | --as_validator_validate_data () - | -
-gboolean - | --as_validator_validate_tree () - | -
-GList * - | --as_validator_get_issues () - | -
#define | -AS_TYPE_VALIDATOR | -
struct | -AsValidatorClass | -
- | AsValidator | -
This object is able to validate AppStream XML metadata (distro and upstream) -and to generate a report about issues found with it.
-See also: AsMetadata
-void
-as_validator_clear_issues (AsValidator *validator
);
-Clears the list of issues
- -gboolean -as_validator_validate_file (-AsValidator *validator
, -GFile *metadata_file
);
Validate an AppStream XML file
-validator |
-An instance of AsValidator. |
-- |
metadata_file |
-An AppStream XML file. |
-- |
gboolean -as_validator_validate_data (-AsValidator *validator
, -const gchar *metadata
);
Validate AppStream XML data
-validator |
-An instance of AsValidator. |
-- |
metadata |
-XML metadata. |
-- |
gboolean -as_validator_validate_tree (-AsValidator *validator
, -const gchar *root_dir
);
Validate a full directory tree for issues in AppStream metadata.
-validator |
-An instance of AsValidator. |
-- |
root_dir |
-The root directory of the filesystem tree that should be validated. |
-- |
GList *
-as_validator_get_issues (AsValidator *validator
);
-Get a list of found metadata format issues.
- - a list of AsValidatorIssue instances, free with g_list_free()
.
[element-type AsValidatorIssue][transfer container]
--Top - | -- | - | - | - |
-AsValidatorIssue-AsValidatorIssue — Object representing an issue found in AppStream metadata - |
-- |
-AsValidatorIssue * - | --as_validator_issue_new () - | -
-AsIssueKind - | --as_validator_issue_get_kind () - | -
-void - | --as_validator_issue_set_kind () - | -
-AsIssueImportance - | --as_validator_issue_get_importance () - | -
-void - | --as_validator_issue_set_importance () - | -
const gchar * - | --as_validator_issue_get_message () - | -
-void - | --as_validator_issue_set_message () - | -
const gchar * - | --as_validator_issue_get_location () - | -
-void - | --as_validator_issue_set_location () - | -
#define | -AS_TYPE_VALIDATOR_ISSUE | -
struct | -AsValidatorIssueClass | -
enum | -AsIssueImportance | -
enum | -AsIssueKind | -
- | AsValidatorIssue | -
AsValidatorIssue *
-as_validator_issue_new (void
);
-Creates a new AsValidatorIssue.
- -AsIssueKind
-as_validator_issue_get_kind (AsValidatorIssue *issue
);
-Gets the issue kind enum, if available.
- - -void -as_validator_issue_set_kind (-AsValidatorIssue *issue
, -AsIssueKind kind
);
Sets the kind enum for this issue, if known.
-issue |
-a AsValidatorIssue instance. |
-- |
kind |
-the AsIssueKind. |
-- |
AsIssueImportance
-as_validator_issue_get_importance (AsValidatorIssue *issue
);
-Gets the importance of this issue.
- - -void -as_validator_issue_set_importance (-AsValidatorIssue *issue
, -AsIssueImportance importance
);
Sets the importance for this issue.
-issue |
-a AsValidatorIssue instance. |
-- |
importance |
-the AsIssueImportance. |
-- |
const gchar *
-as_validator_issue_get_message (AsValidatorIssue *issue
);
-Gets the message for the issue.
- - -void -as_validator_issue_set_message (-AsValidatorIssue *issue
, -const gchar *message
);
Sets a message on the issue.
-issue |
-a AsValidatorIssue instance. |
-- |
message |
-the message text. |
-- |
const gchar *
-as_validator_issue_get_location (AsValidatorIssue *issue
);
-Gets a location hint for the issue.
- - -void -as_validator_issue_set_location (-AsValidatorIssue *issue
, -const gchar *location
);
Sets a location hint for this issue.
-issue |
-a AsValidatorIssue instance. |
-- |
location |
-a location hint. |
-- |
struct AsValidatorIssueClass { - GObjectClass parent_class; -}; --
-
-The importance of an issue found by AsValidator
- -The issue type.
-- |
- Type invalid or not known - |
-- |
- |
- The XML markup is invalid - |
-- |
- |
- An element from a legacy AppStream specification has been found - |
-- |
- |
- A tag is duplicated - |
-- |
- |
- A required tag is missing - |
-- |
- |
- An unknown tag was found - |
-- |
- |
- A tag is not allowed in the current context - |
-- |
- |
- A required property is missing - |
-- |
- |
- A property is invalid - |
-- |
- |
- A value is missing - |
-- |
- |
- The value of a tag or property is wrong - |
-- |
- |
- There is an issue with a tag or property value (often non-fatal) - |
-- |
- |
- A required file or other metadata was missing - |
-- |
- |
- The naming of an entity is wrong - |
-- |
- |
- Reading of data failed - |
-- |
- | - | - | - | - |
- | - | - | - | - |
AppStream Library Reference Manual |
---|
- The latest version of this documentation can be found on-line at - freedesktop.org/software/appstream/docs/api/html. -
- | - | - | - | - |
- | - | - | - | - |
- GObject - ├── AsCacheBuilder - ├── AsCategory - ├── AsComponent - ├── AsDataPool - ├── AsDatabase - ├── AsDistroDetails - ├── AsIcon - ├── AsImage - ├── AsMenuParser - ├── AsMetadata - ├── AsProvided - ├── AsRelease - ├── AsScreenshot - ├── AsTranslation - ├── AsValidator - ├── AsValidatorIssue - ├── AsXMLData - ╰── AsYAMLData - GEnum - ╰── AsComponentKind --
- | - | - | - | - |
-appstreamcli-appstreamcli — Handle AppStream metadata and the AppStream index - |
-- |
appstreamcli
[COMMAND
]
- This manual page documents briefly the appstreamcli command. -
-- appstreamcli is a small helper tool to work with AppStream metadata and - access the AppStream component index from the command-line. The AppStream component - index contains a list of all available software components for your distribution, matched to their - package names. - It is generated using AppStream XML or Debian DEP-11 data, which is provided by your distributor. -
-- For more information about the AppStream project and the other components which are part of it, take a look at - the AppStream pages at Freedesktop.org. -
-
|
-- Display various information about the installed metadata and - the metadata cache. - |
-
|
-Get a component by it's identifier. |
-
|
-Search the AppStream component database for a given search term. |
-
|
-
-
- Return components which provide a given item. An item type can be specified using the
- Examples: -- Get components which handle the "text/xml" mimetype. - -- appstreamcli what-provides mimetype "text/xml" - -- Get component which provides the "libfoo.so.2" library. - -- appstreamcli what-provides lib libfoo.so.2 - - |
-
|
-
-
- Trigger a database refresh, if necessary.
- In case you want to force the database to be rebuilt, supply the This command must be executed with root permission. - |
-
|
-- Dump the XML description of a component with the given ID. - |
-
|
-
- - Validate AppStream XML metadata for compliance with the specification. - -- Both XML metadata types, upstream and distro XML, are handled. - The filetype which should be validated is determined automatically. - -
- The |
-
|
-
- - Validate AppStream XML metadata found in a file-tree. - -- This performs a standard validation of all found metadata, but also checks for additional - errors, like the presence of .desktop files and validity of other additional metadata. - - |
-
|
-
- - Install a software component by its ID. - -- This resolves the AppStream component ID to the package name which provides it and - then calls the distribution's package manager to install the software. - -- This feature is experimental. - - |
-
|
-- Install a metadata file into the right directory on the current machine. - |
-
|
-Print out more information about a found component. |
-
|
-Don't print colored output. |
-
|
-Display the version number of appstreamcli |
-
- | - | - | - | - |
Parameter points to an array of items.
Default parameter value (for in case the shadows-to function has less parameters).
Generics and defining elements of containers and arrays.
NULL may be passed as the value in, out, in-out; or as a return value.
Free data container after the code is done.
Free data after the code is done.
Don't free data after the code is done.
Override the parsed C type with given type.
- | - | - | - | - |
-Top - | -- | - | - | - |
const gchar * - | --as_url_kind_to_string () - | -
-AsUrlKind - | --as_url_kind_from_string () - | -
const gchar * - | --as_bundle_kind_to_string () - | -
-AsBundleKind - | --as_bundle_kind_from_string () - | -
const gchar * - | --as_urgency_kind_to_string () - | -
-AsUrgencyKind - | --as_urgency_kind_from_string () - | -
enum | -AsUrlKind | -
enum | -AsBundleKind | -
enum | -AsUrgencyKind | -
const gchar *
-as_url_kind_to_string (AsUrlKind url_kind
);
-Converts the enumerated value to an text representation.
- - -AsUrlKind
-as_url_kind_from_string (const gchar *url_kind
);
-Converts the text representation to an enumerated value.
- - -const gchar *
-as_bundle_kind_to_string (AsBundleKind bundle_kind
);
-Converts the enumerated value to an text representation.
- - -Since: 0.8.0
-AsBundleKind
-as_bundle_kind_from_string (const gchar *bundle_kind
);
-Converts the text representation to an enumerated value.
- - -const gchar *
-as_urgency_kind_to_string (AsUrgencyKind urgency_kind
);
-Converts the enumerated value to an text representation.
- - -Since: 0.6.5
-AsUrgencyKind
-as_urgency_kind_from_string (const gchar *urgency_kind
);
-Converts the text representation to an enumerated value.
- - -Since: 0.6.5
-The URL type.
- --Top - | -- | - | - | - |
const gchar * - | --as_provides_kind_to_string () - | -
-AsProvidesKind - | --as_provides_kind_from_string () - | -
-gchar * - | --as_provides_item_create () - | -
-AsProvidesKind - | --as_provides_item_get_kind () - | -
-gchar * - | --as_provides_item_get_value () - | -
Components can provide various items, like libraries, Python-modules, -firmware, binaries, etc. -Functions to work with these items are provided here.
-See also: AsComponent
-const gchar *
-as_provides_kind_to_string (AsProvidesKind kind
);
-Converts the enumerated value to an text representation.
- - -AsProvidesKind
-as_provides_kind_from_string (const gchar *kind_str
);
-Converts the text representation to an enumerated value.
- - -gchar * -as_provides_item_create (-AsProvidesKind kind
, -const gchar *value
, -const gchar *data
);
Creates a new provides-item string, which -consists of a type-part describing the items type, and a name-part, -containing the name of the item. Both are separated by a semicolon, -so an item of type KIND_LIBRARY and name libappstream.so.0 will become -"lib;libappstream.so.0;" -A provides-item might also contain a "data" part, describing additional -information about it. For example, for a KIND_DBUS provides type, -the item might look like: dbus;org.freedesktop.PackageKit;system -(specifying that the service name is on the system bus)
-kind
- a AsProvidesKind describing the type of the item string
-value
- the name of the item as string
-data
- (allow-none) (default NULL): additional data associated with this item
AsProvidesKind
-as_provides_item_get_kind (const gchar *item
);
-Returns the type (kind) of a provides-item string -as AsProvidesKind
-item
- a valid provides-item string
Public interfaces components can provide.
-- |
- Unknown kind - |
-- |
- |
- A shared library - |
-- |
- |
- A binary installed into a directory in PATH - |
-- |
- |
- A font - |
-- |
- |
- A modalias - |
-- |
- |
- Runtime or flashed firmware - |
-- |
- |
- A Python2 module - |
-- |
- |
- A Python3 module - |
-- |
- |
- Provides a handler for a mimetype - |
-- |
- |
- A DBus service name - |
-- |
-Top - | -- | - | - | - |
-AsCategory * - | --as_category_new () - | -
-void - | --as_category_complete () - | -
const gchar * - | --as_category_get_directory () - | -
-void - | --as_category_set_directory () - | -
const gchar * - | --as_category_get_name () - | -
-void - | --as_category_set_name () - | -
const gchar * - | --as_category_get_summary () - | -
-void - | --as_category_set_summary () - | -
const gchar * - | --as_category_get_icon () - | -
-void - | --as_category_set_icon () - | -
-gboolean - | --as_category_has_subcategory () - | -
-void - | --as_category_add_subcategory () - | -
-void - | --as_category_remove_subcategory () - | -
-GList * - | --as_category_get_included () - | -
-GList * - | --as_category_get_excluded () - | -
-GList * - | --as_category_get_subcategories () - | -
-gint - | --as_category_get_level () - | -
-void - | --as_category_set_level () - | -
#define | -AS_TYPE_CATEGORY | -
struct | -AsCategoryClass | -
- | AsCategory | -
This object represents an XDG category, as defined at: -http://standards.freedesktop.org/menu-spec/menu-spec-1.0.htmlcategory-registry
-The AsCategory object does not support all aspects of a menu. It's main purpose -is to be used in software-centers to show information about application-groups, -which are use to thematically group applications.
-You can use AsMenuParser to get a set of supported default categories.
-See also: AsMenuParser
-void
-as_category_complete (AsCategory *cat
);
-Update incomplete category data with information from -"/usr/share/desktop-directories".
-const gchar *
-as_category_get_directory (AsCategory *cat
);
-Get associated XDG directory name for this category, -in case one exists in "/usr/share/desktop-directories/".
- -void -as_category_set_directory (-AsCategory *cat
, -const gchar *value
);
Set associated XDG directory name for this category.
- -const gchar *
-as_category_get_name (AsCategory *cat
);
-Get the name of this category.
- -void -as_category_set_name (-AsCategory *cat
, -const gchar *value
);
Set the name of this category.
- -const gchar *
-as_category_get_summary (AsCategory *cat
);
-Get the summary (short description) of this category.
- -void -as_category_set_summary (-AsCategory *cat
, -const gchar *value
);
Get the summary (short description) of this category.
-cat |
-An instance of AsCategory. |
-- |
value |
-A new short summary of this category. |
-- |
const gchar *
-as_category_get_icon (AsCategory *cat
);
-Get the stock icon name for this category.
- -void -as_category_set_icon (-AsCategory *cat
, -const gchar *value
);
Set the stock icon name for this category.
- -gboolean
-as_category_has_subcategory (AsCategory *cat
);
-Test for sub-categories.
- - -void -as_category_add_subcategory (-AsCategory *cat
, -AsCategory *subcat
);
Add a subcategory to this category.
-cat |
-An instance of AsCategory. |
-- |
subcat |
-A subcategory to add. |
-- |
void -as_category_remove_subcategory (-AsCategory *cat
, -AsCategory *subcat
);
Drop a subcategory from this AsCategory.
-cat |
-An instance of AsCategory. |
-- |
subcat |
-A subcategory to remove. |
-- |
-Top - | -- | - | - | - |
GStrv | -categories | -Read / Write | -
-gchar * | -description | -Read / Write | -
-gchar * | -developer-name | -Read / Write | -
gpointer | -icons | -Read | -
-gchar * | -id | -Read / Write | -
GStrv | -keywords | -Read / Write | -
AsComponentKind | -kind | -Read / Write | -
-gchar * | -name | -Read / Write | -
GStrv | -pkgnames | -Read / Write | -
-gchar * | -project-group | -Read / Write | -
-gchar * | -project-license | -Read / Write | -
-GPtrArray * | -screenshots | -Read | -
-gchar * | -summary | -Read / Write | -
-GHashTable * | -urls | -Read | -
#define | -AS_TYPE_COMPONENT | -
struct | -AsComponentClass | -
enum | -AsComponentKind | -
- | AsComponent | -
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
-const gchar *
-as_component_kind_to_string (AsComponentKind kind
);
-Converts the enumerated value to an text representation.
- - -AsComponentKind
-as_component_kind_from_string (const gchar *kind_str
);
-Converts the text representation to an enumerated value.
- - -gboolean
-as_component_is_valid (AsComponent *cpt
);
-Check if the essential properties of this Component are -populated with useful data.
- - -gchar *
-as_component_to_string (AsComponent *cpt
);
-Returns a string identifying this component. -(useful for debugging)
- - -gchar *
-as_component_get_active_locale (AsComponent *cpt
);
-Get the current active locale for this component, which -is used to get localized messages.
- - -void -as_component_set_active_locale (-AsComponent *cpt
, -const gchar *locale
);
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.
-cpt |
-a AsComponent instance. |
-- |
locale |
- the locale, or |
-[nullable] | -
AsComponentKind
-as_component_get_kind (AsComponent *cpt
);
-Returns the AsComponentKind of this component.
- - -void -as_component_set_kind (-AsComponent *cpt
, -AsComponentKind value
);
Sets the AsComponentKind of this component.
-cpt |
-a AsComponent instance. |
-- |
value |
-the AsComponentKind. |
-- |
const gchar *
-as_component_get_id (AsComponent *cpt
);
-Set the unique identifier for this component.
- - -void -as_component_set_id (-AsComponent *cpt
, -const gchar *value
);
Set the unique identifier for this component.
-cpt |
-a AsComponent instance. |
-- |
value |
-the unique identifier. |
-- |
void -as_component_set_origin (- -AsComponent *cpt
, -const gchar *origin
);
gchar **
-as_component_get_pkgnames (AsComponent *cpt
);
-Get a list of package names which this component consists of. -This usually is just one package name.
- - -void -as_component_set_pkgnames (-AsComponent *cpt
, -gchar **value
);
Set a list of package names this component consists of. -(This should usually be just one package name)
-cpt |
-a AsComponent instance. |
-- |
value |
-. |
-[array zero-terminated=1] | -
const gchar *
-as_component_get_source_pkgname (AsComponent *cpt
);
-
-
-void -as_component_set_source_pkgname (-AsComponent *cpt
, -const gchar *spkgname
);
cpt |
-a AsComponent instance. |
-- |
spkgname |
-the source package name. |
-- |
const gchar *
-as_component_get_name (AsComponent *cpt
);
-A human-readable name for this component.
- - -void -as_component_set_name (-AsComponent *cpt
, -const gchar *value
, -const gchar *locale
);
Set a human-readable name for this component.
-cpt |
-A valid AsComponent |
-- |
value |
-The name |
-- |
locale |
- The locale the used for this value, or |
-[nullable] | -
const gchar *
-as_component_get_summary (AsComponent *cpt
);
-Get a short description of this component.
- - -void -as_component_set_summary (-AsComponent *cpt
, -const gchar *value
, -const gchar *locale
);
Set a short description for this component.
-cpt |
-A valid AsComponent |
-- |
value |
-The summary |
-- |
locale |
- The locale the used for this value, or |
-[nullable] | -
const gchar *
-as_component_get_description (AsComponent *cpt
);
-Get the localized long description of this component.
- - -void -as_component_set_description (-AsComponent *cpt
, -const gchar *value
, -const gchar *locale
);
Set long description for this component.
-cpt |
-A valid AsComponent |
-- |
value |
-The long description |
-- |
locale |
- The locale the used for this value, or |
-[nullable] | -
const gchar *
-as_component_get_project_license (AsComponent *cpt
);
-Get the license of the project this component belongs to.
- - -void -as_component_set_project_license (-AsComponent *cpt
, -const gchar *value
);
Set the project license.
-cpt |
-a AsComponent instance. |
-- |
value |
-the project license. |
-- |
const gchar *
-as_component_get_project_group (AsComponent *cpt
);
-Get the component's project group.
- - -void -as_component_set_project_group (-AsComponent *cpt
, -const gchar *value
);
Set the component's project group.
-cpt |
-a AsComponent instance. |
-- |
value |
-the project group. |
-- |
const gchar *
-as_component_get_developer_name (AsComponent *cpt
);
-Get the component's developer or development team name.
- - -void -as_component_set_developer_name (-AsComponent *cpt
, -const gchar *value
, -const gchar *locale
);
Set the the component's developer or development team name.
-cpt |
-a AsComponent instance. |
-- |
value |
-the developer or developer team name |
-- |
locale |
- the locale, or |
-[nullable] | -
gchar **
-as_component_get_compulsory_for_desktops
- (AsComponent *cpt
);
-
-
-void -as_component_set_compulsory_for_desktops - (-AsComponent *cpt
, -gchar **value
);
Set a list of desktops where this component is compulsory.
-cpt |
-a AsComponent instance. |
-- |
value |
-the array of desktop ids. |
-[array zero-terminated=1] | -
gboolean -as_component_is_compulsory_for_desktop - (-AsComponent *cpt
, -const gchar *desktop
);
Check if this component is compulsory for the given desktop.
-cpt |
-an AsComponent object |
-- |
desktop |
-the desktop-id to test for |
-- |
void -as_component_set_categories (-AsComponent *cpt
, -gchar **value
);
cpt |
-a AsComponent instance. |
-- |
value |
-the categories name. |
-[array zero-terminated=1] | -
gboolean -as_component_has_category (-AsComponent *cpt
, -const gchar *category
);
Check if component is in the specified category.
-cpt |
-an AsComponent object |
-- |
category |
-the specified category to check |
-- |
GPtrArray *
-as_component_get_screenshots (AsComponent *cpt
);
-Get a list of associated screenshots.
- - -void -as_component_add_screenshot (-AsComponent *cpt
, -AsScreenshot *sshot
);
Add an AsScreenshot to this component.
-cpt |
-a AsComponent instance. |
-- |
sshot |
-The AsScreenshot to add |
-- |
void -as_component_set_keywords (-AsComponent *cpt
, -gchar **value
, -const gchar *locale
);
Set keywords for this component.
-cpt |
-a AsComponent instance. |
-- |
value |
-String-array of keywords. |
-[array zero-terminated=1] | -
locale |
- Locale of the values, or |
-[nullable] | -
AsIcon * -as_component_get_icon_by_size (-AsComponent *cpt
, -guint width
, -guint height
);
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.
cpt |
-an AsComponent instance |
-- |
width |
-The icon width in pixels. |
-- |
height |
-the icon height in pixels. |
-- |
void -as_component_add_icon (-AsComponent *cpt
, -AsIcon *icon
);
Add an icon to this component.
-cpt |
-an AsComponent instance |
-- |
icon |
-the valid AsIcon instance to add. |
-- |
void -as_component_add_provided (-AsComponent *cpt
, -AsProvided *prov
);
Add a set of provided items to this component.
-cpt |
-a AsComponent instance. |
-- |
prov |
-a AsProvided instance. |
-- |
Since: 0.6.2
-AsProvided * -as_component_get_provided_for_kind (-AsComponent *cpt
, -AsProvidedKind kind
);
Get an AsProvided object for the given interface type, -containing information about the public interfaces (mimetypes, firmware, DBus services, ...) -this component provides.
-cpt |
-a AsComponent instance. |
-- |
kind |
-kind of the provided item, e.g. |
-- |
GList *
-as_component_get_provided (AsComponent *cpt
);
-Get a list of AsProvided objects associated with this component.
- - -const gchar * -as_component_get_url (-AsComponent *cpt
, -AsUrlKind url_kind
);
Gets a URL.
-cpt |
-a AsComponent instance. |
-- |
url_kind |
-the URL kind, e.g. |
-- |
Since: 0.6.2
-void -as_component_add_url (-AsComponent *cpt
, -AsUrlKind url_kind
, -const gchar *url
);
Adds some URL data to the component.
-cpt |
-a AsComponent instance. |
-- |
url_kind |
-the URL kind, e.g. |
-- |
url |
-the full URL. |
-- |
Since: 0.6.2
-GPtrArray *
-as_component_get_releases (AsComponent *cpt
);
-Get an array of the AsRelease items this component -provides.
- - -void -as_component_add_release (-AsComponent *cpt
, -AsRelease *release
);
Add an AsRelease to this component.
-cpt |
-a AsComponent instance. |
-- |
release |
-The AsRelease to add |
-- |
GPtrArray *
-as_component_get_extends (AsComponent *cpt
);
-Returns a string list of IDs of components which -are extended by this addon.
-See as_component_get_extends
() for the reverse.
Since: 0.7.0
-void -as_component_add_extends (-AsComponent *cpt
, -const gchar *cpt_id
);
Add a reference to the extended component
-cpt |
-a AsComponent instance. |
-- |
cpt_id |
-The id of a component which is extended by this component |
-- |
Since: 0.7.0
-GPtrArray *
-as_component_get_extensions (AsComponent *cpt
);
-Returns a string list of IDs of components which -are addons extending this component in functionality.
-This is the reverse of as_component_get_extends
()
Since: 0.9.2
-void -as_component_add_extension (-AsComponent *cpt
, -const gchar *cpt_id
);
Add a reference to the extension enhancing this component.
-cpt |
-a AsComponent instance. |
-- |
cpt_id |
-The id of a component extending this component. |
-- |
Since: 0.9.2
-GList *
-as_component_get_languages (AsComponent *cpt
);
-Get a list of all languages.
- - -Since: 0.7.0
-gint -as_component_get_language (-AsComponent *cpt
, -const gchar *locale
);
Gets the translation coverage in percent for a specific locale
-cpt |
-an AsComponent instance. |
-- |
locale |
- the locale, or |
-[nullable] | -
Since: 0.7.0
-void -as_component_add_language (-AsComponent *cpt
, -const gchar *locale
, -gint percentage
);
Adds a language to the component.
-cpt |
-an AsComponent instance. |
-- |
locale |
- the locale, or |
-[nullable] | -
percentage |
-the percentage completion of the translation, 0 for locales with unknown amount of translation |
-- |
Since: 0.7.0
-GPtrArray *
-as_component_get_translations (AsComponent *cpt
);
-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.
- - -Since: 0.9.2
-void -as_component_add_translation (-AsComponent *cpt
, -AsTranslation *tr
);
Assign an AsTranslation object describing the translation system used -by this component.
-cpt |
-an AsComponent instance. |
-- |
tr |
-an AsTranslation instance. |
-- |
Since: 0.9.2
-const gchar * -as_component_get_bundle_id (-AsComponent *cpt
, -AsBundleKind bundle_kind
);
Gets a bundle identifier string.
-cpt |
-a AsComponent instance. |
-- |
bundle_kind |
-the bundle kind, e.g. |
-- |
Since: 0.8.0
-void -as_component_add_bundle_id (-AsComponent *cpt
, -AsBundleKind bundle_kind
, -const gchar *id
);
Adds a bundle identifier to the component.
-cpt |
-a AsComponent instance. |
-- |
bundle_kind |
-the URL kind, e.g. |
-- |
id |
-The bundle identification string |
-- |
Since: 0.8.0
-The type of an AsComponent.
-- |
- Type invalid or not known - |
-- |
- |
- A generic (= without specialized type) component - |
-- |
- |
- An application with a .desktop-file - |
-- |
- |
- A font - |
-- |
- |
- A multimedia codec - |
-- |
- |
- An input-method provider - |
-- |
- |
- An extension of existing software, which does not run standalone - |
-- |
- |
- Firmware - |
-- |
“description”
property “description” gchar *
-the description
-Flags: Read / Write
-Default value: NULL
-“developer-name”
property “developer-name” gchar *
-the developer name
-Flags: Read / Write
-Default value: NULL
-“icons”
property “icons” gpointer
-hash map of icon urls and sizes
-[type GList(AsIcon)]
-Flags: Read
-“id”
property “id” gchar *
-the unique identifier
-Flags: Read / Write
-Default value: NULL
-“kind”
property“kind” AsComponentKind-
the AsComponentKind of this component
-Flags: Read / Write
-Default value: AS_COMPONENT_KIND_UNKNOWN
-“project-group”
property “project-group” gchar *
-the project group
-Flags: Read / Write
-Default value: NULL
-“project-license”
property “project-license” gchar *
-the project license
-Flags: Read / Write
-Default value: NULL
-“summary”
property “summary” gchar *
-the summary
-Flags: Read / Write
-Default value: NULL
--Top - | -- | - | - | - |
-AsDatabase * - | --as_database_new () - | -
-GQuark - | --as_database_error_quark () - | -
-gboolean - | --as_database_open () - | -
const gchar * - | --as_database_get_location () - | -
-void - | --as_database_set_location () - | -
-GPtrArray * - | --as_database_find_components () - | -
-GPtrArray * - | --as_database_get_all_components () - | -
-AsComponent * - | --as_database_get_component_by_id () - | -
-GPtrArray * - | --as_database_get_components_by_provided_item () - | -
-GPtrArray * - | --as_database_get_components_by_kind () - | -
#define | -AS_TYPE_DATABASE | -
struct | -AsDatabaseClass | -
enum | -AsDatabaseError | -
#define | -AS_DATABASE_ERROR | -
- | AsDatabase | -
This object provides access to the Appstream Xapian database of available software components. -You can search for components using various criteria, as well as getting some information -about the data provided by this AppStream database.
-By default, the global software component cache is used as datasource, unless a different database
-is explicitly defined via as_database_set_location
().
A new cache can be created using the appstreamcli(1) utility.
-See also: AsComponent, AsDataPool
-gboolean -as_database_open (-AsDatabase *db
, -GError **error
);
Open the current AppStream metadata cache for reading.
-db |
-An instance of AsDatabase. |
-- |
error |
-A GError or |
-- |
const gchar *
-as_database_get_location (AsDatabase *db
);
-Get the current path of the AppStream database we use.
- -void -as_database_set_location (-AsDatabase *db
, -const gchar *dir
);
Set the location of the AppStream database we use.
-db |
-An instance of AsDatabase. |
-- |
dir |
-The directory of the Xapian database. |
-- |
GPtrArray * -as_database_find_components (-AsDatabase *db
, -const gchar *term
, -const gchar *cats_str
, -GError **error
);
Find components in the AppStream database, which match a given term. -You can limit the search to a specific set of categories by setting the categories string to -a semicolon-separated list of lower-cased category names.
-db |
-An instance of AsDatabase. |
-- |
term |
-a search-term to look for. |
-[nullable] | -
cats_str |
-A semicolon-delimited list of lower-cased category names, e.g. "science;development". |
-[nullable] | -
error |
-A GError or |
-- |
an array of AsComponent objects which have been found.
-[element-type AsComponent][transfer full]
-GPtrArray * -as_database_get_all_components (-AsDatabase *db
, -GError **error
);
Dump a list of all software components found in the database.
-db |
-An instance of AsDatabase. |
-- |
error |
-A GError or |
-- |
AsComponent * -as_database_get_component_by_id (-AsDatabase *db
, -const gchar *cid
, -GError **error
);
Get a component by its AppStream-ID.
-db |
-An instance of AsDatabase. |
-- |
cid |
-the ID of the component, e.g. "org.kde.gwenview.desktop" |
-- |
error |
-A GError or |
-- |
GPtrArray * -as_database_get_components_by_provided_item - (-AsDatabase *db
, -AsProvidedKind kind
, -const gchar *item
, -GError **error
);
Find components in the Appstream database.
-db |
-An instance of AsDatabase. |
-- |
kind |
-an AsProvidesKind |
-- |
item |
-the name of the provided item. |
-- |
error |
-A GError or |
-- |
an array of AsComponent objects which have been found, NULL on error.
-[element-type AsComponent][transfer full]
-GPtrArray * -as_database_get_components_by_kind (-AsDatabase *db
, -AsComponentKind kind
, -GError **error
);
Return a list of all components in the database which match a certain kind.
-db |
-An instance of AsDatabase. |
-- |
kind |
-an AsComponentKind. |
-- |
error |
-A GError or |
-- |
an array of AsComponent objects which have been found, NULL
on error.
[element-type AsComponent][transfer full]
--Top - | -- | - | - | - |
-GQuark - | --as_data_pool_error_quark () - | -
-AsDataPool * - | --as_data_pool_new () - | -
const gchar * - | --as_data_pool_get_locale () - | -
-void - | --as_data_pool_set_locale () - | -
-gboolean - | --as_data_pool_update () - | -
-GList * - | --as_data_pool_get_components () - | -
-AsComponent * - | --as_data_pool_get_component_by_id () - | -
-GPtrArray * - | --as_data_pool_get_metadata_locations () - | -
-void - | --as_data_pool_set_metadata_locations () - | -
#define | -AS_TYPE_DATA_POOL | -
struct | -AsDataPoolClass | -
enum | -AsDataPoolError | -
#define | -AS_DATA_POOL_ERROR | -
- | AsDataPool | -
This class contains a temporary pool of metadata which has been collected from different -sources on the system. -It can directly be used, but usually it is accessed through a AsDatabase instance. -This class is used by internally by the cache builder, but might be useful for others.
-See also: AsDatabase
-const gchar *
-as_data_pool_get_locale (AsDataPool *dpool
);
-Gets the currently used locale.
- - -void -as_data_pool_set_locale (-AsDataPool *dpool
, -const gchar *locale
);
Sets the current locale which should be used when parsing metadata.
- -gboolean -as_data_pool_update (-AsDataPool *dpool
, -GError **error
);
Builds an index of all found components in the watched locations.
-The function will try to get as much data into the pool as possible, so even if
-the updates completes with FALSE
, it might still add components to the pool.
dpool |
-An instance of AsDataPool. |
-- |
error |
-A GError or |
-- |
GList *
-as_data_pool_get_components (AsDataPool *dpool
);
-Get a list of found components.
- - a list of AsComponent instances, free with g_list_free()
.
[element-type AsComponent][transfer container]
-AsComponent * -as_data_pool_get_component_by_id (-AsDataPool *dpool
, -const gchar *id
);
Get a specific component by its ID.
-dpool |
-An instance of AsDataPool. |
-- |
id |
-The AppStream-ID to look for. |
-- |
GPtrArray *
-as_data_pool_get_metadata_locations (AsDataPool *dpool
);
-Return a list of all locations which are searched for metadata.
- - -void -as_data_pool_set_metadata_locations (-AsDataPool *dpool
, -gchar **dirs
);
Set locations for the data pool to read it's data from. -This is mainly used for testing purposes. Each location should have an -"xmls" and/or "yaml" subdirectory with the actual data as (compressed) -AppStream XML or DEP-11 YAML in it.
-dpool |
-An instance of AsDataPool. |
-- |
dirs |
-a zero-terminated array of data input directories. |
-[array zero-terminated=1] | -
-Top - | -- | - | - | - |
-AsDistroDetails * - | --as_distro_details_new () - | -
const gchar * - | --as_distro_details_get_id () - | -
const gchar * - | --as_distro_details_get_name () - | -
const gchar * - | --as_distro_details_get_version () - | -
-gchar * - | --as_distro_details_get_str () - | -
-gboolean - | --as_distro_details_get_bool () - | -
-gchar ** - | --as_get_icon_repository_paths () - | -
#define | -AS_TYPE_DISTRO_DETAILS | -
struct | -AsDistroDetailsClass | -
- | AsDistroDetails | -
This object abstracts various distribution-specific settings and provides information -about the (Linux) distribution which is currently in use. -It is used internalls to get information about the icon-store or the 3rd-party screenshot -service distributors may want to provide.
-See also: AsDatabase
-AsDistroDetails *
-as_distro_details_new (void
);
-Creates a new instance of AsDistroDetails.
- -const gchar *
-as_distro_details_get_name (AsDistroDetails *distro
);
-const gchar *
-as_distro_details_get_version (AsDistroDetails *distro
);
-gchar * -as_distro_details_get_str (-AsDistroDetails *distro
, -const gchar *key
);
gboolean -as_distro_details_get_bool (-AsDistroDetails *distro
, -const gchar *key
);
-Top - | -- | - | - | - |
-AsIconKind - | --as_icon_kind_from_string () - | -
const gchar * - | --as_icon_kind_to_string () - | -
-AsIcon * - | --as_icon_new () - | -
-AsIconKind - | --as_icon_get_kind () - | -
-void - | --as_icon_set_kind () - | -
const gchar * - | --as_icon_get_name () - | -
-void - | --as_icon_set_name () - | -
const gchar * - | --as_icon_get_url () - | -
-void - | --as_icon_set_url () - | -
const gchar * - | --as_icon_get_filename () - | -
-void - | --as_icon_set_filename () - | -
-guint - | --as_icon_get_width () - | -
-void - | --as_icon_set_width () - | -
-guint - | --as_icon_get_height () - | -
-void - | --as_icon_set_height () - | -
#define | -AS_TYPE_ICON | -
struct | -AsIconClass | -
enum | -AsIconKind | -
- | AsIcon | -
AsIconKind
-as_icon_kind_from_string (const gchar *kind_str
);
-Converts the text representation to an enumerated value.
- - -const gchar *
-as_icon_kind_to_string (AsIconKind kind
);
-Converts the enumerated value to an text representation.
- - -void -as_icon_set_kind (-AsIcon *icon
, -AsIconKind kind
);
Sets the icon kind.
-icon |
-a AsIcon instance. |
-- |
kind |
-the AsIconKind, e.g. |
-- |
void -as_icon_set_name (-AsIcon *icon
, -const gchar *name
);
Sets the stock name or basename to use for the icon.
-icon |
-a AsIcon instance. |
-- |
name |
-the icon stock name, e.g. "gwenview" |
-- |
const gchar *
-as_icon_get_url (AsIcon *icon
);
-Gets the icon URL, pointing at a remote location. HTTPS and FTP urls are allowed.
-This property is only set for icons of type AS_ICON_KIND_REMOTE
void -as_icon_set_url (-AsIcon *icon
, -const gchar *url
);
Sets the icon URL.
- -const gchar *
-as_icon_get_filename (AsIcon *icon
);
-
- The absolute path for the icon on disk.
-This is only set for icons of kind AS_ICON_KIND_LOCAL
or
-AS_ICON_KIND_CACHED
.
void -as_icon_set_filename (-AsIcon *icon
, -const gchar *filename
);
Sets the icon absolute filename.
- -void -as_icon_set_width (-AsIcon *icon
, -guint width
);
Sets the icon width.
- --Top - | -- | - | - | - |
-AsImageKind - | --as_image_kind_from_string () - | -
const gchar * - | --as_image_kind_to_string () - | -
-AsImage * - | --as_image_new () - | -
const gchar * - | --as_image_get_url () - | -
-void - | --as_image_set_url () - | -
-guint - | --as_image_get_width () - | -
-void - | --as_image_set_width () - | -
-guint - | --as_image_get_height () - | -
-void - | --as_image_set_height () - | -
-AsImageKind - | --as_image_get_kind () - | -
-void - | --as_image_set_kind () - | -
#define | -AS_TYPE_IMAGE | -
struct | -AsImageClass | -
enum | -AsImageKind | -
- | AsImage | -
Screenshot may have multiple versions of an image in different resolutions -or aspect ratios. This object allows access to the location and size of a -single image.
-See also: AsScreenshot
-AsImageKind
-as_image_kind_from_string (const gchar *kind
);
-Converts the text representation to an enumerated value.
- - -const gchar *
-as_image_kind_to_string (AsImageKind kind
);
-Converts the enumerated value to an text representation.
- - -const gchar *
-as_image_get_url (AsImage *image
);
-Gets the full qualified URL for the image, usually pointing at some mirror.
- - -void -as_image_set_url (-AsImage *image
, -const gchar *url
);
Sets the fully-qualified mirror URL to use for the image.
- -void -as_image_set_width (-AsImage *image
, -guint width
);
Sets the image width.
-image |
-a AsImage instance. |
-- |
width |
-the width in pixels. |
-- |
void -as_image_set_height (-AsImage *image
, -guint height
);
Sets the image height.
-image |
-a AsImage instance. |
-- |
height |
-the height in pixels. |
-- |
void -as_image_set_kind (-AsImage *image
, -AsImageKind kind
);
Sets the image kind.
-image |
-a AsImage instance. |
-- |
kind |
-the AsImageKind, e.g. |
-- |
-Top - | -- | - | - | - |
-AsMenuParser * - | --as_menu_parser_new () - | -
-AsMenuParser * - | --as_menu_parser_new_from_file () - | -
-GList * - | --as_menu_parser_parse () - | -
-gboolean - | --as_menu_parser_get_update_category_data () - | -
-void - | --as_menu_parser_set_update_category_data () - | -
-GList * - | --as_get_system_categories () - | -
#define | -AS_TYPE_MENU_PARSER | -
struct | -AsMenuParserClass | -
- | AsMenuParser | -
This object parses an XDG menu file and returns a set of AsCategory objects which -can be used by software-centers to group the applications they show. -By default, it loads a common set of categories from an internal menu file. -A custom menu file may be specified using the alternative class constructor.
-See also: AsCategory
-AsMenuParser *
-as_menu_parser_new_from_file (const gchar *menu_file
);
-Creates a new AsMenuParser using a custom XDG menu XML file.
- - -GList *
-as_menu_parser_parse (AsMenuParser *mp
);
-Parse the menu file
- -GList of AsCategory objects found in the menu, or NULL if there was an error.
-[element-type AsCategory][transfer full]
-gboolean
-as_menu_parser_get_update_category_data
- (AsMenuParser *mp
);
-
-void -as_menu_parser_set_update_category_data - (- -AsMenuParser *mp
, -gboolean value
);
-Top - | -- | - | - | - |
#define | -AS_TYPE_METADATA | -
struct | -AsMetadataClass | -
enum | -AsParserMode | -
enum | -AsMetadataError | -
#define | -AS_METADATA_ERROR | -
- | AsMetadata | -
This object parses AppStream metadata, including AppStream -upstream metadata, which is defined by upstream projects. -It returns an AsComponent of the data.
-See also: AsComponent, AsDatabase
-void -as_metadata_parse_file (-AsMetadata *metad
, -GFile *file
, -GError **error
);
Parses an AppStream upstream metadata file.
-metad |
-A valid AsMetadata instance |
-- |
file |
-GFile for the upstream metadata |
-- |
error |
-A GError or |
-- |
void -as_metadata_parse_xml (-AsMetadata *metad
, -const gchar *data
, -GError **error
);
Parses AppStream XML metadata.
-metad |
-A valid AsMetadata instance |
-- |
data |
-XML data describing one or more software components. |
-- |
void -as_metadata_parse_yaml (-AsMetadata *metad
, -const gchar *data
, -GError **error
);
Parses AppStream YAML metadata.
-metad |
-A valid AsMetadata instance |
-- |
data |
-YAML data describing one or more software components. |
-- |
error |
-A GError or |
-- |
AsComponent *
-as_metadata_get_component (AsMetadata *metad
);
-Gets the AsComponent which has been parsed from the XML. -If the AppStream XML contained multiple components, return the first -component that has been parsed.
- - -void -as_metadata_add_component (-AsMetadata *metad
, -AsComponent *cpt
);
Add an AsComponent to the list of components. -This can be used to add multiple components in order to -produce a distro-XML AppStream metadata file.
-gchar *
-as_metadata_component_to_upstream_xml (AsMetadata *metad
);
-Convert an AsComponent to upstream XML. -(The amount of localization included in the metadata depends on how the AsComponent -was initially loaded)
-The first AsComponent added to the internal list will be transformed.
-In case no component is present, NULL
is returned.
void -as_metadata_save_upstream_xml (-AsMetadata *metad
, -const gchar *fname
, -GError **error
);
Serialize AsComponent instance to XML and save it to file. -An existing file at the same location will be overridden.
- -gchar *
-as_metadata_components_to_distro_xml (AsMetadata *metad
);
-Serialize all AsComponent instances into AppStream
-distro-XML data.
-NULL
is returned if there is nothing to serialize.
void -as_metadata_save_distro_xml (-AsMetadata *metad
, -const gchar *fname
, -GError **error
);
Serialize all AsComponent instances to XML and save the data to a file. -An existing file at the same location will be overridden.
- -gchar *
-as_metadata_components_to_distro_yaml (AsMetadata *metad
);
-Serialize all AsComponent instances into AppStream DEP-11
-distro-YAML data.
-NULL
is returned if there is nothing to serialize.
void -as_metadata_save_distro_yaml (-AsMetadata *metad
, -const gchar *fname
, -GError **error
);
Serialize all AsComponent instances to XML and save the data to a file. -An existing file at the same location will be overridden.
- -void -as_metadata_set_locale (-AsMetadata *metad
, -const gchar *locale
);
Sets the locale which should be read when processing metadata. -All other locales are ignored, which increases parsing speed and -reduces memory usage. -If you set the locale to "ALL", all locales will be read.
- -const gchar *
-as_metadata_get_locale (AsMetadata *metad
);
-Gets the current active locale for parsing metadata, -or "ALL" if all locales are read.
- - -void -as_metadata_set_origin (-AsMetadata *metad
, -const gchar *origin
);
Set the origin of AppStream distro metadata
-metad |
-an AsMetadata instance. |
-- |
origin |
-the origin of AppStream distro metadata. |
-- |
gboolean
-as_metadata_get_update_existing (AsMetadata *metad
);
-
-
-void -as_metadata_set_update_existing (-AsMetadata *metad
, -gboolean update
);
If set to TRUE
, the parser will not create new components but
-instead update existing components in the pool with new metadata.
NOTE: Right now, this feature is only implemented for metainfo XML parsing!
-metad |
-an AsMetadata instance. |
-- |
update |
-A boolean value. |
-- |
void -as_metadata_set_write_header (-AsMetadata *metad
, -gboolean wheader
);
If set to TRUE
, tehe metadata writer will omit writing a DEP-11
-header document when in YAML mode, and will not write a root components node
-when writing XML data.
-Please keep in mind that this will create an invalid DEP-11 YAML AppStream
-distro metadata file, and an invalid XML file.
-This parameter should only be changed e.g. by the appstream-generator tool.
NOTE: Right now, this feature is only implemented for YAML!
-metad |
-an AsMetadata instance. |
-- |
wheader |
-A boolean value. |
-- |
void -as_metadata_set_parser_mode (-AsMetadata *metad
, -AsParserMode mode
);
Sets the current metadata parsing mode.
- -AsParserMode
-as_metadata_get_parser_mode (AsMetadata *metad
);
-Gets the current parser mode
- - -const gchar *
-as_metadata_get_architecture (AsMetadata *metad
);
-
-
-void -as_metadata_set_architecture (-AsMetadata *metad
, -const gchar *arch
);
Set the architecture the components in this metadata belong to.
-metad |
-an AsMetadata instance. |
-- |
arch |
-an architecture string. |
-- |
There are a few differences between Appstream's upstream metadata -and the distribution metadata. -The parser mode indicates which style we should process. -Usually you don't want to change this.
- --Top - | -- | - | - | - |
const gchar * - | --as_provided_kind_to_string () - | -
-AsProvidedKind - | --as_provided_kind_from_string () - | -
const gchar * - | --as_provided_kind_to_l10n_string () - | -
-AsProvided * - | --as_provided_new () - | -
-AsProvidedKind - | --as_provided_get_kind () - | -
-void - | --as_provided_set_kind () - | -
-gchar ** - | --as_provided_get_items () - | -
-void - | --as_provided_add_item () - | -
-gboolean - | --as_provided_has_item () - | -
#define | -AS_TYPE_PROVIDED | -
struct | -AsProvidedClass | -
enum | -AsProvidedKind | -
- | AsProvided | -
Components can provide various items, like libraries, Python-modules, -firmware, binaries, etc. -Functions to work with these items are provided here.
-See also: AsComponent
-const gchar *
-as_provided_kind_to_string (AsProvidedKind kind
);
-Converts the enumerated value to a text representation.
- - -AsProvidedKind
-as_provided_kind_from_string (const gchar *kind_str
);
-Converts the text representation to an enumerated value.
- - -const gchar *
-as_provided_kind_to_l10n_string (AsProvidedKind kind
);
-Converts the enumerated value to a localized text representation, -using the plural forms (e.g. "Libraries" instead of "Library").
-This can be useful when displaying provided items in GUI dialogs.
- - -AsProvidedKind
-as_provided_get_kind (AsProvided *prov
);
-The kind of items this AsProvided object stores.
- - -void -as_provided_set_kind (-AsProvided *prov
, -AsProvidedKind kind
);
Set the kind of items this AsProvided object stores.
-prov |
-a AsProvided instance. |
-- |
kind |
-the new AsProvidedKind |
-- |
gchar **
-as_provided_get_items (AsProvided *prov
);
-Get an array of provided data.
- - -void -as_provided_add_item (-AsProvided *prov
, -const gchar *item
);
Add a new provided item.
- -gboolean -as_provided_has_item (-AsProvided *prov
, -const gchar *item
);
Check if the current AsProvided contains an item -of the given name.
-prov |
-a AsProvided instance. |
-- |
item |
-the name of a provided item, e.g. "audio/x-vorbis" (in case the provided kind is a mimetype) |
-- |
Type of the public interface components can provide.
-- |
- Unknown kind - |
-- |
- |
- A shared library - |
-- |
- |
- A binary installed into a directory in PATH - |
-- |
- |
- Provides a handler for a mimetype - |
-- |
- |
- A font - |
-- |
- |
- A modalias - |
-- |
- |
- A Python2 module - |
-- |
- |
- A Python3 module - |
-- |
- |
- A DBus service name on the system bus. - |
-- |
- |
- A DBus service name on the user/session bus. - |
-- |
- |
- Firmware flashed at runtime. - |
-- |
- |
- Firmware flashed permanently to the device. - |
-- |
-Top - | -- | - | - | - |
#define | -AS_TYPE_RELEASE | -
struct | -AsReleaseClass | -
enum | -AsChecksumKind | -
enum | -AsSizeKind | -
- | AsRelease | -
This object represents a single upstream release, typically a minor update. -Releases can contain a localized description of paragraph and list elements -and also have a version number and timestamp.
-Releases can be automatically generated by parsing upstream ChangeLogs or -.spec files, or can be populated using MetaInfo files.
-See also: AsComponent
-const gchar *
-as_checksum_kind_to_string (AsChecksumKind kind
);
-Converts the enumerated value to an text representation.
- - -AsChecksumKind
-as_checksum_kind_from_string (const gchar *kind_str
);
-Converts the text representation to an enumerated value.
- - -const gchar *
-as_size_kind_to_string (AsSizeKind size_kind
);
-Converts the enumerated value to an text representation.
- - -Since: 0.8.6
-AsSizeKind
-as_size_kind_from_string (const gchar *size_kind
);
-Converts the text representation to an enumerated value.
- - -Since: 0.8.6
-const gchar *
-as_release_get_version (AsRelease *release
);
-Gets the release version.
- - -void -as_release_set_version (-AsRelease *release
, -const gchar *version
);
Sets the release version.
-release |
-a AsRelease instance. |
-- |
version |
-the version string. |
-- |
guint64
-as_release_get_timestamp (AsRelease *release
);
-Gets the release timestamp.
- - -void -as_release_set_timestamp (-AsRelease *release
, -guint64 timestamp
);
Sets the release timestamp.
-release |
-a AsRelease instance. |
-- |
timestamp |
-the timestamp value. |
-- |
const gchar *
-as_release_get_description (AsRelease *release
);
-Gets the release description markup for a given locale.
- - -void -as_release_set_description (-AsRelease *release
, -const gchar *description
, -const gchar *locale
);
Sets the description release markup.
-release |
-a AsRelease instance. |
-- |
description |
-the description markup. |
-- |
gchar *
-as_release_get_active_locale (AsRelease *release
);
-Get the current active locale, which -is used to get localized messages.
-void -as_release_set_active_locale (-AsRelease *release
, -const gchar *locale
);
Set the current active locale, which -is used to get localized messages. -If the AsComponent linking this AsRelease was fetched -from a localized database, usually only -one locale is available.
-GPtrArray *
-as_release_get_locations (AsRelease *release
);
-Gets the release locations, typically URLs.
- -Since: 0.8.1
-void -as_release_add_location (-AsRelease *release
, -const gchar *location
);
Adds a release location.
- -Since: 0.8.1
-const gchar * -as_release_get_checksum (-AsRelease *release
, -AsChecksumKind kind
);
Gets the release checksum
- -Since: 0.8.2
-void -as_release_set_checksum (-AsRelease *release
, -const gchar *checksum
, -AsChecksumKind kind
);
Set the release checksum.
-release |
-An instance of AsRelease. |
-- |
checksum |
-The checksum as string. |
-- |
kind |
-The kind of this checksum, e.g. |
-- |
Since: 0.8.2
-AsUrgencyKind
-as_release_get_urgency (AsRelease *release
);
-Gets the urgency of the release -(showing how important it is to update to a more recent release)
- - -Since: 0.6.5
-void -as_release_set_urgency (-AsRelease *release
, -AsUrgencyKind urgency
);
Sets the release urgency.
-release |
-a AsRelease instance. |
-- |
urgency |
-the urgency of this release/update (as AsUrgencyKind) |
-- |
Since: 0.6.5
-guint64 -as_release_get_size (-AsRelease *release
, -AsSizeKind kind
);
Gets the release size.
- - -Since: 0.8.6
-void -as_release_set_size (-AsRelease *release
, -guint64 size
, -AsSizeKind kind
);
Sets the release size for the given kind.
-release |
-a AsRelease instance |
-- |
size |
-a size in bytes, or 0 for unknown |
-- |
kind |
-- | - |
Since: 0.8.6
--Top - | -- | - | - | - |
-AsScreenshotKind - | --as_screenshot_kind_from_string () - | -
const gchar * - | --as_screenshot_kind_to_string () - | -
-gboolean - | --as_screenshot_is_valid () - | -
-AsScreenshot * - | --as_screenshot_new () - | -
-AsScreenshotKind - | --as_screenshot_get_kind () - | -
-void - | --as_screenshot_set_kind () - | -
const gchar * - | --as_screenshot_get_caption () - | -
-void - | --as_screenshot_set_caption () - | -
-GPtrArray * - | --as_screenshot_get_images () - | -
-void - | --as_screenshot_add_image () - | -
-gchar * - | --as_screenshot_get_active_locale () - | -
-void - | --as_screenshot_set_active_locale () - | -
#define | -AS_TYPE_SCREENSHOT | -
struct | -AsScreenshotClass | -
enum | -AsScreenshotKind | -
- | AsScreenshot | -
Screenshots have a localized caption and also contain a number of images -of different resolution.
-See also: AsImage
-AsScreenshotKind
-as_screenshot_kind_from_string (const gchar *kind
);
-Converts the text representation to an enumerated value.
- - -const gchar *
-as_screenshot_kind_to_string (AsScreenshotKind kind
);
-Converts the enumerated value to an text representation.
- - -gboolean
-as_screenshot_is_valid (AsScreenshot *screenshot
);
-Performs a quick validation on this screenshot
- - -AsScreenshotKind
-as_screenshot_get_kind (AsScreenshot *screenshot
);
-Gets the screenshot kind.
- - -void -as_screenshot_set_kind (-AsScreenshot *screenshot
, -AsScreenshotKind kind
);
Sets the screenshot kind.
-screenshot |
-a AsScreenshot instance. |
-- |
kind |
-the AsScreenshotKind. |
-- |
const gchar *
-as_screenshot_get_caption (AsScreenshot *screenshot
);
-Gets the image caption
- - -void -as_screenshot_set_caption (-AsScreenshot *screenshot
, -const gchar *caption
, -const gchar *locale
);
Sets a caption on the screenshot
-screenshot |
-a AsScreenshot instance. |
-- |
caption |
-the caption text. |
-- |
GPtrArray *
-as_screenshot_get_images (AsScreenshot *screenshot
);
-Gets the image sizes included in the screenshot.
- - -void -as_screenshot_add_image (-AsScreenshot *screenshot
, -AsImage *image
);
Adds an image to the screenshot.
-screenshot |
-a AsScreenshot instance. |
-- |
image |
-a AsImage instance. |
-- |
gchar *
-as_screenshot_get_active_locale (AsScreenshot *screenshot
);
-Get the current active locale, which -is used to get localized messages.
-void -as_screenshot_set_active_locale (-AsScreenshot *screenshot
, -const gchar *locale
);
Set the current active locale, which -is used to get localized messages. -If the AsComponent linking this AsScreenshot was fetched -from a localized database, usually only -one locale is available.
--Top - | -- | - | - | - |
-AsSearchQuery * - | --as_search_query_new () - | -
-AsSearchQuery * - | --as_search_query_construct () - | -
-void - | --as_search_query_set_search_term () - | -
-gboolean - | --as_search_query_get_search_all_categories () - | -
-gchar ** - | --as_search_query_get_categories () - | -
-void - | --as_search_query_set_search_all_categories () - | -
-void - | --as_search_query_set_categories () - | -
-void - | --as_search_query_set_categories_from_string () - | -
-void - | --as_search_query_sanitize_search_term () - | -
const gchar * - | --as_search_query_get_search_term () - | -
GStrv | -categories | -Read / Write | -
-gchar * | -search-term | -Read / Write | -
This object defines a search run in the Appstream components database. -It contains a string to search for, as well as information which -categories should be searched. -It also applies some sanity checks and improvements to the entered search string.
-See also: AsDatabase
-AsSearchQuery *
-as_search_query_new (const gchar *term
);
-Creates a new AsSearchQuery.
- - -AsSearchQuery * -as_search_query_construct (-GType object_type
, -const gchar *term
);
Construct a new AsSearchQuery.
- -void -as_search_query_set_search_term (-AsSearchQuery *self
, -const gchar *value
);
Set the search-term we use for the search. Multiple terms may be -comma-separated. -You can use Xapian prefixes, such as "XP" to refine your search.
-self |
-an instance of AsSearchQuery |
-- |
value |
-the string to search for |
-- |
gboolean
-as_search_query_get_search_all_categories
- (AsSearchQuery *self
);
-
-gchar **
-as_search_query_get_categories (AsSearchQuery *self
);
-
-void
-as_search_query_set_search_all_categories
- (AsSearchQuery *self
);
-Shortcut to set that we should search in all categories
- -void -as_search_query_set_categories (-AsSearchQuery *self
, -gchar **value
);
Set the categories to search
-self |
-an instance of AsSearchQuery |
-- |
value |
-a null-terminated string array of categories. |
-[array zero-terminated=1] | -
void -as_search_query_set_categories_from_string - (-AsSearchQuery *self
, -const gchar *categories_str
);
Set the categories list from a string
-self |
-an instance of AsSearchQuery |
-- |
categories_str |
-Semicolon-separated list of category-names |
-- |
void
-as_search_query_sanitize_search_term (AsSearchQuery *self
);
--
-const gchar *
-as_search_query_get_search_term (AsSearchQuery *self
);
-
-
--Top - | -- | - | - | - |
-AsValidator * - | --as_validator_new () - | -
-void - | --as_validator_clear_issues () - | -
-gboolean - | --as_validator_validate_file () - | -
-gboolean - | --as_validator_validate_data () - | -
-gboolean - | --as_validator_validate_tree () - | -
-GList * - | --as_validator_get_issues () - | -
#define | -AS_TYPE_VALIDATOR | -
struct | -AsValidatorClass | -
- | AsValidator | -
This object is able to validate AppStream XML metadata (distro and upstream) -and to generate a report about issues found with it.
-See also: AsMetadata
-void
-as_validator_clear_issues (AsValidator *validator
);
-Clears the list of issues
- -gboolean -as_validator_validate_file (-AsValidator *validator
, -GFile *metadata_file
);
Validate an AppStream XML file
-validator |
-An instance of AsValidator. |
-- |
metadata_file |
-An AppStream XML file. |
-- |
gboolean -as_validator_validate_data (-AsValidator *validator
, -const gchar *metadata
);
Validate AppStream XML data
-validator |
-An instance of AsValidator. |
-- |
metadata |
-XML metadata. |
-- |
gboolean -as_validator_validate_tree (-AsValidator *validator
, -const gchar *root_dir
);
Validate a full directory tree for issues in AppStream metadata.
-validator |
-An instance of AsValidator. |
-- |
root_dir |
-The root directory of the filesystem tree that should be validated. |
-- |
GList *
-as_validator_get_issues (AsValidator *validator
);
-Get a list of found metadata format issues.
- - a list of AsValidatorIssue instances, free with g_list_free()
.
[element-type AsValidatorIssue][transfer container]
--Top - | -- | - | - | - |
-AsValidatorIssue-AsValidatorIssue — Object representing an issue found in AppStream metadata - |
-- |
-AsValidatorIssue * - | --as_validator_issue_new () - | -
-AsIssueKind - | --as_validator_issue_get_kind () - | -
-void - | --as_validator_issue_set_kind () - | -
-AsIssueImportance - | --as_validator_issue_get_importance () - | -
-void - | --as_validator_issue_set_importance () - | -
const gchar * - | --as_validator_issue_get_message () - | -
-void - | --as_validator_issue_set_message () - | -
const gchar * - | --as_validator_issue_get_location () - | -
-void - | --as_validator_issue_set_location () - | -
#define | -AS_TYPE_VALIDATOR_ISSUE | -
struct | -AsValidatorIssueClass | -
enum | -AsIssueImportance | -
enum | -AsIssueKind | -
- | AsValidatorIssue | -
AsValidatorIssue *
-as_validator_issue_new (void
);
-Creates a new AsValidatorIssue.
- -AsIssueKind
-as_validator_issue_get_kind (AsValidatorIssue *issue
);
-Gets the issue kind enum, if available.
- - -void -as_validator_issue_set_kind (-AsValidatorIssue *issue
, -AsIssueKind kind
);
Sets the kind enum for this issue, if known.
-issue |
-a AsValidatorIssue instance. |
-- |
kind |
-the AsIssueKind. |
-- |
AsIssueImportance
-as_validator_issue_get_importance (AsValidatorIssue *issue
);
-Gets the importance of this issue.
- - -void -as_validator_issue_set_importance (-AsValidatorIssue *issue
, -AsIssueImportance importance
);
Sets the importance for this issue.
-issue |
-a AsValidatorIssue instance. |
-- |
importance |
-the AsIssueImportance. |
-- |
const gchar *
-as_validator_issue_get_message (AsValidatorIssue *issue
);
-Gets the message for the issue.
- - -void -as_validator_issue_set_message (-AsValidatorIssue *issue
, -const gchar *message
);
Sets a message on the issue.
-issue |
-a AsValidatorIssue instance. |
-- |
message |
-the message text. |
-- |
const gchar *
-as_validator_issue_get_location (AsValidatorIssue *issue
);
-Gets a location hint for the issue.
- - -void -as_validator_issue_set_location (-AsValidatorIssue *issue
, -const gchar *location
);
Sets a location hint for this issue.
-issue |
-a AsValidatorIssue instance. |
-- |
location |
-a location hint. |
-- |
struct AsValidatorIssueClass { - GObjectClass parent_class; -}; --
-
-The importance of an issue found by AsValidator
- -The issue type.
-- |
- Type invalid or not known - |
-- |
- |
- The XML markup is invalid - |
-- |
- |
- An element from a legacy AppStream specification has been found - |
-- |
- |
- A tag is duplicated - |
-- |
- |
- A required tag is missing - |
-- |
- |
- An unknown tag was found - |
-- |
- |
- A tag is not allowed in the current context - |
-- |
- |
- A required property is missing - |
-- |
- |
- A property is invalid - |
-- |
- |
- A value is missing - |
-- |
- |
- The value of a tag or property is wrong - |
-- |
- |
- There is an issue with a tag or property value (often non-fatal) - |
-- |
- |
- A required file or other metadata was missing - |
-- |
- |
- The naming of an entity is wrong - |
-- |
- |
- Reading of data failed - |
-- |
- | - | - | - | - |
- | - | - | - | - |
AppStream Library Reference Manual |
---|
- The latest version of this documentation can be found on-line at - freedesktop.org/software/appstream/docs/api/html. -