as-enums

as-enums — Helper functions for converting to and from enum strings

Stability Level

Stable, unless otherwise indicated

Synopsis

#include <appstream-glib.h>

enum                AsIdKind;
enum                AsUrlKind;
enum                AsKudoKind;
enum                AsUrgencyKind;
const gchar *       as_urgency_kind_to_string           (AsUrgencyKind urgency_kind);
AsUrgencyKind       as_urgency_kind_from_string         (const gchar *urgency_kind);
const gchar *       as_id_kind_to_string                (AsIdKind id_kind);
AsIdKind            as_id_kind_from_string              (const gchar *id_kind);
const gchar *       as_url_kind_to_string               (AsUrlKind url_kind);
AsUrlKind           as_url_kind_from_string             (const gchar *url_kind);
const gchar *       as_kudo_kind_to_string              (AsKudoKind kudo_kind);
AsKudoKind          as_kudo_kind_from_string            (const gchar *kudo_kind);

Description

These helper functions may be useful if implementing an AppStream parser.

Details

enum AsIdKind

typedef enum {
	AS_ID_KIND_UNKNOWN,		/* Since: 0.1.0 */
	AS_ID_KIND_DESKTOP,		/* Since: 0.1.0 */
	AS_ID_KIND_FONT,		/* Since: 0.1.0 */
	AS_ID_KIND_CODEC,		/* Since: 0.1.0 */
	AS_ID_KIND_INPUT_METHOD, /* Since: 0.1.0 */
	AS_ID_KIND_WEB_APP,		/* Since: 0.1.0 */
	AS_ID_KIND_SOURCE,		/* Since: 0.1.0 */
	AS_ID_KIND_ADDON,		/* Since: 0.1.7 */
	AS_ID_KIND_FIRMWARE,		/* Since: 0.3.5 */
} AsIdKind;

The ID type.

AS_ID_KIND_UNKNOWN

Type invalid or not known

AS_ID_KIND_DESKTOP

A desktop application

AS_ID_KIND_FONT

A font add-on

AS_ID_KIND_CODEC

A codec add-on

AS_ID_KIND_INPUT_METHOD

A input method add-on

AS_ID_KIND_WEB_APP

A web appication

AS_ID_KIND_SOURCE

A software source

AS_ID_KIND_ADDON

An addon, e.g. a plugin

AS_ID_KIND_FIRMWARE

A firmware update

enum AsUrlKind

typedef enum {
	AS_URL_KIND_UNKNOWN,		/* Since: 0.1.0 */
	AS_URL_KIND_HOMEPAGE,		/* Since: 0.1.0 */
	AS_URL_KIND_BUGTRACKER,		/* Since: 0.1.1 */
	AS_URL_KIND_FAQ,		/* Since: 0.1.1 */
	AS_URL_KIND_DONATION,		/* Since: 0.1.1 */
	AS_URL_KIND_HELP,		/* Since: 0.1.5 */
	AS_URL_KIND_MISSING,		/* Since: 0.2.2 */
} AsUrlKind;

The URL type.

AS_URL_KIND_UNKNOWN

Type invalid or not known

AS_URL_KIND_HOMEPAGE

Application project homepage

AS_URL_KIND_BUGTRACKER

Application bugtracker

AS_URL_KIND_FAQ

Application FAQ page

AS_URL_KIND_DONATION

Application donation page

AS_URL_KIND_HELP

Application help manual

AS_URL_KIND_MISSING

The package is available, but missing

enum AsKudoKind

typedef enum {
	AS_KUDO_KIND_UNKNOWN,		/* Since: 0.2.2 */
	AS_KUDO_KIND_SEARCH_PROVIDER, /* Since: 0.2.2 */
	AS_KUDO_KIND_USER_DOCS, 	/* Since: 0.2.2 */
	AS_KUDO_KIND_APP_MENU,		/* Since: 0.2.2 */
	AS_KUDO_KIND_MODERN_TOOLKIT, /* Since: 0.2.2 */
	AS_KUDO_KIND_NOTIFICATIONS, /* Since: 0.2.2 */
	AS_KUDO_KIND_HIGH_CONTRAST, /* Since: 0.3.0 */
	AS_KUDO_KIND_HI_DPI_ICON, /* Since: 0.3.1 */
} AsKudoKind;

The kudo type.

AS_KUDO_KIND_UNKNOWN

Type invalid or not known

AS_KUDO_KIND_SEARCH_PROVIDER

Installs a search provider

AS_KUDO_KIND_USER_DOCS

Installs user documentation

AS_KUDO_KIND_APP_MENU

Uses the GNOME application menu

AS_KUDO_KIND_MODERN_TOOLKIT

Uses a modern toolkit like GTK3 or QT5

AS_KUDO_KIND_NOTIFICATIONS

Registers notifications with KDE or GNOME

AS_KUDO_KIND_HIGH_CONTRAST

Installs a high contrast icon

AS_KUDO_KIND_HI_DPI_ICON

Installs a high DPI icon

enum AsUrgencyKind

typedef enum {
	AS_URGENCY_KIND_UNKNOWN, /* Since: 0.5.1 */
	AS_URGENCY_KIND_LOW,		/* Since: 0.5.1 */
	AS_URGENCY_KIND_MEDIUM,		/* Since: 0.5.1 */
	AS_URGENCY_KIND_HIGH,		/* Since: 0.5.1 */
	AS_URGENCY_KIND_CRITICAL, /* Since: 0.5.1 */
} AsUrgencyKind;

The urgency of a release.

AS_URGENCY_KIND_UNKNOWN

Urgency invalid or not known

AS_URGENCY_KIND_LOW

Low urgency release

AS_URGENCY_KIND_MEDIUM

Medium urgency release

AS_URGENCY_KIND_HIGH

High urgency release

AS_URGENCY_KIND_CRITICAL

Critically urgent release

as_urgency_kind_to_string ()

const gchar *       as_urgency_kind_to_string           (AsUrgencyKind urgency_kind);

Converts the enumerated value to an text representation.

urgency_kind :

the AsUrgencyKind.

Returns :

string version of urgency_kind

Since 0.5.1


as_urgency_kind_from_string ()

AsUrgencyKind       as_urgency_kind_from_string         (const gchar *urgency_kind);

Converts the text representation to an enumerated value.

urgency_kind :

the string.

Returns :

a AsUrgencyKind or AS_URGENCY_KIND_UNKNOWN for unknown

Since 0.5.1


as_id_kind_to_string ()

const gchar *       as_id_kind_to_string                (AsIdKind id_kind);

Converts the enumerated value to an text representation.

id_kind :

the AsIdKind.

Returns :

string version of id_kind

Since 0.1.0


as_id_kind_from_string ()

AsIdKind            as_id_kind_from_string              (const gchar *id_kind);

Converts the text representation to an enumerated value.

id_kind :

the string.

Returns :

a AsIdKind or AS_ID_KIND_UNKNOWN for unknown

Since 0.1.0


as_url_kind_to_string ()

const gchar *       as_url_kind_to_string               (AsUrlKind url_kind);

Converts the enumerated value to an text representation.

url_kind :

the AsUrlKind.

Returns :

string version of url_kind

Since 0.1.0


as_url_kind_from_string ()

AsUrlKind           as_url_kind_from_string             (const gchar *url_kind);

Converts the text representation to an enumerated value.

url_kind :

the string.

Returns :

a AsUrlKind or AS_URL_KIND_UNKNOWN for unknown

Since 0.1.0


as_kudo_kind_to_string ()

const gchar *       as_kudo_kind_to_string              (AsKudoKind kudo_kind);

Converts the enumerated value to an text representation.

kudo_kind :

the AsKudoKind.

Returns :

string version of kudo_kind

Since 0.2.2


as_kudo_kind_from_string ()

AsKudoKind          as_kudo_kind_from_string            (const gchar *kudo_kind);

Converts the text representation to an enumerated value.

kudo_kind :

the string.

Returns :

a AsKudoKind or AS_KUDO_KIND_UNKNOWN for unknown

Since 0.2.2