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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
<!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-provides</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="appstream-as-enums.html" title="as-enums">
<link rel="next" href="AsValidator.html" title="AsValidator">
<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-provides.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-as-enums.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="AsValidator.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="appstream-as-provides"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="appstream-as-provides.top_of_page"></a>as-provides</span></h2>
<p>as-provides — Description of the provides-types in components</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="appstream-as-provides.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-provides.html#as-provides-kind-to-string" title="as_provides_kind_to_string ()">as_provides_kind_to_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="appstream-as-provides.html#AsProvidesKind" title="enum AsProvidesKind"><span class="returnvalue">AsProvidesKind</span></a>
</td>
<td class="function_name">
<a class="link" href="appstream-as-provides.html#as-provides-kind-from-string" title="as_provides_kind_from_string ()">as_provides_kind_from_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<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-provides.html#as-provides-item-create" title="as_provides_item_create ()">as_provides_item_create</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="appstream-as-provides.html#AsProvidesKind" title="enum AsProvidesKind"><span class="returnvalue">AsProvidesKind</span></a>
</td>
<td class="function_name">
<a class="link" href="appstream-as-provides.html#as-provides-item-get-kind" title="as_provides_item_get_kind ()">as_provides_item_get_kind</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<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-provides.html#as-provides-item-get-value" title="as_provides_item_get_value ()">as_provides_item_get_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="appstream-as-provides.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-provides.html#AsProvidesKind" title="enum AsProvidesKind">AsProvidesKind</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="appstream-as-provides.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <appstream.h>
</pre>
</div>
<div class="refsect1">
<a name="appstream-as-provides.description"></a><h2>Description</h2>
<p>Components can provide various items, like libraries, Python-modules,
firmware, binaries, etc.
Functions to work with these items are provided here.</p>
<p>See also: <a class="link" href="AsComponent.html" title="AsComponent"><span class="type">AsComponent</span></a></p>
</div>
<div class="refsect1">
<a name="appstream-as-provides.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="as-provides-kind-to-string"></a><h3>as_provides_kind_to_string ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
as_provides_kind_to_string (<em class="parameter"><code><a class="link" href="appstream-as-provides.html#AsProvidesKind" title="enum AsProvidesKind"><span class="type">AsProvidesKind</span></a> kind</code></em>);</pre>
<p>Converts the enumerated value to an text representation.</p>
<div class="refsect3">
<a name="id-1.2.14.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>kind</p></td>
<td class="parameter_description"><p>the <a class="link" href="appstream-as-provides.html#AsProvidesKind" title="enum AsProvidesKind"><span class="type">AsProvidesKind</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.14.7.2.6"></a><h4>Returns</h4>
<p> string version of <em class="parameter"><code>kind</code></em>
</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-provides-kind-from-string"></a><h3>as_provides_kind_from_string ()</h3>
<pre class="programlisting"><a class="link" href="appstream-as-provides.html#AsProvidesKind" title="enum AsProvidesKind"><span class="returnvalue">AsProvidesKind</span></a>
as_provides_kind_from_string (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *kind_str</code></em>);</pre>
<p>Converts the text representation to an enumerated value.</p>
<div class="refsect3">
<a name="id-1.2.14.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>kind_str</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.14.7.3.6"></a><h4>Returns</h4>
<p> a <a class="link" href="appstream-as-provides.html#AsProvidesKind" title="enum AsProvidesKind"><span class="type">AsProvidesKind</span></a> or <a class="link" href="appstream-as-provides.html#AS-PROVIDES-KIND-UNKNOWN:CAPS"><code class="literal">AS_PROVIDES_KIND_UNKNOWN</code></a> for unknown</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-provides-item-create"></a><h3>as_provides_item_create ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
as_provides_item_create (<em class="parameter"><code><a class="link" href="appstream-as-provides.html#AsProvidesKind" title="enum AsProvidesKind"><span class="type">AsProvidesKind</span></a> kind</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *data</code></em>);</pre>
<p>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)</p>
<p><em class="parameter"><code>kind</code></em>
a <a class="link" href="appstream-as-provides.html#AsProvidesKind" title="enum AsProvidesKind"><span class="type">AsProvidesKind</span></a> describing the type of the item string
<em class="parameter"><code>value</code></em>
the name of the item as string
<em class="parameter"><code>data</code></em>
(allow-none) (default NULL): additional data associated with this item</p>
<div class="refsect3">
<a name="id-1.2.14.7.4.6"></a><h4>Returns</h4>
<p> a new provides-item string. Free with g_free</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-provides-item-get-kind"></a><h3>as_provides_item_get_kind ()</h3>
<pre class="programlisting"><a class="link" href="appstream-as-provides.html#AsProvidesKind" title="enum AsProvidesKind"><span class="returnvalue">AsProvidesKind</span></a>
as_provides_item_get_kind (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *item</code></em>);</pre>
<p>Returns the type (kind) of a provides-item string
as <a class="link" href="appstream-as-provides.html#AsProvidesKind" title="enum AsProvidesKind"><span class="type">AsProvidesKind</span></a></p>
<p><em class="parameter"><code>item</code></em>
a valid provides-item string</p>
<div class="refsect3">
<a name="id-1.2.14.7.5.6"></a><h4>Returns</h4>
<p> the kind of the given item</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-provides-item-get-value"></a><h3>as_provides_item_get_value ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
as_provides_item_get_value (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *item</code></em>);</pre>
<p>Returns the value (name) of a provides-item string</p>
<p><em class="parameter"><code>item</code></em>
a valid provides-item string</p>
<div class="refsect3">
<a name="id-1.2.14.7.6.6"></a><h4>Returns</h4>
<p> the value of the given item, or NULL if the item was invalid</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="appstream-as-provides.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AsProvidesKind"></a><h3>enum AsProvidesKind</h3>
<p>Public interfaces components can provide.</p>
<div class="refsect3">
<a name="id-1.2.14.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-PROVIDES-KIND-UNKNOWN:CAPS"></a>AS_PROVIDES_KIND_UNKNOWN</p></td>
<td class="enum_member_description">
<p>Unknown kind</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="AS-PROVIDES-KIND-LIBRARY:CAPS"></a>AS_PROVIDES_KIND_LIBRARY</p></td>
<td class="enum_member_description">
<p>A shared library</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="AS-PROVIDES-KIND-BINARY:CAPS"></a>AS_PROVIDES_KIND_BINARY</p></td>
<td class="enum_member_description">
<p>A binary installed into a directory in PATH</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="AS-PROVIDES-KIND-FONT:CAPS"></a>AS_PROVIDES_KIND_FONT</p></td>
<td class="enum_member_description">
<p>A font</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="AS-PROVIDES-KIND-MODALIAS:CAPS"></a>AS_PROVIDES_KIND_MODALIAS</p></td>
<td class="enum_member_description">
<p>A modalias</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="AS-PROVIDES-KIND-FIRMWARE:CAPS"></a>AS_PROVIDES_KIND_FIRMWARE</p></td>
<td class="enum_member_description">
<p>Kernel firmware</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="AS-PROVIDES-KIND-PYTHON2:CAPS"></a>AS_PROVIDES_KIND_PYTHON2</p></td>
<td class="enum_member_description">
<p>A Python2 module</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="AS-PROVIDES-KIND-PYTHON3:CAPS"></a>AS_PROVIDES_KIND_PYTHON3</p></td>
<td class="enum_member_description">
<p>A Python3 module</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="AS-PROVIDES-KIND-MIMETYPE:CAPS"></a>AS_PROVIDES_KIND_MIMETYPE</p></td>
<td class="enum_member_description">
<p>Provides a handler for a mimetype</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="AS-PROVIDES-KIND-DBUS:CAPS"></a>AS_PROVIDES_KIND_DBUS</p></td>
<td class="enum_member_description">
<p>A DBus service name</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.21</div>
</body>
</html>
|
