/usr/share/gtk-doc/html/pygtk/class-gtkbuttonbox.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 61 62 63 64 65 66 67 68 69 70 71 72 73 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.ButtonBox</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-gtkbutton.html" title="gtk.Button"><link rel="next" href="class-gtkcalendar.html" title="gtk.Calendar"></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.ButtonBox</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkbutton.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkcalendar.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.ButtonBox"><a name="class-gtkbuttonbox"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.ButtonBox</h2><p>gtk.ButtonBox — the base class for widgets that contain multiple
buttons</p></div><div class="refsect1" title="Synopsis"><a name="id3621500"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.ButtonBox</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkbox.html" title="gtk.Box">gtk.Box</a></span></span>):
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkbuttonbox.html#method-gtkbuttonbox--get-layout" title="gtk.ButtonBox.get_layout">get_layout</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkbuttonbox.html#method-gtkbuttonbox--set-layout" title="gtk.ButtonBox.set_layout">set_layout</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>layout_style</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkbuttonbox.html#method-gtkbuttonbox--get-child-secondary" title="gtk.ButtonBox.get_child_secondary">get_child_secondary</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkbuttonbox.html#method-gtkbuttonbox--set-child-secondary" title="gtk.ButtonBox.set_child_secondary">set_child_secondary</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>is_secondary</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3621627"></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-gtkbox.html" title="gtk.Box">gtk.Box</a>
+-- <a class="link" href="class-gtkbuttonbox.html" title="gtk.ButtonBox">gtk.ButtonBox</a>
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3621670"></a><h2>Implemented Interfaces</h2><p>
<a class="link" href="class-gtkbuttonbox.html" title="gtk.ButtonBox"><code class="classname">gtk.ButtonBox</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.ButtonBox Properties"><a name="properties-gtkbuttonbox"></a><h2>gtk.ButtonBox 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-gtkbox.html#properties-gtkbox" title="gtk.Box Properties">gtk.Box 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">"layout-style"</td><td valign="top">Read/Write</td><td valign="top">the style used to layout the buttons in the box. The layout
styles are: <code class="literal">gtk.BUTTONBOX_SPREAD</code>,
<code class="literal">gtk.BUTTONBOX_EDGE</code>,
<code class="literal">gtk.BUTTONBOX_START</code> and
<code class="literal">gtk.BUTTONBOX_END</code>.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.ButtonBox Style Properties"><a name="style-properties-gtkbuttonbox"></a><h2>gtk.ButtonBox 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 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">"child-internal-pad-x"</td><td valign="top">Read</td><td valign="top">The amount of padding that increases a child's size on
the top and bottom</td></tr><tr valign="top"><td valign="top">"child-internal-pad-y"</td><td valign="top">Read</td><td valign="top">The amount of padding that increases a child's size on
the top and bottom</td></tr><tr valign="top"><td valign="top">"child-min-height"</td><td valign="top">Read</td><td valign="top">The minimum height of buttons inside the box.</td></tr><tr valign="top"><td valign="top">"child-min-width"</td><td valign="top">Read</td><td valign="top">The minimum width of buttons inside the box.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.ButtonBox Child Properties"><a name="child-properties-gtkbuttonbox"></a><h2>gtk.ButtonBox Child Properties</h2><p><a class="link" href="class-gtkbox.html#child-properties-gtkbox" title="gtk.Box Child Properties">gtk.Box Child 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">"secondary"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code>, the child appears in a secondary
group of children, suitable for, e.g., help buttons.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.ButtonBox Signal Prototypes"><a name="signal-prototypes-gtkbuttonbox"></a><h2>gtk.ButtonBox 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="id3622028"></a><h2>Description</h2><p>A button box is used to provide a consistent layout of buttons
throughout an application. The <a class="link" href="class-gtkbuttonbox.html" title="gtk.ButtonBox"><code class="classname">gtk.ButtonBox</code></a> is
subclassed by the <a class="link" href="class-gtkhbuttonbox.html" title="gtk.HButtonBox"><code class="classname">gtk.HButtonBox</code></a>
and <a class="link" href="class-gtkvbuttonbox.html" title="gtk.VButtonBox"><code class="classname">gtk.VButtonBox</code></a>
classes to provide horizontal and vertical button layouts respectively. The
same effect could be achieved by using a <a class="link" href="class-gtkvbuttonbox.html" title="gtk.VButtonBox"><code class="classname">gtk.Box</code></a> but less
conveniently.</p><p>A buttonbox provides one default layout and a default spacing
value that are persistent across all widgets. The layout/spacing can then be
altered by the programmer, or if desired, by the user to alter the 'feel' of
a program to a small degree.</p><p>The <a class="link" href="class-gtkbox.html#method-gtkbox--get-spacing" title="gtk.Box.get_spacing"><code class="methodname">gtk.Box.get_spacing</code>()</a>
method and the <a class="link" href="class-gtkbox.html#method-gtkbox--set-spacing" title="gtk.Box.set_spacing"><code class="methodname">gtk.Box.set_spacing</code>()</a>
methods retrieve and change the default number of pixels between buttons.
The <a class="link" href="class-gtkbuttonbox.html#method-gtkbuttonbox--get-layout" title="gtk.ButtonBox.get_layout"><code class="methodname">get_layout</code>()</a>
and <a class="link" href="class-gtkbuttonbox.html#method-gtkbuttonbox--set-layout" title="gtk.ButtonBox.set_layout"><code class="methodname">set_layout</code>()</a>
methods retrieve and alter the style used to spread the buttons in a button
box across the container. The layout styles are:
<code class="literal">gtk.BUTTONBOX_SPREAD</code>,
<code class="literal">gtk.BUTTONBOX_EDGE</code>,
<code class="literal">gtk.BUTTONBOX_START</code> and
<code class="literal">gtk.BUTTONBOX_END</code>.</p></div><div class="refsect1" title="Methods"><a name="id3622131"></a><h2>Methods</h2><div class="refsect2" title="gtk.ButtonBox.get_layout"><a name="method-gtkbuttonbox--get-layout"></a><h3>gtk.ButtonBox.get_layout</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_layout</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 layout style used by the
buttonbox</td></tr></tbody></table><p>The <code class="methodname">get_layout</code>() method returns the
current value of the "layout-style" property. The possible values are:
<code class="literal">gtk.BUTTONBOX_SPREAD</code>,
<code class="literal">gtk.BUTTONBOX_EDGE</code>,
<code class="literal">gtk.BUTTONBOX_START</code> and
<code class="literal">gtk.BUTTONBOX_END</code>.</p></div><div class="refsect2" title="gtk.ButtonBox.set_layout"><a name="method-gtkbuttonbox--set-layout"></a><h3>gtk.ButtonBox.set_layout</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_layout</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>layout_style</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>layout_style</code></strong> :</span></p></td><td>the new layout style</td></tr></tbody></table><p>The <code class="methodname">set_layout</code>() method sets the
"layout-style" property to the value in <em class="parameter"><code>layout_style</code></em>.
The possible values are: <code class="literal">gtk.BUTTONBOX_SPREAD</code>,
<code class="literal">gtk.BUTTONBOX_EDGE</code>,
<code class="literal">gtk.BUTTONBOX_START</code> and
<code class="literal">gtk.BUTTONBOX_END</code>.</p></div><div class="refsect2" title="gtk.ButtonBox.get_child_secondary"><a name="method-gtkbuttonbox--get-child-secondary"></a><h3>gtk.ButtonBox.get_child_secondary</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_child_secondary</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</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>child</code></strong> :</span></p></td><td>a child button of the
buttonbox</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>if <code class="literal">True</code>, the
<em class="parameter"><code>child</code></em> appears in a secondary group of the button
box.</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_child_secondary</code>() method
returns <code class="literal">True</code> if <em class="parameter"><code>child</code></em> should
appear in a secondary group of children. See the <a class="link" href="class-gtkbuttonbox.html#method-gtkbuttonbox--set-child-secondary" title="gtk.ButtonBox.set_child_secondary"><code class="methodname">set_child_secondary</code>()</a>
method for more information.</p></div><div class="refsect2" title="gtk.ButtonBox.set_child_secondary"><a name="method-gtkbuttonbox--set-child-secondary"></a><h3>gtk.ButtonBox.set_child_secondary</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_child_secondary</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>is_secondary</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>child</code></strong> :</span></p></td><td>a child button of the
buttonbox</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>is_secondary</code></strong> :</span></p></td><td>if <code class="literal">True</code>, the
<em class="parameter"><code>child</code></em> appears in a secondary group of the button
box.</td></tr></tbody></table><p>The <code class="methodname">set_child_secondary</code>() method sets
whether <em class="parameter"><code>child</code></em> should appear in a secondary group of
children. The typical use of a secondary child is the help button in a
dialog that is displayed away from the main group of buttons e.g. right
aligned.</p><p>The secondary group appears after the other children if the
style is <code class="literal">gtk.BUTTONBOX_START</code>,
<code class="literal">gtk.BUTTONBOX_SPREAD</code> or
<code class="literal">gtk.BUTTONBOX_EDGE</code>, and before the the other children if
the style is <code class="literal">gtk.BUTTONBOX_END</code>. For horizontal button
boxes, the definition of before/after depends on direction of the widget
(see <a class="link" href="class-gtkwidget.html#method-gtkwidget--set-direction" title="gtk.Widget.set_direction"><code class="function">gtk.Widget.set_direction()</code></a>).
If the style is <code class="literal">gtk.BUTTONBOX_START</code> or
<code class="literal">gtk.BUTTONBOX_END</code>, then the secondary children are
aligned at the other end of the button box from the main children. For the
other styles, they appear immediately next to the main children.</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-gtkbutton.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-gtkcalendar.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.Button </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.Calendar</td></tr></table></div></body></html>
|