path: root/docs/reference/pygtk-atkcomponent.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-atkcomponent">

  <refnamediv>
    <refname>atk.Component</refname>
      <refpurpose>the ATK interface provided by UI components that occupy a
      physical area on the screen.  </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>atk.Component</classname></ooclass>
      <ooclass><classname>gobject.GInterface</classname></ooclass>
<!-- NOT IMPLEMENTED
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkcomponent- -add-focus-handler">add_focus_handler</link></methodname>
        <methodparam><parameter role="keyword">handler</parameter></methodparam>
      </methodsynopsis>
END NOT IMPLEMENTED -->
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkcomponent--contains">contains</link></methodname>
        <methodparam><parameter role="keyword">x</parameter></methodparam>
        <methodparam><parameter role="keyword">y</parameter></methodparam>
        <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkcomponent--ref-accessible-at-point">ref_accessible_at_point</link></methodname>
        <methodparam><parameter role="keyword">x</parameter></methodparam>
        <methodparam><parameter role="keyword">y</parameter></methodparam>
        <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkcomponent--get-extents">get_extents</link></methodname>
        <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkcomponent--get-position">get_position</link></methodname>
        <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkcomponent--get-size">get_size</link></methodname>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkcomponent--grab-focus">grab_focus</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkcomponent--remove-focus-handler">remove_focus_handler</link></methodname>
        <methodparam><parameter role="keyword">handler_id</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkcomponent--set-extents">set_extents</link></methodname>
        <methodparam><parameter role="keyword">x</parameter></methodparam>
        <methodparam><parameter role="keyword">y</parameter></methodparam>
        <methodparam><parameter role="keyword">width</parameter></methodparam>
        <methodparam><parameter role="keyword">height</parameter></methodparam>
        <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkcomponent--set-position">set_position</link></methodname>
        <methodparam><parameter role="keyword">x</parameter></methodparam>
        <methodparam><parameter role="keyword">y</parameter></methodparam>
        <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkcomponent--set-size">set_size</link></methodname>
        <methodparam><parameter role="keyword">width</parameter></methodparam>
        <methodparam><parameter role="keyword">height</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkcomponent--get-layer">get_layer</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkcomponent--get-mdi-zorder">get_mdi_zorder</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
</classsynopsis>

  </refsect1>

  <refsect1 id="signal-prototypes-atkcomponent">
    <title>atk.Component Signal Prototypes</title>


      <variablelist>
      <varlistentry>
        <term>"<link linkend="signal-atkcomponent--bounds-changed">bounds-changed</link>"</term>
        <listitem>
          <methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>atkcomponent</parameter></methodparam>
            <methodparam><parameter>rect</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1>
    <title>Description</title>

    <para><link
    linkend="class-atkcomponent"><classname>atk.Component</classname></link>
    should be implemented by most if not all UI elements with an actual
    on-screen presence, i.e. components which can be said to have a
    screen-coordinate bounding box.  Virtually all widgets will need to have
    <link
    linkend="class-atkcomponent"><classname>atk.Component</classname></link>
    implementations provided for their corresponding <link
    linkend="class-atkobject"><classname>atk.Object</classname></link>
    class.  In short, only UI elements which are *not* GUI elements will
    omit this ATK interface.</para>

    <para>A possible exception might be textual information with a
    transparent background, in which case text glyph bounding box
    information is provided by <link
    linkend="class-atktext"><classname>atk.Text</classname></link>.</para>

  </refsect1>

  <refsect1>
    <title>Methods</title>

<!-- NOT IMPLEMENTED
    <refsect2 id="method-atkcomponent- -add-focus-handler">
      <title>atk.Component.add_focus_handler</title>

      <programlisting><methodsynopsis language="python">
        <methodname>add_focus_handler</methodname>
        <methodparam><parameter role="keyword">handler</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">handler</parameter>&nbsp;:</term>
          <listitem><simpara>The <literal>AtkFocusHandler</literal> to be attached to <parameter>component</parameter></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a handler id which can be used in atk_component_remove_focus_handler
or zero if the handler was already added.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Add the specified handler to the set of functions to be called 
      when this object receives focus events (in or out). If the handler is
      already added it is not added again</para>

    </refsect2>
END NOT IMPLEMENTED -->

    <refsect2 id="method-atkcomponent--contains">
      <title>atk.Component.contains</title>

      <programlisting><methodsynopsis language="python">
        <methodname>contains</methodname>
        <methodparam><parameter role="keyword">x</parameter></methodparam>
        <methodparam><parameter role="keyword">y</parameter></methodparam>
        <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">x</parameter>&nbsp;:</term>
          <listitem><simpara>x coordinate</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">y</parameter>&nbsp;:</term>
          <listitem><simpara>y coordinate</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">coord_type</parameter>&nbsp;:</term>
          <listitem><simpara>specifies whether the coordinates are relative
          to the screen or to the components top level window - one of the
          <xref linkend="atk-coord-type-constants"
          endterm="atk-coord-type-constants-title"></xref></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> or
          <literal>False</literal> indicating whether the specified point is
          within the extent of the component or not</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Checks whether the specified point is within the extent of the
      <parameter>component</parameter>.</para>

    </refsect2>

    <refsect2 id="method-atkcomponent--ref-accessible-at-point">
      <title>atk.Component.ref_accessible_at_point</title>

      <programlisting><methodsynopsis language="python">
        <methodname>ref_accessible_at_point</methodname>
        <methodparam><parameter role="keyword">x</parameter></methodparam>
        <methodparam><parameter role="keyword">y</parameter></methodparam>
        <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">x</parameter>&nbsp;:</term>
          <listitem><simpara>x coordinate</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">y</parameter>&nbsp;:</term>
          <listitem><simpara>y coordinate</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">coord_type</parameter>&nbsp;:</term>
          <listitem><simpara>specifies whether the coordinates are relative
          to the screen or to the components top level
          window - one of the
          <xref linkend="atk-coord-type-constants"
          endterm="atk-coord-type-constants-title"></xref></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>an <link
          linkend="class-atkobject"><classname>atk.Object</classname></link>
          reference to the accessible child, if one
          exists</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets a reference to the accessible child, if one exists, at the
      coordinate point specified by <parameter>x</parameter> and
      <parameter>y</parameter>.</para>

    </refsect2>

    <refsect2 id="method-atkcomponent--get-extents">
      <title>atk.Component.get_extents</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_extents</methodname>
        <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">coord_type</parameter>&nbsp;:</term>
          <listitem><simpara>specifies whether the coordinates are relative
          to the screen or to the components top level window - one of the
          <xref linkend="atk-coord-type-constants"
          endterm="atk-coord-type-constants-title"></xref></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a 4-tuple containing the x, y position
          coordinates and the width and height of the
          component.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the rectangle which gives the extent of the
      component.</para>

    </refsect2>

    <refsect2 id="method-atkcomponent--get-position">
      <title>atk.Component.get_position</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_position</methodname>
        <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">coord_type</parameter>&nbsp;:</term>
          <listitem><simpara>specifies whether the coordinates are relative
          to the screen or to the components top level window - one of the
          <xref linkend="atk-coord-type-constants"
          endterm="atk-coord-type-constants-title"></xref></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a 2-tuple containing the x, y position
          coordinates of the component.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the position of the component in the form of a point
      specifying the component's top-left corner.</para>

    </refsect2>

    <refsect2 id="method-atkcomponent--get-size">
      <title>atk.Component.get_size</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_size</methodname>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a 2-tuple containing the width and height of
          the component.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the size of the component in terms of width and
      height.</para>

    </refsect2>

    <refsect2 id="method-atkcomponent--grab-focus">
      <title>atk.Component.grab_focus</title>

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

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if successful,
          <literal>False</literal> otherwise.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Grabs focus for this component.</para>

    </refsect2>

    <refsect2 id="method-atkcomponent--remove-focus-handler">
      <title>atk.Component.remove_focus_handler</title>

      <programlisting><methodsynopsis language="python">
        <methodname>remove_focus_handler</methodname>
        <methodparam><parameter role="keyword">handler_id</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">handler_id</parameter>&nbsp;:</term>
          <listitem><simpara>the handler id of the focus handler to be
          removed from component</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Remove the handler specified by
      <parameter>handler_id</parameter> from the list of functions to be
      executed when this object receives focus events (in or out).</para>

    </refsect2>

    <refsect2 id="method-atkcomponent--set-extents">
      <title>atk.Component.set_extents</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_extents</methodname>
        <methodparam><parameter role="keyword">x</parameter></methodparam>
        <methodparam><parameter role="keyword">y</parameter></methodparam>
        <methodparam><parameter role="keyword">width</parameter></methodparam>
        <methodparam><parameter role="keyword">height</parameter></methodparam>
        <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">x</parameter>&nbsp;:</term>
          <listitem><simpara>x coordinate</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">y</parameter>&nbsp;:</term>
          <listitem><simpara>y coordinate</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">width</parameter>&nbsp;:</term>
          <listitem><simpara>width to set for the
          component</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">height</parameter>&nbsp;:</term>
          <listitem><simpara>height to set for the
          component</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">coord_type</parameter>&nbsp;:</term>
          <listitem><simpara>specifies whether the coordinates are relative
          to the screen or to the components top level window - one of the
          <xref linkend="atk-coord-type-constants"
          endterm="atk-coord-type-constants-title"></xref></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if the extents were
          set</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Sets the extents of the component.</para>

    </refsect2>

    <refsect2 id="method-atkcomponent--set-position">
      <title>atk.Component.set_position</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_position</methodname>
        <methodparam><parameter role="keyword">x</parameter></methodparam>
        <methodparam><parameter role="keyword">y</parameter></methodparam>
        <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">x</parameter>&nbsp;:</term>
          <listitem><simpara>x coordinate</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">y</parameter>&nbsp;:</term>
          <listitem><simpara>y coordinate</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">coord_type</parameter>&nbsp;:</term>
          <listitem><simpara>specifies whether the coordinates are relative
          to the screen or to the components top level window - one of the
          <xref linkend="atk-coord-type-constants"
          endterm="atk-coord-type-constants-title"></xref></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if the position was
          set</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Sets the postition of the component.</para>

    </refsect2>

    <refsect2 id="method-atkcomponent--set-size">
      <title>atk.Component.set_size</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_size</methodname>
        <methodparam><parameter role="keyword">width</parameter></methodparam>
        <methodparam><parameter role="keyword">height</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">width</parameter>&nbsp;:</term>
          <listitem><simpara>width to set for component</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">height</parameter>&nbsp;:</term>
          <listitem><simpara>height to set for component</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if the size was
          set</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Set the size of the component in terms of width and
      height.</para>

    </refsect2>

    <refsect2 id="method-atkcomponent--get-layer">
      <title>atk.Component.get_layer</title>

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

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>one of the <xref linkend="atk-layer-constants"
          endterm="atk-layer-constants-title"></xref> which is the layer of
          the component</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the layer of the component.</para>

    </refsect2>

    <refsect2 id="method-atkcomponent--get-mdi-zorder">
      <title>atk.Component.get_mdi_zorder</title>

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

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>an integer which is the zorder of the
          component, i.e. the depth at which the component is shown in
          relation to other components in the same
          container.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the zorder of the component. The value G_MININT will be
      returned if the layer of the component is not
      <literal>atk.LAYER_MDI</literal> or
      <literal>atk.LAYER_WINDOW</literal>.</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Signals</title>

    <refsect2 id="signal-atkcomponent--bounds-changed">
      <title>The "bounds-changed" atk.Component Signal</title>

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

      <variablelist>
        <varlistentry>
          <term><parameter>atkcomponent</parameter>&nbsp;:</term>
          <listitem><simpara>the object which received the signal.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>rect</parameter>&nbsp;:</term>
          <listitem><simpara>The <link
          linkend="class-atkrectangle"><classname>atk.Rectangle</classname></link>
          giving the new position and size.</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 'bounds-changed" signal is emitted when the bposition or
      size of the a component changes.</para>

    </refsect2>

</refsect1>

</refentry>