/usr/share/gtk-doc/html/atk/AtkHyperlink.html is in libatk1.0-doc 2.28.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AtkHyperlink: ATK - Accessibility Toolkit</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="ATK - Accessibility Toolkit">
<link rel="up" href="accessibles.html" title="Custom accessible objects">
<link rel="prev" href="AtkGObjectAccessible.html" title="AtkGObjectAccessible">
<link rel="next" href="AtkNoOpObject.html" title="AtkNoOpObject">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#AtkHyperlink.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#AtkHyperlink.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#AtkHyperlink.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#AtkHyperlink.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#AtkHyperlink.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="accessibles.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="AtkGObjectAccessible.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="AtkNoOpObject.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="AtkHyperlink"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AtkHyperlink.top_of_page"></a>AtkHyperlink</span></h2>
<p>AtkHyperlink — An ATK object which encapsulates a link or set
of links in a hypertext document.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="AtkHyperlink.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkHyperlink.html#atk-hyperlink-get-uri" title="atk_hyperlink_get_uri ()">atk_hyperlink_get_uri</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtkHyperlink.html#atk-hyperlink-get-object" title="atk_hyperlink_get_object ()">atk_hyperlink_get_object</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkHyperlink.html#atk-hyperlink-get-end-index" title="atk_hyperlink_get_end_index ()">atk_hyperlink_get_end_index</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkHyperlink.html#atk-hyperlink-get-start-index" title="atk_hyperlink_get_start_index ()">atk_hyperlink_get_start_index</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkHyperlink.html#atk-hyperlink-is-valid" title="atk_hyperlink_is_valid ()">atk_hyperlink_is_valid</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkHyperlink.html#atk-hyperlink-is-inline" title="atk_hyperlink_is_inline ()">atk_hyperlink_is_inline</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkHyperlink.html#atk-hyperlink-get-n-anchors" title="atk_hyperlink_get_n_anchors ()">atk_hyperlink_get_n_anchors</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="AtkHyperlink.html#atk-hyperlink-is-selected-link" title="atk_hyperlink_is_selected_link ()">atk_hyperlink_is_selected_link</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AtkHyperlink.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="AtkHyperlink.html#AtkHyperlink--end-index" title="The “end-index” property">end-index</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="AtkHyperlink.html#AtkHyperlink--number-of-anchors" title="The “number-of-anchors” property">number-of-anchors</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="AtkHyperlink.html#AtkHyperlink--selected-link" title="The “selected-link” property">selected-link</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="AtkHyperlink.html#AtkHyperlink--start-index" title="The “start-index” property">start-index</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AtkHyperlink.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AtkHyperlink.html#AtkHyperlink-link-activated" title="The “link-activated” signal">link-activated</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AtkHyperlink.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="AtkHyperlink.html#AtkHyperlink-struct" title="struct AtkHyperlink">AtkHyperlink</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="AtkHyperlink.html#AtkHyperlinkStateFlags" title="enum AtkHyperlinkStateFlags">AtkHyperlinkStateFlags</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AtkHyperlink.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a>
<span class="lineart">╰──</span> AtkHyperlinkStateFlags
<a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> AtkHyperlink
</pre>
</div>
<div class="refsect1">
<a name="AtkHyperlink.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
AtkHyperlink implements
<a class="link" href="AtkAction.html" title="AtkAction">AtkAction</a>.</p>
</div>
<div class="refsect1">
<a name="AtkHyperlink.description"></a><h2>Description</h2>
<p>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.</p>
</div>
<div class="refsect1">
<a name="AtkHyperlink.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="atk-hyperlink-get-uri"></a><h3>atk_hyperlink_get_uri ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
atk_hyperlink_get_uri (<em class="parameter"><code><a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> *link_</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);</pre>
<p>Get a the URI associated with the anchor specified
by <em class="parameter"><code>i</code></em>
of <em class="parameter"><code>link_</code></em>
. </p>
<p>Multiple anchors are primarily used by client-side image maps.</p>
<div class="refsect3">
<a name="atk-hyperlink-get-uri.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>link_</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>a (zero-index) integer specifying the desired anchor</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-hyperlink-get-uri.returns"></a><h4>Returns</h4>
<p> a string specifying the URI </p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-hyperlink-get-object"></a><h3>atk_hyperlink_get_object ()</h3>
<pre class="programlisting"><a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *
atk_hyperlink_get_object (<em class="parameter"><code><a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> *link_</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);</pre>
<p>Returns the item associated with this hyperlinks nth anchor.
For instance, the returned <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> will implement <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
if <em class="parameter"><code>link_</code></em>
is a text hyperlink, <a class="link" href="AtkImage.html" title="AtkImage"><span class="type">AtkImage</span></a> if <em class="parameter"><code>link_</code></em>
is an image
hyperlink etc. </p>
<p>Multiple anchors are primarily used by client-side image maps.</p>
<div class="refsect3">
<a name="atk-hyperlink-get-object.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>link_</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>a (zero-index) integer specifying the desired anchor</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-hyperlink-get-object.returns"></a><h4>Returns</h4>
<p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> associated with this hyperlinks
i-th anchor. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-hyperlink-get-end-index"></a><h3>atk_hyperlink_get_end_index ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
atk_hyperlink_get_end_index (<em class="parameter"><code><a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> *link_</code></em>);</pre>
<p>Gets the index with the hypertext document at which this link ends.</p>
<div class="refsect3">
<a name="atk-hyperlink-get-end-index.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>link_</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-hyperlink-get-end-index.returns"></a><h4>Returns</h4>
<p> the index with the hypertext document at which this link ends</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-hyperlink-get-start-index"></a><h3>atk_hyperlink_get_start_index ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
atk_hyperlink_get_start_index (<em class="parameter"><code><a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> *link_</code></em>);</pre>
<p>Gets the index with the hypertext document at which this link begins.</p>
<div class="refsect3">
<a name="atk-hyperlink-get-start-index.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>link_</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-hyperlink-get-start-index.returns"></a><h4>Returns</h4>
<p> the index with the hypertext document at which this link begins</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-hyperlink-is-valid"></a><h3>atk_hyperlink_is_valid ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
atk_hyperlink_is_valid (<em class="parameter"><code><a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> *link_</code></em>);</pre>
<p>Since the document that a link is associated with may have changed
this method returns <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the link is still valid (with
respect to the document it references) and <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
<div class="refsect3">
<a name="atk-hyperlink-is-valid.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>link_</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-hyperlink-is-valid.returns"></a><h4>Returns</h4>
<p> whether or not this link is still valid</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-hyperlink-is-inline"></a><h3>atk_hyperlink_is_inline ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
atk_hyperlink_is_inline (<em class="parameter"><code><a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> *link_</code></em>);</pre>
<p>Indicates whether the link currently displays some or all of its
content inline. Ordinary HTML links will usually return
<a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, but an inline <src> HTML element will return
<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p>
<div class="refsect3">
<a name="atk-hyperlink-is-inline.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>link_</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-hyperlink-is-inline.returns"></a><h4>Returns</h4>
<p> whether or not this link displays its content inline.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-hyperlink-get-n-anchors"></a><h3>atk_hyperlink_get_n_anchors ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
atk_hyperlink_get_n_anchors (<em class="parameter"><code><a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> *link_</code></em>);</pre>
<p>Gets the number of anchors associated with this hyperlink.</p>
<div class="refsect3">
<a name="atk-hyperlink-get-n-anchors.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>link_</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-hyperlink-get-n-anchors.returns"></a><h4>Returns</h4>
<p> the number of anchors associated with this hyperlink</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atk-hyperlink-is-selected-link"></a><h3>atk_hyperlink_is_selected_link ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
atk_hyperlink_is_selected_link (<em class="parameter"><code><a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> *link_</code></em>);</pre>
<div class="warning">
<p><code class="literal">atk_hyperlink_is_selected_link</code> has been deprecated since version 1.8 and should not be used in newly-written code.</p>
<p>Please use ATK_STATE_FOCUSABLE for all links,
and ATK_STATE_FOCUSED for focused links.</p>
</div>
<p>Determines whether this AtkHyperlink is selected</p>
<div class="refsect3">
<a name="atk-hyperlink-is-selected-link.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>link_</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atk-hyperlink-is-selected-link.returns"></a><h4>Returns</h4>
<p> True if the AtkHyperlink is selected, False otherwise</p>
</div>
<p class="since">Since: 1.4</p>
</div>
</div>
<div class="refsect1">
<a name="AtkHyperlink.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AtkHyperlink-struct"></a><h3>struct AtkHyperlink</h3>
<pre class="programlisting">struct AtkHyperlink;</pre>
</div>
<hr>
<div class="refsect2">
<a name="AtkHyperlinkStateFlags"></a><h3>enum AtkHyperlinkStateFlags</h3>
<p>Describes the type of link</p>
<div class="refsect3">
<a name="AtkHyperlinkStateFlags.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody><tr>
<td class="enum_member_name"><p><a name="ATK-HYPERLINK-IS-INLINE:CAPS"></a>ATK_HYPERLINK_IS_INLINE</p></td>
<td class="enum_member_description">
<p>Link is inline</p>
</td>
<td class="enum_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="AtkHyperlink.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="AtkHyperlink--end-index"></a><h3>The <code class="literal">“end-index”</code> property</h3>
<pre class="programlisting"> “end-index” <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The end index of the AtkHyperlink object.</p>
<p>Flags: Read</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkHyperlink--number-of-anchors"></a><h3>The <code class="literal">“number-of-anchors”</code> property</h3>
<pre class="programlisting"> “number-of-anchors” <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The number of anchors associated with the AtkHyperlink object.</p>
<p>Flags: Read</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkHyperlink--selected-link"></a><h3>The <code class="literal">“selected-link”</code> property</h3>
<pre class="programlisting"> “selected-link” <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Selected link</p>
<div class="warning">
<p><code class="literal">AtkHyperlink:selected-link</code> has been deprecated since version 1.8 and should not be used in newly-written code.</p>
<p>Please use ATK_STATE_FOCUSABLE for all links, and
ATK_STATE_FOCUSED for focused links.</p>
</div>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkHyperlink--start-index"></a><h3>The <code class="literal">“start-index”</code> property</h3>
<pre class="programlisting"> “start-index” <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The start index of the AtkHyperlink object.</p>
<p>Flags: Read</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1">
<a name="AtkHyperlink.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="AtkHyperlink-link-activated"></a><h3>The <code class="literal">“link-activated”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> *atkhyperlink,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The signal link-activated is emitted when a link is activated.</p>
<div class="refsect3">
<a name="AtkHyperlink-link-activated.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>atkhyperlink</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|