<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AsScreenshot: AppStream Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.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-AsChecksum.html" title="AsChecksum">
<link rel="next" href="appstream-AsImage.html" title="AsImage">
<meta name="generator" content="GTK-Doc V1.25 (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-AsScreenshot.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-AsChecksum.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="appstream-AsImage.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="appstream-AsScreenshot"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="appstream-AsScreenshot.top_of_page"></a>AsScreenshot</span></h2>
<p>AsScreenshot — Object representing a single screenshot</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="appstream-AsScreenshot.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-AsScreenshot.html#AsScreenshotKind" title="enum AsScreenshotKind"><span class="returnvalue">AsScreenshotKind</span></a>
</td>
<td class="function_name">
<a class="link" href="appstream-AsScreenshot.html#as-screenshot-kind-from-string" title="as_screenshot_kind_from_string ()">as_screenshot_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-AsScreenshot.html#as-screenshot-kind-to-string" title="as_screenshot_kind_to_string ()">as_screenshot_kind_to_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="appstream-AsScreenshot.html#as-screenshot-is-valid" title="as_screenshot_is_valid ()">as_screenshot_is_valid</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="returnvalue">AsScreenshot</span></a> *
</td>
<td class="function_name">
<a class="link" href="appstream-AsScreenshot.html#as-screenshot-new" title="as_screenshot_new ()">as_screenshot_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="appstream-AsScreenshot.html#AsScreenshotKind" title="enum AsScreenshotKind"><span class="returnvalue">AsScreenshotKind</span></a>
</td>
<td class="function_name">
<a class="link" href="appstream-AsScreenshot.html#as-screenshot-get-kind" title="as_screenshot_get_kind ()">as_screenshot_get_kind</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-AsScreenshot.html#as-screenshot-set-kind" title="as_screenshot_set_kind ()">as_screenshot_set_kind</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-AsScreenshot.html#as-screenshot-get-caption" title="as_screenshot_get_caption ()">as_screenshot_get_caption</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-AsScreenshot.html#as-screenshot-set-caption" title="as_screenshot_set_caption ()">as_screenshot_set_caption</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *
</td>
<td class="function_name">
<a class="link" href="appstream-AsScreenshot.html#as-screenshot-get-images-all" title="as_screenshot_get_images_all ()">as_screenshot_get_images_all</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *
</td>
<td class="function_name">
<a class="link" href="appstream-AsScreenshot.html#as-screenshot-get-images" title="as_screenshot_get_images ()">as_screenshot_get_images</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-AsScreenshot.html#as-screenshot-add-image" title="as_screenshot_add_image ()">as_screenshot_add_image</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-AsScreenshot.html#as-screenshot-get-active-locale" title="as_screenshot_get_active_locale ()">as_screenshot_get_active_locale</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-AsScreenshot.html#as-screenshot-set-active-locale" title="as_screenshot_set_active_locale ()">as_screenshot_set_active_locale</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="appstream-AsScreenshot.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-AsScreenshot.html#AS-TYPE-SCREENSHOT:CAPS" title="AS_TYPE_SCREENSHOT">AS_TYPE_SCREENSHOT</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="appstream-AsScreenshot.html#AsScreenshotClass" title="struct AsScreenshotClass">AsScreenshotClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="appstream-AsScreenshot.html#AsScreenshotKind" title="enum AsScreenshotKind">AsScreenshotKind</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot">AsScreenshot</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="appstream-AsScreenshot.description"></a><h2>Description</h2>
<p>Screenshots have a localized caption and also contain a number of images
of different resolution.</p>
<p>See also: <a class="link" href="appstream-AsImage.html#AsImage" title="AsImage"><span class="type">AsImage</span></a></p>
</div>
<div class="refsect1">
<a name="appstream-AsScreenshot.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="as-screenshot-kind-from-string"></a><h3>as_screenshot_kind_from_string ()</h3>
<pre class="programlisting"><a class="link" href="appstream-AsScreenshot.html#AsScreenshotKind" title="enum AsScreenshotKind"><span class="returnvalue">AsScreenshotKind</span></a>
as_screenshot_kind_from_string (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *kind</code></em>);</pre>
<p>Converts the text representation to an enumerated value.</p>
<div class="refsect3">
<a name="as-screenshot-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>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-screenshot-kind-from-string.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="appstream-AsScreenshot.html#AsScreenshotKind" title="enum AsScreenshotKind"><code class="literal">AsScreenshotKind</code></a>, or <a class="link" href="appstream-AsScreenshot.html#AS-SCREENSHOT-KIND-UNKNOWN:CAPS"><code class="literal">AS_SCREENSHOT_KIND_UNKNOWN</code></a> if not known.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-screenshot-kind-to-string"></a><h3>as_screenshot_kind_to_string ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
as_screenshot_kind_to_string (<em class="parameter"><code><a class="link" href="appstream-AsScreenshot.html#AsScreenshotKind" title="enum AsScreenshotKind"><span class="type">AsScreenshotKind</span></a> kind</code></em>);</pre>
<p>Converts the enumerated value to an text representation.</p>
<div class="refsect3">
<a name="as-screenshot-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>kind</p></td>
<td class="parameter_description"><p>the <a class="link" href="appstream-AsScreenshot.html#AsScreenshotKind" title="enum AsScreenshotKind"><span class="type">AsScreenshotKind</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-screenshot-kind-to-string.returns"></a><h4>Returns</h4>
<p> string version of <em class="parameter"><code>kind</code></em>
</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-screenshot-is-valid"></a><h3>as_screenshot_is_valid ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
as_screenshot_is_valid (<em class="parameter"><code><a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a> *screenshot</code></em>);</pre>
<p>Performs a quick validation on this screenshot</p>
<div class="refsect3">
<a name="as-screenshot-is-valid.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>screenshot</p></td>
<td class="parameter_description"><p>a <a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-screenshot-is-valid.returns"></a><h4>Returns</h4>
<p> TRUE if the screenshot is a complete <a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-screenshot-new"></a><h3>as_screenshot_new ()</h3>
<pre class="programlisting"><a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="returnvalue">AsScreenshot</span></a> *
as_screenshot_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a>.</p>
<div class="refsect3">
<a name="as-screenshot-new.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-screenshot-get-kind"></a><h3>as_screenshot_get_kind ()</h3>
<pre class="programlisting"><a class="link" href="appstream-AsScreenshot.html#AsScreenshotKind" title="enum AsScreenshotKind"><span class="returnvalue">AsScreenshotKind</span></a>
as_screenshot_get_kind (<em class="parameter"><code><a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a> *screenshot</code></em>);</pre>
<p>Gets the screenshot kind.</p>
<div class="refsect3">
<a name="as-screenshot-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>screenshot</p></td>
<td class="parameter_description"><p>a <a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-screenshot-get-kind.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="appstream-AsScreenshot.html#AsScreenshotKind" title="enum AsScreenshotKind"><span class="type">AsScreenshotKind</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-screenshot-set-kind"></a><h3>as_screenshot_set_kind ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
as_screenshot_set_kind (<em class="parameter"><code><a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a> *screenshot</code></em>,
<em class="parameter"><code><a class="link" href="appstream-AsScreenshot.html#AsScreenshotKind" title="enum AsScreenshotKind"><span class="type">AsScreenshotKind</span></a> kind</code></em>);</pre>
<p>Sets the screenshot kind.</p>
<div class="refsect3">
<a name="as-screenshot-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>screenshot</p></td>
<td class="parameter_description"><p>a <a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</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 <a class="link" href="appstream-AsScreenshot.html#AsScreenshotKind" title="enum AsScreenshotKind"><span class="type">AsScreenshotKind</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-screenshot-get-caption"></a><h3>as_screenshot_get_caption ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
as_screenshot_get_caption (<em class="parameter"><code><a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a> *screenshot</code></em>);</pre>
<p>Gets the image caption</p>
<div class="refsect3">
<a name="as-screenshot-get-caption.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>screenshot</p></td>
<td class="parameter_description"><p>a <a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-screenshot-get-caption.returns"></a><h4>Returns</h4>
<p> the caption</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-screenshot-set-caption"></a><h3>as_screenshot_set_caption ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
as_screenshot_set_caption (<em class="parameter"><code><a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a> *screenshot</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *caption</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *locale</code></em>);</pre>
<p>Sets a caption on the screenshot</p>
<div class="refsect3">
<a name="as-screenshot-set-caption.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>screenshot</p></td>
<td class="parameter_description"><p>a <a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>caption</p></td>
<td class="parameter_description"><p>the caption text.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-screenshot-get-images-all"></a><h3>as_screenshot_get_images_all ()</h3>
<pre class="programlisting"><a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *
as_screenshot_get_images_all (<em class="parameter"><code><a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a> *screenshot</code></em>);</pre>
<p>Returns an array of all images we have, regardless of their
size and language.</p>
<div class="refsect3">
<a name="as-screenshot-get-images-all.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>screenshot</p></td>
<td class="parameter_description"><p>an <a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-screenshot-get-images-all.returns"></a><h4>Returns</h4>
<p> an array. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AsImage]</span></p>
</div>
<p class="since">Since: 0.10</p>
</div>
<hr>
<div class="refsect2">
<a name="as-screenshot-get-images"></a><h3>as_screenshot_get_images ()</h3>
<pre class="programlisting"><a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *
as_screenshot_get_images (<em class="parameter"><code><a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a> *screenshot</code></em>);</pre>
<p>Gets the images for this screenshots. Only images valid for the current
language are returned. We return all sizes.</p>
<div class="refsect3">
<a name="as-screenshot-get-images.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>screenshot</p></td>
<td class="parameter_description"><p>a <a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-screenshot-get-images.returns"></a><h4>Returns</h4>
<p> an array. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AsImage]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-screenshot-add-image"></a><h3>as_screenshot_add_image ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
as_screenshot_add_image (<em class="parameter"><code><a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a> *screenshot</code></em>,
<em class="parameter"><code><a class="link" href="appstream-AsImage.html#AsImage" title="AsImage"><span class="type">AsImage</span></a> *image</code></em>);</pre>
<p>Adds an image to the screenshot.</p>
<div class="refsect3">
<a name="as-screenshot-add-image.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>screenshot</p></td>
<td class="parameter_description"><p>a <a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>image</p></td>
<td class="parameter_description"><p>a <a class="link" href="appstream-AsImage.html#AsImage" title="AsImage"><span class="type">AsImage</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-screenshot-get-active-locale"></a><h3>as_screenshot_get_active_locale ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
as_screenshot_get_active_locale (<em class="parameter"><code><a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a> *screenshot</code></em>);</pre>
<p>Get the current active locale, which
is used to get localized messages.</p>
</div>
<hr>
<div class="refsect2">
<a name="as-screenshot-set-active-locale"></a><h3>as_screenshot_set_active_locale ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
as_screenshot_set_active_locale (<em class="parameter"><code><a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a> *screenshot</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *locale</code></em>);</pre>
<p>Set the current active locale, which
is used to get localized messages.
If the <a class="link" href="appstream-AsComponent.html#AsComponent" title="AsComponent"><span class="type">AsComponent</span></a> linking this <a class="link" href="appstream-AsScreenshot.html#AsScreenshot" title="AsScreenshot"><span class="type">AsScreenshot</span></a> was fetched
from a localized database, usually only
one locale is available.</p>
</div>
</div>
<div class="refsect1">
<a name="appstream-AsScreenshot.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AS-TYPE-SCREENSHOT:CAPS"></a><h3>AS_TYPE_SCREENSHOT</h3>
<pre class="programlisting">#define AS_TYPE_SCREENSHOT (as_screenshot_get_type ())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="AsScreenshotClass"></a><h3>struct AsScreenshotClass</h3>
<pre class="programlisting">struct AsScreenshotClass {
GObjectClass parent_class;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="AsScreenshotKind"></a><h3>enum AsScreenshotKind</h3>
<p>The screenshot type.</p>
<div class="refsect3">
<a name="AsScreenshotKind.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-SCREENSHOT-KIND-UNKNOWN:CAPS"></a>AS_SCREENSHOT_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-SCREENSHOT-KIND-DEFAULT:CAPS"></a>AS_SCREENSHOT_KIND_DEFAULT</p></td>
<td class="enum_member_description">
<p>The primary screenshot to show by default</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="AS-SCREENSHOT-KIND-EXTRA:CAPS"></a>AS_SCREENSHOT_KIND_EXTRA</p></td>
<td class="enum_member_description">
<p>Optional screenshot</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="AsScreenshot"></a><h3>AsScreenshot</h3>
<pre class="programlisting">typedef struct _AsScreenshot AsScreenshot;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
