diff options
Diffstat (limited to 'gtk+-mingw/share/gtk-doc/html/atk/AtkHyperlink.html')
| -rw-r--r-- | gtk+-mingw/share/gtk-doc/html/atk/AtkHyperlink.html | 400 |
1 files changed, 0 insertions, 400 deletions
diff --git a/gtk+-mingw/share/gtk-doc/html/atk/AtkHyperlink.html b/gtk+-mingw/share/gtk-doc/html/atk/AtkHyperlink.html deleted file mode 100644 index 7cce5b9..0000000 --- a/gtk+-mingw/share/gtk-doc/html/atk/AtkHyperlink.html +++ /dev/null @@ -1,400 +0,0 @@ -<!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</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="index.html" title="ATK - Accessibility Toolkit"> -<link rel="up" href="atk.html" title="ATK Library"> -<link rel="prev" href="AtkGObjectAccessible.html" title="AtkGObjectAccessible"> -<link rel="next" href="atk-AtkHyperlinkImpl.html" title="AtkHyperlinkImpl"> -<meta name="generator" content="GTK-Doc V1.18.1 (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="2"> -<tr valign="middle"> -<td><a accesskey="p" href="AtkGObjectAccessible.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="atk.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> -<th width="100%" align="center">ATK - Accessibility Toolkit</th> -<td><a accesskey="n" href="atk-AtkHyperlinkImpl.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#AtkHyperlink.synopsis" class="shortcut">Top</a> - | - <a href="#AtkHyperlink.description" class="shortcut">Description</a> - | - <a href="#AtkHyperlink.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#AtkHyperlink.implemented-interfaces" class="shortcut">Implemented Interfaces</a> - | - <a href="#AtkHyperlink.properties" class="shortcut">Properties</a> - | - <a href="#AtkHyperlink.signals" class="shortcut">Signals</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 valign="top" align="right"></td> -</tr></table></div> -<div class="refsynopsisdiv"> -<a name="AtkHyperlink.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis">struct <a class="link" href="AtkHyperlink.html#AtkHyperlink-struct" title="struct AtkHyperlink">AtkHyperlink</a>; -enum <a class="link" href="AtkHyperlink.html#AtkHyperlinkStateFlags" title="enum AtkHyperlinkStateFlags">AtkHyperlinkStateFlags</a>; -<span class="returnvalue">gchar</span> * <a class="link" href="AtkHyperlink.html#atk-hyperlink-get-uri" title="atk_hyperlink_get_uri ()">atk_hyperlink_get_uri</a> (<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><span class="type">gint</span> i</code></em>); -<a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> * <a class="link" href="AtkHyperlink.html#atk-hyperlink-get-object" title="atk_hyperlink_get_object ()">atk_hyperlink_get_object</a> (<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><span class="type">gint</span> i</code></em>); -<span class="returnvalue">gint</span> <a class="link" href="AtkHyperlink.html#atk-hyperlink-get-end-index" title="atk_hyperlink_get_end_index ()">atk_hyperlink_get_end_index</a> (<em class="parameter"><code><a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> *link_</code></em>); -<span class="returnvalue">gint</span> <a class="link" href="AtkHyperlink.html#atk-hyperlink-get-start-index" title="atk_hyperlink_get_start_index ()">atk_hyperlink_get_start_index</a> (<em class="parameter"><code><a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> *link_</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="AtkHyperlink.html#atk-hyperlink-is-valid" title="atk_hyperlink_is_valid ()">atk_hyperlink_is_valid</a> (<em class="parameter"><code><a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> *link_</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="AtkHyperlink.html#atk-hyperlink-is-inline" title="atk_hyperlink_is_inline ()">atk_hyperlink_is_inline</a> (<em class="parameter"><code><a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> *link_</code></em>); -<span class="returnvalue">gint</span> <a class="link" href="AtkHyperlink.html#atk-hyperlink-get-n-anchors" title="atk_hyperlink_get_n_anchors ()">atk_hyperlink_get_n_anchors</a> (<em class="parameter"><code><a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> *link_</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="AtkHyperlink.html#atk-hyperlink-is-selected-link" title="atk_hyperlink_is_selected_link ()">atk_hyperlink_is_selected_link</a> (<em class="parameter"><code><a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> *link_</code></em>); -</pre> -</div> -<div class="refsect1"> -<a name="AtkHyperlink.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="synopsis"> - GObject - +----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.properties"></a><h2>Properties</h2> -<pre class="synopsis"> - "<a class="link" href="AtkHyperlink.html#AtkHyperlink--end-index" title='The "end-index" property'>end-index</a>" <span class="type">gint</span> : Read - "<a class="link" href="AtkHyperlink.html#AtkHyperlink--number-of-anchors" title='The "number-of-anchors" property'>number-of-anchors</a>" <span class="type">gint</span> : Read - "<a class="link" href="AtkHyperlink.html#AtkHyperlink--selected-link" title='The "selected-link" property'>selected-link</a>" <span class="type">gboolean</span> : Read - "<a class="link" href="AtkHyperlink.html#AtkHyperlink--start-index" title='The "start-index" property'>start-index</a>" <span class="type">gint</span> : Read -</pre> -</div> -<div class="refsect1"> -<a name="AtkHyperlink.signals"></a><h2>Signals</h2> -<pre class="synopsis"> - "<a class="link" href="AtkHyperlink.html#AtkHyperlink-link-activated" title='The "link-activated" signal'>link-activated</a>" : <code class="literal">Run Last</code> -</pre> -</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.details"></a><h2>Details</h2> -<div class="refsect2"> -<a name="AtkHyperlink-struct"></a><h3>struct AtkHyperlink</h3> -<pre class="programlisting">struct AtkHyperlink;</pre> -<p> -The AtkHyperlink structure should not be accessed directly. -</p> -</div> -<hr> -<div class="refsect2"> -<a name="AtkHyperlinkStateFlags"></a><h3>enum AtkHyperlinkStateFlags</h3> -<pre class="programlisting">typedef enum { - ATK_HYPERLINK_IS_INLINE = 1 << 0 -} AtkHyperlinkStateFlags; -</pre> -<p> -Describes the type of link -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><a name="ATK-HYPERLINK-IS-INLINE:CAPS"></a><span class="term"><code class="literal">ATK_HYPERLINK_IS_INLINE</code></span></p></td> -<td>Link is inline -</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="atk-hyperlink-get-uri"></a><h3>atk_hyperlink_get_uri ()</h3> -<pre class="programlisting"><span class="returnvalue">gchar</span> * 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><span class="type">gint</span> 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="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>link_</code></em> :</span></p></td> -<td>an <a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td> -<td>a (zero-index) integer specifying the desired anchor</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a string specifying the URI</td> -</tr> -</tbody> -</table></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><span class="type">gint</span> 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="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>link_</code></em> :</span></p></td> -<td>an <a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td> -<td>a (zero-index) integer specifying the desired anchor</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> associated with this hyperlinks -i-th anchor. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="atk-hyperlink-get-end-index"></a><h3>atk_hyperlink_get_end_index ()</h3> -<pre class="programlisting"><span class="returnvalue">gint</span> 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="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>link_</code></em> :</span></p></td> -<td>an <a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the index with the hypertext document at which this link ends</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="atk-hyperlink-get-start-index"></a><h3>atk_hyperlink_get_start_index ()</h3> -<pre class="programlisting"><span class="returnvalue">gint</span> 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="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>link_</code></em> :</span></p></td> -<td>an <a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the index with the hypertext document at which this link begins</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="atk-hyperlink-is-valid"></a><h3>atk_hyperlink_is_valid ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> 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 <code class="literal">TRUE</code> if the link is still valid (with -respect to the document it references) and <code class="literal">FALSE</code> otherwise. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>link_</code></em> :</span></p></td> -<td>an <a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>whether or not this link is still valid</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="atk-hyperlink-is-inline"></a><h3>atk_hyperlink_is_inline ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> 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 - <code class="literal">FALSE</code>, but an inline &lt;src&gt; HTML element will return - <code class="literal">TRUE</code>. -a * -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>link_</code></em> :</span></p></td> -<td>an <a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>whether or not this link displays its content inline.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="atk-hyperlink-get-n-anchors"></a><h3>atk_hyperlink_get_n_anchors ()</h3> -<pre class="programlisting"><span class="returnvalue">gint</span> 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="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>link_</code></em> :</span></p></td> -<td>an <a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the number of anchors associated with this hyperlink</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="atk-hyperlink-is-selected-link"></a><h3>atk_hyperlink_is_selected_link ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> 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" style="margin-left: 0.5in; margin-right: 0.5in;"> -<h3 class="title">Warning</h3> -<p><code class="literal">atk_hyperlink_is_selected_link</code> is deprecated and should not be used in newly-written code. Please use ATK_STATE_SELECTED to indicate when a hyperlink within a Hypertext container is selected.</p> -</div> -<p> -Determines whether this AtkHyperlink is selected -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>link_</code></em> :</span></p></td> -<td>an <a class="link" href="AtkHyperlink.html" title="AtkHyperlink"><span class="type">AtkHyperlink</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>True is the AtkHyperlink is selected, False otherwise</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 1.4</p> -</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" <span class="type">gint</span> : Read</pre> -<p>The end index of the AtkHyperlink object.</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" <span class="type">gint</span> : Read</pre> -<p>The number of anchors associated with the AtkHyperlink object.</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" <span class="type">gboolean</span> : Read</pre> -<p>Specifies whether the AtkHyperlink object is selected.</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" <span class="type">gint</span> : Read</pre> -<p>The start index of the AtkHyperlink object.</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, - <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre> -<p> -The signal link-activated is emitted when a link is activated. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>atkhyperlink</code></em> :</span></p></td> -<td>the object which received the signal.</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> -<td>user data set when the signal handler was connected.</td> -</tr> -</tbody> -</table></div> -</div> -</div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.18.1</div> -</body> -</html>
\ No newline at end of file |