diff options
Diffstat (limited to 'docs/reference/pygtk-atkhypertext.xml')
| -rw-r--r-- | docs/reference/pygtk-atkhypertext.xml | 201 |
1 files changed, 0 insertions, 201 deletions
diff --git a/docs/reference/pygtk-atkhypertext.xml b/docs/reference/pygtk-atkhypertext.xml deleted file mode 100644 index 0762f126..00000000 --- a/docs/reference/pygtk-atkhypertext.xml +++ /dev/null @@ -1,201 +0,0 @@ -<?xml version="1.0" standalone="no"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> - -<refentry id="class-atkhypertext"> - - <refnamediv> - <refname>atk.Hypertext</refname> - <refpurpose>the ATK interface which provides standard mechanism for - manipulating hyperlinks. </refpurpose> - </refnamediv> - - <refsect1> - <title>Synopsis</title> - - <classsynopsis language="python"> - <ooclass><classname>atk.Hypertext</classname></ooclass> - <ooclass><classname>gobject.GInterface</classname></ooclass> - <methodsynopsis language="python"> - <methodname><link linkend="method-atkhypertext--get-link">get_link</link></methodname> - <methodparam><parameter role="keyword">link_index</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-atkhypertext--get-n-links">get_n_links</link></methodname> - <methodparam></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link linkend="method-atkhypertext--get-link-index">get_link_index</link></methodname> - <methodparam><parameter role="keyword">char_index</parameter></methodparam> - </methodsynopsis> -</classsynopsis> - - </refsect1> - - <refsect1 id="signal-prototypes-atkhypertext"> - <title>atk.Hypertext Signal Prototypes</title> - - - <variablelist> - <varlistentry> - <term>"<link linkend="signal-atkhypertext--link-selected">link-selected</link>"</term> - <listitem> - <methodsynopsis language="python"><methodname>callback</methodname> - <methodparam><parameter>atkhypertext</parameter></methodparam> - <methodparam><parameter>index</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis> - </listitem> - </varlistentry> - </variablelist> - - </refsect1> - - <refsect1> - <title>Description</title> - - <para>An interface used for objects which implement linking between - multiple resource or content locations, or multiple 'markers' within a - single document. A <link - linkend="class-atkhypertext"><classname>atk.Hypertext</classname></link> - instance is associated with one or more <link - linkend="class-atkhyperlink"><classname>atk.Hyperlink</classname></link> - objects, which are associated with particular offsets within the <link - linkend="class-atkhypertext"><classname>atk.Hypertext</classname></link>'s - included content. While this interface is derived from <link - linkend="class-atktext"><classname>atk.Text</classname></link>, there is - no requirement that <link - linkend="class-atkhypertext"><classname>atk.Hypertext</classname></link> - instances have textual content; they may implement <link - linkend="class-atkimage"><classname>atk.Image</classname></link> as - well, and <link - linkend="class-atkhyperlink"><classname>atk.Hyperlink</classname></link> - objects need not have non-zero text offsets.</para> - - </refsect1> - - <refsect1> - <title>Methods</title> - - <refsect2 id="method-atkhypertext--get-link"> - <title>atk.Hypertext.get_link</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_link</methodname> - <methodparam><parameter role="keyword">link_index</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">link_index</parameter> :</term> - <listitem><simpara>an integer specifying the desired - link</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the link in this hypertext document at -index <parameter>link_index</parameter></simpara></listitem> - </varlistentry> - </variablelist> - - <para>Gets the link in this hypertext document at index - <parameter>link_index</parameter></para> - - </refsect2> - - <refsect2 id="method-atkhypertext--get-n-links"> - <title>atk.Hypertext.get_n_links</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_n_links</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the number of links within this hypertext - document</simpara></listitem> - </varlistentry> - </variablelist> - - <para>Gets the number of links within this hypertext document.</para> - - </refsect2> - - <refsect2 id="method-atkhypertext--get-link-index"> - <title>atk.Hypertext.get_link_index</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_link_index</methodname> - <methodparam><parameter role="keyword">char_index</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter role="keyword">char_index</parameter> :</term> - <listitem><simpara>a character index</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>an index into the array of hyperlinks in the - hypertext</simpara></listitem> - </varlistentry> - </variablelist> - - <para>Gets the index into the array of hyperlinks that is associated - with the character specified by <parameter>char_index</parameter>, or - -1 if there is no hyperlink associated with this character.</para> - - </refsect2> - - </refsect1> - - <refsect1> - <title>Signals</title> - - <refsect2 id="signal-atkhypertext--link-selected"> - <title>The "link-selected" atk.Hypertext Signal</title> - - <programlisting><methodsynopsis language="python"><methodname>callback</methodname> - <methodparam><parameter>atkhypertext</parameter></methodparam> - <methodparam><parameter>index</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter>atkhypertext</parameter> :</term> - <listitem><simpara>the object which received the - signal.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>index</parameter> :</term> - <listitem><simpara>the index of the hyperlink which is - selected</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>user_param1</parameter> :</term> - <listitem><simpara>the first user parameter (if any) specified - with the <link - linkend="method-gobject--connect"><methodname>connect</methodname>()</link> - method</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>...</parameter> :</term> - <listitem><simpara>additional user parameters (if any)</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The "link-selected" signal is emitted by an <link - linkend="class-atkhypertext"><classname>atk.HyperText</classname></link> - object when one of the hyperlinks associated with the object is - selected.</para> - - </refsect2> - -</refsect1> - -</refentry> |