blob: a82ea5e89e282c1865d089deba7e1924f2fc3c8d (
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
|
<?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-gtkimagemenuitem">
<refnamediv>
<refname>gtk.ImageMenuItem</refname>
<refpurpose>a menuitem that displays an image with an accel
label</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.ImageMenuItem</classname></ooclass>
<ooclass><classname><link
linkend="class-gtkmenuitem">gtk.MenuItem</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link
linkend="constructor-gtkimagemenuitem">gtk.ImageMenuItem</link></methodname>
<methodparam><parameter
role="keyword">stock_id</parameter><initializer>None</initializer></methodparam>
<methodparam><parameter
role="keyword">accel_group</parameter><initializer>None</initializer></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkimagemenuitem--set-image">set_image</link></methodname>
<methodparam><parameter
role="keyword">image</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkimagemenuitem--get-image">get_image</link></methodname>
<methodparam></methodparam> </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-gtkbin">gtk.Bin</link>
+-- <link linkend="class-gtkitem">gtk.Item</link>
+-- <link linkend="class-gtkmenuitem">gtk.MenuItem</link>
+-- <link linkend="class-gtkimagemenuitem">gtk.ImageMenuItem</link>
</synopsis>
</refsect1>
<refsect1 id="properties-gtkimagemenuitem">
<title>gtk.ImageMenuItem 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>
<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>"image"</entry>
<entry>Read-Write</entry>
<entry>the child widget that is next to the text in the menu
item</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="style-properties-gtkimagemenuitem">
<title>gtk.ImageMenuItem Style Properties</title>
<para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
<para><link linkend="style-properties-gtkmenuitem">gtk.MenuItem Style Properties</link></para>
</refsect1>
<refsect1 id="signal-prototypes-gtkimagemenuitem">
<title>gtk.ImageMenuItem 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-gtkitem">gtk.Item Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkmenuitem">gtk.MenuItem Signal Prototypes</link></para>
</refsect1>
<refsect1>
<title>Description</title>
<para>The <link
linkend="class-gtkimagemenuitem"><classname>gtk.ImageMenuItem</classname></link>
widget is a subclass of <link
linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> that
contains an image widget and a <link
linkend="class-gtkaccellabel"><classname>gtk.AccelLabel</classname></link>
though a <link
linkend="class-gtkimagemenuitem"><classname>gtk.ImageMenuItem</classname></link>
can be created that has no image and an empty label.</para>
</refsect1>
<refsect1 id="constructor-gtkimagemenuitem">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.ImageMenuItem</methodname>
<methodparam><parameter
role="keyword">stock_id</parameter><initializer>None</initializer></methodparam>
<methodparam><parameter
role="keyword">accel_group</parameter><initializer>None</initializer></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">stock_id</parameter> :</term>
<listitem><simpara>the stock icon ID or <literal>None</literal> if
no image is needed</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter
role="keyword">accel_group</parameter> :</term>
<listitem><simpara>the accel group to add the accel label mnemonic
to</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link
linkend="class-gtkimagemenuitem"><classname>gtk.ImageMenuItem</classname></link>
widget</simpara></listitem>
</varlistentry>
</variablelist>
<para>Creates a new <link
linkend="class-gtkimagemenuitem"><classname>gtk.ImageMenuItem</classname></link>
with a stock label and image specified by <parameter>stock_id</parameter>.
If <parameter>stock_id</parameter> is not a stock item then the image will
be the "broken image" and the label text will be the string in
<parameter>stock_id</parameter>. The label text will be parsed for
underscore characters to indicate the mnemonic character for the
accelerator.</para>
<para>If <parameter>stock_id</parameter> specifies a stock item and
<parameter>accel_group</parameter> specifies a <link
linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
the accelerator is added to <parameter>accel_group</parameter>.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkimagemenuitem--set-image">
<title>gtk.ImageMenuItem.set_image</title>
<programlisting><methodsynopsis language="python">
<methodname>set_image</methodname>
<methodparam><parameter
role="keyword">image</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">image</parameter> :</term>
<listitem><simpara>a widget to set as the image for the menu
item.</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_image</methodname>() method sets the image
of the image menu item to the widget specified in
<parameter>image</parameter>.</para>
</refsect2>
<refsect2 id="method-gtkimagemenuitem--get-image">
<title>gtk.ImageMenuItem.get_image</title>
<programlisting><methodsynopsis language="python">
<methodname>get_image</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the image in the image menu
item</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_image</methodname>() method gets the widget
that is currently set as the image of image menu item. See <link
linkend="method-gtkimagemenuitem--set-image"><methodname>set_image</methodname>()</link>.</para>
</refsect2>
</refsect1>
</refentry>
|
