summaryrefslogtreecommitdiff
path: root/docs/reference/pygtk-gtkmenubar.xml
blob: 03880f7051cb33eff0ac04f8ece8d50ae3c2c6a3 (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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
<?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-gtkmenubar">
  <refnamediv>
    <refname>gtk.MenuBar</refname>
    <refpurpose>a widget that displays <link
linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
widgets horizontally</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.MenuBar</classname></ooclass>
      <ooclass><classname><link
linkend="class-gtkmenushell">gtk.MenuShell</link></classname></ooclass>
      <constructorsynopsis language="python">
	<methodname><link
linkend="constructor-gtkmenubar">gtk.MenuBar</link></methodname>
	<methodparam></methodparam>  </constructorsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkmenubar--set-pack-direction">set_pack_direction</link></methodname>
	<methodparam><parameter
		       role="keyword">pack_dir</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkmenubar--get-pack-direction">get_pack_direction</link></methodname>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkmenubar--set-child-pack-direction">set_child_pack_direction</link></methodname>
	<methodparam><parameter
		       role="keyword">child_pack_dir</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkmenubar--get-child-pack-direction">get_child_pack_direction</link></methodname>
      </methodsynopsis>
    </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-gtkmenushell">gtk.MenuShell</link>
          +-- <link linkend="class-gtkmenubar">gtk.MenuBar</link>
</synopsis>

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


  <refsect1 id="properties-gtkmenubar">
    <title>gtk.MenuBar 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-gtkmenushell">gtk.MenuShell Properties</link></para>

    <blockquote role="properties">
      <informaltable pgwide="1" frame="none">
	<tgroup cols="3">
	  <colspec column="1" colwidth="1in"/>
	  <colspec column="2" colwidth="1in"/>
	  <colspec column="3" colwidth="4in"/>
	  <tbody>

	    <row valign="top">
	      <entry>"child-pack-direction"</entry>
	      <entry>Read-Write</entry>
	      <entry>The pack direction of the menubar. It determines how
the widgets contained in child menuitems are arranged.
Default value: <literal>gtk.PACK_DIRECTION_LTR</literal>.
Available in GTK+ 2.8 and above.</entry>
	    </row>

	    <row valign="top">
	      <entry>"pack-direction"</entry>
	      <entry>Read-Write</entry>
	      <entry>The pack direction of the menubar. It determines how
menuitems are arranged in the menubar.
Default value: <literal>gtk.PACK_DIRECTION_LTR</literal>.
Available in GTK+ 2.8 and above.</entry>
	    </row>

	  </tbody>
	</tgroup>
      </informaltable>
    </blockquote>

  </refsect1>

  <refsect1 id="style-properties-gtkmenubar">
    <title>gtk.MenuBar Style Properties</title>

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

    <blockquote role="properties">
      <informaltable pgwide="1" frame="none">
	<tgroup cols="3">
	  <colspec column="1" colwidth="1in"/>
	  <colspec column="2" colwidth="1in"/>
	  <colspec column="3" colwidth="4in"/>
	  <tbody>

	    <row valign="top">
	      <entry>"internal-padding"</entry>
	      <entry>Read</entry>
	      <entry>Amount of border space between the menubar shadow and
the menu items</entry>
	    </row>

	    <row valign="top">
	      <entry>"shadow-type"</entry>
	      <entry>Read</entry>
	      <entry>The style of bevel around the menubar</entry>
	    </row>

	  </tbody>
	</tgroup>
      </informaltable>
    </blockquote>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkmenubar">
    <title>gtk.MenuBar 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>
    <para><link linkend="signal-prototypes-gtkmenushell">gtk.MenuShell Signal Prototypes</link></para>
  </refsect1>

  <refsect1>
    <title>Description</title>

    <para>The <link
linkend="class-gtkmenubar"><classname>gtk.MenuBar</classname></link> is a
subclass of <link
linkend="class-gtkmenushell"><classname>gtk.MenuShell</classname></link>
which contains one or more <link
linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
widgets. A <link
linkend="class-gtkmenubar"><classname>gtk.MenuBar</classname></link>
displays the menu items horizontally in an application window or
dialog.</para>

  </refsect1>

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

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

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

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtkmenubar--set-pack-direction">
      <title>gtk.MenuBar.set_pack_direction</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_pack_direction</methodname>
	  <methodparam><parameter
			 role="keyword">pack_dir</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">pack_dir</parameter>&nbsp;:</term>
	  <listitem><simpara>one of the <xref 
linkend="gtk-pack-direction-constants" 
endterm="gtk-pack-direction-constants-title"></xref>.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.8 and above.</para>
      </note>

      <para>The <methodname>set_pack_direction</methodname>() sets the
"pack-direction" property to the value of
<parameter>pack_dir</parameter>. <parameter>pack_dir</parameter> must be one
of the <xref linkend="gtk-pack-direction-constants"
endterm="gtk-pack-direction-constants-title"></xref> that specify how
menuitems are arranged in the menubar.</para>

    </refsect2>

    <refsect2 id="method-gtkmenubar--get-pack-direction">
      <title>gtk.MenuBar.get_pack_direction</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_pack_direction</methodname>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the current pack direction of the
menubar.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.8 and above.</para>
      </note>

      <para>The <methodname>get_pack_direction</methodname>() method returns
the value of the "pack-direction" property that specifies the arrangement
of menuitems in the menubar. See the <xref
linkend="gtk-pack-direction-constants"
endterm="gtk-pack-direction-constants-title"></xref> for more
information.</para>

    </refsect2>

    <refsect2 id="method-gtkmenubar--set-child-pack-direction">
      <title>gtk.MenuBar.set_child_pack_direction</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_child_pack_direction</methodname>
	  <methodparam><parameter
			 role="keyword">child_pack_dir</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">child_pack_dir</parameter>&nbsp;:</term>
	  <listitem><simpara>one of the <xref 
linkend="gtk-pack-direction-constants"
endterm="gtk-pack-direction-constants-title"></xref>.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.8 and above.</para>
      </note>

      <para>The <methodname>set_child_pack_direction</methodname>() method
sets the "child-pack-direction" property to the value of
<parameter>child_pack_dir</parameter>. <parameter>child_pack_dir</parameter>
must be one of the <xref linkend="gtk-pack-direction-constants"
endterm="gtk-pack-direction-constants-title"></xref> that specify how
menuitems are arranged in the child menuitems of the menubar.</para>

    </refsect2>

    <refsect2 id="method-gtkmenubar--get-child-pack-direction">
      <title>gtk.MenuBar.get_child_pack_direction</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_child_pack_direction</methodname>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the current child pack
direction</simpara></listitem>
	</varlistentry>
      </variablelist>

       <note>
        <para>This method is available in PyGTK 2.8 and above.</para>
      </note>

     <para>The <methodname>get_child_pack_direction</methodname>() method
returns the value of the "child-pack-direction" property that specifies the
arrangement of menuitems in thechild menuitems of the menubar. See the <xref
linkend="gtk-pack-direction-constants"
endterm="gtk-pack-direction-constants-title"></xref> for more
information.</para>

    </refsect2>

  </refsect1>

</refentry>