blob: 935ac0cd66d740be814b3c53b8afc74ded1c6225 (
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
<!-- ##### SECTION Title ##### -->
AtkDocument
<!-- ##### SECTION Short_Description ##### -->
The ATK interface which represents the toplevel container for document content.
<!-- ##### SECTION Long_Description ##### -->
<para>
The AtkDocument interface should be supported by any object whose content is a
representation or view of a document. The AtkDocument interface should appear
on the toplevel container for the document content; however AtkDocument
instances may be nested (i.e. an AtkDocument may be a descendant of another
AtkDocument) in those cases where one document contains "embedded content"
which can reasonably be considered a document in its own right.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT AtkDocument ##### -->
<para>
The AtkDocument structure does not contain any fields.
</para>
<!-- ##### SIGNAL AtkDocument::load-complete ##### -->
<para>
The 'load-complete' signal is emitted when a pending load of a static
document has completed. This signal is to be expected by ATK clients
if and when AtkDocument implementors expose ATK_STATE_BUSY. If the state
of an AtkObject which implements AtkDocument does not include ATK_STATE_BUSY,
it should be safe for clients to assume that the AtkDocument's static contents
are fully loaded into the container. (Dynamic document contents should
be exposed via other signals.)
</para>
@atkdocument: the object which received the signal.
<!-- ##### SIGNAL AtkDocument::load-stopped ##### -->
<para>
The 'load-stopped' signal is emitted when a pending load of document contents
is cancelled, paused, or otherwise interrupted by the user or application
logic. It should not however be
emitted while waiting for a resource (for instance while blocking on a file or
network read) unless a user-significant timeout has occurred.
</para>
@atkdocument: the object which received the signal.
<!-- ##### SIGNAL AtkDocument::reload ##### -->
<para>
The 'reload' signal is emitted when the contents of a document is refreshed
from its source. Once 'reload' has been emitted, a matching 'load-complete'
or 'load-stopped' signal should follow, which clients may await before
interrogating ATK for the latest document content.
</para>
@atkdocument: the object which received the signal.
<!-- ##### FUNCTION atk_document_get_document_type ##### -->
<para>
</para>
@document:
@Returns:
<!-- ##### FUNCTION atk_document_get_document ##### -->
<para>
</para>
@document:
@Returns:
<!-- ##### FUNCTION atk_document_get_attribute_value ##### -->
<para>
</para>
@document:
@attribute_name:
@Returns:
<!-- ##### FUNCTION atk_document_set_attribute_value ##### -->
<para>
</para>
@document:
@attribute_name:
@attribute_value:
@Returns:
<!-- ##### FUNCTION atk_document_get_attributes ##### -->
<para>
</para>
@document:
@Returns:
<!-- ##### FUNCTION atk_document_get_locale ##### -->
<para>
</para>
@document:
@Returns:
|
