← Back to branch summary

~inkscape.dev/inkscape-devlibs/devlibs-gtk3

« back to all changes in this revision

Viewing changes to share/gtk-doc/html/gtk2/GtkCombo.html

  • Committer: JazzyNico
  • Date: 2013-01-21 10:11:05 UTC
  • Revision ID: nicoduf@yahoo.fr-20130121101105-i8d8slkq9ng4olx8
Adding gtk2 libraries.

Show diffs side-by-side

added added

removed removed

Lines of Context:
share/gtk-doc/html/gtk2/GtkCombo.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>GtkCombo</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
 
7
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
 
8
<link rel="up" href="DeprecatedObjects.html" title="Deprecated">
 
9
<link rel="prev" href="GtkCTree.html" title="GtkCTree">
 
10
<link rel="next" href="GtkFileSelection.html" title="GtkFileSelection">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="GtkCTree.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="DeprecatedObjects.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">GTK+ 2 Reference Manual</th>
 
21
<td><a accesskey="n" href="GtkFileSelection.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#GtkCombo.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#GtkCombo.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#GtkCombo.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#GtkCombo.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
31
                   | 
 
32
                  <a href="#GtkCombo.properties" class="shortcut">Properties</a>
 
33
</td></tr>
 
34
</table>
 
35
<div class="refentry">
 
36
<a name="GtkCombo"></a><div class="titlepage"></div>
 
37
<div class="refnamediv"><table width="100%"><tr>
 
38
<td valign="top">
 
39
<h2><span class="refentrytitle"><a name="GtkCombo.top_of_page"></a>GtkCombo</span></h2>
 
40
<p>GtkCombo — A text entry field with a dropdown list</p>
 
41
</td>
 
42
<td valign="top" align="right"></td>
 
43
</tr></table></div>
 
44
<div class="refsynopsisdiv">
 
45
<a name="GtkCombo.synopsis"></a><h2>Synopsis</h2>
 
46
<pre class="synopsis">
 
47
#include &lt;gtk/gtk.h&gt;
 
48
 
 
49
struct              <a class="link" href="GtkCombo.html#GtkCombo-struct" title="struct GtkCombo">GtkCombo</a>;
 
50
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GtkCombo.html#gtk-combo-new" title="gtk_combo_new ()">gtk_combo_new</a>                       (<em class="parameter"><code><span class="type">void</span></code></em>);
 
51
<span class="returnvalue">void</span>                <a class="link" href="GtkCombo.html#gtk-combo-set-popdown-strings" title="gtk_combo_set_popdown_strings ()">gtk_combo_set_popdown_strings</a>       (<em class="parameter"><code><a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> *combo</code></em>,
 
52
                                                         <em class="parameter"><code><span class="type">GList</span> *strings</code></em>);
 
53
<span class="returnvalue">void</span>                <a class="link" href="GtkCombo.html#gtk-combo-set-value-in-list" title="gtk_combo_set_value_in_list ()">gtk_combo_set_value_in_list</a>         (<em class="parameter"><code><a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> *combo</code></em>,
 
54
                                                         <em class="parameter"><code><span class="type">gboolean</span> val</code></em>,
 
55
                                                         <em class="parameter"><code><span class="type">gboolean</span> ok_if_empty</code></em>);
 
56
<span class="returnvalue">void</span>                <a class="link" href="GtkCombo.html#gtk-combo-set-use-arrows" title="gtk_combo_set_use_arrows ()">gtk_combo_set_use_arrows</a>            (<em class="parameter"><code><a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> *combo</code></em>,
 
57
                                                         <em class="parameter"><code><span class="type">gboolean</span> val</code></em>);
 
58
<span class="returnvalue">void</span>                <a class="link" href="GtkCombo.html#gtk-combo-set-use-arrows-always" title="gtk_combo_set_use_arrows_always ()">gtk_combo_set_use_arrows_always</a>     (<em class="parameter"><code><a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> *combo</code></em>,
 
59
                                                         <em class="parameter"><code><span class="type">gboolean</span> val</code></em>);
 
60
<span class="returnvalue">void</span>                <a class="link" href="GtkCombo.html#gtk-combo-set-case-sensitive" title="gtk_combo_set_case_sensitive ()">gtk_combo_set_case_sensitive</a>        (<em class="parameter"><code><a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> *combo</code></em>,
 
61
                                                         <em class="parameter"><code><span class="type">gboolean</span> val</code></em>);
 
62
<span class="returnvalue">void</span>                <a class="link" href="GtkCombo.html#gtk-combo-set-item-string" title="gtk_combo_set_item_string ()">gtk_combo_set_item_string</a>           (<em class="parameter"><code><a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> *combo</code></em>,
 
63
                                                         <em class="parameter"><code><a class="link" href="GtkItem.html" title="GtkItem"><span class="type">GtkItem</span></a> *item</code></em>,
 
64
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *item_value</code></em>);
 
65
<span class="returnvalue">void</span>                <a class="link" href="GtkCombo.html#gtk-combo-disable-activate" title="gtk_combo_disable_activate ()">gtk_combo_disable_activate</a>          (<em class="parameter"><code><a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> *combo</code></em>);
 
66
</pre>
 
67
</div>
 
68
<div class="refsect1">
 
69
<a name="GtkCombo.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
70
<pre class="synopsis">
 
71
  GObject
 
72
   +----GInitiallyUnowned
 
73
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
 
74
               +----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
 
75
                     +----<a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
 
76
                           +----<a class="link" href="GtkBox.html" title="GtkBox">GtkBox</a>
 
77
                                 +----<a class="link" href="GtkHBox.html" title="GtkHBox">GtkHBox</a>
 
78
                                       +----GtkCombo
 
79
</pre>
 
80
</div>
 
81
<div class="refsect1">
 
82
<a name="GtkCombo.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 
83
<p>
 
84
GtkCombo implements
 
85
 AtkImplementorIface,  <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a> and  <a class="link" href="gtk2-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
 
86
</div>
 
87
<div class="refsect1">
 
88
<a name="GtkCombo.properties"></a><h2>Properties</h2>
 
89
<pre class="synopsis">
 
90
  "<a class="link" href="GtkCombo.html#GtkCombo--allow-empty" title='The "allow-empty" property'>allow-empty</a>"              <span class="type">gboolean</span>              : Read / Write
 
91
  "<a class="link" href="GtkCombo.html#GtkCombo--case-sensitive" title='The "case-sensitive" property'>case-sensitive</a>"           <span class="type">gboolean</span>              : Read / Write
 
92
  "<a class="link" href="GtkCombo.html#GtkCombo--enable-arrow-keys" title='The "enable-arrow-keys" property'>enable-arrow-keys</a>"        <span class="type">gboolean</span>              : Read / Write
 
93
  "<a class="link" href="GtkCombo.html#GtkCombo--enable-arrows-always" title='The "enable-arrows-always" property'>enable-arrows-always</a>"     <span class="type">gboolean</span>              : Read / Write
 
94
  "<a class="link" href="GtkCombo.html#GtkCombo--value-in-list" title='The "value-in-list" property'>value-in-list</a>"            <span class="type">gboolean</span>              : Read / Write
 
95
</pre>
 
96
</div>
 
97
<div class="refsect1">
 
98
<a name="GtkCombo.description"></a><h2>Description</h2>
 
99
<p>
 
100
The <a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> widget consists of a single-line text entry field and a drop-down
 
101
list. The drop-down list is displayed when the user clicks on a small arrow
 
102
button to the right of the entry field.
 
103
</p>
 
104
<p>
 
105
The drop-down list is a <a class="link" href="GtkList.html" title="GtkList"><span class="type">GtkList</span></a> widget and can be accessed using the
 
106
<em class="structfield"><code>list</code></em> member of the <a class="link" href="GtkCombo.html#GtkCombo-struct" title="struct GtkCombo"><span class="type">GtkCombo</span></a>.
 
107
List elements can contain arbitrary widgets, but if an element is not a
 
108
plain label, then you must use the <code class="function">gtk_list_set_item_string()</code> function.
 
109
This sets the string which will be placed in the text entry field when the
 
110
item is selected.
 
111
</p>
 
112
<p>
 
113
By default, the user can step through the items in the list using the
 
114
arrow (cursor) keys, though this behaviour can be turned off with
 
115
<a class="link" href="GtkCombo.html#gtk-combo-set-use-arrows" title="gtk_combo_set_use_arrows ()"><code class="function">gtk_combo_set_use_arrows()</code></a>.
 
116
</p>
 
117
<p>
 
118
As of GTK+ 2.4, <a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> has been deprecated in favor of <a class="link" href="GtkComboBoxEntry.html" title="GtkComboBoxEntry"><span class="type">GtkComboBoxEntry</span></a>.
 
119
</p>
 
120
<div class="example">
 
121
<a name="gtkcombo-simple-example"></a><p class="title"><b>Example 62. Creating a <span class="structname">GtkCombo</span> widget with simple text
 
122
items.</b></p>
 
123
<div class="example-contents">
 
124
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
125
    <tbody>
 
126
      <tr>
 
127
        <td class="listing_lines" align="right"><pre>1
 
128
2
 
129
3
 
130
4
 
131
5
 
132
6
 
133
7
 
134
8
 
135
9</pre></td>
 
136
        <td class="listing_code"><pre class="programlisting"><span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">combo</span><span class="symbol">;</span>
 
137
<span class="usertype">GList</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">items </span><span class="symbol">=</span><span class="normal"> <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS">NULL</a></span><span class="symbol">;</span>
 
138
<span class="normal">items </span><span class="symbol">=</span><span class="normal"> </span><span class="function">g_list_append</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">items</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"First Item"</span><span class="symbol">);</span>
 
139
<span class="normal">items </span><span class="symbol">=</span><span class="normal"> </span><span class="function">g_list_append</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">items</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"Second Item"</span><span class="symbol">);</span>
 
140
<span class="normal">items </span><span class="symbol">=</span><span class="normal"> </span><span class="function">g_list_append</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">items</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"Third Item"</span><span class="symbol">);</span>
 
141
<span class="normal">items </span><span class="symbol">=</span><span class="normal"> </span><span class="function">g_list_append</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">items</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"Fourth Item"</span><span class="symbol">);</span>
 
142
<span class="normal">items </span><span class="symbol">=</span><span class="normal"> </span><span class="function">g_list_append</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">items</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"Fifth Item"</span><span class="symbol">);</span>
 
143
<span class="normal">combo </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkCombo.html#gtk-combo-new">gtk_combo_new</a></span><span class="normal"> </span><span class="symbol">();</span>
 
144
<span class="function"><a href="GtkCombo.html#gtk-combo-set-popdown-strings">gtk_combo_set_popdown_strings</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_COMBO</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">combo</span><span class="symbol">),</span><span class="normal"> items</span><span class="symbol">);</span></pre></td>
 
145
      </tr>
 
146
    </tbody>
 
147
  </table>
 
148
</div>
 
149
 
 
150
</div>
 
151
<br class="example-break"><div class="example">
 
152
<a name="idp103804784"></a><p class="title"><b>Example 63. Creating a <span class="structname">GtkCombo</span> widget with a complex item.</b></p>
 
153
<div class="example-contents">
 
154
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
155
    <tbody>
 
156
      <tr>
 
157
        <td class="listing_lines" align="right"><pre>1
 
158
2
 
159
3
 
160
4
 
161
5
 
162
6
 
163
7
 
164
8
 
165
9
 
166
10
 
167
11
 
168
12
 
169
13
 
170
14
 
171
15
 
172
16
 
173
17
 
174
18
 
175
19
 
176
20</pre></td>
 
177
        <td class="listing_code"><pre class="programlisting"><span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">combo</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">item</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">hbox</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">arrow</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">label</span><span class="symbol">;</span>
 
178
<span class="normal">combo </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkCombo.html#gtk-combo-new">gtk_combo_new</a></span><span class="normal"> </span><span class="symbol">();</span>
 
179
<span class="normal">item </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkListItem.html#gtk-list-item-new">gtk_list_item_new</a></span><span class="normal"> </span><span class="symbol">();</span>
 
180
<span class="function"><a href="GtkWidget.html#gtk-widget-show">gtk_widget_show</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">item</span><span class="symbol">);</span>
 
181
<span class="comment">/* You can put almost anything into the GtkListItem widget. Here we will use</span>
 
182
<span class="comment">   a horizontal box with an arrow and a label in it. */</span>
 
183
<span class="normal">hbox </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkHBox.html#gtk-hbox-new">gtk_hbox_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">FALSE</span><span class="symbol">,</span><span class="normal"> </span><span class="number">3</span><span class="symbol">);</span>
 
184
<span class="function"><a href="GtkContainer.html#gtk-container-add">gtk_container_add</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_CONTAINER</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">item</span><span class="symbol">),</span><span class="normal"> hbox</span><span class="symbol">);</span>
 
185
<span class="function"><a href="GtkWidget.html#gtk-widget-show">gtk_widget_show</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">hbox</span><span class="symbol">);</span>
 
186
<span class="normal">arrow </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkArrow.html#gtk-arrow-new">gtk_arrow_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="gtk2-Standard-Enumerations.html#GTK-ARROW-RIGHT:CAPS">GTK_ARROW_RIGHT</a></span><span class="symbol">,</span><span class="normal"> <a href="gtk2-Standard-Enumerations.html#GTK-SHADOW-OUT:CAPS">GTK_SHADOW_OUT</a></span><span class="symbol">);</span>
 
187
<span class="function"><a href="GtkWidget.html#gtk-widget-show">gtk_widget_show</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">arrow</span><span class="symbol">);</span>
 
188
<span class="function"><a href="GtkBox.html#gtk-box-pack-start">gtk_box_pack_start</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_BOX</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">hbox</span><span class="symbol">),</span><span class="normal"> arrow</span><span class="symbol">,</span><span class="normal"> FALSE</span><span class="symbol">,</span><span class="normal"> FALSE</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">);</span>
 
189
<span class="normal">label </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkLabel.html#gtk-label-new">gtk_label_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"First Item"</span><span class="symbol">);</span>
 
190
<span class="function"><a href="GtkWidget.html#gtk-widget-show">gtk_widget_show</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">label</span><span class="symbol">);</span>
 
191
<span class="function"><a href="GtkBox.html#gtk-box-pack-start">gtk_box_pack_start</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_BOX</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">hbox</span><span class="symbol">),</span><span class="normal"> label</span><span class="symbol">,</span><span class="normal"> FALSE</span><span class="symbol">,</span><span class="normal"> FALSE</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">);</span>
 
192
<span class="comment">/* You must set the string to display in the entry field when the item is</span>
 
193
<span class="comment">   selected. */</span>
 
194
<span class="function"><a href="GtkCombo.html#gtk-combo-set-item-string">gtk_combo_set_item_string</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_COMBO</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">combo</span><span class="symbol">),</span><span class="normal"> </span><span class="function">GTK_ITEM</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">item</span><span class="symbol">),</span><span class="normal"> </span><span class="string">"1st Item"</span><span class="symbol">);</span>
 
195
<span class="comment">/* Now we simply add the item to the combo's list. */</span>
 
196
<span class="function"><a href="GtkContainer.html#gtk-container-add">gtk_container_add</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_CONTAINER</span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_COMBO</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">combo</span><span class="symbol">)-&gt;</span><span class="normal">list</span><span class="symbol">),</span><span class="normal"> item</span><span class="symbol">);</span></pre></td>
 
197
      </tr>
 
198
    </tbody>
 
199
  </table>
 
200
</div>
 
201
 
 
202
</div>
 
203
<br class="example-break">
 
204
</div>
 
205
<div class="refsect1">
 
206
<a name="GtkCombo.details"></a><h2>Details</h2>
 
207
<div class="refsect2">
 
208
<a name="GtkCombo-struct"></a><h3>struct GtkCombo</h3>
 
209
<pre class="programlisting">struct GtkCombo {
 
210
        GtkWidget *entry;
 
211
        
 
212
        GtkWidget *list;
 
213
};
 
214
</pre>
 
215
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
216
<h3 class="title">Warning</h3>
 
217
<p><code class="literal">GtkCombo</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a class="link" href="GtkComboBox.html" title="GtkComboBox"><span class="type">GtkComboBox</span></a> instead.</p>
 
218
</div>
 
219
<p>
 
220
The <a class="link" href="GtkCombo.html#GtkCombo-struct" title="struct GtkCombo"><span class="type">GtkCombo</span></a> struct contains the following fields.
 
221
(These fields should be considered read-only. They should never be set by
 
222
an application.)
 
223
</p>
 
224
<div class="variablelist"><table border="0" class="variablelist">
 
225
<colgroup>
 
226
<col align="left" valign="top">
 
227
<col>
 
228
</colgroup>
 
229
<tbody>
 
230
<tr>
 
231
<td><p><span class="term"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *<em class="structfield"><code><a name="GtkCombo-struct.entry"></a>entry</code></em>;</span></p></td>
 
232
<td>the text entry field.</td>
 
233
</tr>
 
234
<tr>
 
235
<td><p><span class="term"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *<em class="structfield"><code><a name="GtkCombo-struct.list"></a>list</code></em>;</span></p></td>
 
236
<td>the list shown in the drop-down window.</td>
 
237
</tr>
 
238
</tbody>
 
239
</table></div>
 
240
</div>
 
241
<hr>
 
242
<div class="refsect2">
 
243
<a name="gtk-combo-new"></a><h3>gtk_combo_new ()</h3>
 
244
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         gtk_combo_new                       (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
245
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
246
<h3 class="title">Warning</h3>
 
247
<p><code class="literal">gtk_combo_new</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a class="link" href="GtkComboBox.html" title="GtkComboBox"><span class="type">GtkComboBox</span></a> instead.</p>
 
248
</div>
 
249
<p>
 
250
Creates a new <a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a>.
 
251
</p>
 
252
<div class="variablelist"><table border="0" class="variablelist">
 
253
<colgroup>
 
254
<col align="left" valign="top">
 
255
<col>
 
256
</colgroup>
 
257
<tbody><tr>
 
258
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
259
<td>a new <a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a>.</td>
 
260
</tr></tbody>
 
261
</table></div>
 
262
</div>
 
263
<hr>
 
264
<div class="refsect2">
 
265
<a name="gtk-combo-set-popdown-strings"></a><h3>gtk_combo_set_popdown_strings ()</h3>
 
266
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_combo_set_popdown_strings       (<em class="parameter"><code><a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> *combo</code></em>,
 
267
                                                         <em class="parameter"><code><span class="type">GList</span> *strings</code></em>);</pre>
 
268
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
269
<h3 class="title">Warning</h3>
 
270
<p><code class="literal">gtk_combo_set_popdown_strings</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a class="link" href="GtkComboBox.html" title="GtkComboBox"><span class="type">GtkComboBox</span></a> instead.</p>
 
271
</div>
 
272
<p>
 
273
Convenience function to set all of the items in the popup list.
 
274
(See the <a class="link" href="GtkCombo.html#gtkcombo-simple-example" title="Example 62. Creating a GtkCombo widget with simple text items.">example</a> above.)
 
275
</p>
 
276
<div class="variablelist"><table border="0" class="variablelist">
 
277
<colgroup>
 
278
<col align="left" valign="top">
 
279
<col>
 
280
</colgroup>
 
281
<tbody>
 
282
<tr>
 
283
<td><p><span class="term"><em class="parameter"><code>combo</code></em> :</span></p></td>
 
284
<td>a <a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a>.</td>
 
285
</tr>
 
286
<tr>
 
287
<td><p><span class="term"><em class="parameter"><code>strings</code></em> :</span></p></td>
 
288
<td>a list of strings, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> to clear the popup list</td>
 
289
</tr>
 
290
</tbody>
 
291
</table></div>
 
292
</div>
 
293
<hr>
 
294
<div class="refsect2">
 
295
<a name="gtk-combo-set-value-in-list"></a><h3>gtk_combo_set_value_in_list ()</h3>
 
296
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_combo_set_value_in_list         (<em class="parameter"><code><a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> *combo</code></em>,
 
297
                                                         <em class="parameter"><code><span class="type">gboolean</span> val</code></em>,
 
298
                                                         <em class="parameter"><code><span class="type">gboolean</span> ok_if_empty</code></em>);</pre>
 
299
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
300
<h3 class="title">Warning</h3>
 
301
<p><code class="literal">gtk_combo_set_value_in_list</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a class="link" href="GtkComboBox.html" title="GtkComboBox"><span class="type">GtkComboBox</span></a> instead.</p>
 
302
</div>
 
303
<p>
 
304
Specifies whether the value entered in the text entry field must match one of
 
305
the values in the list. If this is set then the user will not be able to
 
306
perform any other action until a valid value has been entered.
 
307
</p>
 
308
<p>
 
309
If an empty field is acceptable, the <em class="parameter"><code>ok_if_empty</code></em> parameter should be <code class="literal">TRUE</code>.
 
310
</p>
 
311
<div class="variablelist"><table border="0" class="variablelist">
 
312
<colgroup>
 
313
<col align="left" valign="top">
 
314
<col>
 
315
</colgroup>
 
316
<tbody>
 
317
<tr>
 
318
<td><p><span class="term"><em class="parameter"><code>combo</code></em> :</span></p></td>
 
319
<td>a <a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a>.</td>
 
320
</tr>
 
321
<tr>
 
322
<td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
 
323
<td>
 
324
<code class="literal">TRUE</code> if the value entered must match one of the values in the list.</td>
 
325
</tr>
 
326
<tr>
 
327
<td><p><span class="term"><em class="parameter"><code>ok_if_empty</code></em> :</span></p></td>
 
328
<td>
 
329
<code class="literal">TRUE</code> if an empty value is considered valid.</td>
 
330
</tr>
 
331
</tbody>
 
332
</table></div>
 
333
</div>
 
334
<hr>
 
335
<div class="refsect2">
 
336
<a name="gtk-combo-set-use-arrows"></a><h3>gtk_combo_set_use_arrows ()</h3>
 
337
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_combo_set_use_arrows            (<em class="parameter"><code><a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> *combo</code></em>,
 
338
                                                         <em class="parameter"><code><span class="type">gboolean</span> val</code></em>);</pre>
 
339
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
340
<h3 class="title">Warning</h3>
 
341
<p><code class="literal">gtk_combo_set_use_arrows</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a class="link" href="GtkComboBox.html" title="GtkComboBox"><span class="type">GtkComboBox</span></a> instead.</p>
 
342
</div>
 
343
<p>
 
344
Specifies if the arrow (cursor) keys can be used to step through the items in
 
345
the list. This is on by default.
 
346
</p>
 
347
<div class="variablelist"><table border="0" class="variablelist">
 
348
<colgroup>
 
349
<col align="left" valign="top">
 
350
<col>
 
351
</colgroup>
 
352
<tbody>
 
353
<tr>
 
354
<td><p><span class="term"><em class="parameter"><code>combo</code></em> :</span></p></td>
 
355
<td>a <a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a>.</td>
 
356
</tr>
 
357
<tr>
 
358
<td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
 
359
<td>
 
360
<code class="literal">TRUE</code> if the arrow keys can be used to step through the items in
 
361
the list.</td>
 
362
</tr>
 
363
</tbody>
 
364
</table></div>
 
365
</div>
 
366
<hr>
 
367
<div class="refsect2">
 
368
<a name="gtk-combo-set-use-arrows-always"></a><h3>gtk_combo_set_use_arrows_always ()</h3>
 
369
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_combo_set_use_arrows_always     (<em class="parameter"><code><a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> *combo</code></em>,
 
370
                                                         <em class="parameter"><code><span class="type">gboolean</span> val</code></em>);</pre>
 
371
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
372
<h3 class="title">Warning</h3>
 
373
<p><code class="literal">gtk_combo_set_use_arrows_always</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a class="link" href="GtkComboBox.html" title="GtkComboBox"><span class="type">GtkComboBox</span></a> instead.</p>
 
374
</div>
 
375
<p>
 
376
Obsolete function, does nothing.
 
377
</p>
 
378
<div class="variablelist"><table border="0" class="variablelist">
 
379
<colgroup>
 
380
<col align="left" valign="top">
 
381
<col>
 
382
</colgroup>
 
383
<tbody>
 
384
<tr>
 
385
<td><p><span class="term"><em class="parameter"><code>combo</code></em> :</span></p></td>
 
386
<td>a <a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a>.</td>
 
387
</tr>
 
388
<tr>
 
389
<td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
 
390
<td>unused</td>
 
391
</tr>
 
392
</tbody>
 
393
</table></div>
 
394
</div>
 
395
<hr>
 
396
<div class="refsect2">
 
397
<a name="gtk-combo-set-case-sensitive"></a><h3>gtk_combo_set_case_sensitive ()</h3>
 
398
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_combo_set_case_sensitive        (<em class="parameter"><code><a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> *combo</code></em>,
 
399
                                                         <em class="parameter"><code><span class="type">gboolean</span> val</code></em>);</pre>
 
400
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
401
<h3 class="title">Warning</h3>
 
402
<p><code class="literal">gtk_combo_set_case_sensitive</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a class="link" href="GtkComboBox.html" title="GtkComboBox"><span class="type">GtkComboBox</span></a> instead.</p>
 
403
</div>
 
404
<p>
 
405
Specifies whether the text entered into the <a class="link" href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a> field and the text in
 
406
the list items is case sensitive.
 
407
</p>
 
408
<p>
 
409
This may be useful, for example, when you have called
 
410
<a class="link" href="GtkCombo.html#gtk-combo-set-value-in-list" title="gtk_combo_set_value_in_list ()"><code class="function">gtk_combo_set_value_in_list()</code></a> to limit the values entered, but you are not
 
411
worried about differences in case.
 
412
</p>
 
413
<div class="variablelist"><table border="0" class="variablelist">
 
414
<colgroup>
 
415
<col align="left" valign="top">
 
416
<col>
 
417
</colgroup>
 
418
<tbody>
 
419
<tr>
 
420
<td><p><span class="term"><em class="parameter"><code>combo</code></em> :</span></p></td>
 
421
<td>a <a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a>.</td>
 
422
</tr>
 
423
<tr>
 
424
<td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
 
425
<td>
 
426
<code class="literal">TRUE</code> if the text in the list items is case sensitive.</td>
 
427
</tr>
 
428
</tbody>
 
429
</table></div>
 
430
</div>
 
431
<hr>
 
432
<div class="refsect2">
 
433
<a name="gtk-combo-set-item-string"></a><h3>gtk_combo_set_item_string ()</h3>
 
434
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_combo_set_item_string           (<em class="parameter"><code><a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> *combo</code></em>,
 
435
                                                         <em class="parameter"><code><a class="link" href="GtkItem.html" title="GtkItem"><span class="type">GtkItem</span></a> *item</code></em>,
 
436
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *item_value</code></em>);</pre>
 
437
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
438
<h3 class="title">Warning</h3>
 
439
<p><code class="literal">gtk_combo_set_item_string</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a class="link" href="GtkComboBox.html" title="GtkComboBox"><span class="type">GtkComboBox</span></a> instead.</p>
 
440
</div>
 
441
<p>
 
442
Sets the string to place in the <a class="link" href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a> field when a particular list item is
 
443
selected. This is needed if the list item is not a simple label.
 
444
</p>
 
445
<div class="variablelist"><table border="0" class="variablelist">
 
446
<colgroup>
 
447
<col align="left" valign="top">
 
448
<col>
 
449
</colgroup>
 
450
<tbody>
 
451
<tr>
 
452
<td><p><span class="term"><em class="parameter"><code>combo</code></em> :</span></p></td>
 
453
<td>a <a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a>.</td>
 
454
</tr>
 
455
<tr>
 
456
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
 
457
<td>a <a class="link" href="GtkItem.html" title="GtkItem"><span class="type">GtkItem</span></a>.</td>
 
458
</tr>
 
459
<tr>
 
460
<td><p><span class="term"><em class="parameter"><code>item_value</code></em> :</span></p></td>
 
461
<td>the string to place in the <a class="link" href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a> when <em class="parameter"><code>item</code></em> is selected.</td>
 
462
</tr>
 
463
</tbody>
 
464
</table></div>
 
465
</div>
 
466
<hr>
 
467
<div class="refsect2">
 
468
<a name="gtk-combo-disable-activate"></a><h3>gtk_combo_disable_activate ()</h3>
 
469
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_combo_disable_activate          (<em class="parameter"><code><a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> *combo</code></em>);</pre>
 
470
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
471
<h3 class="title">Warning</h3>
 
472
<p><code class="literal">gtk_combo_disable_activate</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a class="link" href="GtkComboBox.html" title="GtkComboBox"><span class="type">GtkComboBox</span></a> instead.</p>
 
473
</div>
 
474
<p>
 
475
Stops the <a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a> widget from showing the popup list when the <a class="link" href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
 
476
emits the "activate" signal, i.e. when the Return key is pressed.
 
477
This may be useful if, for example, you want the Return key to close a dialog
 
478
instead.
 
479
</p>
 
480
<div class="variablelist"><table border="0" class="variablelist">
 
481
<colgroup>
 
482
<col align="left" valign="top">
 
483
<col>
 
484
</colgroup>
 
485
<tbody><tr>
 
486
<td><p><span class="term"><em class="parameter"><code>combo</code></em> :</span></p></td>
 
487
<td>a <a class="link" href="GtkCombo.html" title="GtkCombo"><span class="type">GtkCombo</span></a>.</td>
 
488
</tr></tbody>
 
489
</table></div>
 
490
</div>
 
491
</div>
 
492
<div class="refsect1">
 
493
<a name="GtkCombo.property-details"></a><h2>Property Details</h2>
 
494
<div class="refsect2">
 
495
<a name="GtkCombo--allow-empty"></a><h3>The <code class="literal">"allow-empty"</code> property</h3>
 
496
<pre class="programlisting">  "allow-empty"              <span class="type">gboolean</span>              : Read / Write</pre>
 
497
<p>Whether an empty value may be entered in this field.</p>
 
498
<p>Default value: TRUE</p>
 
499
</div>
 
500
<hr>
 
501
<div class="refsect2">
 
502
<a name="GtkCombo--case-sensitive"></a><h3>The <code class="literal">"case-sensitive"</code> property</h3>
 
503
<pre class="programlisting">  "case-sensitive"           <span class="type">gboolean</span>              : Read / Write</pre>
 
504
<p>Whether list item matching is case sensitive.</p>
 
505
<p>Default value: FALSE</p>
 
506
</div>
 
507
<hr>
 
508
<div class="refsect2">
 
509
<a name="GtkCombo--enable-arrow-keys"></a><h3>The <code class="literal">"enable-arrow-keys"</code> property</h3>
 
510
<pre class="programlisting">  "enable-arrow-keys"        <span class="type">gboolean</span>              : Read / Write</pre>
 
511
<p>Whether the arrow keys move through the list of items.</p>
 
512
<p>Default value: TRUE</p>
 
513
</div>
 
514
<hr>
 
515
<div class="refsect2">
 
516
<a name="GtkCombo--enable-arrows-always"></a><h3>The <code class="literal">"enable-arrows-always"</code> property</h3>
 
517
<pre class="programlisting">  "enable-arrows-always"     <span class="type">gboolean</span>              : Read / Write</pre>
 
518
<p>Obsolete property, ignored.</p>
 
519
<p>Default value: TRUE</p>
 
520
</div>
 
521
<hr>
 
522
<div class="refsect2">
 
523
<a name="GtkCombo--value-in-list"></a><h3>The <code class="literal">"value-in-list"</code> property</h3>
 
524
<pre class="programlisting">  "value-in-list"            <span class="type">gboolean</span>              : Read / Write</pre>
 
525
<p>Whether entered values must already be present in the list.</p>
 
526
<p>Default value: FALSE</p>
 
527
</div>
 
528
</div>
 
529
</div>
 
530
<div class="footer">
 
531
<hr>
 
532
          Generated by GTK-Doc V1.18</div>
 
533
</body>
 
534
</html>
 
 
b'\\ No newline at end of file'