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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and GtkComboBoxEntry: GTK+ 2 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
<link rel="up" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="prev" href="migrating-gnomeuiinfo.html" title="Migrating from GnomeUIInfo">
<link rel="next" href="migrating-GtkCombo.html" title="Migrating from GtkCombo to GtkComboBoxEntry">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts"></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="migrating.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="migrating-gnomeuiinfo.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="migrating-GtkCombo.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="chapter">
<div class="titlepage"><div><div><h2 class="title">
<a name="gtk-migrating-GtkComboBox"></a>Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and
GtkComboBoxEntry</h2></div></div></div>
<div class="toc"><dl class="toc">
<dt><span class="section"><a href="gtk-migrating-GtkComboBox.html#migrating-GtkOptionMenu">Migrating from GtkOptionMenu to GtkComboBox</a></span></dt>
<dt><span class="section"><a href="migrating-GtkCombo.html">Migrating from GtkCombo to GtkComboBoxEntry</a></span></dt>
<dt><span class="section"><a href="new-features-GtkComboBox.html">New features</a></span></dt>
</dl></div>
<p>
Prior to 2.4, GTK+ offered two widgets for the task of selecting one
item from a list of options. <a class="link" href="GtkOptionMenu.html" title="GtkOptionMenu"><span class="type">GtkOptionMenu</span></a> presents the list of
options as a menu while <a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> presents them in a Windows-style list
popup. The only difference between the two is that a <a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> allows to
manually edit the selected value, while the <a class="link" href="GtkOptionMenu.html" title="GtkOptionMenu"><span class="type">GtkOptionMenu</span></a> does not.
</p>
<p>
In GTK+ 2.4, a unified API for list selection was introduced, with
<a class="link" href="GtkComboBox.html" title="GtkComboBox"><span class="type">GtkComboBox</span></a> for the non-editable case and <a class="link" href="GtkComboBoxEntry.html" title="GtkComboBoxEntry"><span class="type">GtkComboBoxEntry</span></a> for the
editable case.
The selection of the display style — menu or list —
is no longer done at the API level, but has been made themeable via
the style property <span class="type">“appears-as-list”</span>.
</p>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="migrating-GtkOptionMenu"></a>Migrating from GtkOptionMenu to GtkComboBox</h2></div></div></div>
<p>
Here is an example of a simple, but typical use of
<a class="link" href="GtkOptionMenu.html" title="GtkOptionMenu"><span class="type">GtkOptionMenu</span></a>:
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="n">GtkWidget</span> <span class="o">*</span><span class="n">option_menu</span><span class="p">,</span> <span class="o">*</span><span class="n">menu</span><span class="p">,</span> <span class="o">*</span><span class="n">menu_item</span><span class="p">;</span>
<span class="n">option_menu</span> <span class="o">=</span> <span class="n">gtk_option_menu_new</span> <span class="p">();</span>
<span class="n">menu</span> <span class="o">=</span> <span class="n">gtk_menu_new</span> <span class="p">();</span>
<span class="n">menu_item</span> <span class="o">=</span> <span class="n">gtk_menu_item_new_with_label</span> <span class="p">(</span><span class="s">"First Item"</span><span class="p">);</span>
<span class="n">gtk_menu_shell_append</span> <span class="p">(</span><span class="n">GTK_MENU_SHELL</span> <span class="p">(</span><span class="n">menu</span><span class="p">),</span> <span class="n">menu_item</span><span class="p">);</span>
<span class="n">gtk_widget_show</span> <span class="p">(</span><span class="n">menu_item</span><span class="p">);</span>
<span class="n">menu_item</span> <span class="o">=</span> <span class="n">gtk_menu_item_new_with_label</span> <span class="p">(</span><span class="s">"Second Item"</span><span class="p">);</span>
<span class="n">gtk_menu_shell_append</span> <span class="p">(</span><span class="n">GTK_MENU_SHELL</span> <span class="p">(</span><span class="n">menu</span><span class="p">),</span> <span class="n">menu_item</span><span class="p">);</span>
<span class="n">gtk_widget_show</span> <span class="p">(</span><span class="n">menu_item</span><span class="p">);</span>
<span class="n">menu_item</span> <span class="o">=</span> <span class="n">gtk_menu_item_new_with_label</span> <span class="p">(</span><span class="s">"Third Item"</span><span class="p">);</span>
<span class="n">gtk_menu_shell_append</span> <span class="p">(</span><span class="n">GTK_MENU_SHELL</span> <span class="p">(</span><span class="n">menu</span><span class="p">),</span> <span class="n">menu_item</span><span class="p">);</span>
<span class="n">gtk_widget_show</span> <span class="p">(</span><span class="n">menu_item</span><span class="p">);</span>
<span class="n">gtk_option_menu_set_menu</span> <span class="p">(</span><span class="n">GTK_OPTION_MENU</span> <span class="p">(</span><span class="n">option_menu</span><span class="p">),</span> <span class="n">menu</span><span class="p">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
In order to react to the user's selection, connect to the <a class="link" href="GtkOptionMenu.html#GtkOptionMenu-changed" title="The “changed” signal"><span class="type">“changed”</span></a>
signal on the option menu and use <a class="link" href="GtkOptionMenu.html#gtk-option-menu-get-history" title="gtk_option_menu_get_history ()"><code class="function">gtk_option_menu_get_history()</code></a>
to retrieve the index of the selected item.
</p>
<p>
And here is how it would be done with a <a class="link" href="GtkComboBox.html" title="GtkComboBox"><span class="type">GtkComboBox</span></a>:
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="n">GtkWidget</span> <span class="o">*</span><span class="n">combo_box</span><span class="p">;</span>
<span class="n">combo_box</span> <span class="o">=</span> <span class="n">gtk_combo_box_text_new</span> <span class="p">();</span>
<span class="n">gtk_combo_box_text_append</span> <span class="p">(</span><span class="n">GTK_COMBO_BOX_TEXT</span> <span class="p">(</span><span class="n">combo_box</span><span class="p">),</span> <span class="s">"First Item"</span><span class="p">);</span>
<span class="n">gtk_combo_box_text_append</span> <span class="p">(</span><span class="n">GTK_COMBO_BOX_TEXT</span> <span class="p">(</span><span class="n">combo_box</span><span class="p">),</span> <span class="s">"Second Item"</span><span class="p">);</span>
<span class="n">gtk_combo_box_text_append</span> <span class="p">(</span><span class="n">GTK_COMBO_BOX_TEXT</span> <span class="p">(</span><span class="n">combo_box</span><span class="p">),</span> <span class="s">"Third Item"</span><span class="p">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
In order to react to the user's selection, connect to the
<a class="link" href="GtkComboBox.html#GtkComboBox-changed" title="The “changed” signal"><span class="type">“changed”</span></a> signal and use <a class="link" href="GtkComboBox.html#gtk-combo-box-get-active" title="gtk_combo_box_get_active ()"><code class="function">gtk_combo_box_get_active()</code></a>
to retrieve the index of the selected item.
</p>
<p>
A slightly more complex example involving images:
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="n">GtkWidget</span> <span class="o">*</span><span class="n">option_menu</span><span class="p">,</span> <span class="o">*</span><span class="n">menu</span><span class="p">,</span> <span class="o">*</span><span class="n">menu_item</span><span class="p">;</span>
<span class="n">option_menu</span> <span class="o">=</span> <span class="n">gtk_option_menu_new</span> <span class="p">();</span>
<span class="n">menu</span> <span class="o">=</span> <span class="n">gtk_menu_new</span> <span class="p">();</span>
<span class="n">menu_item</span> <span class="o">=</span> <span class="n">gtk_image_menu_item_new_with_label</span> <span class="p">(</span><span class="s">"First Item"</span><span class="p">);</span>
<span class="n">gtk_image_menu_item_set_image</span> <span class="p">(</span><span class="n">gtk_image_new_from_pixbuf</span> <span class="p">(</span><span class="n">pixbuf1</span><span class="p">));</span>
<span class="n">gtk_menu_shell_append</span> <span class="p">(</span><span class="n">GTK_MENU_SHELL</span> <span class="p">(</span><span class="n">menu</span><span class="p">),</span> <span class="n">menu_item</span><span class="p">);</span>
<span class="n">gtk_widget_show</span> <span class="p">(</span><span class="n">menu_item</span><span class="p">);</span>
<span class="n">menu_item</span> <span class="o">=</span> <span class="n">gtk_image_menu_item_new_with_label</span> <span class="p">(</span><span class="s">"Second Item"</span><span class="p">);</span>
<span class="n">gtk_image_menu_item_set_image</span> <span class="p">(</span><span class="n">gtk_image_new_from_pixbuf</span> <span class="p">(</span><span class="n">pixbuf2</span><span class="p">));</span>
<span class="n">gtk_menu_shell_append</span> <span class="p">(</span><span class="n">GTK_MENU_SHELL</span> <span class="p">(</span><span class="n">menu</span><span class="p">),</span> <span class="n">menu_item</span><span class="p">);</span>
<span class="n">gtk_widget_show</span> <span class="p">(</span><span class="n">menu_item</span><span class="p">);</span>
<span class="n">menu_item</span> <span class="o">=</span> <span class="n">gtk_image_menu_item_new_with_label</span> <span class="p">(</span><span class="s">"Third Item"</span><span class="p">);</span>
<span class="n">gtk_image_menu_item_set_image</span> <span class="p">(</span><span class="n">gtk_image_new_from_pixbuf</span> <span class="p">(</span><span class="n">pixbuf3</span><span class="p">));</span>
<span class="n">gtk_menu_shell_append</span> <span class="p">(</span><span class="n">GTK_MENU_SHELL</span> <span class="p">(</span><span class="n">menu</span><span class="p">),</span> <span class="n">menu_item</span><span class="p">);</span>
<span class="n">gtk_widget_show</span> <span class="p">(</span><span class="n">menu_item</span><span class="p">);</span>
<span class="n">gtk_option_menu_set_menu</span> <span class="p">(</span><span class="n">GTK_OPTION_MENU</span> <span class="p">(</span><span class="n">option_menu</span><span class="p">),</span> <span class="n">menu</span><span class="p">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
<p>
can be done using a <a class="link" href="GtkComboBox.html" title="GtkComboBox"><span class="type">GtkComboBox</span></a> as follows:
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>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</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="n">GtkListStore</span> <span class="o">*</span><span class="n">store</span><span class="p">;</span>
<span class="n">GtkTreeIter</span> <span class="n">iter</span><span class="p">;</span>
<span class="n">GtkCellRenderer</span> <span class="o">*</span><span class="n">renderer</span><span class="p">;</span>
<span class="n">GtkWidget</span> <span class="o">*</span><span class="n">combo_box</span><span class="p">;</span>
<span class="n">store</span> <span class="o">=</span> <span class="n">gtk_list_store_new</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="n">GDK_TYPE_PIXBUF</span><span class="p">,</span> <span class="n">G_TYPE_STRING</span><span class="p">);</span>
<span class="n">gtk_list_store_append</span> <span class="p">(</span><span class="n">store</span><span class="p">,</span> <span class="o">&</span><span class="n">iter</span><span class="p">);</span>
<span class="n">gtk_list_store_set</span> <span class="p">(</span><span class="n">store</span><span class="p">,</span> <span class="o">&</span><span class="n">iter</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">pixbuf1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="s">"First Item"</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">);</span>
<span class="n">gtk_list_store_append</span> <span class="p">(</span><span class="n">store</span><span class="p">,</span> <span class="o">&</span><span class="n">iter</span><span class="p">);</span>
<span class="n">gtk_list_store_set</span> <span class="p">(</span><span class="n">store</span><span class="p">,</span> <span class="o">&</span><span class="n">iter</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">pixbuf2</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="s">"Second Item"</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">);</span>
<span class="n">gtk_list_store_append</span> <span class="p">(</span><span class="n">store</span><span class="p">,</span> <span class="o">&</span><span class="n">iter</span><span class="p">);</span>
<span class="n">gtk_list_store_set</span> <span class="p">(</span><span class="n">store</span><span class="p">,</span> <span class="o">&</span><span class="n">iter</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">pixbuf3</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="s">"Third Item"</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">);</span>
<span class="n">combo_box</span> <span class="o">=</span> <span class="n">gtk_combo_box_new_with_model</span> <span class="p">(</span><span class="n">GTK_TREE_MODEL</span> <span class="p">(</span><span class="n">store</span><span class="p">));</span>
<span class="n">renderer</span> <span class="o">=</span> <span class="n">gtk_cell_renderer_pixbuf_new</span> <span class="p">();</span>
<span class="n">gtk_cell_layout_pack_start</span> <span class="p">(</span><span class="n">GTK_CELL_LAYOUT</span> <span class="p">(</span><span class="n">combo_box</span><span class="p">),</span> <span class="n">renderer</span><span class="p">,</span> <span class="n">FALSE</span><span class="p">);</span>
<span class="n">gtk_cell_layout_set_attributes</span> <span class="p">(</span><span class="n">GTK_CELL_LAYOUT</span> <span class="p">(</span><span class="n">combo_box</span><span class="p">),</span> <span class="n">renderer</span><span class="p">,</span>
<span class="s">"pixbuf"</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span>
<span class="nb">NULL</span><span class="p">);</span>
<span class="n">renderer</span> <span class="o">=</span> <span class="n">gtk_cell_renderer_text_new</span> <span class="p">();</span>
<span class="n">gtk_cell_layout_pack_start</span> <span class="p">(</span><span class="n">GTK_CELL_LAYOUT</span> <span class="p">(</span><span class="n">combo_box</span><span class="p">),</span> <span class="n">renderer</span><span class="p">,</span> <span class="n">TRUE</span><span class="p">);</span>
<span class="n">gtk_cell_layout_set_attributes</span> <span class="p">(</span><span class="n">GTK_CELL_LAYOUT</span> <span class="p">(</span><span class="n">combo_box</span><span class="p">),</span> <span class="n">renderer</span><span class="p">,</span>
<span class="s">"text"</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span>
<span class="nb">NULL</span><span class="p">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>
|
