summaryrefslogtreecommitdiff
path: root/docs/reference/pygtk-gtkvbuttonbox.xml
blob: 053e3b11ee2e51255c5fff93bf223a208e38a41c (plain)
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-gtkvbuttonbox">
  <refnamediv>
    <refname>gtk.VButtonBox</refname>
    <refpurpose>a container for arranging buttons vertically.</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.VButtonBox</classname></ooclass>
      <ooclass><classname><link
linkend="class-gtkbuttonbox">gtk.ButtonBox</link></classname></ooclass>
      <constructorsynopsis language="python">
	<methodname><link
linkend="constructor-gtkvbuttonbox">gtk.VButtonBox</link></methodname>
	<methodparam></methodparam>  </constructorsynopsis>
    </classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtkobject">gtk.Object</link>
    +-- <link linkend="class-gtkwidget">gtk.Widget</link>
      +-- <link linkend="class-gtkcontainer">gtk.Container</link>
        +-- <link linkend="class-gtkbox">gtk.Box</link>
          +-- <link linkend="class-gtkbuttonbox">gtk.ButtonBox</link>
            +-- <link linkend="class-gtkvbuttonbox">gtk.VButtonBox</link>
</synopsis>

  </refsect1>
  
  <refsect1>
		<title>Implemented Interfaces</title>
		<para>
			<link linkend="class-gtkvbuttonbox"><classname>gtk.VButtonBox</classname></link>
			implements 
			<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
		</para>
	</refsect1>

  <refsect1 id="properties-gtkvbuttonbox">
    <title>gtk.VButtonBox Properties</title>

    <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
    <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
    <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
    <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>
    <para><link linkend="properties-gtkbuttonbox">gtk.ButtonBox Properties</link></para>

  </refsect1>

  <refsect1 id="style-properties-gtkvbuttonbox">
    <title>gtk.VButtonBox Style Properties</title>

    <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
    <para><link linkend="style-properties-gtkbuttonbox">gtk.ButtonBox Style Properties</link></para>

  </refsect1>

  <refsect1 id="child-properties-gtkvbuttonbox">
    <title>gtk.VButtonBox Child Properties</title>

    <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>
    <para><link linkend="child-properties-gtkbuttonbox">gtk.ButtonBox Child Properties</link></para>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkvbuttonbox">
    <title>gtk.VButtonBox Signal Prototypes</title>

    <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
  </refsect1>

  <refsect1>
    <title>Description</title>

    <para>A <link
linkend="class-gtkvbuttonbox"><classname>gtk.VButtonBox</classname></link>
is a container subclassed from <link
linkend="class-gtkbuttonbox"><classname>gtk.ButtonBox</classname></link>
that is optimized for the vertical layout of buttons. The <link
linkend="class-gtkvbuttonbox"><classname>gtk.VButtonBox</classname></link>
helps provide a consistent layout of buttons in an application by supplying
default values of spacing, padding and layout style (see the <link
linkend="class-gtkbuttonbox"><classname>gtk.ButtonBox</classname></link>
reference for more detail). Buttons are packed into a <link
linkend="class-gtkvbuttonbox"><classname>gtk.VButtonBox</classname></link>
using the <link
linkend="method-gtkcontainer--add"><methodname>gtk.Container.add</methodname>()</link>)
method. The <link
linkend="method-gtkbox--pack-start"><methodname>pack_start</methodname>()</link>
and <link
linkend="method-gtkbox--pack-end"><methodname>pack_end</methodname>()</link>
methods can also be used but they work just like the <link
linkend="method-gtkcontainer--add"><methodname>gtk.Container.add</methodname>()</link>)
method i.e. they pack the button in a way that depends on the current layout
style and on whether the button has had the <link
linkend="method-gtkbuttonbox--set-child-secondary"><methodname>gtk.ButtonBox.set_child_secondary</methodname>()</link>
method called on it. The spacing between buttons can be set with the <link
linkend="method-gtkbox--set-spacing"><methodname>gtk.Box.set_spacing</methodname>()</link>
method. The arrangement and layout of the buttons can be changed with the
<link
linkend="method-gtkbuttonbox--set-layout"><methodname>gtk.ButtonBox.set_layout</methodname>()</link>
method.</para>

  </refsect1>

  <refsect1 id="constructor-gtkvbuttonbox">
    <title>Constructor</title>

    <programlisting><constructorsynopsis language="python">
	<methodname>gtk.VButtonBox</methodname>
	<methodparam></methodparam>  </constructorsynopsis></programlisting>
    <variablelist>
      <varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	<listitem><simpara>a new <link
linkend="class-gtkvbuttonbox"><classname>gtk.VButtonBox</classname></link>
widget</simpara></listitem>
      </varlistentry>
    </variablelist>

    <para>Creates a new <link
linkend="class-gtkvbuttonbox"><classname>gtk.VButtonBox</classname></link>
widget</para>

  </refsect1>

</refentry>