1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.AspectFrame</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="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkarrow.html" title="gtk.Arrow"><link rel="next" href="class-gtkassistant.html" title="gtk.Assistant"></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.AspectFrame</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkarrow.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkassistant.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkaspectframe"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.AspectFrame</h2><p>gtk.AspectFrame — A frame that constrains its child to a particular aspect
2
ratio.</p></div><div class="refsect1" lang="en"><a name="id3161943"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.AspectFrame</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkframe.html" title="gtk.Frame">gtk.Frame</a></span></span>):
3
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkaspectframe.html#constructor-gtkaspectframe" title="Constructor">gtk.AspectFrame</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>label</code></strong></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>xalign</code></strong></span><span class="initializer">=0.5</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>yalign</code></strong></span><span class="initializer">=0.5</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>ratio</code></strong></span><span class="initializer">=1.0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>obey_child</code></strong></span><span class="initializer">=True</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkaspectframe.html#method-gtkaspectframe--set" title="gtk.AspectFrame.set">set</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>ratio</code></strong></span><span class="initializer">=1.0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>obey_child</code></strong></span><span class="initializer">=True</span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3159598"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.AspectFrame</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="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkarrow.html" title="gtk.Arrow"><link rel="next" href="class-gtkassistant.html" title="gtk.Assistant"></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.AspectFrame</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkarrow.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkassistant.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.AspectFrame"><a name="class-gtkaspectframe"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.AspectFrame</h2><p>gtk.AspectFrame — A frame that constrains its child to a particular aspect
2
ratio.</p></div><div class="refsect1" title="Synopsis"><a name="id3550658"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.AspectFrame</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkframe.html" title="gtk.Frame">gtk.Frame</a></span></span>):
3
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkaspectframe.html#constructor-gtkaspectframe" title="Constructor">gtk.AspectFrame</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>label</code></strong></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>xalign</code></strong></span><span class="initializer">=0.5</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>yalign</code></strong></span><span class="initializer">=0.5</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>ratio</code></strong></span><span class="initializer">=1.0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>obey_child</code></strong></span><span class="initializer">=True</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkaspectframe.html#method-gtkaspectframe--set" title="gtk.AspectFrame.set">set</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>ratio</code></strong></span><span class="initializer">=1.0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>obey_child</code></strong></span><span class="initializer">=True</span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3447803"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
4
4
+-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
5
5
+-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
6
6
+-- <a class="link" href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
7
7
+-- <a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
8
8
+-- <a class="link" href="class-gtkframe.html" title="gtk.Frame">gtk.Frame</a>
9
9
+-- <a class="link" href="class-gtkaspectframe.html" title="gtk.AspectFrame">gtk.AspectFrame</a>
10
</pre></div><div class="refsect1" lang="en"><a name="id3248400"></a><h2>Implemented Interfaces</h2><p>
10
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3387431"></a><h2>Implemented Interfaces</h2><p>
11
11
<a class="link" href="class-gtkaspectframe.html" title="gtk.AspectFrame"><code class="classname">gtk.AspectFrame</code></a>
13
13
<a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
14
</p></div><div class="refsect1" lang="en"><a name="properties-gtkaspectframe"></a><h2>gtk.AspectFrame 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><p><a class="link" href="class-gtkframe.html#properties-gtkframe" title="gtk.Frame Properties">gtk.Frame 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><col><col></colgroup><tbody><tr valign="top"><td valign="top">"obey-child"</td><td valign="top">Read/Write</td><td valign="top">Make aspect ratio match that of the child widget</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
14
</p></div><div class="refsect1" title="gtk.AspectFrame Properties"><a name="properties-gtkaspectframe"></a><h2>gtk.AspectFrame 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><p><a class="link" href="class-gtkframe.html#properties-gtkframe" title="gtk.Frame Properties">gtk.Frame 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="4.5in"></colgroup><tbody><tr valign="top"><td valign="top">"obey-child"</td><td valign="top">Read/Write</td><td valign="top">Make aspect ratio match that of the child widget</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
15
15
to the left of the child. 0.0 means no <span class="emphasis"><em>free</em></span>
16
16
space to the left, 1.0 means all <span class="emphasis"><em>free</em></span> space
17
17
to the left.</td></tr><tr valign="top"><td valign="top">"ratio"</td><td valign="top">Read/Write</td><td valign="top">The aspect ratio of the widget in the range of 0.0001 to
18
18
10000.0 if "obey-child" is <code class="literal">False</code>.</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
19
19
above the child. 0.0 means no <span class="emphasis"><em>free</em></span> space
20
20
above, 1.0 means all <span class="emphasis"><em>free</em></span> space
21
above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="style-properties-gtkaspectframe"></a><h2>gtk.AspectFrame 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" lang="en"><a name="signal-prototypes-gtkaspectframe"></a><h2>gtk.AspectFrame 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" lang="en"><a name="id3195711"></a><h2>Description</h2><p>The <a class="link" href="class-gtkaspectframe.html" title="gtk.AspectFrame"><code class="classname">gtk.AspectFrame</code></a>
21
above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.AspectFrame Style Properties"><a name="style-properties-gtkaspectframe"></a><h2>gtk.AspectFrame 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.AspectFrame Signal Prototypes"><a name="signal-prototypes-gtkaspectframe"></a><h2>gtk.AspectFrame 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="id3471130"></a><h2>Description</h2><p>The <a class="link" href="class-gtkaspectframe.html" title="gtk.AspectFrame"><code class="classname">gtk.AspectFrame</code></a>
22
22
packs a widget so that it can resize but always retains the same aspect
23
23
ratio. For instance, one might be drawing a small preview of a larger image.
24
24
<a class="link" href="class-gtkaspectframe.html" title="gtk.AspectFrame"><code class="classname">gtk.AspectFrame</code></a>
36
36
left of the child) . The default value for both align properties is
37
37
0.5.</p><p>If the "obey-child" property is True (the default value), the
38
38
"ratio" property is ignored and the aspect ratio is set by the child
39
widget.</p></div><div class="refsect1" lang="en"><a name="constructor-gtkaspectframe"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.AspectFrame</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>label</code></strong></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>xalign</code></strong></span><span class="initializer">=0.5</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>yalign</code></strong></span><span class="initializer">=0.5</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>ratio</code></strong></span><span class="initializer">=1.0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>obey_child</code></strong></span><span class="initializer">=True</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>label</code></strong> :</span></p></td><td>a string used to set the aspect frame
39
widget.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtkaspectframe"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.AspectFrame</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>label</code></strong></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>xalign</code></strong></span><span class="initializer">=0.5</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>yalign</code></strong></span><span class="initializer">=0.5</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>ratio</code></strong></span><span class="initializer">=1.0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>obey_child</code></strong></span><span class="initializer">=True</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>label</code></strong> :</span></p></td><td>a string used to set the aspect frame
40
40
label</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>xalign</code></strong> :</span></p></td><td>The fraction of horizontal
41
41
<span class="emphasis"><em>free</em></span> space to the left of the child. 0.0 means no
42
42
<span class="emphasis"><em>free</em></span> space to the left, 1.0 means all
56
56
<em class="parameter"><code>obey_child</code></em> is False, <em class="parameter"><code>ratio</code></em>
57
57
sets the aspect ratio for the child widget. The default value for
58
58
<em class="parameter"><code>ratio</code></em> is 1.0. The default value for
59
<em class="parameter"><code>obey_child</code></em> is True.</p></div><div class="refsect1" lang="en"><a name="id3279355"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkaspectframe--set"></a><h3>gtk.AspectFrame.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 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>ratio</code></strong></span><span class="initializer">=1.0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>obey_child</code></strong></span><span class="initializer">=True</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
59
<em class="parameter"><code>obey_child</code></em> is True.</p></div><div class="refsect1" title="Methods"><a name="id3574153"></a><h2>Methods</h2><div class="refsect2" title="gtk.AspectFrame.set"><a name="method-gtkaspectframe--set"></a><h3>gtk.AspectFrame.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 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>ratio</code></strong></span><span class="initializer">=1.0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>obey_child</code></strong></span><span class="initializer">=True</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
60
60
<span class="emphasis"><em>free</em></span> space to the left of the child. 0.0 means no
61
61
<span class="emphasis"><em>free</em></span> space to the left, 1.0 means all
62
62
<span class="emphasis"><em>free</em></span> space to the left.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>yalign</code></strong> :</span></p></td><td>The fraction of vertical
added
removed
docs/html/class-gtkaspectframe.html
