summaryrefslogtreecommitdiff
path: root/docs/tmpl/atkhyperlinkimpl.sgml
blob: c220304f60da1c8500c1777fbcdadfc222c7d09d (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
<!-- ##### SECTION Title ##### -->
AtkHyperlinkImpl

<!-- ##### SECTION Short_Description ##### -->
An interface from which the AtkHyperlink associated with an
AtkObject may be obtained.

<!-- ##### SECTION Long_Description ##### -->
<para>
AtkHyperlinkImpl allows AtkObjects to
refer to their associated AtkHyperlink instance, if one
exists.  AtkHyperlinkImpl differs from AtkHyperlink in that 
AtkHyperlinkImpl is an interface, whereas AtkHyperlink is
a object type.  The AtkHyperlinkImpl interface allows
a client to query an AtkObject for the availability of
an associated AtkHyperlink instance, and obtain that
instance.  It is thus particularly useful in cases where
embedded content or inline content within a text object
is present, since the embedding text object implements
AtkHypertext and the inline/embedded objects are 
exposed as children which implement AtkHyperlinkImpl,
in addition to their being obtainable via AtkHypertext:getLink
followed by AtkHyperlink:getObject.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### STRUCT AtkHyperlinkImpl ##### -->
<para>
A queryable interface which allows AtkHyperlink instances associated with an 
AtkObject to be obtained.  AtkHyperlinkImpl corresponds to AT-SPI's 
Hyperlink interface, and differs from AtkHyperlink in that AtkHyperlink 
is an object type, rather than an interface, and thus cannot be directly 
queried.
</para>


<!-- ##### FUNCTION atk_hyperlink_impl_get_hyperlink ##### -->
<para>

</para>

@obj: 
@Returns: