<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>as-enums: AppStream Library Reference Manual</title> <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> <link rel="home" href="index.html" title="AppStream Library Reference Manual"> <link rel="up" href="ch01.html" title="AppStream API Reference"> <link rel="prev" href="appstream-AsComponent.html" title="AsComponent"> <link rel="next" href="appstream-AsIcon.html" title="AsIcon"> <meta name="generator" content="GTK-Doc V1.29 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> <td width="100%" align="left" class="shortcuts"> <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> <a href="#appstream-as-enums.description" class="shortcut">Description</a></span> </td> <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> <td><a accesskey="p" href="appstream-AsComponent.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> <td><a accesskey="n" href="appstream-AsIcon.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="refentry"> <a name="appstream-as-enums"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> <h2><span class="refentrytitle"><a name="appstream-as-enums.top_of_page"></a>as-enums</span></h2> <p>as-enums — Some enums used by various other modules</p> </td> <td class="gallery_image" valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> <a name="appstream-as-enums.functions"></a><h2>Functions</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="functions_return"> <col class="functions_name"> </colgroup> <tbody> <tr> <td class="define_keyword">#define</td> <td class="function_name"> <a class="link" href="appstream-as-enums.html#as-flags-add" title="as_flags_add()">as_flags_add</a><span class="c_punctuation">()</span> </td> </tr> <tr> <td class="define_keyword">#define</td> <td class="function_name"> <a class="link" href="appstream-as-enums.html#as-flags-remove" title="as_flags_remove()">as_flags_remove</a><span class="c_punctuation">()</span> </td> </tr> <tr> <td class="define_keyword">#define</td> <td class="function_name"> <a class="link" href="appstream-as-enums.html#as-flags-invert" title="as_flags_invert()">as_flags_invert</a><span class="c_punctuation">()</span> </td> </tr> <tr> <td class="define_keyword">#define</td> <td class="function_name"> <a class="link" href="appstream-as-enums.html#as-flags-contains" title="as_flags_contains()">as_flags_contains</a><span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * </td> <td class="function_name"> <a class="link" href="appstream-as-enums.html#as-url-kind-to-string" title="as_url_kind_to_string ()">as_url_kind_to_string</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <a class="link" href="appstream-as-enums.html#AsUrlKind" title="enum AsUrlKind"><span class="returnvalue">AsUrlKind</span></a> </td> <td class="function_name"> <a class="link" href="appstream-as-enums.html#as-url-kind-from-string" title="as_url_kind_from_string ()">as_url_kind_from_string</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * </td> <td class="function_name"> <a class="link" href="appstream-as-enums.html#as-urgency-kind-to-string" title="as_urgency_kind_to_string ()">as_urgency_kind_to_string</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <a class="link" href="appstream-as-enums.html#AsUrgencyKind" title="enum AsUrgencyKind"><span class="returnvalue">AsUrgencyKind</span></a> </td> <td class="function_name"> <a class="link" href="appstream-as-enums.html#as-urgency-kind-from-string" title="as_urgency_kind_from_string ()">as_urgency_kind_from_string</a> <span class="c_punctuation">()</span> </td> </tr> </tbody> </table></div> </div> <div class="refsect1"> <a name="appstream-as-enums.other"></a><h2>Types and Values</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="name"> <col class="description"> </colgroup> <tbody> <tr> <td class="datatype_keyword">enum</td> <td class="function_name"><a class="link" href="appstream-as-enums.html#AsUrlKind" title="enum AsUrlKind">AsUrlKind</a></td> </tr> <tr> <td class="datatype_keyword">enum</td> <td class="function_name"><a class="link" href="appstream-as-enums.html#AsUrgencyKind" title="enum AsUrgencyKind">AsUrgencyKind</a></td> </tr> </tbody> </table></div> </div> <div class="refsect1"> <a name="appstream-as-enums.includes"></a><h2>Includes</h2> <pre class="synopsis">#include <appstream.h> </pre> </div> <div class="refsect1"> <a name="appstream-as-enums.description"></a><h2>Description</h2> </div> <div class="refsect1"> <a name="appstream-as-enums.functions_details"></a><h2>Functions</h2> <div class="refsect2"> <a name="as-flags-add"></a><h3>as_flags_add()</h3> <pre class="programlisting">#define as_flags_add(bitfield,enum) do { ((bitfield) |= enum); } while (0) </pre> </div> <hr> <div class="refsect2"> <a name="as-flags-remove"></a><h3>as_flags_remove()</h3> <pre class="programlisting">#define as_flags_remove(bitfield,enum) do { ((bitfield) &= ~enum); } while (0) </pre> </div> <hr> <div class="refsect2"> <a name="as-flags-invert"></a><h3>as_flags_invert()</h3> <pre class="programlisting">#define as_flags_invert(bitfield,enum) do { ((bitfield) ^= enum); } while (0) </pre> </div> <hr> <div class="refsect2"> <a name="as-flags-contains"></a><h3>as_flags_contains()</h3> <pre class="programlisting">#define as_flags_contains(bitfield,enum) (((bitfield) & enum) > 0) </pre> </div> <hr> <div class="refsect2"> <a name="as-url-kind-to-string"></a><h3>as_url_kind_to_string ()</h3> <pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * as_url_kind_to_string (<em class="parameter"><code><a class="link" href="appstream-as-enums.html#AsUrlKind" title="enum AsUrlKind"><span class="type">AsUrlKind</span></a> url_kind</code></em>);</pre> <p>Converts the enumerated value to an text representation.</p> <div class="refsect3"> <a name="as-url-kind-to-string.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody><tr> <td class="parameter_name"><p>url_kind</p></td> <td class="parameter_description"><p>the <a class="link" href="appstream-as-enums.html#AsUrlKind" title="enum AsUrlKind"><code class="literal">AsUrlKind</code></a>.</p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="as-url-kind-to-string.returns"></a><h4>Returns</h4> <p> string version of <em class="parameter"><code>url_kind</code></em> </p> </div> </div> <hr> <div class="refsect2"> <a name="as-url-kind-from-string"></a><h3>as_url_kind_from_string ()</h3> <pre class="programlisting"><a class="link" href="appstream-as-enums.html#AsUrlKind" title="enum AsUrlKind"><span class="returnvalue">AsUrlKind</span></a> as_url_kind_from_string (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url_kind</code></em>);</pre> <p>Converts the text representation to an enumerated value.</p> <div class="refsect3"> <a name="as-url-kind-from-string.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody><tr> <td class="parameter_name"><p>url_kind</p></td> <td class="parameter_description"><p>the string.</p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="as-url-kind-from-string.returns"></a><h4>Returns</h4> <p> a <a class="link" href="appstream-as-enums.html#AsUrlKind" title="enum AsUrlKind"><span class="type">AsUrlKind</span></a> or <a class="link" href="appstream-as-enums.html#AS-URL-KIND-UNKNOWN:CAPS"><code class="literal">AS_URL_KIND_UNKNOWN</code></a> for unknown</p> </div> </div> <hr> <div class="refsect2"> <a name="as-urgency-kind-to-string"></a><h3>as_urgency_kind_to_string ()</h3> <pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * as_urgency_kind_to_string (<em class="parameter"><code><a class="link" href="appstream-as-enums.html#AsUrgencyKind" title="enum AsUrgencyKind"><span class="type">AsUrgencyKind</span></a> urgency_kind</code></em>);</pre> <p>Converts the enumerated value to an text representation.</p> <div class="refsect3"> <a name="as-urgency-kind-to-string.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody><tr> <td class="parameter_name"><p>urgency_kind</p></td> <td class="parameter_description"><p>the <a class="link" href="appstream-as-enums.html#AsUrgencyKind" title="enum AsUrgencyKind"><code class="literal">AsUrgencyKind</code></a>.</p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="as-urgency-kind-to-string.returns"></a><h4>Returns</h4> <p> string version of <em class="parameter"><code>urgency_kind</code></em> </p> </div> <p class="since">Since: 0.6.5</p> </div> <hr> <div class="refsect2"> <a name="as-urgency-kind-from-string"></a><h3>as_urgency_kind_from_string ()</h3> <pre class="programlisting"><a class="link" href="appstream-as-enums.html#AsUrgencyKind" title="enum AsUrgencyKind"><span class="returnvalue">AsUrgencyKind</span></a> as_urgency_kind_from_string (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *urgency_kind</code></em>);</pre> <p>Converts the text representation to an enumerated value.</p> <div class="refsect3"> <a name="as-urgency-kind-from-string.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody><tr> <td class="parameter_name"><p>urgency_kind</p></td> <td class="parameter_description"><p>the string.</p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="as-urgency-kind-from-string.returns"></a><h4>Returns</h4> <p> a <a class="link" href="appstream-as-enums.html#AsUrgencyKind" title="enum AsUrgencyKind"><code class="literal">AsUrgencyKind</code></a> or <a class="link" href="appstream-as-enums.html#AS-URGENCY-KIND-UNKNOWN:CAPS"><code class="literal">AS_URGENCY_KIND_UNKNOWN</code></a> for unknown</p> </div> <p class="since">Since: 0.6.5</p> </div> </div> <div class="refsect1"> <a name="appstream-as-enums.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> <a name="AsUrlKind"></a><h3>enum AsUrlKind</h3> <p>The URL type.</p> <div class="refsect3"> <a name="AsUrlKind.members"></a><h4>Members</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="300px" class="enum_members_name"> <col class="enum_members_description"> <col width="200px" class="enum_members_annotations"> </colgroup> <tbody> <tr> <td class="enum_member_name"><p><a name="AS-URL-KIND-UNKNOWN:CAPS"></a>AS_URL_KIND_UNKNOWN</p></td> <td class="enum_member_description"> <p>Type invalid or not known</p> </td> <td class="enum_member_annotations"> </td> </tr> <tr> <td class="enum_member_name"><p><a name="AS-URL-KIND-HOMEPAGE:CAPS"></a>AS_URL_KIND_HOMEPAGE</p></td> <td class="enum_member_description"> <p>Project homepage</p> </td> <td class="enum_member_annotations"> </td> </tr> <tr> <td class="enum_member_name"><p><a name="AS-URL-KIND-BUGTRACKER:CAPS"></a>AS_URL_KIND_BUGTRACKER</p></td> <td class="enum_member_description"> <p>Bugtracker</p> </td> <td class="enum_member_annotations"> </td> </tr> <tr> <td class="enum_member_name"><p><a name="AS-URL-KIND-FAQ:CAPS"></a>AS_URL_KIND_FAQ</p></td> <td class="enum_member_description"> <p>FAQ page</p> </td> <td class="enum_member_annotations"> </td> </tr> <tr> <td class="enum_member_name"><p><a name="AS-URL-KIND-HELP:CAPS"></a>AS_URL_KIND_HELP</p></td> <td class="enum_member_description"> <p>Help manual</p> </td> <td class="enum_member_annotations"> </td> </tr> <tr> <td class="enum_member_name"><p><a name="AS-URL-KIND-DONATION:CAPS"></a>AS_URL_KIND_DONATION</p></td> <td class="enum_member_description"> <p>Page with information about how to donate to the project</p> </td> <td class="enum_member_annotations"> </td> </tr> <tr> <td class="enum_member_name"><p><a name="AS-URL-KIND-TRANSLATE:CAPS"></a>AS_URL_KIND_TRANSLATE</p></td> <td class="enum_member_description"> <p>Page with instructions on how to translate the project / submit translations.</p> </td> <td class="enum_member_annotations"> </td> </tr> <tr> <td class="enum_member_name"><p><a name="AS-URL-KIND-CONTACT:CAPS"></a>AS_URL_KIND_CONTACT</p></td> <td class="enum_member_description"> <p>Contact the developers</p> </td> <td class="enum_member_annotations"> </td> </tr> </tbody> </table></div> </div> </div> <hr> <div class="refsect2"> <a name="AsUrgencyKind"></a><h3>enum AsUrgencyKind</h3> <p>The urgency of an <a class="link" href="appstream-AsRelease.html#AsRelease" title="AsRelease"><span class="type">AsRelease</span></a></p> <div class="refsect3"> <a name="AsUrgencyKind.members"></a><h4>Members</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="300px" class="enum_members_name"> <col class="enum_members_description"> <col width="200px" class="enum_members_annotations"> </colgroup> <tbody> <tr> <td class="enum_member_name"><p><a name="AS-URGENCY-KIND-UNKNOWN:CAPS"></a>AS_URGENCY_KIND_UNKNOWN</p></td> <td class="enum_member_description"> <p>Urgency is unknown or not set</p> </td> <td class="enum_member_annotations"> </td> </tr> <tr> <td class="enum_member_name"><p><a name="AS-URGENCY-KIND-LOW:CAPS"></a>AS_URGENCY_KIND_LOW</p></td> <td class="enum_member_description"> <p>Low urgency</p> </td> <td class="enum_member_annotations"> </td> </tr> <tr> <td class="enum_member_name"><p><a name="AS-URGENCY-KIND-MEDIUM:CAPS"></a>AS_URGENCY_KIND_MEDIUM</p></td> <td class="enum_member_description"> <p>Medium urgency</p> </td> <td class="enum_member_annotations"> </td> </tr> <tr> <td class="enum_member_name"><p><a name="AS-URGENCY-KIND-HIGH:CAPS"></a>AS_URGENCY_KIND_HIGH</p></td> <td class="enum_member_description"> <p>High urgency</p> </td> <td class="enum_member_annotations"> </td> </tr> <tr> <td class="enum_member_name"><p><a name="AS-URGENCY-KIND-CRITICAL:CAPS"></a>AS_URGENCY_KIND_CRITICAL</p></td> <td class="enum_member_description"> <p>Critical urgency</p> </td> <td class="enum_member_annotations"> </td> </tr> </tbody> </table></div> </div> </div> </div> </div> <div class="footer"> <hr>Generated by GTK-Doc V1.29</div> </body> </html>