blob: 919270ad64ab59b5fade1514ae0e82c67802f941 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-atkdocument">
<refnamediv>
<refname>atk.Document</refname>
<refpurpose>the ATK interface which allows access to a DOM associated
with on object. </refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>atk.Document</classname></ooclass>
<ooclass><classname>gobject.GInterface</classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-atkdocument--get-document-type">get_document_type</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<!-- NOT IMPLEMENTED
<methodsynopsis language="python">
<methodname><link linkend="method-atkdocument- -get-document">get_document</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
END -->
</classsynopsis>
</refsect1>
<refsect1>
<title>Description</title>
<para>The <link
linkend="class-atkdocument"><classname>atk.Document</classname></link>
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.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-atkdocument--get-document-type">
<title>atk.Document.get_document_type</title>
<programlisting><methodsynopsis language="python">
<methodname>get_document_type</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a string indicating the document type</simpara></listitem>
</varlistentry>
</variablelist>
<para>Gets a string indicating the document type.</para>
</refsect2>
<!-- NOT IMPLEMENTED
<refsect2 id="method-atkdocument- -get-document">
<title>atk.Document.get_document</title>
<programlisting><methodsynopsis language="python">
<methodname>get_document</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a <literal>gpointer</literal> that points to an instance of the DOM.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Gets a <literal>gpointer</literal> that points to an instance of the DOM. It is
up to the caller to check atk_document_get_type to determine
how to cast this pointer.</para>
</refsect2>
END -->
</refsect1>
</refentry>
|
