← Back to branch summary

~ubuntu-branches/ubuntu/natty/pygtk/natty-proposed

« back to all changes in this revision

Viewing changes to docs/html/class-atkcomponent.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-01-07 11:08:47 UTC
  • mfrom: (1.2.8 upstream)
  • Revision ID: james.westby@ubuntu.com-20100107110847-f5av7e1ttudh7ra6
Tags: 2.17.0-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/class-atkcomponent.html
1
 
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>atk.Component</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="atk-class-reference.html" title="The atk Class Reference"><link rel="prev" href="class-atkaction.html" title="atk.Action"><link rel="next" href="class-atkdocument.html" title="atk.Document"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">atk.Component</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-atkaction.html">Prev</a> </td><th width="60%" align="center">The atk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-atkdocument.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-atkcomponent"></a><div class="titlepage"></div><div class="refnamediv"><h2>atk.Component</h2><p>atk.Component — the ATK interface provided by UI components that occupy a
2
 
      physical area on the screen.  </p></div><div class="refsect1" lang="en"><a name="id2854095"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.Component</span></span>(<span class="ooclass"><span class="classname">gobject.GInterface</span></span>):
3
 
<code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--contains" title="atk.Component.contains">contains</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--ref-accessible-at-point" title="atk.Component.ref_accessible_at_point">ref_accessible_at_point</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--get-extents" title="atk.Component.get_extents">get_extents</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--get-position" title="atk.Component.get_position">get_position</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--get-size" title="atk.Component.get_size">get_size</a></span>()</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--grab-focus" title="atk.Component.grab_focus">grab_focus</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--remove-focus-handler" title="atk.Component.remove_focus_handler">remove_focus_handler</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>handler_id</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--set-extents" title="atk.Component.set_extents">set_extents</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--set-position" title="atk.Component.set_position">set_position</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--set-size" title="atk.Component.set_size">set_size</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--get-layer" title="atk.Component.get_layer">get_layer</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--get-mdi-zorder" title="atk.Component.get_mdi_zorder">get_mdi_zorder</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="signal-prototypes-atkcomponent"></a><h2>atk.Component Signal Prototypes</h2><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-atkcomponent.html#signal-atkcomponent--bounds-changed" title='The "bounds-changed" atk.Component Signal'>bounds-changed</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkcomponent</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>rect</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id2853667"></a><h2>Description</h2><p><a class="link" href="class-atkcomponent.html" title="atk.Component"><code class="classname">atk.Component</code></a>
 
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>atk.Component</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="atk-class-reference.html" title="The atk Class Reference"><link rel="prev" href="class-atkaction.html" title="atk.Action"><link rel="next" href="class-atkdocument.html" title="atk.Document"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">atk.Component</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-atkaction.html">Prev</a> </td><th width="60%" align="center">The atk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-atkdocument.html">Next</a></td></tr></table><hr></div><div class="refentry" title="atk.Component"><a name="class-atkcomponent"></a><div class="titlepage"></div><div class="refnamediv"><h2>atk.Component</h2><p>atk.Component — the ATK interface provided by UI components that occupy a
 
2
      physical area on the screen.  </p></div><div class="refsect1" title="Synopsis"><a name="id3164335"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.Component</span></span>(<span class="ooclass"><span class="classname">gobject.GInterface</span></span>):
 
3
<code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--contains" title="atk.Component.contains">contains</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--ref-accessible-at-point" title="atk.Component.ref_accessible_at_point">ref_accessible_at_point</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--get-extents" title="atk.Component.get_extents">get_extents</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--get-position" title="atk.Component.get_position">get_position</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--get-size" title="atk.Component.get_size">get_size</a></span>()</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--grab-focus" title="atk.Component.grab_focus">grab_focus</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--remove-focus-handler" title="atk.Component.remove_focus_handler">remove_focus_handler</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>handler_id</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--set-extents" title="atk.Component.set_extents">set_extents</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--set-position" title="atk.Component.set_position">set_position</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--set-size" title="atk.Component.set_size">set_size</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--get-layer" title="atk.Component.get_layer">get_layer</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atkcomponent.html#method-atkcomponent--get-mdi-zorder" title="atk.Component.get_mdi_zorder">get_mdi_zorder</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="atk.Component Signal Prototypes"><a name="signal-prototypes-atkcomponent"></a><h2>atk.Component Signal Prototypes</h2><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-atkcomponent.html#signal-atkcomponent--bounds-changed" title='The "bounds-changed" atk.Component Signal'>bounds-changed</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkcomponent</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>rect</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" title="Description"><a name="id3163899"></a><h2>Description</h2><p><a class="link" href="class-atkcomponent.html" title="atk.Component"><code class="classname">atk.Component</code></a>
4
4
    should be implemented by most if not all UI elements with an actual
5
5
    on-screen presence, i.e. components which can be said to have a
6
6
    screen-coordinate bounding box.  Virtually all widgets will need to have
9
9
    class.  In short, only UI elements which are *not* GUI elements will
10
10
    omit this ATK interface.</p><p>A possible exception might be textual information with a
11
11
    transparent background, in which case text glyph bounding box
12
 
    information is provided by <a class="link" href="class-atktext.html" title="atk.Text"><code class="classname">atk.Text</code></a>.</p></div><div class="refsect1" lang="en"><a name="id2853630"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-atkcomponent--contains"></a><h3>atk.Component.contains</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">contains</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>x</code></strong> :</span></p></td><td>x coordinate</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>y</code></strong> :</span></p></td><td>y coordinate</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>coord_type</code></strong> :</span></p></td><td>specifies whether the coordinates are relative
 
12
    information is provided by <a class="link" href="class-atktext.html" title="atk.Text"><code class="classname">atk.Text</code></a>.</p></div><div class="refsect1" title="Methods"><a name="id3163859"></a><h2>Methods</h2><div class="refsect2" title="atk.Component.contains"><a name="method-atkcomponent--contains"></a><h3>atk.Component.contains</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">contains</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>x</code></strong> :</span></p></td><td>x coordinate</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>y</code></strong> :</span></p></td><td>y coordinate</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>coord_type</code></strong> :</span></p></td><td>specifies whether the coordinates are relative
13
13
          to the screen or to the components top level window - one of the
14
14
          <a class="xref" href="atk-constants.html#atk-coord-type-constants" title="Atk Coord Type Constants">Atk Coord Type Constants</a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> or
15
15
          <code class="literal">False</code> indicating whether the specified point is
16
16
          within the extent of the component or not</td></tr></tbody></table><p>Checks whether the specified point is within the extent of the
17
 
      <em class="parameter"><code>component</code></em>.</p></div><div class="refsect2" lang="en"><a name="method-atkcomponent--ref-accessible-at-point"></a><h3>atk.Component.ref_accessible_at_point</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">ref_accessible_at_point</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>x</code></strong> :</span></p></td><td>x coordinate</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>y</code></strong> :</span></p></td><td>y coordinate</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>coord_type</code></strong> :</span></p></td><td>specifies whether the coordinates are relative
 
17
      <em class="parameter"><code>component</code></em>.</p></div><div class="refsect2" title="atk.Component.ref_accessible_at_point"><a name="method-atkcomponent--ref-accessible-at-point"></a><h3>atk.Component.ref_accessible_at_point</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">ref_accessible_at_point</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>x</code></strong> :</span></p></td><td>x coordinate</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>y</code></strong> :</span></p></td><td>y coordinate</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>coord_type</code></strong> :</span></p></td><td>specifies whether the coordinates are relative
18
18
          to the screen or to the components top level
19
19
          window - one of the
20
20
          <a class="xref" href="atk-constants.html#atk-coord-type-constants" title="Atk Coord Type Constants">Atk Coord Type Constants</a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>an <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
21
21
          reference to the accessible child, if one
22
22
          exists</td></tr></tbody></table><p>Gets a reference to the accessible child, if one exists, at the
23
23
      coordinate point specified by <em class="parameter"><code>x</code></em> and
24
 
      <em class="parameter"><code>y</code></em>.</p></div><div class="refsect2" lang="en"><a name="method-atkcomponent--get-extents"></a><h3>atk.Component.get_extents</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_extents</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>coord_type</code></strong> :</span></p></td><td>specifies whether the coordinates are relative
 
24
      <em class="parameter"><code>y</code></em>.</p></div><div class="refsect2" title="atk.Component.get_extents"><a name="method-atkcomponent--get-extents"></a><h3>atk.Component.get_extents</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_extents</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>coord_type</code></strong> :</span></p></td><td>specifies whether the coordinates are relative
25
25
          to the screen or to the components top level window - one of the
26
26
          <a class="xref" href="atk-constants.html#atk-coord-type-constants" title="Atk Coord Type Constants">Atk Coord Type Constants</a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 4-tuple containing the x, y position
27
27
          coordinates and the width and height of the
28
28
          component.</td></tr></tbody></table><p>Gets the rectangle which gives the extent of the
29
 
      component.</p></div><div class="refsect2" lang="en"><a name="method-atkcomponent--get-position"></a><h3>atk.Component.get_position</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_position</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>coord_type</code></strong> :</span></p></td><td>specifies whether the coordinates are relative
 
29
      component.</p></div><div class="refsect2" title="atk.Component.get_position"><a name="method-atkcomponent--get-position"></a><h3>atk.Component.get_position</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_position</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>coord_type</code></strong> :</span></p></td><td>specifies whether the coordinates are relative
30
30
          to the screen or to the components top level window - one of the
31
31
          <a class="xref" href="atk-constants.html#atk-coord-type-constants" title="Atk Coord Type Constants">Atk Coord Type Constants</a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 2-tuple containing the x, y position
32
32
          coordinates of the component.</td></tr></tbody></table><p>Gets the position of the component in the form of a point
33
 
      specifying the component's top-left corner.</p></div><div class="refsect2" lang="en"><a name="method-atkcomponent--get-size"></a><h3>atk.Component.get_size</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_size</span>()</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 2-tuple containing the width and height of
 
33
      specifying the component's top-left corner.</p></div><div class="refsect2" title="atk.Component.get_size"><a name="method-atkcomponent--get-size"></a><h3>atk.Component.get_size</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_size</span>()</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 2-tuple containing the width and height of
34
34
          the component.</td></tr></tbody></table><p>Gets the size of the component in terms of width and
35
 
      height.</p></div><div class="refsect2" lang="en"><a name="method-atkcomponent--grab-focus"></a><h3>atk.Component.grab_focus</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">grab_focus</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if successful,
36
 
          <code class="literal">False</code> otherwise.</td></tr></tbody></table><p>Grabs focus for this component.</p></div><div class="refsect2" lang="en"><a name="method-atkcomponent--remove-focus-handler"></a><h3>atk.Component.remove_focus_handler</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">remove_focus_handler</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>handler_id</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>handler_id</code></strong> :</span></p></td><td>the handler id of the focus handler to be
 
35
      height.</p></div><div class="refsect2" title="atk.Component.grab_focus"><a name="method-atkcomponent--grab-focus"></a><h3>atk.Component.grab_focus</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">grab_focus</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if successful,
 
36
          <code class="literal">False</code> otherwise.</td></tr></tbody></table><p>Grabs focus for this component.</p></div><div class="refsect2" title="atk.Component.remove_focus_handler"><a name="method-atkcomponent--remove-focus-handler"></a><h3>atk.Component.remove_focus_handler</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">remove_focus_handler</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>handler_id</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>handler_id</code></strong> :</span></p></td><td>the handler id of the focus handler to be
37
37
          removed from component</td></tr></tbody></table><p>Remove the handler specified by
38
38
      <em class="parameter"><code>handler_id</code></em> from the list of functions to be
39
 
      executed when this object receives focus events (in or out).</p></div><div class="refsect2" lang="en"><a name="method-atkcomponent--set-extents"></a><h3>atk.Component.set_extents</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_extents</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>x</code></strong> :</span></p></td><td>x coordinate</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>y</code></strong> :</span></p></td><td>y coordinate</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>width</code></strong> :</span></p></td><td>width to set for the
 
39
      executed when this object receives focus events (in or out).</p></div><div class="refsect2" title="atk.Component.set_extents"><a name="method-atkcomponent--set-extents"></a><h3>atk.Component.set_extents</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_extents</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>x</code></strong> :</span></p></td><td>x coordinate</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>y</code></strong> :</span></p></td><td>y coordinate</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>width</code></strong> :</span></p></td><td>width to set for the
40
40
          component</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>height</code></strong> :</span></p></td><td>height to set for the
41
41
          component</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>coord_type</code></strong> :</span></p></td><td>specifies whether the coordinates are relative
42
42
          to the screen or to the components top level window - one of the
43
43
          <a class="xref" href="atk-constants.html#atk-coord-type-constants" title="Atk Coord Type Constants">Atk Coord Type Constants</a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the extents were
44
 
          set</td></tr></tbody></table><p>Sets the extents of the component.</p></div><div class="refsect2" lang="en"><a name="method-atkcomponent--set-position"></a><h3>atk.Component.set_position</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_position</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>x</code></strong> :</span></p></td><td>x coordinate</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>y</code></strong> :</span></p></td><td>y coordinate</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>coord_type</code></strong> :</span></p></td><td>specifies whether the coordinates are relative
 
44
          set</td></tr></tbody></table><p>Sets the extents of the component.</p></div><div class="refsect2" title="atk.Component.set_position"><a name="method-atkcomponent--set-position"></a><h3>atk.Component.set_position</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_position</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>x</code></strong> :</span></p></td><td>x coordinate</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>y</code></strong> :</span></p></td><td>y coordinate</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>coord_type</code></strong> :</span></p></td><td>specifies whether the coordinates are relative
45
45
          to the screen or to the components top level window - one of the
46
46
          <a class="xref" href="atk-constants.html#atk-coord-type-constants" title="Atk Coord Type Constants">Atk Coord Type Constants</a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the position was
47
 
          set</td></tr></tbody></table><p>Sets the postition of the component.</p></div><div class="refsect2" lang="en"><a name="method-atkcomponent--set-size"></a><h3>atk.Component.set_size</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_size</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>width</code></strong> :</span></p></td><td>width to set for component</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>height</code></strong> :</span></p></td><td>height to set for component</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the size was
 
47
          set</td></tr></tbody></table><p>Sets the postition of the component.</p></div><div class="refsect2" title="atk.Component.set_size"><a name="method-atkcomponent--set-size"></a><h3>atk.Component.set_size</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_size</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>width</code></strong> :</span></p></td><td>width to set for component</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>height</code></strong> :</span></p></td><td>height to set for component</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the size was
48
48
          set</td></tr></tbody></table><p>Set the size of the component in terms of width and
49
 
      height.</p></div><div class="refsect2" lang="en"><a name="method-atkcomponent--get-layer"></a><h3>atk.Component.get_layer</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_layer</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>one of the <a class="xref" href="atk-constants.html#atk-layer-constants" title="Atk Layer Constants">Atk Layer Constants</a> which is the layer of
50
 
          the component</td></tr></tbody></table><p>Gets the layer of the component.</p></div><div class="refsect2" lang="en"><a name="method-atkcomponent--get-mdi-zorder"></a><h3>atk.Component.get_mdi_zorder</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_mdi_zorder</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>an integer which is the zorder of the
 
49
      height.</p></div><div class="refsect2" title="atk.Component.get_layer"><a name="method-atkcomponent--get-layer"></a><h3>atk.Component.get_layer</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_layer</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>one of the <a class="xref" href="atk-constants.html#atk-layer-constants" title="Atk Layer Constants">Atk Layer Constants</a> which is the layer of
 
50
          the component</td></tr></tbody></table><p>Gets the layer of the component.</p></div><div class="refsect2" title="atk.Component.get_mdi_zorder"><a name="method-atkcomponent--get-mdi-zorder"></a><h3>atk.Component.get_mdi_zorder</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_mdi_zorder</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>an integer which is the zorder of the
51
51
          component, i.e. the depth at which the component is shown in
52
52
          relation to other components in the same
53
53
          container.</td></tr></tbody></table><p>Gets the zorder of the component. The value G_MININT will be
54
54
      returned if the layer of the component is not
55
55
      <code class="literal">atk.LAYER_MDI</code> or
56
 
      <code class="literal">atk.LAYER_WINDOW</code>.</p></div></div><div class="refsect1" lang="en"><a name="id2799320"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-atkcomponent--bounds-changed"></a><h3>The "bounds-changed" atk.Component Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkcomponent</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>rect</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>atkcomponent</code></em> :</span></p></td><td>the object which received the signal.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>rect</code></em> :</span></p></td><td>The <a class="link" href="class-atkrectangle.html" title="atk.Rectangle"><code class="classname">atk.Rectangle</code></a>
 
56
      <code class="literal">atk.LAYER_WINDOW</code>.</p></div></div><div class="refsect1" title="Signals"><a name="id3136483"></a><h2>Signals</h2><div class="refsect2" title='The "bounds-changed" atk.Component Signal'><a name="signal-atkcomponent--bounds-changed"></a><h3>The "bounds-changed" atk.Component Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atkcomponent</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>rect</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>atkcomponent</code></em> :</span></p></td><td>the object which received the signal.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>rect</code></em> :</span></p></td><td>The <a class="link" href="class-atkrectangle.html" title="atk.Rectangle"><code class="classname">atk.Rectangle</code></a>
57
57
          giving the new position and size.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
58
58
          with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
59
59
          method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if any)</td></tr></tbody></table><p>The 'bounds-changed" signal is emitted when the bposition or