← Back to branch summary

~ubuntu-branches/ubuntu/maverick/atk1.0/maverick

« back to all changes in this revision

Viewing changes to docs/xml/atkhypertext.xml

  • Committer: Bazaar Package Importer
  • Author(s): Luke Yelavich
  • Date: 2010-09-28 09:03:21 UTC
  • mfrom: (1.2.30 upstream)
  • Revision ID: james.westby@ubuntu.com-20100928090321-1eq83h0ssvc5yfoq
Tags: 1.32.0-0ubuntu1
* New upstream release
  - Fixes: #630097, #621717, #571622, #617851, #616812.
  - Translation update.
* debian/patches/90-relibtoolize.patch: Refreshed
* debian/watch: Update to retrieve 1.32 version series

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/xml/atkhypertext.xml
1
 
<refentry id="AtkHypertext">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="AtkHypertext.top_of_page">AtkHypertext</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>ATK Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>AtkHypertext</refname>
10
 
<refpurpose>The ATK interface which provides standard mechanism for manipulating hyperlinks.</refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="AtkHypertext.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
                    <link linkend="AtkHypertext-struct">AtkHypertext</link>;
18
 
<link linkend="AtkHyperlink">AtkHyperlink</link>*       <link linkend="atk-hypertext-get-link">atk_hypertext_get_link</link>              (<link linkend="AtkHypertext">AtkHypertext</link> *hypertext,
19
 
                                                         <link linkend="gint">gint</link> link_index);
20
 
<link linkend="gint">gint</link>                <link linkend="atk-hypertext-get-n-links">atk_hypertext_get_n_links</link>           (<link linkend="AtkHypertext">AtkHypertext</link> *hypertext);
21
 
<link linkend="gint">gint</link>                <link linkend="atk-hypertext-get-link-index">atk_hypertext_get_link_index</link>        (<link linkend="AtkHypertext">AtkHypertext</link> *hypertext,
22
 
                                                         <link linkend="gint">gint</link> char_index);
23
 
</synopsis>
24
 
</refsynopsisdiv>
25
 
 
26
 
<refsect1 id="AtkHypertext.object-hierarchy" role="object_hierarchy">
27
 
<title role="object_hierarchy.title">Object Hierarchy</title>
28
 
<synopsis>
29
 
  <link linkend="GInterface">GInterface</link>
30
 
   +----AtkHypertext
31
 
</synopsis>
32
 
</refsect1>
33
 
 
34
 
 
35
 
 
36
 
 
37
 
<refsect1 id="AtkHypertext.implementations" role="implementations">
38
 
<title role="implementations.title">Known Implementations</title>
39
 
<para>
40
 
AtkHypertext is implemented by
41
 
 <link linkend="AtkNoOpObject">AtkNoOpObject</link>.</para>
42
 
</refsect1>
43
 
 
44
 
 
45
 
<refsect1 id="AtkHypertext.signals" role="signal_proto">
46
 
<title role="signal_proto.title">Signals</title>
47
 
<synopsis>
48
 
  &quot;<link linkend="AtkHypertext-link-selected">link-selected</link>&quot;                                  : Run Last
49
 
</synopsis>
50
 
</refsect1>
51
 
 
52
 
 
53
 
<refsect1 id="AtkHypertext.description" role="desc">
54
 
<title role="desc.title">Description</title>
55
 
<para>
56
 
An interface used for objects which implement linking between multiple
57
 
resource or content locations, or multiple 'markers' within a single
58
 
document.  A Hypertext instance is associated with one or more Hyperlinks,
59
 
which are associated with particular offsets within the Hypertext's included
60
 
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.
61
 
</para>
62
 
</refsect1>
63
 
 
64
 
<refsect1 id="AtkHypertext.details" role="details">
65
 
<title role="details.title">Details</title>
66
 
<refsect2 id="AtkHypertext-struct" role="struct">
67
 
<title>AtkHypertext</title>
68
 
<indexterm zone="AtkHypertext-struct"><primary sortas="AtkHypertext">AtkHypertext</primary></indexterm><programlisting>typedef struct _AtkHypertext AtkHypertext;</programlisting>
69
 
<para>
70
 
The AtkHypertext structure does not contain any fields.
71
 
</para></refsect2>
72
 
<refsect2 id="atk-hypertext-get-link" role="function">
73
 
<title>atk_hypertext_get_link ()</title>
74
 
<indexterm zone="atk-hypertext-get-link"><primary sortas="atk_hypertext_get_link">atk_hypertext_get_link</primary></indexterm><programlisting><link linkend="AtkHyperlink">AtkHyperlink</link>*       atk_hypertext_get_link              (<link linkend="AtkHypertext">AtkHypertext</link> *hypertext,
75
 
                                                         <link linkend="gint">gint</link> link_index);</programlisting>
76
 
<para>
77
 
Gets the link in this hypertext document at index 
78
 
<parameter>link_index</parameter></para>
79
 
<para>
80
 
</para><variablelist role="params">
81
 
<varlistentry><term><parameter>hypertext</parameter>&#160;:</term>
82
 
<listitem><simpara> an <link linkend="AtkHypertext"><type>AtkHypertext</type></link>
83
 
</simpara></listitem></varlistentry>
84
 
<varlistentry><term><parameter>link_index</parameter>&#160;:</term>
85
 
<listitem><simpara> an integer specifying the desired link
86
 
</simpara></listitem></varlistentry>
87
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the link in this hypertext document at
88
 
index <parameter>link_index</parameter>
89
 
</simpara></listitem></varlistentry>
90
 
</variablelist></refsect2>
91
 
<refsect2 id="atk-hypertext-get-n-links" role="function">
92
 
<title>atk_hypertext_get_n_links ()</title>
93
 
<indexterm zone="atk-hypertext-get-n-links"><primary sortas="atk_hypertext_get_n_links">atk_hypertext_get_n_links</primary></indexterm><programlisting><link linkend="gint">gint</link>                atk_hypertext_get_n_links           (<link linkend="AtkHypertext">AtkHypertext</link> *hypertext);</programlisting>
94
 
<para>
95
 
Gets the number of links within this hypertext document.</para>
96
 
<para>
97
 
</para><variablelist role="params">
98
 
<varlistentry><term><parameter>hypertext</parameter>&#160;:</term>
99
 
<listitem><simpara> an <link linkend="AtkHypertext"><type>AtkHypertext</type></link>
100
 
</simpara></listitem></varlistentry>
101
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the number of links within this hypertext document
102
 
</simpara></listitem></varlistentry>
103
 
</variablelist></refsect2>
104
 
<refsect2 id="atk-hypertext-get-link-index" role="function">
105
 
<title>atk_hypertext_get_link_index ()</title>
106
 
<indexterm zone="atk-hypertext-get-link-index"><primary sortas="atk_hypertext_get_link_index">atk_hypertext_get_link_index</primary></indexterm><programlisting><link linkend="gint">gint</link>                atk_hypertext_get_link_index        (<link linkend="AtkHypertext">AtkHypertext</link> *hypertext,
107
 
                                                         <link linkend="gint">gint</link> char_index);</programlisting>
108
 
<para>
109
 
Gets the index into the array of hyperlinks that is associated with
110
 
the character specified by <parameter>char_index</parameter>.</para>
111
 
<para>
112
 
</para><variablelist role="params">
113
 
<varlistentry><term><parameter>hypertext</parameter>&#160;:</term>
114
 
<listitem><simpara> an <link linkend="AtkHypertext"><type>AtkHypertext</type></link>
115
 
</simpara></listitem></varlistentry>
116
 
<varlistentry><term><parameter>char_index</parameter>&#160;:</term>
117
 
<listitem><simpara> a character index
118
 
</simpara></listitem></varlistentry>
119
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> an index into the array of hyperlinks in <parameter>hypertext</parameter>,
120
 
or -1 if there is no hyperlink associated with this character.
121
 
</simpara></listitem></varlistentry>
122
 
</variablelist></refsect2>
123
 
 
124
 
</refsect1>
125
 
 
126
 
<refsect1 id="AtkHypertext.signal-details" role="signals">
127
 
<title role="signals.title">Signal Details</title>
128
 
<refsect2 id="AtkHypertext-link-selected" role="signal"><title>The <literal>&quot;link-selected&quot;</literal> signal</title>
129
 
<indexterm zone="AtkHypertext-link-selected"><primary sortas="AtkHypertext::link-selected">AtkHypertext::link-selected</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="AtkHypertext">AtkHypertext</link> *atkhypertext,
130
 
                                                        <link linkend="gint">gint</link>          arg1,
131
 
                                                        <link linkend="gpointer">gpointer</link>      user_data)         : Run Last</programlisting>
132
 
<para>
133
 
The "link-selected" signal is emitted by an AtkHyperText object when one of
134
 
the hyperlinks associated with the object is selected.
135
 
</para><variablelist role="params">
136
 
<varlistentry><term><parameter>atkhypertext</parameter>&#160;:</term>
137
 
<listitem><simpara>the object which received the signal.
138
 
</simpara></listitem></varlistentry>
139
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
140
 
<listitem><simpara>the index of the hyperlink which is selected
141
 
</simpara></listitem></varlistentry>
142
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
143
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
144
 
</variablelist></refsect2>
145
 
</refsect1>
146
 
 
147
 
 
148
 
<refsect1 id="AtkHypertext.see-also">
149
 
<title>See Also</title>
150
 
<para>
151
 
AtkHyperlink
152
 
</para>
153
 
</refsect1>
154
 
 
155
 
</refentry>