/usr/share/gtk-doc/html/pygtk/class-gtkframe.html is in python-gtk2-doc 2.24.0-3.
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 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Frame</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-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" title="gtk.Frame"><a name="class-gtkframe"></a><div class="titlepage"></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" title="Synopsis"><a name="id3721577"></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 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-gtkframe.html#constructor-gtkframe" title="Constructor">gtk.Frame</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>label</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkframe.html#method-gtkframe--set-label" title="gtk.Frame.set_label">set_label</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>label</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" 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 class="link" 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"><strong class="parameter"><code>label_widget</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" 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 class="link" 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"><strong class="parameter"><code>xalign</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>yalign</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" 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 class="link" 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"><strong class="parameter"><code>type</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" 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" title="Ancestry"><a name="id3721840"></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-gtkframe.html" title="gtk.Frame">gtk.Frame</a>
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3721890"></a><h2>Implemented Interfaces</h2><p>
<a class="link" href="class-gtkframe.html" title="gtk.Frame"><code class="classname">gtk.Frame</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.Frame Properties"><a name="properties-gtkframe"></a><h2>gtk.Frame 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="4in"></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-widget"</td><td valign="top">Read-Write</td><td valign="top">The widget to display in place of the usual frame
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:
<code class="literal">gtk.SHADOW_NONE</code>, <code class="literal">gtk.SHADOW_IN</code>,
<code class="literal">gtk.SHADOW_OUT</code>, <code class="literal">gtk.SHADOW_ETCHED_IN</code>,
<code class="literal">gtk.SHADOW_ETCHED_OUT</code></td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.Frame Style Properties"><a name="style-properties-gtkframe"></a><h2>gtk.Frame 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.Frame Signal Prototypes"><a name="signal-prototypes-gtkframe"></a><h2>gtk.Frame 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="id3722176"></a><h2>Description</h2><p>The <a class="link" href="class-gtkframe.html" title="gtk.Frame"><code class="classname">gtk.Frame</code></a> widget is a
<a class="link" href="class-gtkbin.html" title="gtk.Bin"><code class="classname">gtk.Bin</code></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 class="link" href="class-gtkframe.html#method-gtkframe--set-label-align" title="gtk.Frame.set_label_align"><code class="methodname">set_label_align</code>()</a>.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtkframe"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.Frame</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>label</code></strong></span><span class="initializer">=None</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 to use as the label text or None if no
label is required.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new frame widget</td></tr></tbody></table><p>Creates a new <a class="link" href="class-gtkframe.html" title="gtk.Frame"><code class="classname">gtk.Frame</code></a> widget with
the label text specified by <em class="parameter"><code>label</code></em>. If
<em class="parameter"><code>label</code></em> is <code class="literal">None</code> no label is
created.</p></div><div class="refsect1" title="Methods"><a name="id3722323"></a><h2>Methods</h2><div class="refsect2" title="gtk.Frame.set_label"><a name="method-gtkframe--set-label"></a><h3>gtk.Frame.set_label</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_label</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>label</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>label</code></strong> :</span></p></td><td>a string to be used as the label
text</td></tr></tbody></table><p>The <code class="methodname">set_label</code>() method sets the text of
the label as specified by <em class="parameter"><code>label</code></em>. If
<em class="parameter"><code>label</code></em> is <code class="literal">None</code> the current label is
removed.</p></div><div class="refsect2" title="gtk.Frame.get_label"><a name="method-gtkframe--get-label"></a><h3>gtk.Frame.get_label</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_label</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>the text in the label, or
<code class="literal">None</code> if there is no label widget or the label widget is
not a <a class="link" href="class-gtklabel.html" title="gtk.Label"><code class="classname">gtk.Label</code></a>.</td></tr></tbody></table><p>The <code class="methodname">get_label</code>() method returns the text
in the label widget. If there is no label widget or the label widget is not
a <a class="link" href="class-gtklabel.html" title="gtk.Label"><code class="classname">gtk.Label</code></a> the
method returns <code class="literal">None</code>.</p></div><div class="refsect2" title="gtk.Frame.set_label_widget"><a name="method-gtkframe--set-label-widget"></a><h3>gtk.Frame.set_label_widget</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_label_widget</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>label_widget</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>label_widget</code></strong> :</span></p></td><td>the new label widget</td></tr></tbody></table><p>The <code class="methodname">set_label_widget</code>() method set the
label widget (usually to something other than a <a class="link" href="class-gtklabel.html" title="gtk.Label"><code class="classname">gtk.Label</code></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" title="gtk.Frame.get_label_widget"><a name="method-gtkframe--get-label-widget"></a><h3>gtk.Frame.get_label_widget</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_label_widget</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>the label widget, or <code class="literal">None</code> if
there is no label widget.</td></tr></tbody></table><p>The <code class="methodname">get_label_widget</code>() method retrieves
the label widget for the frame. See <a class="link" href="class-gtkframe.html#method-gtkframe--set-label-widget" title="gtk.Frame.set_label_widget"><code class="methodname">set_label_widget</code>()</a>.</p></div><div class="refsect2" title="gtk.Frame.set_label_align"><a name="method-gtkframe--set-label-align"></a><h3>gtk.Frame.set_label_align</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_label_align</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>)</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 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><p><span class="term"><strong class="parameter"><code>yalign</code></strong> :</span></p></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 <code class="methodname">set_label_align</code>() method sets the
alignment of the frame's label widget and decoration (defaults are 0.0 and
0.5) as specified by <em class="parameter"><code>xalign</code></em> and
<em class="parameter"><code>yalign</code></em>. The <em class="parameter"><code>xalign</code></em> value
specifies the fraction of free horizontal space that is allocated to the
left of the label widget. The <em class="parameter"><code>yalign</code></em> value specifies
the fraction of label widget height above the decoration.</p></div><div class="refsect2" title="gtk.Frame.get_label_align"><a name="method-gtkframe--get-label-align"></a><h3>gtk.Frame.get_label_align</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_label_align</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 tuple containing the x and y alignments of
the frame's label widget</td></tr></tbody></table><p>The <code class="methodname">get_label_align</code>() method returns a
tuple containing the X and Y alignment of the frame's label widget and
decoration. See the <a class="link" href="class-gtkframe.html#method-gtkframe--set-label-align" title="gtk.Frame.set_label_align"><code class="methodname">set_label_align</code>()</a>
method.</p></div><div class="refsect2" title="gtk.Frame.set_shadow_type"><a name="method-gtkframe--set-shadow-type"></a><h3>gtk.Frame.set_shadow_type</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_shadow_type</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>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>type</code></strong> :</span></p></td><td>a shadow type:
<code class="literal">gtk.SHADOW_NONE</code>, <code class="literal">gtk.SHADOW_IN</code>,
<code class="literal">gtk.SHADOW_OUT</code>, <code class="literal">gtk.SHADOW_ETCHED_IN</code>,
<code class="literal">gtk.SHADOW_ETCHED_OUT</code></td></tr></tbody></table><p>The <code class="methodname">set_shadow_type</code>() method sets the
frame's shadow type to the value of <em class="parameter"><code>type</code></em>. The type
must be one of: <code class="literal">gtk.SHADOW_NONE</code>,
<code class="literal">gtk.SHADOW_IN</code>, <code class="literal">gtk.SHADOW_OUT</code>,
<code class="literal">gtk.SHADOW_ETCHED_IN</code>,
<code class="literal">gtk.SHADOW_ETCHED_OUT</code></p></div><div class="refsect2" title="gtk.Frame.get_shadow_type"><a name="method-gtkframe--get-shadow-type"></a><h3>gtk.Frame.get_shadow_type</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_shadow_type</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>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: <code class="literal">gtk.SHADOW_NONE</code>,
<code class="literal">gtk.SHADOW_IN</code>, <code class="literal">gtk.SHADOW_OUT</code>,
<code class="literal">gtk.SHADOW_ETCHED_IN</code>,
<code class="literal">gtk.SHADOW_ETCHED_OUT</code>. See <a class="link" href="class-gtkframe.html#method-gtkframe--set-shadow-type" title="gtk.Frame.set_shadow_type"><code class="methodname">set_shadow_type</code>()</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>
|