← Back to branch summary

~ubuntu-branches/ubuntu/saucy/atkmm1.6/saucy-proposed

« back to all changes in this revision

Viewing changes to doc/reference/html/classAtk_1_1Document.html

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2013-05-28 13:04:34 UTC
  • mfrom: (0.1.6 sid)
  • Revision ID: package-import@ubuntu.com-20130528130434-e0esxsm4eo8bn8tf
Tags: 2.22.7-1ubuntu1
https://launchpad.net/bugs/902703
* Resynchronize on Debian, remaining diff
* Convert to multiarch (LP: #902703):
  - Pass --libdir with multiarch path to configure
  - Adjust .install files to refer to /usr/lib subdirs
  - Add multiarch Pre-Depends
  - Bump debhelper and cdbs build-deps for ${misc:Pre-Depends} and
    $(DEB_HOST_MULTIARCH) support, respectively
* debian/compat: update to 9.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/classAtk_1_1Document.html
2
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
 
6
<meta name="generator" content="Doxygen 1.8.3.1"/>
5
7
<title>atkmm: Atk::Document Class Reference</title>
6
8
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
 
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
9
<script type="text/javascript" src="jquery.js"></script>
 
10
<script type="text/javascript" src="dynsections.js"></script>
 
11
<link href="doxygen.css" rel="stylesheet" type="text/css" />
8
12
</head>
9
13
<body>
10
 
<!-- Generated by Doxygen 1.7.4 -->
11
 
<div id="top">
 
14
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
12
15
<div id="titlearea">
13
16
<table cellspacing="0" cellpadding="0">
14
17
 <tbody>
15
18
 <tr style="height: 56px;">
16
19
  <td style="padding-left: 0.5em;">
17
 
   <div id="projectname">atkmm&#160;<span id="projectnumber">2.22.6</span></div>
 
20
   <div id="projectname">atkmm
 
21
   &#160;<span id="projectnumber">2.22.7</span>
 
22
   </div>
18
23
  </td>
19
24
 </tr>
20
25
 </tbody>
21
26
</table>
22
27
</div>
 
28
<!-- end header part -->
 
29
<!-- Generated by Doxygen 1.8.3.1 -->
23
30
  <div id="navrow1" class="tabs">
24
31
    <ul class="tablist">
25
32
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
36
43
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
37
44
    </ul>
38
45
  </div>
39
 
  <div id="nav-path" class="navpath">
40
 
    <ul>
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>
43
 
    </ul>
44
 
  </div>
 
46
<div id="nav-path" class="navpath">
 
47
  <ul>
 
48
<li class="navelem"><a class="el" href="namespaceAtk.html">Atk</a></li><li class="navelem"><a class="el" href="classAtk_1_1Document.html">Document</a></li>  </ul>
45
49
</div>
 
50
</div><!-- top -->
46
51
<div class="header">
47
52
  <div class="summary">
48
53
<a href="#pub-methods">Public Member Functions</a> &#124;
49
 
<a href="#related">Related Functions</a> </div>
 
54
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
 
55
<a href="#pro-methods">Protected Member Functions</a> &#124;
 
56
<a href="#related">Related Functions</a> &#124;
 
57
<a href="classAtk_1_1Document-members.html">List of all members</a>  </div>
50
58
  <div class="headertitle">
51
 
<div class="title">Atk::Document Class Reference</div> </div>
52
 
</div>
 
59
<div class="title">Atk::Document Class Reference</div>  </div>
 
60
</div><!--header-->
53
61
<div class="contents">
54
 
<!-- doxytag: class="Atk::Document" --><!-- doxytag: inherits="Glib::Interface" -->
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>
 
62
 
 
63
<p>The ATK interface which allows access to a DOM associated with on object.  
 
64
 <a href="classAtk_1_1Document.html#details">More...</a></p>
56
65
 
57
66
<p><code>#include &lt;atkmm/document.h&gt;</code></p>
58
67
<div class="dynheader">
60
69
<div class="dyncontent">
61
70
<div class="center"><img src="classAtk_1_1Document__inherit__graph.png" border="0" usemap="#Atk_1_1Document_inherit__map" alt="Inheritance graph"/></div>
62
71
<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>
 
72
</map>
64
73
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
65
 
 
66
 
<p><a href="classAtk_1_1Document-members.html">List of all members.</a></p>
67
74
<table class="memberdecls">
68
 
<tr><td colspan="2"><h2><a name="pub-methods"></a>
 
75
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
69
76
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="()" -->
 
77
<tr class="memitem:a4090329c34cc13c4a9f0ccfdce4cab81"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4090329c34cc13c4a9f0ccfdce4cab81"></a>
71
78
AtkDocument*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#a4090329c34cc13c4a9f0ccfdce4cab81">gobj</a> ()</td></tr>
72
 
<tr><td class="mdescLeft">&#160;</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 " -->
 
79
<tr class="memdesc:a4090329c34cc13c4a9f0ccfdce4cab81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
 
80
<tr class="separator:a4090329c34cc13c4a9f0ccfdce4cab81"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
81
<tr class="memitem:ab78f086eab33695dcf4d762155d28d43"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab78f086eab33695dcf4d762155d28d43"></a>
74
82
const AtkDocument*&#160;</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">&#160;</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>&#160;</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">&#160;</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&#160;</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">&#160;</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>
 
83
<tr class="memdesc:ab78f086eab33695dcf4d762155d28d43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
 
84
<tr class="separator:ab78f086eab33695dcf4d762155d28d43"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
85
<tr class="memitem:afc3d3f8af8e9788684fa9075d4b19ca3"><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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#afc3d3f8af8e9788684fa9075d4b19ca3">get_document_type</a> () const </td></tr>
 
86
<tr class="memdesc:afc3d3f8af8e9788684fa9075d4b19ca3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a string indicating the document type.  <a href="#afc3d3f8af8e9788684fa9075d4b19ca3">More...</a><br/></td></tr>
 
87
<tr class="separator:afc3d3f8af8e9788684fa9075d4b19ca3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
88
<tr class="memitem:a9416b4cdce5546b53c01590cf345d916"><td class="memItemLeft" align="right" valign="top">gpointer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#a9416b4cdce5546b53c01590cf345d916">get_document</a> ()</td></tr>
 
89
<tr class="memdesc:a9416b4cdce5546b53c01590cf345d916"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a gpointer that points to an instance of the DOM.  <a href="#a9416b4cdce5546b53c01590cf345d916">More...</a><br/></td></tr>
 
90
<tr class="separator:a9416b4cdce5546b53c01590cf345d916"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
91
</table><table class="memberdecls">
 
92
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
 
93
Static Public Member Functions</h2></td></tr>
 
94
<tr class="memitem:a2fbe181bf5391efbc4cd83df6aae15d5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2fbe181bf5391efbc4cd83df6aae15d5"></a>
 
95
static GType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#a2fbe181bf5391efbc4cd83df6aae15d5">get_type</a> ()</td></tr>
 
96
<tr class="memdesc:a2fbe181bf5391efbc4cd83df6aae15d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the GType for this class, for use with the underlying GObject type system. <br/></td></tr>
 
97
<tr class="separator:a2fbe181bf5391efbc4cd83df6aae15d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
98
</table><table class="memberdecls">
 
99
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
 
100
Protected Member Functions</h2></td></tr>
 
101
<tr class="memitem:a7d887df675bfe88dca815e09684e4eba"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d887df675bfe88dca815e09684e4eba"></a>
 
102
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Document.html#a7d887df675bfe88dca815e09684e4eba">Document</a> ()</td></tr>
 
103
<tr class="memdesc:a7d887df675bfe88dca815e09684e4eba"><td class="mdescLeft">&#160;</td><td class="mdescRight">You should derive from this class to use it. <br/></td></tr>
 
104
<tr class="separator:a7d887df675bfe88dca815e09684e4eba"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
105
</table><table class="memberdecls">
 
106
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
81
107
Related Functions</h2></td></tr>
82
108
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
83
109
</td></tr>
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>&lt; <a class="el" href="classAtk_1_1Document.html">Atk::Document</a> &gt;&#160;</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">&#160;</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>
 
110
<tr class="memitem:a03ea1365835687a661421ef1a4ea4582"><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>&lt; <a class="el" href="classAtk_1_1Document.html">Atk::Document</a> &gt;&#160;</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>
 
111
<tr class="memdesc:a03ea1365835687a661421ef1a4ea4582"><td class="mdescLeft">&#160;</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">More...</a><br/></td></tr>
 
112
<tr class="separator:a03ea1365835687a661421ef1a4ea4582"><td class="memSeparator" colspan="2">&#160;</td></tr>
86
113
</table>
87
 
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
 
114
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
88
115
<div class="textblock"><p>The ATK interface which allows access to a DOM associated with on object. </p>
89
116
<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>
90
 
</div><hr/><h2>Member Function Documentation</h2>
91
 
<a class="anchor" id="a9416b4cdce5546b53c01590cf345d916"></a><!-- doxytag: member="Atk::Document::get_document" ref="a9416b4cdce5546b53c01590cf345d916" args="()" -->
 
117
</div><h2 class="groupheader">Member Function Documentation</h2>
 
118
<a class="anchor" id="a9416b4cdce5546b53c01590cf345d916"></a>
92
119
<div class="memitem">
93
120
<div class="memproto">
94
121
      <table class="memname">
99
126
          <td></td>
100
127
        </tr>
101
128
      </table>
102
 
</div>
103
 
<div class="memdoc">
 
129
</div><div class="memdoc">
104
130
 
105
131
<p>Gets a gpointer that points to an instance of the DOM. </p>
106
132
<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>
 
133
<dl class="section return"><dt>Returns</dt><dd>A gpointer that points to an instance of the DOM. </dd></dl>
108
134
 
109
135
</div>
110
136
</div>
111
 
<a class="anchor" id="afc3d3f8af8e9788684fa9075d4b19ca3"></a><!-- doxytag: member="Atk::Document::get_document_type" ref="afc3d3f8af8e9788684fa9075d4b19ca3" args="() const " -->
 
137
<a class="anchor" id="afc3d3f8af8e9788684fa9075d4b19ca3"></a>
112
138
<div class="memitem">
113
139
<div class="memproto">
114
140
      <table class="memname">
119
145
          <td> const</td>
120
146
        </tr>
121
147
      </table>
122
 
</div>
123
 
<div class="memdoc">
 
148
</div><div class="memdoc">
124
149
 
125
150
<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>
 
151
<dl class="section return"><dt>Returns</dt><dd>A string indicating the document type. </dd></dl>
127
152
 
128
153
</div>
129
154
</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)" -->
 
155
<h2 class="groupheader">Friends And Related Function Documentation</h2>
 
156
<a class="anchor" id="a03ea1365835687a661421ef1a4ea4582"></a>
132
157
<div class="memitem">
133
158
<div class="memproto">
 
159
<table class="mlabels">
 
160
  <tr>
 
161
  <td class="mlabels-left">
134
162
      <table class="memname">
135
163
        <tr>
136
164
          <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>&lt; <a class="el" href="classAtk_1_1Document.html">Atk::Document</a> &gt; wrap </td>
147
175
        <tr>
148
176
          <td></td>
149
177
          <td>)</td>
150
 
          <td></td><td><code> [related]</code></td>
 
178
          <td></td><td></td>
151
179
        </tr>
152
180
      </table>
153
 
</div>
154
 
<div class="memdoc">
 
181
  </td>
 
182
  <td class="mlabels-right">
 
183
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
 
184
  </tr>
 
185
</table>
 
186
</div><div class="memdoc">
155
187
 
156
188
<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>
 
189
<dl class="params"><dt>Parameters</dt><dd>
158
190
  <table class="params">
159
191
    <tr><td class="paramname">object</td><td>The C instance. </td></tr>
160
192
    <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
193
  </table>
162
194
  </dd>
163
195
</dl>
164
 
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
 
196
<dl class="section return"><dt>Returns</dt><dd>A C++ instance that wraps this C instance. </dd></dl>
165
197
 
166
198
</div>
167
199
</div>
168
 
</div>
169
 
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 26 2011 13:06:40 for atkmm by&#160;
170
 
<a href="http://www.doxygen.org/index.html">
171
 
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
 
200
</div><!-- contents -->
 
201
<!-- start footer part -->
 
202
<hr class="footer"/><address class="footer"><small>
 
203
Generated on Wed Apr 24 2013 11:08:12 for atkmm by &#160;<a href="http://www.doxygen.org/index.html">
 
204
<img class="footer" src="doxygen.png" alt="doxygen"/>
 
205
</a> 1.8.3.1
 
206
</small></address>
172
207
</body>
173
208
</html>