path: root/docs/reference/pygtk-atkhyperlink.xml

<?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-atkhyperlink">

  <refnamediv>
    <refname>atk.Hyperlink</refname>
      <refpurpose>An ATK object which encapsulates a link or set of links in a hypertext document.  </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>atk.Hyperlink</classname></ooclass>
      <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkhyperlink--get-uri">get_uri</link></methodname>
        <methodparam><parameter role="keyword">i</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkhyperlink--get-object">get_object</link></methodname>
        <methodparam><parameter role="keyword">i</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkhyperlink--get-end-index">get_end_index</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkhyperlink--get-start-index">get_start_index</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkhyperlink--is-valid">is_valid</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkhyperlink--get-n-anchors">get_n_anchors</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkhyperlink--is-inline">is_inline</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkhyperlink--is-selected-link">is_selected_link</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
</classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-atkhyperlink">atk.Hyperlink</link>
</synopsis>

  </refsect1>

  <refsect1 id="properties-atkhyperlink">
    <title>atk.Hyperlink Properties</title>

    <blockquote role="properties">
      <informaltable pgwide="1" frame="none">
        <tgroup cols="3">
          <colspec column="1" colwidth="1in"/>
          <colspec column="2" colwidth="1in"/>
          <colspec column="3" colwidth="3.5in"/>
        <tbody>

        <row valign="top">
          <entry>"end-index"</entry>
          <entry>Read</entry>
          <entry>The end index of the <link
          linkend="class-atkhyperlink"><classname>atk.Hyperlink</classname></link>
          object. Allowed values: >= 0.  Default value: 0.</entry>
        </row>

        <row valign="top">
          <entry>"number-of-anchors"</entry>
          <entry>Read</entry>
          <entry>The number of anchors associated with the <link
          linkend="class-atkhyperlink"><classname>atk.Hyperlink</classname></link>
          object. Allowed values: >= 0.  Default value: 0.</entry>
        </row>

        <row valign="top">
          <entry>"selected-link"</entry>
          <entry>Read</entry>
          <entry>if <literal>True</literal> the <link
          linkend="class-atkhyperlink"><classname>atk.Hyperlink</classname></link>
          object is selected. Default value:
          <literal>False</literal>.</entry>
        </row>

        <row valign="top">
          <entry>"start-index"</entry>
          <entry>Read</entry>
          <entry>The start index of the AtkHyperlink object. Allowed values:
          >= 0.  Default value: 0.</entry>
        </row>

        </tbody>
      </tgroup>
      </informaltable>
    </blockquote>

  </refsect1>

  <refsect1 id="signal-prototypes-atkhyperlink">
    <title>atk.Hyperlink Signal Prototypes</title>

    <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>

      <variablelist>
      <varlistentry>
        <term>"<link linkend="signal-atkhyperlink--link-activated">link-activated</link>"</term>
        <listitem>
          <methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>atkhyperlink</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1>
    <title>Description</title>

    <para>An ATK object which encapsulates a link or set of links in a
    hypertext document.  It implements the <link
    linkend="class-atkaction"><classname>atk.Action</classname></link>
    interface.</para>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-atkhyperlink--get-uri">
      <title>atk.Hyperlink.get_uri</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_uri</methodname>
        <methodparam><parameter role="keyword">i</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">i</parameter>&nbsp;:</term>
          <listitem><simpara>a (zero-index) integer specifying the desired
          anchor</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a string specifying the
          URI</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Get a the URI associated with the anchor specified by
      <parameter>i</parameter>.</para>
      
      <para>Multiple anchors are primarily used by client-side image
      maps.</para>

    </refsect2>

    <refsect2 id="method-atkhyperlink--get-object">
      <title>atk.Hyperlink.get_object</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_object</methodname>
        <methodparam><parameter role="keyword">i</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">i</parameter>&nbsp;:</term>
          <listitem><simpara>a (zero-index) integer specifying the desired
          anchor</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>an <link
          linkend="class-atkobject"><classname>atk.Object</classname></link>
          associated with this hyperlinks i-th anchor</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Returns the item associated with this hyperlinks nth anchor.
      For instance, the returned <link
      linkend="class-atkobject"><classname>atk.Object</classname></link>
      will implement <link
      linkend="class-atktext"><classname>atk.Text</classname></link> if
      the link is a text hyperlink, <link
      linkend="class-atkimage"><classname>atk.Image</classname></link> if
      the link is an image hyperlink etc. </para>
      
      <para>Multiple anchors are primarily used by client-side image
      maps.</para>

    </refsect2>

    <refsect2 id="method-atkhyperlink--get-end-index">
      <title>atk.Hyperlink.get_end_index</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_end_index</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the index with the hypertext document at which
          this link ends</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the index with the hypertext document at which this link
      ends.</para>

    </refsect2>

    <refsect2 id="method-atkhyperlink--get-start-index">
      <title>atk.Hyperlink.get_start_index</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_start_index</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the index with the hypertext document at which
          this link begins</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the index with the hypertext document at which this link
      begins.</para>

    </refsect2>

    <refsect2 id="method-atkhyperlink--is-valid">
      <title>atk.Hyperlink.is_valid</title>

      <programlisting><methodsynopsis language="python">
        <methodname>is_valid</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>if <literal>True</literal> this link is still
          valid</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Since the document that a link is associated with may have
      changed this method returns <literal>True</literal> if the link is
      still valid (with respect to the document it references) and
      <literal>False</literal> otherwise.</para>

    </refsect2>

    <refsect2 id="method-atkhyperlink--get-n-anchors">
      <title>atk.Hyperlink.get_n_anchors</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_n_anchors</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the number of anchors associated with this
          hyperlink</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the number of anchors associated with this
      hyperlink.</para>

    </refsect2>

    <refsect2 id="method-atkhyperlink--is-inline">
      <title>atk.Hyperlink.is_inline</title>

      <programlisting><methodsynopsis language="python">
        <methodname>is_inline</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>if <literal>True</literal> this link displays
          its content inline.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Indicates whether the link currently displays some or all of its
      content inline.  Ordinary HTML links will usually return
      <literal>False</literal>, but an inline &lt;src&gt; HTML element will
      return <literal>True</literal>.</para>

    </refsect2>

    <refsect2 id="method-atkhyperlink--is-selected-link">
      <title>atk.Hyperlink.is_selected_link</title>

      <programlisting><methodsynopsis language="python">
        <methodname>is_selected_link</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if the <link
          linkend="class-atkhyperlink"><classname>atk.Hyperlink</classname></link>
          is selected.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Determines whether this <link
      linkend="class-atkhyperlink"><classname>atk.Hyperlink</classname></link>
      is selected</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Signals</title>

    <refsect2 id="signal-atkhyperlink--link-activated">
      <title>The "link-activated" atk.Hyperlink Signal</title>

      <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>atkhyperlink</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter>atkhyperlink</parameter>&nbsp;:</term>
          <listitem><simpara>the object which received the signal.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>user_param1</parameter>&nbsp;:</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>&nbsp;:</term>
          <listitem><simpara>additional user parameters (if any)</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>The signal "link-activated" is emitted when a link is
      activated.</para>

    </refsect2>

</refsect1>

</refentry>