<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>AtkImage</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.64.1">
<link rel="home" href="index.html" title="ATK - Accessibility Toolkit">
<link rel="up" href="atk.html" title="ATK Library">
<link rel="previous" href="AtkHypertext.html" title="AtkHypertext">
<link rel="next" href="AtkNoOpObject.html" title="AtkNoOpObject">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="atk.html" title="ATK Library">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="AtkHypertext.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="atk.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">ATK - Accessibility Toolkit</th>
<td><a accesskey="n" href="AtkNoOpObject.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry" lang="en">
<a name="AtkImage"></a><div class="titlepage">
<div></div>
<div></div>
</div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">AtkImage</span></h2>
<p>AtkImage — The ATK Interface implemented by components which expose image or pixmap
content on-screen.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="AtkImage.html#AtkImage-struct">AtkImage</a>;
<a
href="../gss/gss-ext.html#void"
>void</a> <a href="AtkImage.html#atk-image-get-image-position">atk_image_get_image_position</a> (<a href="AtkImage.html" title="AtkImage">AtkImage</a> *image,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *y,
<a href="AtkUtil.html#AtkCoordType">AtkCoordType</a> coord_type);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="AtkImage.html#atk-image-get-image-description">atk_image_get_image_description</a>
(<a href="AtkImage.html" title="AtkImage">AtkImage</a> *image);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="AtkImage.html#atk-image-set-image-description">atk_image_set_image_description</a> (<a href="AtkImage.html" title="AtkImage">AtkImage</a> *image,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *description);
<a
href="../gss/gss-ext.html#void"
>void</a> <a href="AtkImage.html#atk-image-get-image-size">atk_image_get_image_size</a> (<a href="AtkImage.html" title="AtkImage">AtkImage</a> *image,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *height);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="AtkImage.html#atk-image-get-image-locale">atk_image_get_image_locale</a> (<a href="AtkImage.html" title="AtkImage">AtkImage</a> *image);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id276128"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----AtkImage
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id276147"></a><h2>Known Implementations</h2>
<p>
AtkImage is implemented by
<a href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="id276164"></a><h2>Description</h2>
<p>
<a href="AtkImage.html" title="AtkImage"><span class="type">AtkImage</span></a> should be implemented by <a href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> subtypes on behalf of
components which display image/pixmap information onscreen, and which
provide information (other than just widget borders, etc.) via that
image content. For instance, icons, buttons with icons, toolbar
elements, and image viewing panes typically should implement <a href="AtkImage.html" title="AtkImage"><span class="type">AtkImage</span></a>.
</p>
<p>
<a href="AtkImage.html" title="AtkImage"><span class="type">AtkImage</span></a> primarily provides two types of information: coordinate
information (useful for screen review mode of screenreaders, and for use
by onscreen magnifiers), and descriptive information. The descriptive
information is provided for alternative, text-only presentation of the
most significant information present in the image.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id276214"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id276219"></a><h3>
<a name="AtkImage-struct"></a>AtkImage</h3>
<a class="indexterm" name="id276230"></a><pre class="programlisting">typedef struct _AtkImage AtkImage;</pre>
<p>
The AtkImage structure does not contain any fields.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id276245"></a><h3>
<a name="atk-image-get-image-position"></a>atk_image_get_image_position ()</h3>
<a class="indexterm" name="id276255"></a><pre class="programlisting"><a
href="../gss/gss-ext.html#void"
>void</a> atk_image_get_image_position (<a href="AtkImage.html" title="AtkImage">AtkImage</a> *image,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *y,
<a href="AtkUtil.html#AtkCoordType">AtkCoordType</a> coord_type);</pre>
<p>
Gets the position of the image in the form of a point specifying the
images top-left corner.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>image</tt></i> :</span></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> instance that implements AtkImageIface
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>x</tt></i> :</span></td>
<td> address of <a
href="../glib/glib-Basic-Types.html#gint"
><span class="type">gint</span></a> to put x coordinate position; otherwise, -1 if value cannot be obtained.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>y</tt></i> :</span></td>
<td> address of <a
href="../glib/glib-Basic-Types.html#gint"
><span class="type">gint</span></a> to put y coordinate position; otherwise, -1 if value cannot be obtained.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>coord_type</tt></i> :</span></td>
<td> specifies whether the coordinates are relative to the screen
or to the components top level window
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id276393"></a><h3>
<a name="atk-image-get-image-description"></a>atk_image_get_image_description ()</h3>
<a class="indexterm" name="id276403"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* atk_image_get_image_description
(<a href="AtkImage.html" title="AtkImage">AtkImage</a> *image);</pre>
<p>
Get a textual description of this image.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>image</tt></i> :</span></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> instance that implements AtkImageIface
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a string representing the image description
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id276473"></a><h3>
<a name="atk-image-set-image-description"></a>atk_image_set_image_description ()</h3>
<a class="indexterm" name="id276483"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> atk_image_set_image_description (<a href="AtkImage.html" title="AtkImage">AtkImage</a> *image,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *description);</pre>
<p>
Sets the textual description for this image.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>image</tt></i> :</span></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> instance that implements AtkImageIface
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>description</tt></i> :</span></td>
<td> a string description to set for <i class="parameter"><tt>image</tt></i>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> boolean TRUE, or FALSE if operation could
not be completed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id276578"></a><h3>
<a name="atk-image-get-image-size"></a>atk_image_get_image_size ()</h3>
<a class="indexterm" name="id276589"></a><pre class="programlisting"><a
href="../gss/gss-ext.html#void"
>void</a> atk_image_get_image_size (<a href="AtkImage.html" title="AtkImage">AtkImage</a> *image,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *height);</pre>
<p>
Get the width and height in pixels for the specified image.
The values of <i class="parameter"><tt>width</tt></i> and <i class="parameter"><tt>height</tt></i> are returned as -1 if the
values cannot be obtained (for instance, if the object is not onscreen).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>image</tt></i> :</span></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> instance that implements AtkImageIface
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>width</tt></i> :</span></td>
<td> filled with the image width, or -1 if the value cannot be obtained.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>height</tt></i> :</span></td>
<td> filled with the image height, or -1 if the value cannot be obtained.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id276702"></a><h3>
<a name="atk-image-get-image-locale"></a>atk_image_get_image_locale ()</h3>
<a class="indexterm" name="id276712"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* atk_image_get_image_locale (<a href="AtkImage.html" title="AtkImage">AtkImage</a> *image);</pre>
<p>
<i class="parameter"><tt>Since</tt></i> ATK 1.12</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>image</tt></i> :</span></td>
<td> An <a href="AtkImage.html" title="AtkImage"><span class="type">AtkImage</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>a string corresponding to the POSIX LC_MESSAGES locale used by the image description, or NULL if the image does not specify a locale.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="AtkHypertext.html"><b><< AtkHypertext</b></a></td>
<td align="right"><a accesskey="n" href="AtkNoOpObject.html"><b>AtkNoOpObject >></b></a></td>
</tr></table>
</body>
</html>
