<!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::Document 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_1Document.html">Document</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::Document Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="Atk::Document" --><!-- doxytag: inherits="Glib::Interface" --> <p>The ATK interface which allows access to a DOM associated with on object. <a href="#_details">More...</a></p> <p><code>#include <atkmm/document.h></code></p> <!-- startSectionHeader --><div class="dynheader"> Inheritance diagram for Atk::Document:<!-- endSectionHeader --></div> <!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent"> <div class="center"><img src="classAtk_1_1Document__inherit__graph.png" border="0" usemap="#Atk_1_1Document_inherit__map" alt="Inheritance graph"/></div> <map name="Atk_1_1Document_inherit__map" id="Atk_1_1Document_inherit__map"> <area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="13,160,123,189"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,83,131,112"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="11,5,125,35"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div> <p><a href="classAtk_1_1Document-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="a4090329c34cc13c4a9f0ccfdce4cab81"></a><!-- doxytag: member="Atk::Document::gobj" ref="a4090329c34cc13c4a9f0ccfdce4cab81" args="()" --> AtkDocument* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#a4090329c34cc13c4a9f0ccfdce4cab81">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="ab78f086eab33695dcf4d762155d28d43"></a><!-- doxytag: member="Atk::Document::gobj" ref="ab78f086eab33695dcf4d762155d28d43" args="() const " --> const AtkDocument* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#ab78f086eab33695dcf4d762155d28d43">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="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_1Document.html#afc3d3f8af8e9788684fa9075d4b19ca3">get_document_type</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets a string indicating the document type. <a href="#afc3d3f8af8e9788684fa9075d4b19ca3"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">gpointer </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#a9416b4cdce5546b53c01590cf345d916">get_document</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets a gpointer that points to an instance of the DOM. <a href="#a9416b4cdce5546b53c01590cf345d916"></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_1Document.html">Atk::Document</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#a03ea1365835687a661421ef1a4ea4582">wrap</a> (AtkDocument* 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="#a03ea1365835687a661421ef1a4ea4582"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>The ATK interface which allows access to a DOM associated with on object. </p> <p>This interface should be supported by any object that has an associated document object model (DOM). This interface provides the standard mechanism allowing an assistive technology access to the DOM. </p> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a9416b4cdce5546b53c01590cf345d916"></a><!-- doxytag: member="Atk::Document::get_document" ref="a9416b4cdce5546b53c01590cf345d916" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gpointer Atk::Document::get_document </td> <td>(</td> <td class="paramname"> )</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Gets a gpointer that points to an instance of the DOM. </p> <p>It is up to the caller to check atk_document_get_type to determine how to cast this pointer. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A gpointer that points to an instance of the DOM. </dd></dl> </div> </div> <a class="anchor" id="afc3d3f8af8e9788684fa9075d4b19ca3"></a><!-- doxytag: member="Atk::Document::get_document_type" ref="afc3d3f8af8e9788684fa9075d4b19ca3" 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::Document::get_document_type </td> <td>(</td> <td class="paramname"> )</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Gets a string indicating the document type. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A string indicating the document type. </dd></dl> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="a03ea1365835687a661421ef1a4ea4582"></a><!-- doxytag: member="Atk::Document::wrap" ref="a03ea1365835687a661421ef1a4ea4582" args="(AtkDocument *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_1Document.html">Atk::Document</a> > wrap </td> <td>(</td> <td class="paramtype">AtkDocument * </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>