|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
|
3 |
<head> |
|
4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|
5 |
<title>atkmm: Atk::Document Class Reference</title> |
|
6 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
7 |
<link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
8 |
</head> |
|
9 |
<body> |
|
|
0.2.3
by Michael Biebl
Import upstream version 2.22.6 |
10 |
<!-- Generated by Doxygen 1.7.4 -->
|
11 |
<div id="top"> |
|
12 |
<div id="titlearea"> |
|
13 |
<table cellspacing="0" cellpadding="0"> |
|
14 |
<tbody> |
|
15 |
<tr style="height: 56px;"> |
|
16 |
<td style="padding-left: 0.5em;"> |
|
17 |
<div id="projectname">atkmm <span id="projectnumber">2.22.6</span></div> |
|
18 |
</td> |
|
19 |
</tr> |
|
20 |
</tbody> |
|
21 |
</table> |
|
22 |
</div> |
|
23 |
<div id="navrow1" class="tabs"> |
|
|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
24 |
<ul class="tablist"> |
25 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
26 |
<li><a href="pages.html"><span>Related Pages</span></a></li> |
|
27 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
28 |
<li><a href="namespaces.html"><span>Namespaces</span></a></li> |
|
29 |
<li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
|
30 |
</ul> |
|
31 |
</div> |
|
|
0.2.3
by Michael Biebl
Import upstream version 2.22.6 |
32 |
<div id="navrow2" class="tabs2"> |
|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
33 |
<ul class="tablist"> |
34 |
<li><a href="annotated.html"><span>Class List</span></a></li> |
|
|
0.2.3
by Michael Biebl
Import upstream version 2.22.6 |
35 |
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li> |
|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
36 |
<li><a href="functions.html"><span>Class Members</span></a></li> |
37 |
</ul> |
|
38 |
</div> |
|
|
0.2.3
by Michael Biebl
Import upstream version 2.22.6 |
39 |
<div id="nav-path" class="navpath"> |
|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
40 |
<ul> |
|
0.2.3
by Michael Biebl
Import upstream version 2.22.6 |
41 |
<li class="navelem"><a class="el" href="namespaceAtk.html">Atk</a> </li> |
42 |
<li class="navelem"><a class="el" href="classAtk_1_1Document.html">Document</a> </li> |
|
|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
43 |
</ul> |
44 |
</div> |
|
45 |
</div> |
|
46 |
<div class="header"> |
|
47 |
<div class="summary"> |
|
48 |
<a href="#pub-methods">Public Member Functions</a> | |
|
49 |
<a href="#related">Related Functions</a> </div> |
|
50 |
<div class="headertitle"> |
|
|
0.2.3
by Michael Biebl
Import upstream version 2.22.6 |
51 |
<div class="title">Atk::Document Class Reference</div> </div> |
|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
52 |
</div> |
53 |
<div class="contents"> |
|
54 |
<!-- doxytag: class="Atk::Document" --><!-- doxytag: inherits="Glib::Interface" -->
|
|
|
0.2.3
by Michael Biebl
Import upstream version 2.22.6 |
55 |
<p>The ATK interface which allows access to a DOM associated with on object. <a href="classAtk_1_1Document.html#details">More...</a></p> |
|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
56 |
|
57 |
<p><code>#include <atkmm/document.h></code></p> |
|
|
0.2.3
by Michael Biebl
Import upstream version 2.22.6 |
58 |
<div class="dynheader"> |
59 |
Inheritance diagram for Atk::Document:</div> |
|
60 |
<div class="dyncontent"> |
|
|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
61 |
<div class="center"><img src="classAtk_1_1Document__inherit__graph.png" border="0" usemap="#Atk_1_1Document_inherit__map" alt="Inheritance graph"/></div> |
62 |
<map name="Atk_1_1Document_inherit__map" id="Atk_1_1Document_inherit__map"> |
|
63 |
<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="13,160,123,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="5,83,131,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="11,5,125,35"/></map> |
|
|
0.2.3
by Michael Biebl
Import upstream version 2.22.6 |
64 |
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> |
|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
65 |
|
66 |
<p><a href="classAtk_1_1Document-members.html">List of all members.</a></p> |
|
67 |
<table class="memberdecls"> |
|
68 |
<tr><td colspan="2"><h2><a name="pub-methods"></a> |
|
69 |
Public Member Functions</h2></td></tr> |
|
70 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4090329c34cc13c4a9f0ccfdce4cab81"></a><!-- doxytag: member="Atk::Document::gobj" ref="a4090329c34cc13c4a9f0ccfdce4cab81" args="()" --> |
|
71 |
AtkDocument* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#a4090329c34cc13c4a9f0ccfdce4cab81">gobj</a> ()</td></tr> |
|
72 |
<tr><td class="mdescLeft"> </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="ab78f086eab33695dcf4d762155d28d43"></a><!-- doxytag: member="Atk::Document::gobj" ref="ab78f086eab33695dcf4d762155d28d43" args="() const " --> |
|
74 |
const AtkDocument* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#ab78f086eab33695dcf4d762155d28d43">gobj</a> () const </td></tr> |
|
75 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr> |
|
76 |
<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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#afc3d3f8af8e9788684fa9075d4b19ca3">get_document_type</a> () const </td></tr> |
|
77 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets a string indicating the document type. <a href="#afc3d3f8af8e9788684fa9075d4b19ca3"></a><br/></td></tr> |
|
78 |
<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> |
|
79 |
<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> |
|
80 |
<tr><td colspan="2"><h2><a name="related"></a> |
|
81 |
Related Functions</h2></td></tr> |
|
|
0.2.3
by Michael Biebl
Import upstream version 2.22.6 |
82 |
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p> |
83 |
</td></tr> |
|
|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
84 |
<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>< <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> |
85 |
<tr><td class="mdescLeft"> </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="#a03ea1365835687a661421ef1a4ea4582"></a><br/></td></tr> |
|
86 |
</table> |
|
|
0.2.3
by Michael Biebl
Import upstream version 2.22.6 |
87 |
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> |
88 |
<div class="textblock"><p>The ATK interface which allows access to a DOM associated with on object. </p> |
|
|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
89 |
<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> |
|
0.2.3
by Michael Biebl
Import upstream version 2.22.6 |
90 |
</div><hr/><h2>Member Function Documentation</h2> |
|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
91 |
<a class="anchor" id="a9416b4cdce5546b53c01590cf345d916"></a><!-- doxytag: member="Atk::Document::get_document" ref="a9416b4cdce5546b53c01590cf345d916" args="()" --> |
92 |
<div class="memitem"> |
|
93 |
<div class="memproto"> |
|
94 |
<table class="memname"> |
|
95 |
<tr> |
|
96 |
<td class="memname">gpointer Atk::Document::get_document </td> |
|
97 |
<td>(</td> |
|
|
0.2.3
by Michael Biebl
Import upstream version 2.22.6 |
98 |
<td class="paramname"></td><td>)</td> |
|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
99 |
<td></td> |
100 |
</tr> |
|
101 |
</table> |
|
102 |
</div> |
|
103 |
<div class="memdoc"> |
|
104 |
||
105 |
<p>Gets a gpointer that points to an instance of the DOM. </p> |
|
106 |
<p>It is up to the caller to check atk_document_get_type to determine how to cast this pointer. </p> |
|
107 |
<dl class="return"><dt><b>Returns:</b></dt><dd>A gpointer that points to an instance of the DOM. </dd></dl> |
|
108 |
||
109 |
</div> |
|
110 |
</div> |
|
111 |
<a class="anchor" id="afc3d3f8af8e9788684fa9075d4b19ca3"></a><!-- doxytag: member="Atk::Document::get_document_type" ref="afc3d3f8af8e9788684fa9075d4b19ca3" args="() const " --> |
|
112 |
<div class="memitem"> |
|
113 |
<div class="memproto"> |
|
114 |
<table class="memname"> |
|
115 |
<tr> |
|
116 |
<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_1ustring.html">Glib::ustring</a> Atk::Document::get_document_type </td> |
|
117 |
<td>(</td> |
|
|
0.2.3
by Michael Biebl
Import upstream version 2.22.6 |
118 |
<td class="paramname"></td><td>)</td> |
|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
119 |
<td> const</td> |
120 |
</tr> |
|
121 |
</table> |
|
122 |
</div> |
|
123 |
<div class="memdoc"> |
|
124 |
||
125 |
<p>Gets a string indicating the document type. </p> |
|
126 |
<dl class="return"><dt><b>Returns:</b></dt><dd>A string indicating the document type. </dd></dl> |
|
127 |
||
128 |
</div> |
|
129 |
</div> |
|
130 |
<hr/><h2>Friends And Related Function Documentation</h2> |
|
131 |
<a class="anchor" id="a03ea1365835687a661421ef1a4ea4582"></a><!-- doxytag: member="Atk::Document::wrap" ref="a03ea1365835687a661421ef1a4ea4582" args="(AtkDocument *object, bool take_copy=false)" --> |
|
132 |
<div class="memitem"> |
|
133 |
<div class="memproto"> |
|
134 |
<table class="memname"> |
|
135 |
<tr> |
|
136 |
<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>< <a class="el" href="classAtk_1_1Document.html">Atk::Document</a> > wrap </td> |
|
137 |
<td>(</td> |
|
138 |
<td class="paramtype">AtkDocument * </td> |
|
|
0.2.3
by Michael Biebl
Import upstream version 2.22.6 |
139 |
<td class="paramname"><em>object</em>, </td> |
|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
140 |
</tr> |
141 |
<tr> |
|
142 |
<td class="paramkey"></td> |
|
143 |
<td></td> |
|
144 |
<td class="paramtype">bool </td> |
|
|
0.2.3
by Michael Biebl
Import upstream version 2.22.6 |
145 |
<td class="paramname"><em>take_copy</em> = <code>false</code> </td> |
|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
146 |
</tr> |
147 |
<tr> |
|
148 |
<td></td> |
|
149 |
<td>)</td> |
|
150 |
<td></td><td><code> [related]</code></td> |
|
151 |
</tr> |
|
152 |
</table> |
|
153 |
</div> |
|
154 |
<div class="memdoc"> |
|
155 |
||
156 |
<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> |
|
157 |
<dl><dt><b>Parameters:</b></dt><dd> |
|
158 |
<table class="params"> |
|
159 |
<tr><td class="paramname">object</td><td>The C instance. </td></tr> |
|
160 |
<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> |
|
161 |
</table> |
|
162 |
</dd> |
|
163 |
</dl> |
|
164 |
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl> |
|
165 |
||
166 |
</div> |
|
167 |
</div> |
|
168 |
</div> |
|
|
0.2.3
by Michael Biebl
Import upstream version 2.22.6 |
169 |
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 26 2011 13:06:40 for atkmm by  |
|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
170 |
<a href="http://www.doxygen.org/index.html"> |
|
0.2.3
by Michael Biebl
Import upstream version 2.22.6 |
171 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address> |
|
0.1.1
by Krzysztof Klimonda
Import upstream version 2.22.1 |
172 |
</body> |
173 |
</html> |