~ubuntu-branches/ubuntu/saucy/atkmm1.6/saucy-proposed

« back to all changes in this revision

Viewing changes to doc/reference/html/classAtk_1_1Image.html

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2013-05-28 13:04:34 UTC
  • mfrom: (0.1.6 sid)
  • Revision ID: package-import@ubuntu.com-20130528130434-e0esxsm4eo8bn8tf
Tags: 2.22.7-1ubuntu1
* Resynchronize on Debian, remaining diff
* Convert to multiarch (LP: #902703):
  - Pass --libdir with multiarch path to configure
  - Adjust .install files to refer to /usr/lib subdirs
  - Add multiarch Pre-Depends
  - Bump debhelper and cdbs build-deps for ${misc:Pre-Depends} and
    $(DEB_HOST_MULTIARCH) support, respectively
* debian/compat: update to 9.

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
3
<head>
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" />
8
12
</head>
9
13
<body>
10
 
<!-- Generated by Doxygen 1.7.4 -->
11
 
<div id="top">
 
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">
14
17
 <tbody>
15
18
 <tr style="height: 56px;">
16
19
  <td style="padding-left: 0.5em;">
17
 
   <div id="projectname">atkmm&#160;<span id="projectnumber">2.22.6</span></div>
 
20
   <div id="projectname">atkmm
 
21
   &#160;<span id="projectnumber">2.22.7</span>
 
22
   </div>
18
23
  </td>
19
24
 </tr>
20
25
 </tbody>
21
26
</table>
22
27
</div>
 
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&#160;Page</span></a></li>
36
43
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
37
44
    </ul>
38
45
  </div>
39
 
  <div id="nav-path" class="navpath">
40
 
    <ul>
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>
43
 
    </ul>
44
 
  </div>
 
46
<div id="nav-path" class="navpath">
 
47
  <ul>
 
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>
45
49
</div>
 
50
</div><!-- top -->
46
51
<div class="header">
47
52
  <div class="summary">
48
53
<a href="#pub-methods">Public Member Functions</a> &#124;
49
 
<a href="#related">Related Functions</a> </div>
 
54
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
 
55
<a href="#pro-methods">Protected Member Functions</a> &#124;
 
56
<a href="#related">Related Functions</a> &#124;
 
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>
52
 
</div>
 
59
<div class="title">Atk::Image Class Reference</div>  </div>
 
60
</div><!--header-->
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>
 
62
 
 
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>
56
65
 
57
66
<p><code>#include &lt;atkmm/image.h&gt;</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>
 
72
</map>
64
73
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
65
 
 
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*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Image.html#a7649474169b7726721b1b5688420c377">gobj</a> ()</td></tr>
72
 
<tr><td class="mdescLeft">&#160;</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">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
 
80
<tr class="separator:a7649474169b7726721b1b5688420c377"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
81
<tr class="memitem:a671c40909151052e66300c1324217377"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a671c40909151052e66300c1324217377"></a>
74
82
const AtkImage*&#160;</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">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
76
 
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</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>&amp; description)</td></tr>
77
 
<tr><td class="mdescLeft">&#160;</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>&#160;</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">&#160;</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&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Image.html#a22a4c26e1642a421ffec41ea6492e11b">get_image_size</a> (int&amp; width, int&amp; height) const </td></tr>
81
 
<tr><td class="mdescLeft">&#160;</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&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Image.html#af22f48ac491ceddb82329076cc63fca9">get_image_position</a> (int&amp; x, int&amp; y, CoordType coord_type) const </td></tr>
83
 
<tr><td class="mdescLeft">&#160;</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">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
 
84
<tr class="separator:a671c40909151052e66300c1324217377"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
85
<tr class="memitem:a53fe6d9b350bf5fd7ba19a6f7179a55c"><td class="memItemLeft" align="right" valign="top">bool&#160;</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>&amp; description)</td></tr>
 
86
<tr class="memdesc:a53fe6d9b350bf5fd7ba19a6f7179a55c"><td class="mdescLeft">&#160;</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">&#160;</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>&#160;</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">&#160;</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">&#160;</td></tr>
 
91
<tr class="memitem:a22a4c26e1642a421ffec41ea6492e11b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Image.html#a22a4c26e1642a421ffec41ea6492e11b">get_image_size</a> (int&amp; width, int&amp; height) const </td></tr>
 
92
<tr class="memdesc:a22a4c26e1642a421ffec41ea6492e11b"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
 
94
<tr class="memitem:af22f48ac491ceddb82329076cc63fca9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Image.html#af22f48ac491ceddb82329076cc63fca9">get_image_position</a> (int&amp; x, int&amp; y, CoordType coord_type) const </td></tr>
 
95
<tr class="memdesc:af22f48ac491ceddb82329076cc63fca9"><td class="mdescLeft">&#160;</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">&#160;</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&#160;</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">&#160;</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">&#160;</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
&#160;</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">&#160;</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">&#160;</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>
87
115
</td></tr>
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>&lt; <a class="el" href="classAtk_1_1Image.html">Atk::Image</a> &gt;&#160;</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">&#160;</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>&lt; <a class="el" href="classAtk_1_1Image.html">Atk::Image</a> &gt;&#160;</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">&#160;</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">&#160;</td></tr>
90
119
</table>
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">
104
133
          <td> const</td>
105
134
        </tr>
106
135
      </table>
107
 
</div>
108
 
<div class="memdoc">
 
136
</div><div class="memdoc">
109
137
 
110
138
<p>Get a textual description of this image. </p>
111
 
<dl class="return"><dt><b>Returns:</b></dt><dd>A string representing the image description. </dd></dl>
 
139
<dl class="section return"><dt>Returns</dt><dd>A string representing the image description. </dd></dl>
112
140
 
113
141
</div>
114
142
</div>
115
 
<a class="anchor" id="af22f48ac491ceddb82329076cc63fca9"></a><!-- doxytag: member="Atk::Image::get_image_position" ref="af22f48ac491ceddb82329076cc63fca9" args="(int &amp;x, int &amp;y, CoordType coord_type) const " -->
 
143
<a class="anchor" id="af22f48ac491ceddb82329076cc63fca9"></a>
116
144
<div class="memitem">
117
145
<div class="memproto">
118
146
      <table class="memname">
140
168
          <td></td><td> const</td>
141
169
        </tr>
142
170
      </table>
143
 
</div>
144
 
<div class="memdoc">
 
171
</div><div class="memdoc">
145
172
 
146
173
<p>Gets the position of the image in the form of a point specifying the images top-left corner. </p>
147
 
<dl><dt><b>Parameters:</b></dt><dd>
 
174
<dl class="params"><dt>Parameters</dt><dd>
148
175
  <table class="params">
149
176
    <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>
150
177
    <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>
155
182
 
156
183
</div>
157
184
</div>
158
 
<a class="anchor" id="a22a4c26e1642a421ffec41ea6492e11b"></a><!-- doxytag: member="Atk::Image::get_image_size" ref="a22a4c26e1642a421ffec41ea6492e11b" args="(int &amp;width, int &amp;height) const " -->
 
185
<a class="anchor" id="a22a4c26e1642a421ffec41ea6492e11b"></a>
159
186
<div class="memitem">
160
187
<div class="memproto">
161
188
      <table class="memname">
177
204
          <td></td><td> const</td>
178
205
        </tr>
179
206
      </table>
180
 
</div>
181
 
<div class="memdoc">
 
207
</div><div class="memdoc">
182
208
 
183
209
<p>Get the width and height in pixels for the specified image. </p>
184
210
<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>
185
 
<dl><dt><b>Parameters:</b></dt><dd>
 
211
<dl class="params"><dt>Parameters</dt><dd>
186
212
  <table class="params">
187
213
    <tr><td class="paramname">width</td><td>Filled with the image width, or -1 if the value cannot be obtained. </td></tr>
188
214
    <tr><td class="paramname">height</td><td>Filled with the image height, or -1 if the value cannot be obtained. </td></tr>
192
218
 
193
219
</div>
194
220
</div>
195
 
<a class="anchor" id="a53fe6d9b350bf5fd7ba19a6f7179a55c"></a><!-- doxytag: member="Atk::Image::set_image_description" ref="a53fe6d9b350bf5fd7ba19a6f7179a55c" args="(const Glib::ustring &amp;description)" -->
 
221
<a class="anchor" id="a53fe6d9b350bf5fd7ba19a6f7179a55c"></a>
196
222
<div class="memitem">
197
223
<div class="memproto">
198
224
      <table class="memname">
204
230
          <td></td>
205
231
        </tr>
206
232
      </table>
207
 
</div>
208
 
<div class="memdoc">
 
233
</div><div class="memdoc">
209
234
 
210
235
<p>Sets the textual description for this image. </p>
211
 
<dl><dt><b>Parameters:</b></dt><dd>
 
236
<dl class="params"><dt>Parameters</dt><dd>
212
237
  <table class="params">
213
238
    <tr><td class="paramname">description</td><td>A string description to set for <em>image</em>. </td></tr>
214
239
  </table>
215
240
  </dd>
216
241
</dl>
217
 
<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>
 
242
<dl class="section return"><dt>Returns</dt><dd>Boolean <code>true</code>, or <code>false</code> if operation could not be completed. </dd></dl>
218
243
 
219
244
</div>
220
245
</div>
221
 
<hr/><h2>Friends And Related Function Documentation</h2>
222
 
<a class="anchor" id="a03bbf10f56b004d274029b27bd9d83f2"></a><!-- doxytag: member="Atk::Image::wrap" ref="a03bbf10f56b004d274029b27bd9d83f2" args="(AtkImage *object, bool take_copy=false)" -->
 
246
<h2 class="groupheader">Friends And Related Function Documentation</h2>
 
247
<a class="anchor" id="a03bbf10f56b004d274029b27bd9d83f2"></a>
223
248
<div class="memitem">
224
249
<div class="memproto">
 
250
<table class="mlabels">
 
251
  <tr>
 
252
  <td class="mlabels-left">
225
253
      <table class="memname">
226
254
        <tr>
227
255
          <td class="memname"><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>&lt; <a class="el" href="classAtk_1_1Image.html">Atk::Image</a> &gt; wrap </td>
238
266
        <tr>
239
267
          <td></td>
240
268
          <td>)</td>
241
 
          <td></td><td><code> [related]</code></td>
 
269
          <td></td><td></td>
242
270
        </tr>
243
271
      </table>
244
 
</div>
245
 
<div class="memdoc">
 
272
  </td>
 
273
  <td class="mlabels-right">
 
274
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
 
275
  </tr>
 
276
</table>
 
277
</div><div class="memdoc">
246
278
 
247
279
<p>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. </p>
248
 
<dl><dt><b>Parameters:</b></dt><dd>
 
280
<dl class="params"><dt>Parameters</dt><dd>
249
281
  <table class="params">
250
282
    <tr><td class="paramname">object</td><td>The C instance. </td></tr>
251
283
    <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>
252
284
  </table>
253
285
  </dd>
254
286
</dl>
255
 
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
 
287
<dl class="section return"><dt>Returns</dt><dd>A C++ instance that wraps this C instance. </dd></dl>
256
288
 
257
289
</div>
258
290
</div>
259
 
</div>
260
 
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 26 2011 13:06:40 for atkmm by&#160;
261
 
<a href="http://www.doxygen.org/index.html">
262
 
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
 
291
</div><!-- contents -->
 
292
<!-- start footer part -->
 
293
<hr class="footer"/><address class="footer"><small>
 
294
Generated on Wed Apr 24 2013 11:08:12 for atkmm by &#160;<a href="http://www.doxygen.org/index.html">
 
295
<img class="footer" src="doxygen.png" alt="doxygen"/>
 
296
</a> 1.8.3.1
 
297
</small></address>
263
298
</body>
264
299
</html>