File: appstream-as-enums.html

package info (click to toggle)
appstream 0.7.3-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 7,660 kB
  • ctags: 2,618
  • sloc: xml: 10,142; ansic: 8,362; cpp: 1,905; python: 236; sh: 58; makefile: 13
file content (209 lines) | stat: -rw-r--r-- 8,566 bytes parent folder | download | duplicates (2) 
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AppStream Library Reference Manual: as-enums</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<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="AsCategory.html" title="AsCategory">
<link rel="next" href="appstream-as-provides.html" title="as-provides">
<meta name="generator" content="GTK-Doc V1.21 (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="AsCategory.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="appstream-as-provides.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 width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<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>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="appstream-as-enums.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table 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></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="appstream-as-enums.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;appstream.h&gt;
</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-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="id-1.2.13.7.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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="id-1.2.13.7.2.6"></a><h4>Returns</h4>
<p> string version of <em class="parameter"><code>url_kind</code></em>
</p>
<p></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="id-1.2.13.7.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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="id-1.2.13.7.3.6"></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>
<p></p>
</div>
</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="id-1.2.13.8.2.4"></a><h4>Members</h4>
<div class="informaltable"><table 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-LAST:CAPS"></a>AS_URL_KIND_LAST</p></td>
<td class="enum_member_description"> </td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.21</div>
</body>
</html>