1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<refentry id="appstream-as-enums">
<refmeta>
<refentrytitle role="top_of_page" id="appstream-as-enums.top_of_page">as-enums</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
APPSTREAM Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>as-enums</refname>
<refpurpose>Some enums used by various other modules</refpurpose>
</refnamediv>
<refsect1 id="appstream-as-enums.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_return" colwidth="150px"/>
<colspec colname="functions_name"/>
<tbody>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *
</entry><entry role="function_name"><link linkend="as-url-kind-to-string">as_url_kind_to_string</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="AsUrlKind"><returnvalue>AsUrlKind</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-url-kind-from-string">as_url_kind_from_string</link> <phrase role="c_punctuation">()</phrase></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="appstream-as-enums.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="name" colwidth="150px"/>
<colspec colname="description"/>
<tbody>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="AsUrlKind">AsUrlKind</link></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="appstream-as-enums.includes"><title>Includes</title><synopsis>#include <appstream.h>
</synopsis></refsect1>
<refsect1 id="appstream-as-enums.description" role="desc">
<title role="desc.title">Description</title>
</refsect1>
<refsect1 id="appstream-as-enums.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="as-url-kind-to-string" role="function">
<title>as_url_kind_to_string ()</title>
<indexterm zone="as-url-kind-to-string"><primary>as_url_kind_to_string</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *
as_url_kind_to_string (<parameter><link linkend="AsUrlKind"><type>AsUrlKind</type></link> url_kind</parameter>);</programlisting>
<para>Converts the enumerated value to an text representation.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>url_kind</para></entry>
<entry role="parameter_description"><para>the <link linkend="AsUrlKind"><literal>AsUrlKind</literal></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> string version of <parameter>url_kind</parameter>
</para>
<para></para>
</refsect3></refsect2>
<refsect2 id="as-url-kind-from-string" role="function">
<title>as_url_kind_from_string ()</title>
<indexterm zone="as-url-kind-from-string"><primary>as_url_kind_from_string</primary></indexterm>
<programlisting language="C"><link linkend="AsUrlKind"><returnvalue>AsUrlKind</returnvalue></link>
as_url_kind_from_string (<parameter>const <link linkend="gchar"><type>gchar</type></link> *url_kind</parameter>);</programlisting>
<para>Converts the text representation to an enumerated value.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>url_kind</para></entry>
<entry role="parameter_description"><para>the string.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> a <link linkend="AsUrlKind"><type>AsUrlKind</type></link> or <link linkend="AS-URL-KIND-UNKNOWN:CAPS"><literal>AS_URL_KIND_UNKNOWN</literal></link> for unknown</para>
<para></para>
</refsect3></refsect2>
</refsect1>
<refsect1 id="appstream-as-enums.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="AsUrlKind" role="enum">
<title>enum AsUrlKind</title>
<indexterm zone="AsUrlKind"><primary>AsUrlKind</primary></indexterm>
<para>The URL type.</para>
<refsect3 role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="AS-URL-KIND-UNKNOWN:CAPS">AS_URL_KIND_UNKNOWN</para></entry>
<entry role="enum_member_description"><para>Type invalid or not known</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-URL-KIND-HOMEPAGE:CAPS">AS_URL_KIND_HOMEPAGE</para></entry>
<entry role="enum_member_description"><para>Project homepage</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-URL-KIND-BUGTRACKER:CAPS">AS_URL_KIND_BUGTRACKER</para></entry>
<entry role="enum_member_description"><para>Bugtracker</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-URL-KIND-FAQ:CAPS">AS_URL_KIND_FAQ</para></entry>
<entry role="enum_member_description"><para>FAQ page</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-URL-KIND-HELP:CAPS">AS_URL_KIND_HELP</para></entry>
<entry role="enum_member_description"><para>Help manual</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-URL-KIND-DONATION:CAPS">AS_URL_KIND_DONATION</para></entry>
<entry role="enum_member_description"><para>Page with information about how to donate to the project</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-URL-KIND-LAST:CAPS">AS_URL_KIND_LAST</para></entry>
<entry role="enum_member_description"></entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
</refsect1>
</refentry>
|
