summaryrefslogtreecommitdiff
path: root/docs/tmpl/atkhyperlink.sgml
blob: edd4855ccf84145ffb5987e29031851ca1695891 (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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
<!-- ##### SECTION Title ##### -->
AtkHyperlink

<!-- ##### SECTION Short_Description ##### -->
An ATK object which encapsulates a link or set of links in a hypertext document.

<!-- ##### SECTION Long_Description ##### -->
<para>
An ATK object which encapsulates a link or set of links 
(for instance in the case of client-side image maps) in a hypertext document.
It may implement the AtkAction interface.  AtkHyperlink may also be used
to refer to inline embedded content, since it allows specification of a start
and end offset within the host AtkHypertext object.
</para>

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

</para>

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


<!-- ##### SECTION Image ##### -->


<!-- ##### STRUCT AtkHyperlink ##### -->
<para>
The AtkHyperlink structure should not be accessed directly.

</para>


<!-- ##### SIGNAL AtkHyperlink::link-activated ##### -->
<para>
The signal link-activated is emitted when a link is activated.
</para>

@atkhyperlink: the object which received the signal.

<!-- ##### ARG AtkHyperlink:end-index ##### -->
<para>

</para>

<!-- ##### ARG AtkHyperlink:number-of-anchors ##### -->
<para>

</para>

<!-- ##### ARG AtkHyperlink:selected-link ##### -->
<para>

</para>

<!-- ##### ARG AtkHyperlink:start-index ##### -->
<para>

</para>

<!-- ##### ENUM AtkHyperlinkStateFlags ##### -->
<para>

</para>

@ATK_HYPERLINK_IS_INLINE: 

<!-- ##### FUNCTION atk_hyperlink_get_uri ##### -->
<para>

</para>

@link_: 
@i: 
@Returns: 


<!-- ##### FUNCTION atk_hyperlink_get_object ##### -->
<para>

</para>

@link_: 
@i: 
@Returns: 


<!-- ##### FUNCTION atk_hyperlink_get_end_index ##### -->
<para>

</para>

@link_: 
@Returns: 


<!-- ##### FUNCTION atk_hyperlink_get_start_index ##### -->
<para>

</para>

@link_: 
@Returns: 


<!-- ##### FUNCTION atk_hyperlink_is_valid ##### -->
<para>

</para>

@link_: 
@Returns: 


<!-- ##### FUNCTION atk_hyperlink_is_inline ##### -->
<para>

</para>

@link_: 
@Returns: 


<!-- ##### FUNCTION atk_hyperlink_get_n_anchors ##### -->
<para>

</para>

@link_: 
@Returns: 


<!-- ##### FUNCTION atk_hyperlink_is_selected_link ##### -->
<para>

</para>

@link_: 
@Returns: 
@Deprecated: Please use ATK_STATE_SELECTED to indicate when a hyperlink within a Hypertext container is selected.