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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Atk::Hyperlink Class Reference</h1>An AtkHyperlink C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="hyperlink_8hh-source.html">gfc/atk/hyperlink.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Atk::Hyperlink:
<p><center><img src="classGFC_1_1Atk_1_1Hyperlink.png" usemap="#GFC::Atk::Hyperlink_map" border="0" alt=""></center>
<map name="GFC::Atk::Hyperlink_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,168,137,192">
<area href="classGFC_1_1Atk_1_1Action.html" alt="GFC::Atk::Action" shape="rect" coords="147,168,284,192">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,112,137,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInterface.html" alt="GFC::G::TypeInterface" shape="rect" coords="147,112,284,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,56,137,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="147,56,284,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="147,0,284,24">
</map>
<a href="classGFC_1_1Atk_1_1Hyperlink-members.html">List of all members.</a><h2>Signal Prototpyes</h2>
<ul>
<li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">LinkActivatedSignalType</a> <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html#z16_2">link_activated_signal</a>
<dl class="el"><dd class="mdescRight">Link activated signal (see <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html#z19_0">sig_link_activated()</a>). <a href="#z16_2"></a><br></dl></ul>
<h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z17_0" doxytag="GFC::Atk::Hyperlink::~Hyperlink" ></a>
virtual <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html#z17_0">~Hyperlink</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z18_0" doxytag="GFC::Atk::Hyperlink::atk_hyperlink" ></a>
AtkHyperlink * <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html#z18_0">atk_hyperlink</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the AtkHyperlink structure. <br></dl><li><a class="anchor" name="z18_1" doxytag="GFC::Atk::Hyperlink::operator AtkHyperlink *" ></a>
<a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html#z18_1">operator AtkHyperlink *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html">Hyperlink</a> to an AtkHyperlink pointer. <br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html#z18_2">get_uri</a> (int i) const
<dl class="el"><dd class="mdescRight">Gets the URI associated with the anchor of the link specified by i. <a href="#z18_2"></a><br></dl><li><a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a> * <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html#z18_3">get_object</a> (int i) const
<dl class="el"><dd class="mdescRight">Returns the item associated with this hyperlink's nth anchor. <a href="#z18_3"></a><br></dl><li>int <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html#z18_4">get_end_index</a> () const
<dl class="el"><dd class="mdescRight">Gets the index with the hypertext document at which this link ends. <a href="#z18_4"></a><br></dl><li>int <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html#z18_5">get_start_index</a> () const
<dl class="el"><dd class="mdescRight">Gets the index with the hypertext document at which this link begins. <a href="#z18_5"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html#z18_6">is_valid</a> () const
<dl class="el"><dd class="mdescRight">Since the document that a link is associated with may have changed this method returns <em>true</em> if the link is still valid (with respect to the document it references) and <em>false</em> otherwise. <a href="#z18_6"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html#z18_7">is_inline</a> () const
<dl class="el"><dd class="mdescRight">Indicates whether the link currently displays some or all of its content inline. <a href="#z18_7"></a><br></dl><li><a class="anchor" name="z18_8" doxytag="GFC::Atk::Hyperlink::get_n_anchors" ></a>
int <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html#z18_8">get_n_anchors</a> () const
<dl class="el"><dd class="mdescRight">Returns the number of anchors associated with this hyperlink. <br></dl><li>bool <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html#z18_9">is_selected_link</a> () const
<dl class="el"><dd class="mdescRight">Determines whether this hyperlink is selected. <a href="#z18_9"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Signal Proxies</div></td></tr>
<ul>
<li><a class="anchor" name="z19_0" doxytag="GFC::Atk::Hyperlink::sig_link_activated" ></a>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">LinkActivatedSignalProxy</a> <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html#z19_0">sig_link_activated</a> ()
<dl class="el"><dd class="mdescRight">Connect to the link_activated_signal; emitted when the hyperlink object is activated. <br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html#z15_0">Hyperlink</a> (AtkHyperlink *hyperlink, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=true)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html">Hyperlink</a> from an existing AtkHyperlink. <a href="#z15_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An AtkHyperlink C++ wrapper class.
<p>
<a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html">Hyperlink</a> is an <a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a> which encapsulates a link or set of links in a hypertext document. It implements the <a class="el" href="classGFC_1_1Atk_1_1Action.html">Atk::Action</a> interface.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z15_0" doxytag="GFC::Atk::Hyperlink::Hyperlink" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Atk::Hyperlink::Hyperlink </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">AtkHyperlink * </td>
<td class="mdname" nowrap> <em>hyperlink</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>owns_reference</em> = <code>true</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html">Hyperlink</a> from an existing AtkHyperlink.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>hyperlink</em> </td><td>A pointer to a AtkHyperlink. </td></tr>
<tr><td></td><td valign=top><em>owns_reference</em> </td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
</table>
</dl>
<br>
The <em>hyperlink</em> can be a newly created AtkHyperlink or an existing AtkHyperlink. (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>). </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z18_4" doxytag="GFC::Atk::Hyperlink::get_end_index" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int GFC::Atk::Hyperlink::get_end_index </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the index with the hypertext document at which this link ends.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The index with the hypertext document at which this link ends. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z18_3" doxytag="GFC::Atk::Hyperlink::get_object" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a>* GFC::Atk::Hyperlink::get_object </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>i</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the item associated with this hyperlink's nth anchor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>i</em> </td><td>A zero-index integer specifying the desired anchor. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>An <a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a> associated with this hyperlink's i-th anchor.</dd></dl>
<br>
For instance, the returned <a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a> will implement <a class="el" href="classGFC_1_1Atk_1_1Text.html">Text</a> if the link is a text hyperlink, <a class="el" href="classGFC_1_1Atk_1_1Image.html">Image</a> if the link is an image hyperlink etc. Multiple anchors are primarily used by client-side image maps. </td>
</tr>
</table>
<a class="anchor" name="z18_5" doxytag="GFC::Atk::Hyperlink::get_start_index" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int GFC::Atk::Hyperlink::get_start_index </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the index with the hypertext document at which this link begins.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The index with the hypertext document at which this link begins. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z18_2" doxytag="GFC::Atk::Hyperlink::get_uri" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> GFC::Atk::Hyperlink::get_uri </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>i</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the URI associated with the anchor of the link specified by i.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>i</em> </td><td>A zero-index integer specifying the desired anchor. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A string specifying the URI.</dd></dl>
<br>
Multiple anchors are primarily used by client-side image maps. </td>
</tr>
</table>
<a class="anchor" name="z18_7" doxytag="GFC::Atk::Hyperlink::is_inline" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Atk::Hyperlink::is_inline </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Indicates whether the link currently displays some or all of its content inline.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Whether or not this link displays its content inline.</dd></dl>
<br>
Ordinary HTML links will usually return false, but an inline source HTML element will return true. </td>
</tr>
</table>
<a class="anchor" name="z18_9" doxytag="GFC::Atk::Hyperlink::is_selected_link" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Atk::Hyperlink::is_selected_link </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Determines whether this hyperlink is selected.
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the AtkHyperlink is selected, <em>false</em> otherwise. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z18_6" doxytag="GFC::Atk::Hyperlink::is_valid" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Atk::Hyperlink::is_valid </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Since the document that a link is associated with may have changed this method returns <em>true</em> if the link is still valid (with respect to the document it references) and <em>false</em> otherwise.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Whether or not this link is still valid. </dd></dl>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="z16_2" doxytag="GFC::Atk::Hyperlink::link_activated_signal" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">LinkActivatedSignalType</a> <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html#z16_2">GFC::Atk::Hyperlink::link_activated_signal</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Link activated signal (see <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html#z19_0">sig_link_activated()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">void</span> function();
</pre></div> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="hyperlink_8hh-source.html">hyperlink.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:34 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
