<!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::ObjectAccessible 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_1ObjectAccessible.html">ObjectAccessible</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#pro-static-methods">Static Protected Member Functions</a> | <a href="#related">Related Functions</a> </div> <div class="headertitle"> <h1>Atk::ObjectAccessible Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="Atk::ObjectAccessible" --><!-- doxytag: inherits="Atk::Object" --> <p>This object class is derived from AtkObject and can be used as a basis implementing accessible objects. <a href="#_details">More...</a></p> <p><code>#include <atkmm/objectaccessible.h></code></p> <!-- startSectionHeader --><div class="dynheader"> Inheritance diagram for Atk::ObjectAccessible:<!-- endSectionHeader --></div> <!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent"> <div class="center"><img src="classAtk_1_1ObjectAccessible__inherit__graph.png" border="0" usemap="#Atk_1_1ObjectAccessible_inherit__map" alt="Inheritance graph"/></div> <map name="Atk_1_1ObjectAccessible_inherit__map" id="Atk_1_1ObjectAccessible_inherit__map"> <area shape="rect" id="node2" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API." alt="" coords="39,237,129,267"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="37,160,131,189"/><area shape="rect" id="node6" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="21,83,147,112"/><area shape="rect" id="node8" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="27,5,141,35"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div> <p><a href="classAtk_1_1ObjectAccessible-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="a418f39365081796182a26468acec8a3d"></a><!-- doxytag: member="Atk::ObjectAccessible::gobj" ref="a418f39365081796182a26468acec8a3d" args="()" --> AtkGObjectAccessible* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1ObjectAccessible.html#a418f39365081796182a26468acec8a3d">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="a3e55ead94a3c4fe574d1dca3e0b081d8"></a><!-- doxytag: member="Atk::ObjectAccessible::gobj" ref="a3e55ead94a3c4fe574d1dca3e0b081d8" args="() const " --> const AtkGObjectAccessible* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1ObjectAccessible.html#a3e55ead94a3c4fe574d1dca3e0b081d8">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"><a class="anchor" id="a5b85926be5fdab14aa1ef9db671c2b3c"></a><!-- doxytag: member="Atk::ObjectAccessible::gobj_copy" ref="a5b85926be5fdab14aa1ef9db671c2b3c" args="()" --> AtkGObjectAccessible* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1ObjectAccessible.html#a5b85926be5fdab14aa1ef9db671c2b3c">gobj_copy</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <br/></td></tr> <tr><td colspan="2"><h2><a name="pro-methods"></a> Protected Member Functions</h2></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="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html">Glib::Object</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1ObjectAccessible.html#a5237c718032945105d72b772297cd849">get_object</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the GObject for which <em>obj</em> is the accessible object. <a href="#a5237c718032945105d72b772297cd849"></a><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>< const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html">Glib::Object</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1ObjectAccessible.html#acfba15fe7e643cbdb6f76ce691570215">get_object</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the GObject for which <em>obj</em> is the accessible object. <a href="#acfba15fe7e643cbdb6f76ce691570215"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="pro-static-methods"></a> Static Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1Object.html">Atk::Object</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1ObjectAccessible.html#a236c02ae1ea75cec8db3e07ae6a47b84">for_object</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html">Glib::Object</a> >& obj)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the accessible object for the specified <em>obj</em>. <a href="#a236c02ae1ea75cec8db3e07ae6a47b84"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <br class="typebreak"/> <a class="el" href="classAtk_1_1Object.html">Atk::Object</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1ObjectAccessible.html#a96e311079f82b9b5e2368c6ea72fa5c3">for_object</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html">Glib::Object</a> >& obj)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the accessible object for the specified <em>obj</em>. <a href="#a96e311079f82b9b5e2368c6ea72fa5c3"></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><br class="typebreak"/> < <a class="el" href="classAtk_1_1ObjectAccessible.html">Atk::ObjectAccessible</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1ObjectAccessible.html#ad064cd66c057c1e305272a0e7ae8a993">wrap</a> (AtkGObjectAccessible* 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="#ad064cd66c057c1e305272a0e7ae8a993"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>This object class is derived from AtkObject and can be used as a basis implementing accessible objects. </p> <p>This can be used as a basis for implementing accessible objects for Glib::Objects which are not derived from Gtk::Widget. One example of its use is in providing an accessible object for GnomeCanvasItem in the GAIL library. </p> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a236c02ae1ea75cec8db3e07ae6a47b84"></a><!-- doxytag: member="Atk::ObjectAccessible::for_object" ref="a236c02ae1ea75cec8db3e07ae6a47b84" args="(const Glib::RefPtr< Glib::Object > &obj)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classAtk_1_1Object.html">Atk::Object</a>> Atk::ObjectAccessible::for_object </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html">Glib::Object</a> > & </td> <td class="paramname"> <em>obj</em> )</td> <td><code> [static, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Gets the accessible object for the specified <em>obj</em>. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">obj</td><td>A <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Object</a>. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Atk::Object</a> which is the accessible object for the <em>obj</em>. </dd></dl> </div> </div> <a class="anchor" id="a96e311079f82b9b5e2368c6ea72fa5c3"></a><!-- doxytag: member="Atk::ObjectAccessible::for_object" ref="a96e311079f82b9b5e2368c6ea72fa5c3" args="(const Glib::RefPtr< const Glib::Object > &obj)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classAtk_1_1Object.html">Atk::Object</a>> Atk::ObjectAccessible::for_object </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html">Glib::Object</a> > & </td> <td class="paramname"> <em>obj</em> )</td> <td><code> [static, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Gets the accessible object for the specified <em>obj</em>. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">obj</td><td>A <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Object</a>. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Atk::Object</a> which is the accessible object for the <em>obj</em>. </dd></dl> </div> </div> <a class="anchor" id="acfba15fe7e643cbdb6f76ce691570215"></a><!-- doxytag: member="Atk::ObjectAccessible::get_object" ref="acfba15fe7e643cbdb6f76ce691570215" 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_1RefPtr.html">Glib::RefPtr</a><const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html">Glib::Object</a>> Atk::ObjectAccessible::get_object </td> <td>(</td> <td class="paramname"> )</td> <td> const<code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Gets the GObject for which <em>obj</em> is the accessible object. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Object</a> which is the object for which <em>obj</em> is the accessible object. </dd></dl> </div> </div> <a class="anchor" id="a5237c718032945105d72b772297cd849"></a><!-- doxytag: member="Atk::ObjectAccessible::get_object" ref="a5237c718032945105d72b772297cd849" args="()" --> <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="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html">Glib::Object</a>> Atk::ObjectAccessible::get_object </td> <td>(</td> <td class="paramname"> )</td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Gets the GObject for which <em>obj</em> is the accessible object. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Object</a> which is the object for which <em>obj</em> is the accessible object. </dd></dl> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="ad064cd66c057c1e305272a0e7ae8a993"></a><!-- doxytag: member="Atk::ObjectAccessible::wrap" ref="ad064cd66c057c1e305272a0e7ae8a993" args="(AtkGObjectAccessible *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_1ObjectAccessible.html">Atk::ObjectAccessible</a> > wrap </td> <td>(</td> <td class="paramtype">AtkGObjectAccessible * </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>