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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gtk.Frame</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.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="previous" href="class-gtkfontselectiondialog.html" title="gtk.FontSelectionDialog"><link rel="next" href="class-gtkgammacurve.html" title="gtk.GammaCurve"></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.Frame</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkfontselectiondialog.html">Prev</a></td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"><a accesskey="n" href="class-gtkgammacurve.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkframe"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>gtk.Frame</h2><p>gtk.Frame — a bin with a decorative frame and optional
label.</p></div><div class="refsect1" lang="en"><a name="id3426850"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Frame</span></span>(<span class="ooclass"><span class="classname"><a href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a href="class-gtkframe.html#constructor-gtkframe" title="Constructor">gtk.Frame</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>label</tt></b></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkframe.html#method-gtkframe--set-label" title="gtk.Frame.set_label">set_label</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>label</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkframe.html#method-gtkframe--get-label" title="gtk.Frame.get_label">get_label</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkframe.html#method-gtkframe--set-label-widget" title="gtk.Frame.set_label_widget">set_label_widget</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>label_widget</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkframe.html#method-gtkframe--get-label-widget" title="gtk.Frame.get_label_widget">get_label_widget</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkframe.html#method-gtkframe--set-label-align" title="gtk.Frame.set_label_align">set_label_align</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>xalign</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>yalign</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkframe.html#method-gtkframe--get-label-align" title="gtk.Frame.get_label_align">get_label_align</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkframe.html#method-gtkframe--set-shadow-type" title="gtk.Frame.set_shadow_type">set_shadow_type</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>type</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkframe.html#method-gtkframe--get-shadow-type" title="gtk.Frame.get_shadow_type">get_shadow_type</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3427025"></a><h2>Ancestry</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="synopsis">+-- <a href="class-gobject.html" title="gobject.GObject">gobject.GObject</a>
+-- <a href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
+-- <a href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
+-- <a href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
+-- <a href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
+-- <a href="class-gtkframe.html" title="gtk.Frame">gtk.Frame</a>
</pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3427066"></a><h2>Properties</h2><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">"label"</td><td valign="top">Read-Write</td><td valign="top">The text of the frame's label</td></tr><tr valign="top"><td valign="top">"label-xalign"</td><td valign="top">Read-Write</td><td valign="top">The horizontal alignment of the label widget in the
range of 0.0 to 1.0</td></tr><tr valign="top"><td valign="top">"label-yalign"</td><td valign="top">Read-Write</td><td valign="top">The vertical alignment of the decoration within the
label widget height in the range of 0.0 to 1.0</td></tr><tr valign="top"><td valign="top">"shadow-type"</td><td valign="top">Read-Write</td><td valign="top">The style of the frame's border; one of:
<tt class="literal">gtk.SHADOW_NONE</tt>, <tt class="literal">gtk.SHADOW_IN</tt>,
<tt class="literal">gtk.SHADOW_OUT</tt>, <tt class="literal">gtk.SHADOW_ETCHED_IN</tt>,
<tt class="literal">gtk.SHADOW_ETCHED_OUT</tt></td></tr><tr valign="top"><td valign="top">"label-widget"</td><td valign="top">Read-Write</td><td valign="top">The widget to display in place of the usual frame
label.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="id3427204"></a><h2>Description</h2><p>The <a href="class-gtkframe.html" title="gtk.Frame"><tt class="classname">gtk.Frame</tt></a> widget is a
<a href="class-gtkbin.html" title="gtk.Bin"><tt class="classname">gtk.Bin</tt></a> that
surrounds its child with a decorative frame and an optional label. If
present, the label is drawn in a gap in the top side of the frame. The
position of the label can be controlled with <a href="class-gtkframe.html#method-gtkframe--set-label-align" title="gtk.Frame.set_label_align"><tt class="methodname">set_label_align</tt>()</a>.</p></div><div class="refsect1" lang="en"><a name="constructor-gtkframe"></a><h2>Constructor</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.Frame</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>label</tt></b></span><span class="initializer">=None</span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>label</tt></b>:</span></td><td>a string to use as the label text or None if no
label is required.</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a new frame widget</td></tr></tbody></table><p>Creates a new <a href="class-gtkframe.html" title="gtk.Frame"><tt class="classname">gtk.Frame</tt></a> widget with
the label text specified by <i class="parameter"><tt>label</tt></i>. If
<i class="parameter"><tt>label</tt></i> is <tt class="literal">None</tt> no label is
created.</p></div><div class="refsect1" lang="en"><a name="id3427315"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkframe--set-label"></a><h3>gtk.Frame.set_label</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_label</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>label</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>label</tt></b>:</span></td><td>a string to be used as the label
text</td></tr></tbody></table><p>The <tt class="methodname">set_label</tt>() method sets the text of
the label as specified by <i class="parameter"><tt>label</tt></i>. If
<i class="parameter"><tt>label</tt></i> is <tt class="literal">None</tt> the current label is
removed.</p></div><div class="refsect2" lang="en"><a name="method-gtkframe--get-label"></a><h3>gtk.Frame.get_label</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_label</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the text in the label, or
<tt class="literal">None</tt> if there is no label widget or the label widget is
not a <a href="class-gtklabel.html" title="gtk.Label"><tt class="classname">gtk.Label</tt></a>.</td></tr></tbody></table><p>The <tt class="methodname">get_label</tt>() method returns the text
in the label widget. If there is no label widget or the label widget is not
a <a href="class-gtklabel.html" title="gtk.Label"><tt class="classname">gtk.Label</tt></a> the
method returns <tt class="literal">None</tt>.</p></div><div class="refsect2" lang="en"><a name="method-gtkframe--set-label-widget"></a><h3>gtk.Frame.set_label_widget</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_label_widget</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>label_widget</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>label_widget</tt></b>:</span></td><td>the new label widget</td></tr></tbody></table><p>The <tt class="methodname">set_label_widget</tt>() method set the
label widget (usually to something other than a <a href="class-gtklabel.html" title="gtk.Label"><tt class="classname">gtk.Label</tt></a> widget) for
the frame. This widget will appear embedded in the top edge of the frame as
a title.</p></div><div class="refsect2" lang="en"><a name="method-gtkframe--get-label-widget"></a><h3>gtk.Frame.get_label_widget</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_label_widget</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the label widget, or <tt class="literal">None</tt> if
there is no label widget.</td></tr></tbody></table><p>The <tt class="methodname">get_label_widget</tt>() method retrieves
the label widget for the frame. See <a href="class-gtkframe.html#method-gtkframe--set-label-widget" title="gtk.Frame.set_label_widget"><tt class="methodname">set_label_widget</tt>()</a>.</p></div><div class="refsect2" lang="en"><a name="method-gtkframe--set-label-align"></a><h3>gtk.Frame.set_label_align</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_label_align</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>xalign</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>yalign</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>xalign</tt></b>:</span></td><td>the horizontal alignment of the label widget
along the top edge of the frame (in the range of 0.0 to
1.0)</td></tr><tr><td><span class="term"><b class="parameter"><tt>yalign</tt></b>:</span></td><td>the vertical alignment of the decoration with
respect to the label widget (in the range 0.0 to 1.0)</td></tr></tbody></table><p>The <tt class="methodname">set_label_align</tt>() method sets the
alignment of the frame's label widget and decoration (defaults are 0.0 and
0.5) as specified by <i class="parameter"><tt>xalign</tt></i> and
<i class="parameter"><tt>yalign</tt></i>. The <i class="parameter"><tt>xalign</tt></i> value
specifies the fraction of free horizontal space that is allocated to the
left of the label widget. The <i class="parameter"><tt>yalign</tt></i> value specifies
the fraction of label widget height above the decoration.</p></div><div class="refsect2" lang="en"><a name="method-gtkframe--get-label-align"></a><h3>gtk.Frame.get_label_align</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_label_align</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a tuple containing the x and y alignments of
the frame's label widget</td></tr></tbody></table><p>The <tt class="methodname">get_label_align</tt>() method returns a
tuple containing the X and Y alignment of the frame's label widget and
decoration. See the <a href="class-gtkframe.html#method-gtkframe--set-label-align" title="gtk.Frame.set_label_align"><tt class="methodname">set_label_align</tt>()</a>
method.</p></div><div class="refsect2" lang="en"><a name="method-gtkframe--set-shadow-type"></a><h3>gtk.Frame.set_shadow_type</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_shadow_type</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>type</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>type</tt></b>:</span></td><td>a shadow type:
<tt class="literal">gtk.SHADOW_NONE</tt>, <tt class="literal">gtk.SHADOW_IN</tt>,
<tt class="literal">gtk.SHADOW_OUT</tt>, <tt class="literal">gtk.SHADOW_ETCHED_IN</tt>,
<tt class="literal">gtk.SHADOW_ETCHED_OUT</tt></td></tr></tbody></table><p>The <tt class="methodname">set_shadow_type</tt>() method sets the
frame's shadow type to the value of <i class="parameter"><tt>type</tt></i>. The type
must be one of: <tt class="literal">gtk.SHADOW_NONE</tt>,
<tt class="literal">gtk.SHADOW_IN</tt>, <tt class="literal">gtk.SHADOW_OUT</tt>,
<tt class="literal">gtk.SHADOW_ETCHED_IN</tt>,
<tt class="literal">gtk.SHADOW_ETCHED_OUT</tt></p></div><div class="refsect2" lang="en"><a name="method-gtkframe--get-shadow-type"></a><h3>gtk.Frame.get_shadow_type</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_shadow_type</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the current shadow type of the
frame.</td></tr></tbody></table><p>The get_shadow_type() method retrieves the shadow type of the
frame; one of: <tt class="literal">gtk.SHADOW_NONE</tt>,
<tt class="literal">gtk.SHADOW_IN</tt>, <tt class="literal">gtk.SHADOW_OUT</tt>,
<tt class="literal">gtk.SHADOW_ETCHED_IN</tt>,
<tt class="literal">gtk.SHADOW_ETCHED_OUT</tt>. See <a href="class-gtkframe.html#method-gtkframe--set-shadow-type" title="gtk.Frame.set_shadow_type"><tt class="methodname">set_shadow_type</tt>()</a>.</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-gtkfontselectiondialog.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-gtkgammacurve.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.FontSelectionDialog</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">gtk.GammaCurve</td></tr></table></div></body></html>
|
