/usr/share/gtk-doc/html/pygtk/class-gtkalignment.html is in python-gtk2-doc 2.24.0-5.1ubuntu2.
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 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Alignment</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="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkadjustment.html" title="gtk.Adjustment"><link rel="next" href="class-gtkarrow.html" title="gtk.Arrow"></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">gtk.Alignment</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkadjustment.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkarrow.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.Alignment"><a name="class-gtkalignment"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Alignment</h2><p>gtk.Alignment — a widget that controls the alignment and size of its
child</p></div><div class="refsect1" title="Synopsis"><a name="id3497996"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Alignment</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkalignment.html#constructor-gtkalignment" title="Constructor">gtk.Alignment</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>xalign</code></strong></span><span class="initializer">=0.0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>yalign</code></strong></span><span class="initializer">=0.0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>xscale</code></strong></span><span class="initializer">=0.0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>yscale</code></strong></span><span class="initializer">=0.0</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkalignment.html#method-gtkalignment--set" title="gtk.Alignment.set">set</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>xalign</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>yalign</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>xscale</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>yscale</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkalignment.html#method-gtkalignment--set-padding" title="gtk.Alignment.set_padding">set_padding</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>padding_top</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>padding_bottom</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>padding_left</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>padding_right</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkalignment.html#method-gtkalignment--get-padding" title="gtk.Alignment.get_padding">get_padding</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3348136"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
+-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
+-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
+-- <a class="link" href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
+-- <a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
+-- <a class="link" href="class-gtkalignment.html" title="gtk.Alignment">gtk.Alignment</a>
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3331766"></a><h2>Implemented Interfaces</h2><p>
<a class="link" href="class-gtkalignment.html" title="gtk.Alignment"><code class="classname">gtk.Alignment</code></a>
implements
<a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
</p></div><div class="refsect1" title="gtk.Alignment Properties"><a name="properties-gtkalignment"></a><h2>gtk.Alignment Properties</h2><p><a class="link" href="class-gtkobject.html#properties-gtkobject" title="gtk.Object Properties">gtk.Object Properties</a></p><p><a class="link" href="class-gtkwidget.html#properties-gtkwidget" title="gtk.Widget Properties">gtk.Widget Properties</a></p><p><a class="link" href="class-gtkcontainer.html#properties-gtkcontainer" title="gtk.Container Properties">gtk.Container Properties</a></p><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="3.5in"></colgroup><tbody><tr valign="top"><td valign="top">"bottom-padding"</td><td valign="top">Read/Write</td><td valign="top">The padding to insert at the bottom of the widget. GTK+ 2.4
and above.</td></tr><tr valign="top"><td valign="top">"left-padding"</td><td valign="top">Read/Write</td><td valign="top">The padding to insert at the left of the widget. GTK+ 2.4
and above.</td></tr><tr valign="top"><td valign="top">"right-padding"</td><td valign="top">Read/Write</td><td valign="top">The padding to insert at the right of the widget. GTK+ 2.4
and above.</td></tr><tr valign="top"><td valign="top">"top-padding"</td><td valign="top">Read/Write</td><td valign="top">The padding to insert at the top of the widget. GTK+ 2.4
and above.</td></tr><tr valign="top"><td valign="top">"xalign"</td><td valign="top">Read/Write</td><td valign="top">The fraction of horizontal <span class="emphasis"><em>free</em></span> space
to the left of the child. 0.0 means no <span class="emphasis"><em>free</em></span>
space to the left, 1.0 means all <span class="emphasis"><em>free</em></span> space
to the left.</td></tr><tr valign="top"><td valign="top">"xscale"</td><td valign="top">Read/Write</td><td valign="top">The fraction of horizontal <span class="emphasis"><em>free</em></span> space
(beyond that needed by the child) that the child will absorb. 0.0 means the
child will absorb none, 1.0 means the child will absorb all</td></tr><tr valign="top"><td valign="top">"yalign"</td><td valign="top">Read/Write</td><td valign="top">The fraction of vertical <span class="emphasis"><em>free</em></span> space
above the child. 0.0 means no <span class="emphasis"><em>free</em></span> space
above, 1.0 means all <span class="emphasis"><em>free</em></span> space
above.</td></tr><tr valign="top"><td valign="top">"yscale"</td><td valign="top">Read/Write</td><td valign="top">The fraction of vertical <span class="emphasis"><em>free</em></span> space
(beyond that needed by the child) that the child will absorb. 0.0 means the
child will absorb none, 1.0 means the child will absorb all</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.Alignment Style Properties"><a name="style-properties-gtkalignment"></a><h2>gtk.Alignment Style Properties</h2><p><a class="link" href="class-gtkwidget.html#style-properties-gtkwidget" title="gtk.Widget Style Properties">gtk.Widget Style Properties</a></p></div><div class="refsect1" title="gtk.Alignment Signal Prototypes"><a name="signal-prototypes-gtkalignment"></a><h2>gtk.Alignment Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkobject.html#signal-prototypes-gtkobject" title="gtk.Object Signal Prototypes">gtk.Object Signal Prototypes</a></p><p><a class="link" href="class-gtkwidget.html#signal-prototypes-gtkwidget" title="gtk.Widget Signal Prototypes">gtk.Widget Signal Prototypes</a></p><p><a class="link" href="class-gtkcontainer.html#signal-prototypes-gtkcontainer" title="gtk.Container Signal Prototypes">gtk.Container Signal Prototypes</a></p></div><div class="refsect1" title="Description"><a name="id3498258"></a><h2>Description</h2><p>The <a class="link" href="class-gtkalignment.html" title="gtk.Alignment"><code class="classname">gtk.Alignment</code></a>
widget controls the alignment and size of its child widget. It has four
properties: xscale, yscale, xalign, and yalign. The scale properties are
used to specify how much of the <span class="emphasis"><em>free</em></span> (extra) space
allocated to the <a class="link" href="class-gtkalignment.html" title="gtk.Alignment"><code class="classname">gtk.Alignment</code></a>
should be absorbed by the child widget. The values can range from 0.0
(meaning the child absorbs none) to 1.0 (meaning the child absorbs all of
the <span class="emphasis"><em>free</em></span> space). If the value is 0.5, the child widget
absorbs half the <span class="emphasis"><em>free</em></span> space. The align properties are
used to place the child widget within the available area by specifying the
fraction of <span class="emphasis"><em>free</em></span> space that will be placed above or to
the left of the child widget. The values range from 0.0 (no
<span class="emphasis"><em>free</em></span> space above or to the left of the child) to 1.0
(all <span class="emphasis"><em>free</em></span> space above or to the left of the child). Of
course, if the scale properties are both set to 1.0, the alignment
properties have no effect.</p><p>An example may make this clearer. A <a class="link" href="class-gtkimage.html" title="gtk.Image"><code class="classname">gtk.Button</code></a> widget (32
pixels wide by 32 pixels high) is placed inside a <a class="link" href="class-gtkalignment.html" title="gtk.Alignment"><code class="classname">gtk.Alignment</code></a>
widget (256 pixels wide by 128 pixels high) which has xalign of 0.25, yalign
of 0.25, xscale of 0.25 and yscale of 0.25. The horizontal
<span class="emphasis"><em>free</em></span> space is 256-32=224 pixels and the vertical
<span class="emphasis"><em>free</em></span> space is 128-32=96 pixels. The button will absorb
0.25x224=56 pixels horizontally and 0.25x96=24 pixels vertically since the
xscale and yscale are 0.25 thus becoming 32+56=88 pixels wide by 32+24=56
pixels high. This will leave 256-88=168 pixels of horizontal
<span class="emphasis"><em>free</em></span> space and 128-56=72 pixels of vertical
<span class="emphasis"><em>free</em></span> space. Since the xalign value is 0.25 the
horizontal <span class="emphasis"><em>free</em></span> space will be allocated as 0.25x168=42
pixels to the left of the button and 0.72x168=126 pixels to the right.
Likewise since the yalign is 0.25 the vertical <span class="emphasis"><em>free</em></span>
space is allocated as 0.25x72=18 pixels above the button and 0.75*72=54
pixels below.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtkalignment"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.Alignment</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>xalign</code></strong></span><span class="initializer">=0.0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>yalign</code></strong></span><span class="initializer">=0.0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>xscale</code></strong></span><span class="initializer">=0.0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>yscale</code></strong></span><span class="initializer">=0.0</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>xalign</code></strong> :</span></p></td><td>the fraction of horizontal
<span class="emphasis"><em>free</em></span> space to the left of the child widget. Ranges from
0.0 to 1.0</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>yalign</code></strong> :</span></p></td><td>the fraction of vertical
<span class="emphasis"><em>free</em></span> space above the child widget. Ranges from 0.0 to
1.0</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>xscale</code></strong> :</span></p></td><td>the fraction of horizontal
<span class="emphasis"><em>free</em></span> space that the child widget absorbs, from 0.0 to
1.0</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>yscale</code></strong> :</span></p></td><td>the fraction of vertical
<span class="emphasis"><em>free</em></span> space that the child widget absorbs, from 0.0 to
1.0</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new alignment object</td></tr></tbody></table><p>Creates a new alignment widget with the specified properties. If
the scale and alignment parameters are not specified they default to
0.0.</p></div><div class="refsect1" title="Methods"><a name="id3253333"></a><h2>Methods</h2><div class="refsect2" title="gtk.Alignment.set"><a name="method-gtkalignment--set"></a><h3>gtk.Alignment.set</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>xalign</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>yalign</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>xscale</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>yscale</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>xalign</code></strong> :</span></p></td><td>the fraction of horizontal
<span class="emphasis"><em>free</em></span> space to the left of the child widget. Ranges from
0.0 to 1.0</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>yalign</code></strong> :</span></p></td><td>the fraction of vertical
<span class="emphasis"><em>free</em></span> space above the child widget. Ranges from 0.0 to
1.0</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>xscale</code></strong> :</span></p></td><td>the fraction of horizontal
<span class="emphasis"><em>free</em></span> space that the child widget absorbs, from 0.0 to
1.0</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>yscale</code></strong> :</span></p></td><td>the fraction of vertical
<span class="emphasis"><em>free</em></span> space that the child widget absorbs, from 0.0 to
1.0</td></tr></tbody></table><p>The <code class="methodname">set</code>() method sets the properties of
the alignment widget to the specified values.</p></div><div class="refsect2" title="gtk.Alignment.set_padding"><a name="method-gtkalignment--set-padding"></a><h3>gtk.Alignment.set_padding</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_padding</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>padding_top</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>padding_bottom</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>padding_left</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>padding_right</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>padding_top</code></strong> :</span></p></td><td> the padding at the top of the
widget</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>padding_bottom</code></strong> :</span></p></td><td> the padding at the bottom of the
widget</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>padding_left</code></strong> :</span></p></td><td> the padding at the left of the
widget</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>padding_right</code></strong> :</span></p></td><td> the padding at the right of the
widget.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_padding</code>() method sets the
padding around the sides of the alignment widget to the values specified by
<em class="parameter"><code>padding_top</code></em>, <em class="parameter"><code>padding_bottom</code></em>,
<em class="parameter"><code>padding_left</code></em> and
<em class="parameter"><code>padding_right</code></em>. The padding adds blank space to the
sides of the widget. For instance, this can be used to indent the child
widget toward the right by adding padding on the left.</p></div><div class="refsect2" title="gtk.Alignment.get_padding"><a name="method-gtkalignment--get-padding"></a><h3>gtk.Alignment.get_padding</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_padding</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>a 4-tuple containing the padding set on the
top, bottom, left and right sides of the
widget</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_padding</code>() method returns a
4-tuple containing the padding set on the sides of the widget.</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-gtkadjustment.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gtkarrow.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.Adjustment </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.Arrow</td></tr></table></div></body></html>
|