/usr/share/gtk-doc/html/pygtk/class-atkcomponent.html is in python-gtk2-doc 2.24.0-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 | <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.2"><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
physical area on the screen. </p></div><div class="refsect1" title="Synopsis"><a name="id3005709"></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>):
<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="id3005272"></a><h2>Description</h2><p><a class="link" href="class-atkcomponent.html" title="atk.Component"><code class="classname">atk.Component</code></a>
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
<a class="link" href="class-atkcomponent.html" title="atk.Component"><code class="classname">atk.Component</code></a>
implementations provided for their corresponding <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
class. In short, only UI elements which are *not* GUI elements will
omit this ATK interface.</p><p>A possible exception might be textual information with a
transparent background, in which case text glyph bounding box
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="id3005232"></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
to the screen or to the components top level window - one of the
<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
<code class="literal">False</code> indicating whether the specified point is
within the extent of the component or not</td></tr></tbody></table><p>Checks whether the specified point is within the extent of the
<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
to the screen or to the components top level
window - one of the
<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>
reference to the accessible child, if one
exists</td></tr></tbody></table><p>Gets a reference to the accessible child, if one exists, at the
coordinate point specified by <em class="parameter"><code>x</code></em> and
<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
to the screen or to the components top level window - one of the
<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
coordinates and the width and height of the
component.</td></tr></tbody></table><p>Gets the rectangle which gives the extent of the
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
to the screen or to the components top level window - one of the
<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
coordinates of the component.</td></tr></tbody></table><p>Gets the position of the component in the form of a point
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
the component.</td></tr></tbody></table><p>Gets the size of the component in terms of width and
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,
<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
removed from component</td></tr></tbody></table><p>Remove the handler specified by
<em class="parameter"><code>handler_id</code></em> from the list of functions to be
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
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
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
to the screen or to the components top level window - one of the
<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
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
to the screen or to the components top level window - one of the
<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
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
set</td></tr></tbody></table><p>Set the size of the component in terms of width and
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
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
component, i.e. the depth at which the component is shown in
relation to other components in the same
container.</td></tr></tbody></table><p>Gets the zorder of the component. The value G_MININT will be
returned if the layer of the component is not
<code class="literal">atk.LAYER_MDI</code> or
<code class="literal">atk.LAYER_WINDOW</code>.</p></div></div><div class="refsect1" title="Signals"><a name="id2932635"></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>
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
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
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
size of the a component changes.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-atkaction.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="atk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-atkdocument.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">atk.Action </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> atk.Document</td></tr></table></div></body></html>
|