summaryrefslogtreecommitdiff
path: root/docs/reference/pygtk-gtkhbox.xml
blob: 9be497bb8dc48986dedeb196052c1bb1081fd594 (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
<?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-gtkhbox">
  <refnamediv>
    <refname>gtk.HBox</refname>
    <refpurpose>a horizontal container box</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.HBox</classname></ooclass>
      <ooclass><classname><link
linkend="class-gtkbox">gtk.Box</link></classname></ooclass>
      <constructorsynopsis language="python">
	<methodname><link
linkend="constructor-gtkhbox">gtk.HBox</link></methodname>
	<methodparam><parameter
		       role="keyword">homogeneous</parameter><initializer>False</initializer></methodparam>
	<methodparam><parameter
		       role="keyword">spacing</parameter><initializer>0</initializer></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-gtkhbox">gtk.HBox</link>
</synopsis>

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


  <refsect1 id="properties-gtkhbox">
    <title>gtk.HBox 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>

  </refsect1>

  <refsect1 id="style-properties-gtkhbox">
    <title>gtk.HBox Style Properties</title>

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

  </refsect1>

  <refsect1 id="child-properties-gtkhbox">
    <title>gtk.HBox Child Properties</title>

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

  </refsect1>

  <refsect1 id="signal-prototypes-gtkhbox">
    <title>gtk.HBox 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>The <link
linkend="class-gtkhbox"><classname>gtk.HBox</classname></link> is a
container subclassed from <link
linkend="class-gtkbox"><classname>gtk.Box</classname></link> that organizes
its child widgets into a single horizontal row. The <link
linkend="class-gtkbox"><classname>gtk.Box</classname></link> methods are
used to manage the order, spacing, width and alignment of the child widgets
though all widgets are allocated the same height.</para>

  </refsect1>

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

    <programlisting><constructorsynopsis language="python">
	<methodname>gtk.HBox</methodname>
	<methodparam><parameter
		       role="keyword">homogeneous</parameter><initializer>False</initializer></methodparam>
	<methodparam><parameter
		       role="keyword">spacing</parameter><initializer>0</initializer></methodparam>
      </constructorsynopsis></programlisting>
    <variablelist>
      <varlistentry>
	<term><parameter
role="keyword">homogeneous</parameter>&nbsp;:</term>
	<listitem><simpara>If <literal>True</literal> all children are given
equal space allocations.</simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><parameter role="keyword">spacing</parameter>&nbsp;:</term>
	<listitem><simpara>The additional horizontal space between children
in pixels</simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	<listitem><simpara>a new hbox widget</simpara></listitem>
      </varlistentry>
    </variablelist>

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

  </refsect1>

</refentry>