2
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6
<meta name="generator" content="Doxygen 1.8.3.1"/>
5
7
<title>atkmm: Atk::Image Class Reference</title>
6
8
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
9
<script type="text/javascript" src="jquery.js"></script>
10
<script type="text/javascript" src="dynsections.js"></script>
11
<link href="doxygen.css" rel="stylesheet" type="text/css" />
10
<!-- Generated by Doxygen 1.7.4 -->
14
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
12
15
<div id="titlearea">
13
16
<table cellspacing="0" cellpadding="0">
15
18
<tr style="height: 56px;">
16
19
<td style="padding-left: 0.5em;">
17
<div id="projectname">atkmm <span id="projectnumber">2.22.6</span></div>
20
<div id="projectname">atkmm
21
 <span id="projectnumber">2.22.7</span>
28
<!-- end header part -->
29
<!-- Generated by Doxygen 1.8.3.1 -->
23
30
<div id="navrow1" class="tabs">
24
31
<ul class="tablist">
25
32
<li><a href="index.html"><span>Main Page</span></a></li>
36
43
<li><a href="functions.html"><span>Class Members</span></a></li>
39
<div id="nav-path" class="navpath">
41
<li class="navelem"><a class="el" href="namespaceAtk.html">Atk</a> </li>
42
<li class="navelem"><a class="el" href="classAtk_1_1Image.html">Image</a> </li>
46
<div id="nav-path" class="navpath">
48
<li class="navelem"><a class="el" href="namespaceAtk.html">Atk</a></li><li class="navelem"><a class="el" href="classAtk_1_1Image.html">Image</a></li> </ul>
46
51
<div class="header">
47
52
<div class="summary">
48
53
<a href="#pub-methods">Public Member Functions</a> |
49
<a href="#related">Related Functions</a> </div>
54
<a href="#pub-static-methods">Static Public Member Functions</a> |
55
<a href="#pro-methods">Protected Member Functions</a> |
56
<a href="#related">Related Functions</a> |
57
<a href="classAtk_1_1Image-members.html">List of all members</a> </div>
50
58
<div class="headertitle">
51
<div class="title">Atk::Image Class Reference</div> </div>
59
<div class="title">Atk::Image Class Reference</div> </div>
53
61
<div class="contents">
54
<!-- doxytag: class="Atk::Image" --><!-- doxytag: inherits="Glib::Interface" -->
55
<p>The ATK Interface implemented by components which expose image or pixmap content on-screen. <a href="classAtk_1_1Image.html#details">More...</a></p>
63
<p>The ATK Interface implemented by components which expose image or pixmap content on-screen.
64
<a href="classAtk_1_1Image.html#details">More...</a></p>
57
66
<p><code>#include <atkmm/image.h></code></p>
58
67
<div class="dynheader">
60
69
<div class="dyncontent">
61
70
<div class="center"><img src="classAtk_1_1Image__inherit__graph.png" border="0" usemap="#Atk_1_1Image_inherit__map" alt="Inheritance graph"/></div>
62
71
<map name="Atk_1_1Image_inherit__map" id="Atk_1_1Image_inherit__map">
63
<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" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="15,160,124,189"/><area shape="rect" id="node4" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="7,83,132,112"/><area shape="rect" id="node6" doxygen="libsigc++-2.0.tag:http://library.gnome.org/devel/libsigc++/unstable/" href="http://library.gnome.org/devel/libsigc++/unstable/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,5,127,35"/></map>
64
73
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
66
<p><a href="classAtk_1_1Image-members.html">List of all members.</a></p>
67
74
<table class="memberdecls">
68
<tr><td colspan="2"><h2><a name="pub-methods"></a>
75
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
69
76
Public Member Functions</h2></td></tr>
70
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7649474169b7726721b1b5688420c377"></a><!-- doxytag: member="Atk::Image::gobj" ref="a7649474169b7726721b1b5688420c377" args="()" -->
77
<tr class="memitem:a7649474169b7726721b1b5688420c377"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7649474169b7726721b1b5688420c377"></a>
71
78
AtkImage* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Image.html#a7649474169b7726721b1b5688420c377">gobj</a> ()</td></tr>
72
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
73
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a671c40909151052e66300c1324217377"></a><!-- doxytag: member="Atk::Image::gobj" ref="a671c40909151052e66300c1324217377" args="() const " -->
79
<tr class="memdesc:a7649474169b7726721b1b5688420c377"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
80
<tr class="separator:a7649474169b7726721b1b5688420c377"><td class="memSeparator" colspan="2"> </td></tr>
81
<tr class="memitem:a671c40909151052e66300c1324217377"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a671c40909151052e66300c1324217377"></a>
74
82
const AtkImage* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Image.html#a671c40909151052e66300c1324217377">gobj</a> () const </td></tr>
75
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
76
<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" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a>& description)</td></tr>
77
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the textual description for this image. <a href="#a53fe6d9b350bf5fd7ba19a6f7179a55c"></a><br/></td></tr>
78
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/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>
79
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a textual description of this image. <a href="#a857112f6307dfbf5177096f3bb72d80c"></a><br/></td></tr>
80
<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>
81
<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>
82
<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>
83
<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>
84
<tr><td colspan="2"><h2><a name="related"></a>
83
<tr class="memdesc:a671c40909151052e66300c1324217377"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
84
<tr class="separator:a671c40909151052e66300c1324217377"><td class="memSeparator" colspan="2"> </td></tr>
85
<tr class="memitem:a53fe6d9b350bf5fd7ba19a6f7179a55c"><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" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a>& description)</td></tr>
86
<tr class="memdesc:a53fe6d9b350bf5fd7ba19a6f7179a55c"><td class="mdescLeft"> </td><td class="mdescRight">Sets the textual description for this image. <a href="#a53fe6d9b350bf5fd7ba19a6f7179a55c">More...</a><br/></td></tr>
87
<tr class="separator:a53fe6d9b350bf5fd7ba19a6f7179a55c"><td class="memSeparator" colspan="2"> </td></tr>
88
<tr class="memitem:a857112f6307dfbf5177096f3bb72d80c"><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/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>
89
<tr class="memdesc:a857112f6307dfbf5177096f3bb72d80c"><td class="mdescLeft"> </td><td class="mdescRight">Get a textual description of this image. <a href="#a857112f6307dfbf5177096f3bb72d80c">More...</a><br/></td></tr>
90
<tr class="separator:a857112f6307dfbf5177096f3bb72d80c"><td class="memSeparator" colspan="2"> </td></tr>
91
<tr class="memitem:a22a4c26e1642a421ffec41ea6492e11b"><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>
92
<tr class="memdesc:a22a4c26e1642a421ffec41ea6492e11b"><td class="mdescLeft"> </td><td class="mdescRight">Get the width and height in pixels for the specified image. <a href="#a22a4c26e1642a421ffec41ea6492e11b">More...</a><br/></td></tr>
93
<tr class="separator:a22a4c26e1642a421ffec41ea6492e11b"><td class="memSeparator" colspan="2"> </td></tr>
94
<tr class="memitem:af22f48ac491ceddb82329076cc63fca9"><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>
95
<tr class="memdesc:af22f48ac491ceddb82329076cc63fca9"><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">More...</a><br/></td></tr>
96
<tr class="separator:af22f48ac491ceddb82329076cc63fca9"><td class="memSeparator" colspan="2"> </td></tr>
97
</table><table class="memberdecls">
98
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
99
Static Public Member Functions</h2></td></tr>
100
<tr class="memitem:a39e9cbc314b2bf63805ead79dcd8a745"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39e9cbc314b2bf63805ead79dcd8a745"></a>
101
static GType </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Image.html#a39e9cbc314b2bf63805ead79dcd8a745">get_type</a> ()</td></tr>
102
<tr class="memdesc:a39e9cbc314b2bf63805ead79dcd8a745"><td class="mdescLeft"> </td><td class="mdescRight">Get the GType for this class, for use with the underlying GObject type system. <br/></td></tr>
103
<tr class="separator:a39e9cbc314b2bf63805ead79dcd8a745"><td class="memSeparator" colspan="2"> </td></tr>
104
</table><table class="memberdecls">
105
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
106
Protected Member Functions</h2></td></tr>
107
<tr class="memitem:acbfd02f0474db188114575c0070efbca"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acbfd02f0474db188114575c0070efbca"></a>
108
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Image.html#acbfd02f0474db188114575c0070efbca">Image</a> ()</td></tr>
109
<tr class="memdesc:acbfd02f0474db188114575c0070efbca"><td class="mdescLeft"> </td><td class="mdescRight">You should derive from this class to use it. <br/></td></tr>
110
<tr class="separator:acbfd02f0474db188114575c0070efbca"><td class="memSeparator" colspan="2"> </td></tr>
111
</table><table class="memberdecls">
112
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
85
113
Related Functions</h2></td></tr>
86
114
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
88
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/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>
89
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a03bbf10f56b004d274029b27bd9d83f2"></a><br/></td></tr>
116
<tr class="memitem:a03bbf10f56b004d274029b27bd9d83f2"><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/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>
117
<tr class="memdesc:a03bbf10f56b004d274029b27bd9d83f2"><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a03bbf10f56b004d274029b27bd9d83f2">More...</a><br/></td></tr>
118
<tr class="separator:a03bbf10f56b004d274029b27bd9d83f2"><td class="memSeparator" colspan="2"> </td></tr>
91
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
120
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
92
121
<div class="textblock"><p>The ATK Interface implemented by components which expose image or pixmap content on-screen. </p>
93
122
<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>
94
123
<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>
95
</div><hr/><h2>Member Function Documentation</h2>
96
<a class="anchor" id="a857112f6307dfbf5177096f3bb72d80c"></a><!-- doxytag: member="Atk::Image::get_image_description" ref="a857112f6307dfbf5177096f3bb72d80c" args="() const " -->
124
</div><h2 class="groupheader">Member Function Documentation</h2>
125
<a class="anchor" id="a857112f6307dfbf5177096f3bb72d80c"></a>
97
126
<div class="memitem">
98
127
<div class="memproto">
99
128
<table class="memname">