/usr/share/gtk-doc/html/appstream-glib/appstream-glib-AsContentRating.html is in appstream-glib-doc 0.7.7-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AsContentRating: AppStream-glib Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="AppStream-glib Reference Manual">
<link rel="up" href="libappstream-glib.html" title="libappstream-glib GObject library">
<link rel="prev" href="appstream-glib-AsChecksum.html" title="AsChecksum">
<link rel="next" href="appstream-glib-AsFormat.html" title="AsFormat">
<meta name="generator" content="GTK-Doc V1.27 (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-glib-AsContentRating.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="libappstream-glib.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="appstream-glib-AsChecksum.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="appstream-glib-AsFormat.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="appstream-glib-AsContentRating"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="appstream-glib-AsContentRating.top_of_page"></a>AsContentRating</span></h2>
<p>AsContentRating — Object representing a content rating</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="appstream-glib-AsContentRating.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Unstable"><span class="acronym">Unstable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="appstream-glib-AsContentRating.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="function_type">
<a class="link" href="appstream-glib-AsContentRating.html#AsContentRating" title="AsContentRating"><span class="returnvalue">AsContentRating</span></a> *
</td>
<td class="function_name">
<a class="link" href="appstream-glib-AsContentRating.html#as-content-rating-new" title="as_content_rating_new ()">as_content_rating_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="appstream-glib-AsContentRating.html#as-content-rating-value-to-string" title="as_content_rating_value_to_string ()">as_content_rating_value_to_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="appstream-glib-AsContentRating.html#AsContentRatingValue" title="enum AsContentRatingValue"><span class="returnvalue">AsContentRatingValue</span></a>
</td>
<td class="function_name">
<a class="link" href="appstream-glib-AsContentRating.html#as-content-rating-value-from-string" title="as_content_rating_value_from_string ()">as_content_rating_value_from_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="appstream-glib-AsContentRating.html#as-content-rating-get-kind" title="as_content_rating_get_kind ()">as_content_rating_get_kind</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="appstream-glib-AsContentRating.html#as-content-rating-get-minimum-age" title="as_content_rating_get_minimum_age ()">as_content_rating_get_minimum_age</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="appstream-glib-AsContentRating.html#AsContentRatingValue" title="enum AsContentRatingValue"><span class="returnvalue">AsContentRatingValue</span></a>
</td>
<td class="function_name">
<a class="link" href="appstream-glib-AsContentRating.html#as-content-rating-get-value" title="as_content_rating_get_value ()">as_content_rating_get_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="appstream-glib-AsContentRating.html#as-content-rating-set-kind" title="as_content_rating_set_kind ()">as_content_rating_set_kind</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="appstream-glib-AsContentRating.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="appstream-glib-AsContentRating.html#AS-TYPE-CONTENT:CAPS" title="AS_TYPE_CONTENT">AS_TYPE_CONTENT</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="appstream-glib-AsContentRating.html#AsContentRatingClass" title="struct AsContentRatingClass">AsContentRatingClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="appstream-glib-AsContentRating.html#AsContentRatingValue" title="enum AsContentRatingValue">AsContentRatingValue</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="appstream-glib-AsContentRating.html#AsContentRating" title="AsContentRating">AsContentRating</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="appstream-glib-AsContentRating.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <appstream-glib.h>
</pre>
</div>
<div class="refsect1">
<a name="appstream-glib-AsContentRating.description"></a><h2>Description</h2>
<p>Content ratings are age-specific guidelines for applications.</p>
<p>See also: <a class="link" href="appstream-glib-AsApp.html#AsApp" title="AsApp"><span class="type">AsApp</span></a></p>
</div>
<div class="refsect1">
<a name="appstream-glib-AsContentRating.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="as-content-rating-new"></a><h3>as_content_rating_new ()</h3>
<pre class="programlisting"><a class="link" href="appstream-glib-AsContentRating.html#AsContentRating" title="AsContentRating"><span class="returnvalue">AsContentRating</span></a> *
as_content_rating_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="appstream-glib-AsContentRating.html#AsContentRating" title="AsContentRating"><span class="type">AsContentRating</span></a>.</p>
<div class="refsect3">
<a name="as-content-rating-new.returns"></a><h4>Returns</h4>
<p>a <a class="link" href="appstream-glib-AsContentRating.html#AsContentRating" title="AsContentRating"><span class="type">AsContentRating</span></a>. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
<p class="since">Since: 0.5.12</p>
</div>
<hr>
<div class="refsect2">
<a name="as-content-rating-value-to-string"></a><h3>as_content_rating_value_to_string ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
as_content_rating_value_to_string (<em class="parameter"><code><a class="link" href="appstream-glib-AsContentRating.html#AsContentRatingValue" title="enum AsContentRatingValue"><span class="type">AsContentRatingValue</span></a> value</code></em>);</pre>
<p>Converts the enumerated value to an text representation.</p>
<div class="refsect3">
<a name="as-content-rating-value-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>value</p></td>
<td class="parameter_description"><p>the <a class="link" href="appstream-glib-AsContentRating.html#AsContentRatingValue" title="enum AsContentRatingValue"><span class="type">AsContentRatingValue</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-content-rating-value-to-string.returns"></a><h4>Returns</h4>
<p> string version of <em class="parameter"><code>value</code></em>
</p>
</div>
<p class="since">Since: 0.5.12</p>
</div>
<hr>
<div class="refsect2">
<a name="as-content-rating-value-from-string"></a><h3>as_content_rating_value_from_string ()</h3>
<pre class="programlisting"><a class="link" href="appstream-glib-AsContentRating.html#AsContentRatingValue" title="enum AsContentRatingValue"><span class="returnvalue">AsContentRatingValue</span></a>
as_content_rating_value_from_string (<em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);</pre>
<p>Converts the text representation to an enumerated value.</p>
<div class="refsect3">
<a name="as-content-rating-value-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>value</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-content-rating-value-from-string.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="appstream-glib-AsContentRating.html#AsContentRatingValue" title="enum AsContentRatingValue"><span class="type">AsContentRatingValue</span></a> or <a class="link" href="appstream-glib-AsContentRating.html#AS-CONTENT-RATING-VALUE-UNKNOWN:CAPS"><code class="literal">AS_CONTENT_RATING_VALUE_UNKNOWN</code></a> for unknown</p>
</div>
<p class="since">Since: 0.5.12</p>
</div>
<hr>
<div class="refsect2">
<a name="as-content-rating-get-kind"></a><h3>as_content_rating_get_kind ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
as_content_rating_get_kind (<em class="parameter"><code><a class="link" href="appstream-glib-AsContentRating.html#AsContentRating" title="AsContentRating"><span class="type">AsContentRating</span></a> *content_rating</code></em>);</pre>
<p>Gets the content_rating kind.</p>
<div class="refsect3">
<a name="as-content-rating-get-kind.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>content_rating</p></td>
<td class="parameter_description"><p>a <a class="link" href="appstream-glib-AsContentRating.html#AsContentRating" title="AsContentRating"><span class="type">AsContentRating</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-content-rating-get-kind.returns"></a><h4>Returns</h4>
<p> a string, e.g. "oars-1.0", or NULL</p>
</div>
<p class="since">Since: 0.5.12</p>
</div>
<hr>
<div class="refsect2">
<a name="as-content-rating-get-minimum-age"></a><h3>as_content_rating_get_minimum_age ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
as_content_rating_get_minimum_age (<em class="parameter"><code><a class="link" href="appstream-glib-AsContentRating.html#AsContentRating" title="AsContentRating"><span class="type">AsContentRating</span></a> *content_rating</code></em>);</pre>
<p>Gets the lowest Common Sense Media approved age for the content_rating block.
NOTE: these numbers are based on the data and descriptions available from
https://www.commonsensemedia.org/about-us/our-mission/about-our-ratings and
you may disagree with them.</p>
<p>You're free to disagree with these, and of course you should use your own
brain to work our if your child is able to cope with the concepts enumerated
here. Some 13 year olds mey be fine with the concept of mutilation of body
parts, others may get nightmares.</p>
<div class="refsect3">
<a name="as-content-rating-get-minimum-age.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>content_rating</p></td>
<td class="parameter_description"><p>a <a class="link" href="appstream-glib-AsContentRating.html#AsContentRating" title="AsContentRating"><span class="type">AsContentRating</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-content-rating-get-minimum-age.returns"></a><h4>Returns</h4>
<p> The age in years, 0 for no rating, or G_MAXUINT for no details.</p>
</div>
<p class="since">Since: 0.5.12</p>
</div>
<hr>
<div class="refsect2">
<a name="as-content-rating-get-value"></a><h3>as_content_rating_get_value ()</h3>
<pre class="programlisting"><a class="link" href="appstream-glib-AsContentRating.html#AsContentRatingValue" title="enum AsContentRatingValue"><span class="returnvalue">AsContentRatingValue</span></a>
as_content_rating_get_value (<em class="parameter"><code><a class="link" href="appstream-glib-AsContentRating.html#AsContentRating" title="AsContentRating"><span class="type">AsContentRating</span></a> *content_rating</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);</pre>
<p>Gets the set value of a content rating key.</p>
<div class="refsect3">
<a name="as-content-rating-get-value.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>content_rating</p></td>
<td class="parameter_description"><p>a <a class="link" href="appstream-glib-AsContentRating.html#AsContentRating" title="AsContentRating"><span class="type">AsContentRating</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>id</p></td>
<td class="parameter_description"><p>A ratings ID, e.g. <code class="literal">violence-bloodshed</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-content-rating-get-value.returns"></a><h4>Returns</h4>
<p> the <a class="link" href="appstream-glib-AsContentRating.html#AsContentRatingValue" title="enum AsContentRatingValue"><span class="type">AsContentRatingValue</span></a>, or <a class="link" href="appstream-glib-AsContentRating.html#AS-CONTENT-RATING-VALUE-UNKNOWN:CAPS"><code class="literal">AS_CONTENT_RATING_VALUE_UNKNOWN</code></a></p>
</div>
<p class="since">Since: 0.6.4</p>
</div>
<hr>
<div class="refsect2">
<a name="as-content-rating-set-kind"></a><h3>as_content_rating_set_kind ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
as_content_rating_set_kind (<em class="parameter"><code><a class="link" href="appstream-glib-AsContentRating.html#AsContentRating" title="AsContentRating"><span class="type">AsContentRating</span></a> *content_rating</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *kind</code></em>);</pre>
<p>Sets the content rating kind.</p>
<div class="refsect3">
<a name="as-content-rating-set-kind.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>content_rating</p></td>
<td class="parameter_description"><p>a <a class="link" href="appstream-glib-AsContentRating.html#AsContentRating" title="AsContentRating"><span class="type">AsContentRating</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>kind</p></td>
<td class="parameter_description"><p>the rating kind, e.g. "oars-1.0"</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.5.12</p>
</div>
</div>
<div class="refsect1">
<a name="appstream-glib-AsContentRating.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AS-TYPE-CONTENT:CAPS"></a><h3>AS_TYPE_CONTENT</h3>
<pre class="programlisting">#define AS_TYPE_CONTENT (as_content_rating_get_type ())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="AsContentRatingClass"></a><h3>struct AsContentRatingClass</h3>
<pre class="programlisting">struct AsContentRatingClass {
GObjectClass parent_class;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="AsContentRatingValue"></a><h3>enum AsContentRatingValue</h3>
<p>The specified level of an content_rating rating ID.</p>
<div class="refsect3">
<a name="AsContentRatingValue.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-CONTENT-RATING-VALUE-UNKNOWN:CAPS"></a>AS_CONTENT_RATING_VALUE_UNKNOWN</p></td>
<td class="enum_member_description">
<p>Unknown value</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="AS-CONTENT-RATING-VALUE-NONE:CAPS"></a>AS_CONTENT_RATING_VALUE_NONE</p></td>
<td class="enum_member_description">
<p>None</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="AS-CONTENT-RATING-VALUE-MILD:CAPS"></a>AS_CONTENT_RATING_VALUE_MILD</p></td>
<td class="enum_member_description">
<p>A small amount</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="AS-CONTENT-RATING-VALUE-MODERATE:CAPS"></a>AS_CONTENT_RATING_VALUE_MODERATE</p></td>
<td class="enum_member_description">
<p>A moderate amount</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="AS-CONTENT-RATING-VALUE-INTENSE:CAPS"></a>AS_CONTENT_RATING_VALUE_INTENSE</p></td>
<td class="enum_member_description">
<p>An intense amount</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="AsContentRating"></a><h3>AsContentRating</h3>
<pre class="programlisting">typedef struct _AsContentRating AsContentRating;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|