atkimage.xml

linux下图形库开发包atk-1.4.0.tar.gz

<refentry id="AtkImage">
<refmeta>
<refentrytitle>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>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>



struct      <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);
G_CONST_RETURN <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);

</synopsis>
</refsynopsisdiv>

<refsect1>
<title>Object Hierarchy</title>
<synopsis>

  <link linkend="GInterface">GInterface</link>
   +----AtkImage
</synopsis>

</refsect1>




<refsect1>
<title>Known Implementations</title>
<para>
AtkImage is implemented by
 <link linkend="AtkNoOpObject">AtkNoOpObject</link>.</para>

</refsect1>




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

</para></refsect2>
<refsect2>
<title><anchor id="atk-image-get-image-position"/>atk_image_get_image_position ()</title>
<indexterm><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.  The values of <parameter>x</parameter> and <parameter>y</parameter> are returned as -1
if the values cannot be obtained.</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
</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
</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>
<title><anchor id="atk-image-get-image-description"/>atk_image_get_image_description ()</title>
<indexterm><primary>atk_image_get_image_description</primary></indexterm><programlisting>G_CONST_RETURN <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> :</term><listitem><simpara> a string representing the image description
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-image-set-image-description"/>atk_image_set_image_description ()</title>
<indexterm><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> :</term><listitem><simpara> boolean TRUE, or FALSE if operation could
not be completed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-image-get-image-size"/>atk_image_get_image_size ()</title>
<indexterm><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.</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
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> filled with the image height
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>