<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>gtkmm 2.4: Atk::Document Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
<td width="10%" height="40"><img src="../../images/gtkmm_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
<td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
<a class="qindex" href="../../index.html">Main Page</a>
<a href="group__Widgets.html">Widgets</a>
<a class="qindex" href="namespaces.html"> Namespaces</a>
<a href="../../tutorial/html/index.html"> Book</a>
</center>
<hr width="100%"/>
<!-- begin main content -->
<div id="content">
<!-- Generated by Doxygen 1.5.1 -->
<div class="nav">
<a class="el" href="namespaceAtk.html">Atk</a>::<a class="el" href="classAtk_1_1Document.html">Document</a></div>
<h1>Atk::Document Class Reference</h1><!-- doxytag: class="Atk::Document" --><!-- doxytag: inherits="Glib::Interface" -->Inheritance diagram for Atk::Document:<p><center><img src="classAtk_1_1Document__inherit__graph.png" border="0" usemap="#Atk_1_1Document__inherit__map" alt="Inheritance graph"></center>
<map name="Atk_1_1Document__inherit__map">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1Interface.html" shape="rect" coords="13,161,123,188" alt="">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ObjectBase.html" shape="rect" coords="5,84,131,111" alt="">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classsigc_1_1trackable.html" shape="rect" coords="12,7,124,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classAtk_1_1Document-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
The ATK interface which allows access to a DOM associated with on object.
<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>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">gpointer </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#9416b4cdce5546b53c01590cf345d916">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="#9416b4cdce5546b53c01590cf345d916"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#93c1d822a7139d7d2c4ecef982eb9919">get_document_type</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets a string indicating the document type. <a href="#93c1d822a7139d7d2c4ecef982eb9919"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const AtkDocument* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#cfc19dbad9ec55bd3599d3ce6657ccb3">gobj</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#cfc19dbad9ec55bd3599d3ce6657ccb3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AtkDocument* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#4090329c34cc13c4a9f0ccfdce4cab81">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#4090329c34cc13c4a9f0ccfdce4cab81"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#8f3b2dbf16d9922eaad196249ef221e9">~Document</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#4196505a6fa361087e1331099f163a9b">add_interface</a> (GType gtype_implementer)</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const gchar* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#a5cad9c4e1d0d2ff7bd66185e1249828">get_document_type_vfunc</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual gpointer </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#ecb092e7d42b5694ee2fa47984f0b15e">get_document_vfunc</a> () const</td></tr>
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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#03ea1365835687a661421ef1a4ea4582">wrap</a> (AtkDocument* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#03ea1365835687a661421ef1a4ea4582"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="8f3b2dbf16d9922eaad196249ef221e9"></a><!-- doxytag: member="Atk::Document::~Document" ref="8f3b2dbf16d9922eaad196249ef221e9" 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 width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4196505a6fa361087e1331099f163a9b"></a><!-- doxytag: member="Atk::Document::add_interface" ref="4196505a6fa361087e1331099f163a9b" 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 width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="9416b4cdce5546b53c01590cf345d916"></a><!-- doxytag: member="Atk::Document::get_document" ref="9416b4cdce5546b53c01590cf345d916" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets a gpointer that points to an instance of the DOM.
<p>
It is up to the caller to check atk_document_get_type to determine how to cast this pointer. <dl class="return" compact><dt><b>Returns:</b></dt><dd>A gpointer that points to an instance of the DOM. </dd></dl>
</div>
</div><p>
<a class="anchor" name="93c1d822a7139d7d2c4ecef982eb9919"></a><!-- doxytag: member="Atk::Document::get_document_type" ref="93c1d822a7139d7d2c4ecef982eb9919" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Atk::Document::get_document_type </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets a string indicating the document type.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A string indicating the document type. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a5cad9c4e1d0d2ff7bd66185e1249828"></a><!-- doxytag: member="Atk::Document::get_document_type_vfunc" ref="a5cad9c4e1d0d2ff7bd66185e1249828" 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 width="100%"><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="ecb092e7d42b5694ee2fa47984f0b15e"></a><!-- doxytag: member="Atk::Document::get_document_vfunc" ref="ecb092e7d42b5694ee2fa47984f0b15e" 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 width="100%"> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="cfc19dbad9ec55bd3599d3ce6657ccb3"></a><!-- doxytag: member="Atk::Document::gobj" ref="cfc19dbad9ec55bd3599d3ce6657ccb3" 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 width="100%"> 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" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1Interface.html#4737c92fa9930b4f006ab8b3c9487504">Glib::Interface</a>.
</div>
</div><p>
<a class="anchor" name="4090329c34cc13c4a9f0ccfdce4cab81"></a><!-- doxytag: member="Atk::Document::gobj" ref="4090329c34cc13c4a9f0ccfdce4cab81" 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 width="100%"><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" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1Interface.html#969e9396f75132a9577428f4fa932d42">Glib::Interface</a>.
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="03ea1365835687a661421ef1a4ea4582"></a><!-- doxytag: member="Atk::Document::wrap" ref="03ea1365835687a661421ef1a4ea4582" args="(AtkDocument *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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 width="100%"><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object.
<p>
<dl compact><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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="document_8h.html">document.h</a></ul>
</div>
<!-- end main content -->
<hr><address><small>
Generated for gtkmm 2.4 by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.5.1 © 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
9411cff4bc6d4e61b29ae81cd24665af
>
files
>
71
