<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>atkmm: Atk::Image Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.2 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespaceAtk.html">Atk</a> </li>
<li><a class="el" href="classAtk_1_1Image.html">Image</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#related">Related Functions</a> </div>
<div class="headertitle">
<h1>Atk::Image Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Atk::Image" --><!-- doxytag: inherits="Glib::Interface" -->
<p>The ATK Interface implemented by components which expose image or pixmap content on-screen. <a href="#_details">More...</a></p>
<p><code>#include <atkmm/image.h></code></p>
<!-- startSectionHeader --><div class="dynheader">
Inheritance diagram for Atk::Image:<!-- endSectionHeader --></div>
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
<div class="center"><img src="classAtk_1_1Image__inherit__graph.png" border="0" usemap="#Atk_1_1Image_inherit__map" alt="Inheritance graph"/></div>
<map name="Atk_1_1Image_inherit__map" id="Atk_1_1Image_inherit__map">
<area shape="rect" id="node9" href="classAtk_1_1NoOpObject.html" title="An Atk::NoOpObject is an Atk::Object which purports to implement all ATK interfaces." alt="" coords="5,315,133,344"/><area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="15,160,124,189"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="7,83,132,112"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,5,127,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
<p><a href="classAtk_1_1Image-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7649474169b7726721b1b5688420c377"></a><!-- doxytag: member="Atk::Image::gobj" ref="a7649474169b7726721b1b5688420c377" args="()" -->
AtkImage* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Image.html#a7649474169b7726721b1b5688420c377">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a671c40909151052e66300c1324217377"></a><!-- doxytag: member="Atk::Image::gobj" ref="a671c40909151052e66300c1324217377" args="() const " -->
const AtkImage* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Image.html#a671c40909151052e66300c1324217377">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Image.html#a53fe6d9b350bf5fd7ba19a6f7179a55c">set_image_description</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& description)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the textual description for this image. <a href="#a53fe6d9b350bf5fd7ba19a6f7179a55c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Image.html#a857112f6307dfbf5177096f3bb72d80c">get_image_description</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a textual description of this image. <a href="#a857112f6307dfbf5177096f3bb72d80c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Image.html#a22a4c26e1642a421ffec41ea6492e11b">get_image_size</a> (int& width, int& height) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the width and height in pixels for the specified image. <a href="#a22a4c26e1642a421ffec41ea6492e11b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Image.html#af22f48ac491ceddb82329076cc63fca9">get_image_position</a> (int& x, int& y, CoordType coord_type) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the position of the image in the form of a point specifying the images top-left corner. <a href="#af22f48ac491ceddb82329076cc63fca9"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1Image.html">Atk::Image</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Image.html#a03bbf10f56b004d274029b27bd9d83f2">wrap</a> (AtkImage* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a03bbf10f56b004d274029b27bd9d83f2"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The ATK Interface implemented by components which expose image or pixmap content on-screen. </p>
<p>This should be implemented by <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Atk::Object</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 AtkImage.</p>
<p><a class="el" href="classAtk_1_1Image.html" title="The ATK Interface implemented by components which expose image or pixmap content on-screen.">Atk::Image</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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a857112f6307dfbf5177096f3bb72d80c"></a><!-- doxytag: member="Atk::Image::get_image_description" ref="a857112f6307dfbf5177096f3bb72d80c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Atk::Image::get_image_description </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a textual description of this image. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A string representing the image description. </dd></dl>
</div>
</div>
<a class="anchor" id="af22f48ac491ceddb82329076cc63fca9"></a><!-- doxytag: member="Atk::Image::get_image_position" ref="af22f48ac491ceddb82329076cc63fca9" args="(int &x, int &y, CoordType coord_type) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Atk::Image::get_image_position </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">CoordType </td>
<td class="paramname"> <em>coord_type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the position of the image in the form of a point specifying the images top-left corner. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>Address of <code>int</code> to put x coordinate position; otherwise, -1 if value cannot be obtained. </td></tr>
<tr><td class="paramname">y</td><td>Address of <code>int</code> to put y coordinate position; otherwise, -1 if value cannot be obtained. </td></tr>
<tr><td class="paramname">coord_type</td><td>Specifies whether the coordinates are relative to the screen or to the components top level window. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a22a4c26e1642a421ffec41ea6492e11b"></a><!-- doxytag: member="Atk::Image::get_image_size" ref="a22a4c26e1642a421ffec41ea6492e11b" args="(int &width, int &height) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Atk::Image::get_image_size </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>height</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the width and height in pixels for the specified image. </p>
<p>The values of <em>width</em> and <em>height</em> are returned as -1 if the values cannot be obtained (for instance, if the object is not onscreen). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">width</td><td>Filled with the image width, or -1 if the value cannot be obtained. </td></tr>
<tr><td class="paramname">height</td><td>Filled with the image height, or -1 if the value cannot be obtained. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a53fe6d9b350bf5fd7ba19a6f7179a55c"></a><!-- doxytag: member="Atk::Image::set_image_description" ref="a53fe6d9b350bf5fd7ba19a6f7179a55c" args="(const Glib::ustring &description)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Atk::Image::set_image_description </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>description</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the textual description for this image. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">description</td><td>A string description to set for <em>image</em>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Boolean <code>true</code>, or <code>false</code> if operation could not be completed. </dd></dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a03bbf10f56b004d274029b27bd9d83f2"></a><!-- doxytag: member="Atk::Image::wrap" ref="a03bbf10f56b004d274029b27bd9d83f2" args="(AtkImage *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1Image.html">Atk::Image</a> > wrap </td>
<td>(</td>
<td class="paramtype">AtkImage * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
<tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Mar 30 2011 09:27:41 for atkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
</body>
</html>
