<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
  <!ENTITY % gtkdocentities SYSTEM "../xml/gtkdocentities.ent">
  %gtkdocentities;
]>
<refentry id="AtkImage">
<refmeta>
<refentrytitle role="top_of_page" id="AtkImage.top_of_page">AtkImage</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>ATK Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>AtkImage</refname>
<refpurpose>The ATK Interface implemented by components
which expose image or pixmap content on-screen.</refpurpose>
</refnamediv>

<refsect1 id="AtkImage.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_proto_type" colwidth="150px"/>
<colspec colname="functions_proto_name"/>
<tbody>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="atk-image-get-image-position">atk_image_get_image_position</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="atk-image-get-image-description">atk_image_get_image_description</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="atk-image-set-image-description">atk_image_set_image_description</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="atk-image-get-image-size">atk_image_get_image_size</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="atk-image-get-image-locale">atk_image_get_image_locale</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AtkImage.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="other_proto_type" colwidth="150px"/>
<colspec colname="other_proto_name"/>
<tbody>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="AtkImage-struct">AtkImage</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AtkImage.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GInterface">GInterface</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> AtkImage
</screen>
</refsect1>
<refsect1 id="AtkImage.implementations" role="implementations">
<title role="implementations.title">Known Implementations</title>
<para>
AtkImage is implemented by
 <link linkend="AtkNoOpObject">AtkNoOpObject</link>.</para>

</refsect1>


<refsect1 id="AtkImage.description" role="desc">
<title role="desc.title">Description</title>
<para><link linkend="AtkImage"><type>AtkImage</type></link> should be implemented by <link linkend="AtkObject"><type>AtkObject</type></link> 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 <link linkend="AtkImage"><type>AtkImage</type></link>.</para>
<para><link linkend="AtkImage"><type>AtkImage</type></link> 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.</para>

</refsect1>
<refsect1 id="AtkImage.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="atk-image-get-image-position" role="function">
<title>atk_image_get_image_position&#160;()</title>
<indexterm zone="atk-image-get-image-position"><primary>atk_image_get_image_position</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
atk_image_get_image_position (<parameter><link linkend="AtkImage"><type>AtkImage</type></link> *image</parameter>,
                              <parameter><link linkend="gint"><type>gint</type></link> *x</parameter>,
                              <parameter><link linkend="gint"><type>gint</type></link> *y</parameter>,
                              <parameter><link linkend="AtkCoordType"><type>AtkCoordType</type></link> coord_type</parameter>);</programlisting>
<para>Gets the position of the image in the form of a point specifying the
images top-left corner.</para>
<refsect3 id="atk-image-get-image-position.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>image</para></entry>
<entry role="parameter_description"><para>a <link linkend="GObject"><type>GObject</type></link> instance that implements AtkImageIface</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>x</para></entry>
<entry role="parameter_description"><para>address of <link linkend="gint"><type>gint</type></link> to put x coordinate position; otherwise, -1 if value cannot be obtained. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>optional</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>y</para></entry>
<entry role="parameter_description"><para>address of <link linkend="gint"><type>gint</type></link> to put y coordinate position; otherwise, -1 if value cannot be obtained. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>optional</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>coord_type</para></entry>
<entry role="parameter_description"><para>specifies whether the coordinates are relative to the screen
or to the components top level window</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="atk-image-get-image-description" role="function">
<title>atk_image_get_image_description&#160;()</title>
<indexterm zone="atk-image-get-image-description"><primary>atk_image_get_image_description</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
atk_image_get_image_description (<parameter><link linkend="AtkImage"><type>AtkImage</type></link> *image</parameter>);</programlisting>
<para>Get a textual description of this image.</para>
<refsect3 id="atk-image-get-image-description.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>image</para></entry>
<entry role="parameter_description"><para>a <link linkend="GObject"><type>GObject</type></link> instance that implements AtkImageIface</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-image-get-image-description.returns" role="returns">
<title>Returns</title>
<para> a string representing the image description</para>
</refsect3></refsect2>
<refsect2 id="atk-image-set-image-description" role="function">
<title>atk_image_set_image_description&#160;()</title>
<indexterm zone="atk-image-set-image-description"><primary>atk_image_set_image_description</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
atk_image_set_image_description (<parameter><link linkend="AtkImage"><type>AtkImage</type></link> *image</parameter>,
                                 <parameter>const <link linkend="gchar"><type>gchar</type></link> *description</parameter>);</programlisting>
<para>Sets the textual description for this image.</para>
<refsect3 id="atk-image-set-image-description.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>image</para></entry>
<entry role="parameter_description"><para>a <link linkend="GObject"><type>GObject</type></link> instance that implements AtkImageIface</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>description</para></entry>
<entry role="parameter_description"><para>a string description to set for <parameter>image</parameter>
</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-image-set-image-description.returns" role="returns">
<title>Returns</title>
<para> boolean TRUE, or FALSE if operation could
not be completed.</para>
</refsect3></refsect2>
<refsect2 id="atk-image-get-image-size" role="function">
<title>atk_image_get_image_size&#160;()</title>
<indexterm zone="atk-image-get-image-size"><primary>atk_image_get_image_size</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
atk_image_get_image_size (<parameter><link linkend="AtkImage"><type>AtkImage</type></link> *image</parameter>,
                          <parameter><link linkend="gint"><type>gint</type></link> *width</parameter>,
                          <parameter><link linkend="gint"><type>gint</type></link> *height</parameter>);</programlisting>
<para>Get the width and height in pixels for the specified image.
The values of <parameter>width</parameter>
 and <parameter>height</parameter>
 are returned as -1 if the
values cannot be obtained (for instance, if the object is not onscreen).</para>
<refsect3 id="atk-image-get-image-size.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>image</para></entry>
<entry role="parameter_description"><para>a <link linkend="GObject"><type>GObject</type></link> instance that implements AtkImageIface</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>width</para></entry>
<entry role="parameter_description"><para>filled with the image width, or -1 if the value cannot be obtained. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>optional</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>height</para></entry>
<entry role="parameter_description"><para>filled with the image height, or -1 if the value cannot be obtained. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>optional</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="atk-image-get-image-locale" role="function" condition="since:1.12">
<title>atk_image_get_image_locale&#160;()</title>
<indexterm zone="atk-image-get-image-locale" role="1.12"><primary>atk_image_get_image_locale</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
atk_image_get_image_locale (<parameter><link linkend="AtkImage"><type>AtkImage</type></link> *image</parameter>);</programlisting>
<refsect3 id="atk-image-get-image-locale.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>image</para></entry>
<entry role="parameter_description"><para>An <link linkend="AtkImage"><type>AtkImage</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-image-get-image-locale.returns" role="returns">
<title>Returns</title>
<para>a string corresponding to the POSIX
LC_MESSAGES locale used by the image description, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the
image does not specify a locale. </para>
<para><emphasis role="annotation">[<acronym>nullable</acronym>]</emphasis></para>
</refsect3><para role="since">Since: <link linkend="api-index-1.12">1.12</link></para></refsect2>

</refsect1>
<refsect1 id="AtkImage.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="AtkImage-struct" role="struct">
<title>AtkImage</title>
<indexterm zone="AtkImage-struct"><primary>AtkImage</primary></indexterm>
<programlisting language="C">typedef struct _AtkImage AtkImage;</programlisting>
</refsect2>

</refsect1>

</refentry>
