atkimage.xml

The ATK library provides a set of interfaces for accessibility.By supporting the ATK interfaces, an

<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>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="AtkImage.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="AtkImage-struct">AtkImage</link>;
<link linkend="void">void</link>                <link linkend="atk-image-get-image-position">atk_image_get_image_position</link>        (<link linkend="AtkImage">AtkImage</link> *image,
                                                         <link linkend="gint">gint</link> *x,
                                                         <link linkend="gint">gint</link> *y,
                                                         <link linkend="AtkCoordType">AtkCoordType</link> coord_type);
const <link linkend="gchar">gchar</link>*        <link linkend="atk-image-get-image-description">atk_image_get_image_description</link>     (<link linkend="AtkImage">AtkImage</link> *image);
<link linkend="gboolean">gboolean</link>            <link linkend="atk-image-set-image-description">atk_image_set_image_description</link>     (<link linkend="AtkImage">AtkImage</link> *image,
                                                         const <link linkend="gchar">gchar</link> *description);
<link linkend="void">void</link>                <link linkend="atk-image-get-image-size">atk_image_get_image_size</link>            (<link linkend="AtkImage">AtkImage</link> *image,
                                                         <link linkend="gint">gint</link> *width,
                                                         <link linkend="gint">gint</link> *height);
const <link linkend="gchar">gchar</link>*        <link linkend="atk-image-get-image-locale">atk_image_get_image_locale</link>          (<link linkend="AtkImage">AtkImage</link> *image);
</synopsis>
</refsynopsisdiv>

<refsect1 id="AtkImage.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GInterface">GInterface</link>
   +----AtkImage
</synopsis>

</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.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="AtkImage-struct" role="struct">
<title>AtkImage</title>
<indexterm zone="AtkImage-struct"><primary>AtkImage</primary></indexterm><programlisting>typedef struct _AtkImage AtkImage;</programlisting>
<para>
The AtkImage structure does not contain any fields.

</para></refsect2>
<refsect2 id="atk-image-get-image-position" role="function">
<title>atk_image_get_image_position ()</title>
<indexterm zone="atk-image-get-image-position"><primary>atk_image_get_image_position</primary></indexterm><programlisting><link linkend="void">void</link>                atk_image_get_image_position        (<link linkend="AtkImage">AtkImage</link> *image,
                                                         <link linkend="gint">gint</link> *x,
                                                         <link linkend="gint">gint</link> *y,
                                                         <link linkend="AtkCoordType">AtkCoordType</link> coord_type);</programlisting>
<para>
Gets the position of the image in the form of a point specifying the
images top-left corner.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>image</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> instance that implements AtkImageIface
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara> address of <link linkend="gint"><type>gint</type></link> to put x coordinate position; otherwise, -1 if value cannot be obtained.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> address of <link linkend="gint"><type>gint</type></link> to put y coordinate position; otherwise, -1 if value cannot be obtained.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>coord_type</parameter>&nbsp;:</term>
<listitem><simpara> specifies whether the coordinates are relative to the screen
or to the components top level window
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-image-get-image-description" role="function">
<title>atk_image_get_image_description ()</title>
<indexterm zone="atk-image-get-image-description"><primary>atk_image_get_image_description</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        atk_image_get_image_description     (<link linkend="AtkImage">AtkImage</link> *image);</programlisting>
<para>
Get a textual description of this image.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>image</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> instance that implements AtkImageIface
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a string representing the image description
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-image-set-image-description" role="function">
<title>atk_image_set_image_description ()</title>
<indexterm zone="atk-image-set-image-description"><primary>atk_image_set_image_description</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            atk_image_set_image_description     (<link linkend="AtkImage">AtkImage</link> *image,
                                                         const <link linkend="gchar">gchar</link> *description);</programlisting>
<para>
Sets the textual description for this image.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>image</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> instance that implements AtkImageIface
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>description</parameter>&nbsp;:</term>
<listitem><simpara> a string description to set for <parameter>image</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> boolean TRUE, or FALSE if operation could
not be completed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-image-get-image-size" role="function">
<title>atk_image_get_image_size ()</title>
<indexterm zone="atk-image-get-image-size"><primary>atk_image_get_image_size</primary></indexterm><programlisting><link linkend="void">void</link>                atk_image_get_image_size            (<link linkend="AtkImage">AtkImage</link> *image,
                                                         <link linkend="gint">gint</link> *width,
                                                         <link linkend="gint">gint</link> *height);</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>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>image</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> instance that implements AtkImageIface
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> filled with the image width, or -1 if the value cannot be obtained.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> filled with the image height, or -1 if the value cannot be obtained.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-image-get-image-locale" role="function">
<title>atk_image_get_image_locale ()</title>
<indexterm zone="atk-image-get-image-locale"><primary>atk_image_get_image_locale</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        atk_image_get_image_locale          (<link linkend="AtkImage">AtkImage</link> *image);</programlisting>
<para>
Since ATK 1.12</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>image</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="AtkImage"><type>AtkImage</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a string corresponding to the POSIX LC_MESSAGES locale used by the image description, or NULL if the image does not specify a locale. 

</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>