← Back to branch summary

~ubuntu-branches/ubuntu/vivid/atk1.0/vivid-proposed

« back to all changes in this revision

Viewing changes to docs/tmpl/atkhypertext.sgml

  • Committer: Package Import Robot
  • Author(s): Luke Yelavich
  • Date: 2013-08-27 07:52:22 UTC
  • mfrom: (1.4.9) (11.2.12 saucy-proposed)
  • Revision ID: package-import@ubuntu.com-20130827075222-59k70z0310f06jbb
* New upstream release
* Update symbols

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/tmpl/atkhypertext.sgml
2
2
AtkHypertext
3
3
 
4
4
<!-- ##### SECTION Short_Description ##### -->
5
 
The ATK interface which provides standard mechanism for manipulating hyperlinks.
 
5
 
6
6
 
7
7
<!-- ##### SECTION Long_Description ##### -->
8
8
<para>
9
 
An interface used for objects which implement linking between multiple
10
 
resource or content locations, or multiple 'markers' within a single
11
 
document.  A Hypertext instance is associated with one or more Hyperlinks,
12
 
which are associated with particular offsets within the Hypertext's included
13
 
content.  While this interface is derived from Text, there is no requirement that Hypertext instances have textual content; they may implement Image as well, and Hyperlinks need not have non-zero text offsets.
 
9
 
14
10
</para>
15
11
 
 
12
 
16
13
<!-- ##### SECTION See_Also ##### -->
17
14
<para>
18
 
AtkHyperlink
 
15
 
19
16
</para>
20
17
 
 
18
 
21
19
<!-- ##### SECTION Stability_Level ##### -->
22
20
 
23
21
 
26
24
 
27
25
<!-- ##### STRUCT AtkHypertext ##### -->
28
26
<para>
29
 
The AtkHypertext structure does not contain any fields.
 
27
 
30
28
</para>
31
29
 
32
30
 
33
31
<!-- ##### SIGNAL AtkHypertext::link-selected ##### -->
34
32
<para>
35
 
The "link-selected" signal is emitted by an AtkHyperText object when one of
36
 
the hyperlinks associated with the object is selected.
 
33
 
37
34
</para>
38
35
 
39
36
@atkhypertext: the object which received the signal.
40
 
@arg1: the index of the hyperlink which is selected
 
37
@arg1: 
41
38
 
42
39
<!-- ##### FUNCTION atk_hypertext_get_link ##### -->
43
40
<para>