<!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>gtkmm: 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.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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"><a class="el" href="namespaceAtk.html">Atk</a>::<a class="el" href="classAtk_1_1Document.html">Document</a>
</div>
</div>
<div class="contents">
<h1>Atk::Document Class Reference</h1><!-- 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>Inherits <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html">Glib::Interface</a>.</p>
<div class="dynheader">
Collaboration diagram for Atk::Document:</div>
<div class="dynsection">
<div class="center"><img src="classAtk_1_1Document__coll__graph.png" border="0" usemap="#Atk_1_1Document_coll__map" alt="Collaboration graph"/></div>
<map name="Atk_1_1Document_coll__map" id="Atk_1_1Document_coll__map">
<area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="13,160,117,189"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,83,125,112"/><area shape="rect" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,5,119,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classAtk_1_1Document-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#a8f3b2dbf16d9922eaad196249ef221e9">~Document</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">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. <a href="#a4090329c34cc13c4a9f0ccfdce4cab81"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">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. <a href="#ab78f086eab33695dcf4d762155d28d43"></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_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>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#a4196505a6fa361087e1331099f163a9b">add_interface</a> (GType gtype_implementer)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const gchar* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#aa5cad9c4e1d0d2ff7bd66185e1249828">get_document_type_vfunc</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual gpointer </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#a55bcf80a0f7e9e6d65e9668cd02f5064">get_document_vfunc</a> () const </td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><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>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8f3b2dbf16d9922eaad196249ef221e9"></a><!-- doxytag: member="Atk::Document::~Document" ref="a8f3b2dbf16d9922eaad196249ef221e9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Atk::Document::~Document </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4196505a6fa361087e1331099f163a9b"></a><!-- doxytag: member="Atk::Document::add_interface" ref="a4196505a6fa361087e1331099f163a9b" args="(GType gtype_implementer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void Atk::Document::add_interface </td>
<td>(</td>
<td class="paramtype">GType </td>
<td class="paramname"> <em>gtype_implementer</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<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>
<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> ) </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>
<a class="anchor" id="aa5cad9c4e1d0d2ff7bd66185e1249828"></a><!-- doxytag: member="Atk::Document::get_document_type_vfunc" ref="aa5cad9c4e1d0d2ff7bd66185e1249828" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const gchar* Atk::Document::get_document_type_vfunc </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a55bcf80a0f7e9e6d65e9668cd02f5064"></a><!-- doxytag: member="Atk::Document::get_document_vfunc" ref="a55bcf80a0f7e9e6d65e9668cd02f5064" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual gpointer Atk::Document::get_document_vfunc </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ab78f086eab33695dcf4d762155d28d43"></a><!-- doxytag: member="Atk::Document::gobj" ref="ab78f086eab33695dcf4d762155d28d43" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const AtkDocument* Atk::Document::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GObject. </p>
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html#a70a443071a69d3372c2cdd7128a91ed1">Glib::Interface</a>.</p>
</div>
</div>
<a class="anchor" id="a4090329c34cc13c4a9f0ccfdce4cab81"></a><!-- doxytag: member="Atk::Document::gobj" ref="a4090329c34cc13c4a9f0ccfdce4cab81" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AtkDocument* Atk::Document::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GObject. </p>
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html#a969e9396f75132a9577428f4fa932d42">Glib::Interface</a>.</p>
</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><td> </td>
</tr>
<tr>
<td></td>
<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 border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </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>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>atkmm/document.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 13:21:42 2010 for gtkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
22e237efd6851989a23adf3360bb53d0
>
files
>
25
