|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/gtk-doc/html/gtk/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GtkComboBoxEntry</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GTK+ Reference Manual">
<link rel="up" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="prev" href="GtkComboBox.html" title="GtkComboBox">
<link rel="next" href="GtkMenu.html" title="GtkMenu">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and
GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
</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="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkComboBox.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="MenusAndCombos.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ Reference Manual</th>
<td><a accesskey="n" href="GtkMenu.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3268784" class="shortcut">Top</a>
 | 
<a href="#id3269066" class="shortcut">Description</a>
 | 
<a href="#id3268925" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id3268994" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id3269032" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkComboBoxEntry"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id3268784"></a><span class="refentrytitle">GtkComboBoxEntry</span>
</h2>
<p>GtkComboBoxEntry — A text entry field with a dropdown list</p>
</td>
<td valign="top" align="right"><img src="combo-box-entry.png"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <gtk/gtk.h>
<a href="GtkComboBoxEntry.html#GtkComboBoxEntry-struct">GtkComboBoxEntry</a>;
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkComboBoxEntry.html#gtk-combo-box-entry-new">gtk_combo_box_entry_new</a> (void);
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkComboBoxEntry.html#gtk-combo-box-entry-new-with-model">gtk_combo_box_entry_new_with_model</a>
(<a href="GtkTreeModel.html" title="GtkTreeModel">GtkTreeModel</a> *model,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> text_column);
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkComboBoxEntry.html#gtk-combo-box-entry-new-text">gtk_combo_box_entry_new_text</a> (void);
void <a href="GtkComboBoxEntry.html#gtk-combo-box-entry-set-text-column">gtk_combo_box_entry_set_text_column</a>
(<a href="GtkComboBoxEntry.html" title="GtkComboBoxEntry">GtkComboBoxEntry</a> *entry_box,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> text_column);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="GtkComboBoxEntry.html#gtk-combo-box-entry-get-text-column">gtk_combo_box_entry_get_text_column</a>
(<a href="GtkComboBoxEntry.html" title="GtkComboBoxEntry">GtkComboBoxEntry</a> *entry_box);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3268925"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a href="GtkObject.html" title="GtkObject">GtkObject</a>
+----<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
+----<a href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
+----<a href="GtkBin.html" title="GtkBin">GtkBin</a>
+----<a href="GtkComboBox.html" title="GtkComboBox">GtkComboBox</a>
+----GtkComboBoxEntry
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3268994"></a><h2>Implemented Interfaces</h2>
<p>
GtkComboBoxEntry implements
AtkImplementorIface, <a href="GtkCellEditable.html" title="GtkCellEditable">GtkCellEditable</a> and <a href="GtkCellLayout.html" title="GtkCellLayout">GtkCellLayout</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="id3269032"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GtkComboBoxEntry.html#GtkComboBoxEntry--text-column">text-column</a>" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3269066"></a><h2>Description</h2>
<p>
A <a href="GtkComboBoxEntry.html" title="GtkComboBoxEntry"><span class="type">GtkComboBoxEntry</span></a> is a widget that allows the user to choose from a
list of valid choices or enter a different value. It is very similar
to a <a href="GtkComboBox.html" title="GtkComboBox"><span class="type">GtkComboBox</span></a>, but it displays the selected value in an entry to
allow modifying it.
</p>
<p>
In contrast to a <a href="GtkComboBox.html" title="GtkComboBox"><span class="type">GtkComboBox</span></a>, the underlying model of a <a href="GtkComboBoxEntry.html" title="GtkComboBoxEntry"><span class="type">GtkComboBoxEntry</span></a>
must always have a text column (see <a href="GtkComboBoxEntry.html#gtk-combo-box-entry-set-text-column"><code class="function">gtk_combo_box_entry_set_text_column()</code></a>),
and the entry will show the content of the text column in the selected row. To
get the text from the entry, use <a href="GtkComboBox.html#gtk-combo-box-get-active-text"><code class="function">gtk_combo_box_get_active_text()</code></a>.
</p>
<p>The changed signal will be emitted while typing into a GtkComboBoxEntry,
as well as when selecting an item from the GtkComboBoxEntry's list. Use
<a href="GtkComboBox.html#gtk-combo-box-get-active"><code class="function">gtk_combo_box_get_active()</code></a> or <a href="GtkComboBox.html#gtk-combo-box-get-active-iter"><code class="function">gtk_combo_box_get_active_iter()</code></a> to discover
whether an item was actually selected from the list.
</p>
<p>Connect to the activate signal of the GtkEntry (use <a href="GtkBin.html#gtk-bin-get-child"><code class="function">gtk_bin_get_child()</code></a>) to
detect when the user actually finishes entering text.</p>
<p>
The convenience API to construct simple text-only <a href="GtkComboBox.html" title="GtkComboBox"><span class="type">GtkComboBox</span></a>es can
also be used with <a href="GtkComboBoxEntry.html" title="GtkComboBoxEntry"><span class="type">GtkComboBoxEntry</span></a>s which have been constructed
with <a href="GtkComboBoxEntry.html#gtk-combo-box-entry-new-text"><code class="function">gtk_combo_box_entry_new_text()</code></a>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id3269226"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id3269237"></a><h3>
<a name="GtkComboBoxEntry-struct"></a>GtkComboBoxEntry</h3>
<a class="indexterm" name="id3269250"></a><pre class="programlisting">typedef struct _GtkComboBoxEntry GtkComboBoxEntry;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3269266"></a><h3>
<a name="gtk-combo-box-entry-new"></a>gtk_combo_box_entry_new ()</h3>
<a class="indexterm" name="id3269281"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_combo_box_entry_new (void);</pre>
<p>
Creates a new <a href="GtkComboBoxEntry.html" title="GtkComboBoxEntry"><span class="type">GtkComboBoxEntry</span></a> which has a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a> as child. After
construction, you should set a model using <a href="GtkComboBox.html#gtk-combo-box-set-model"><code class="function">gtk_combo_box_set_model()</code></a> and a
text_column * using <a href="GtkComboBoxEntry.html#gtk-combo-box-entry-set-text-column"><code class="function">gtk_combo_box_entry_set_text_column()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A new <a href="GtkComboBoxEntry.html" title="GtkComboBoxEntry"><span class="type">GtkComboBoxEntry</span></a>.
</td>
</tr></tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3269374"></a><h3>
<a name="gtk-combo-box-entry-new-with-model"></a>gtk_combo_box_entry_new_with_model ()</h3>
<a class="indexterm" name="id3269390"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_combo_box_entry_new_with_model
(<a href="GtkTreeModel.html" title="GtkTreeModel">GtkTreeModel</a> *model,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> text_column);</pre>
<p>
Creates a new <a href="GtkComboBoxEntry.html" title="GtkComboBoxEntry"><span class="type">GtkComboBoxEntry</span></a> which has a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a> as child and a list
of strings as popup. You can get the <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a> from a <a href="GtkComboBoxEntry.html" title="GtkComboBoxEntry"><span class="type">GtkComboBoxEntry</span></a>
using GTK_ENTRY (GTK_BIN (combo_box_entry)->child). To add and remove
strings from the list, just modify <em class="parameter"><code>model</code></em> using its data manipulation
API.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>model</code></em> :</span></td>
<td> A <a href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>text_column</code></em> :</span></td>
<td> A column in <em class="parameter"><code>model</code></em> to get the strings from.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A new <a href="GtkComboBoxEntry.html" title="GtkComboBoxEntry"><span class="type">GtkComboBoxEntry</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3269541"></a><h3>
<a name="gtk-combo-box-entry-new-text"></a>gtk_combo_box_entry_new_text ()</h3>
<a class="indexterm" name="id3269557"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_combo_box_entry_new_text (void);</pre>
<p>
Convenience function which constructs a new editable text combo box, which
is a <a href="GtkComboBoxEntry.html" title="GtkComboBoxEntry"><span class="type">GtkComboBoxEntry</span></a> just displaying strings. If you use this function to
create a text combo box, you should only manipulate its data source with
the following convenience functions: <a href="GtkComboBox.html#gtk-combo-box-append-text"><code class="function">gtk_combo_box_append_text()</code></a>,
<a href="GtkComboBox.html#gtk-combo-box-insert-text"><code class="function">gtk_combo_box_insert_text()</code></a>, <a href="GtkComboBox.html#gtk-combo-box-prepend-text"><code class="function">gtk_combo_box_prepend_text()</code></a> and
<a href="GtkComboBox.html#gtk-combo-box-remove-text"><code class="function">gtk_combo_box_remove_text()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A new text <a href="GtkComboBoxEntry.html" title="GtkComboBoxEntry"><span class="type">GtkComboBoxEntry</span></a>.
</td>
</tr></tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3269665"></a><h3>
<a name="gtk-combo-box-entry-set-text-column"></a>gtk_combo_box_entry_set_text_column ()</h3>
<a class="indexterm" name="id3269682"></a><pre class="programlisting">void gtk_combo_box_entry_set_text_column
(<a href="GtkComboBoxEntry.html" title="GtkComboBoxEntry">GtkComboBoxEntry</a> *entry_box,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> text_column);</pre>
<p>
Sets the model column which <em class="parameter"><code>entry_box</code></em> should use to get strings from
to be <em class="parameter"><code>text_column</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry_box</code></em> :</span></td>
<td> A <a href="GtkComboBoxEntry.html" title="GtkComboBoxEntry"><span class="type">GtkComboBoxEntry</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>text_column</code></em> :</span></td>
<td> A column in <em class="parameter"><code>model</code></em> to get the strings from.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3269785"></a><h3>
<a name="gtk-combo-box-entry-get-text-column"></a>gtk_combo_box_entry_get_text_column ()</h3>
<a class="indexterm" name="id3269802"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gtk_combo_box_entry_get_text_column
(<a href="GtkComboBoxEntry.html" title="GtkComboBoxEntry">GtkComboBoxEntry</a> *entry_box);</pre>
<p>
Returns the column which <em class="parameter"><code>entry_box</code></em> is using to get the strings from.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry_box</code></em> :</span></td>
<td> A <a href="GtkComboBoxEntry.html" title="GtkComboBoxEntry"><span class="type">GtkComboBoxEntry</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A column in the data source model of <em class="parameter"><code>entry_box</code></em>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3269889"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id3269900"></a><h3>
<a name="GtkComboBoxEntry--text-column"></a>The "<code class="literal">text-column</code>" property</h3>
<a class="indexterm" name="id3269916"></a><pre class="programlisting"> "text-column" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read / Write</pre>
<p>A column in the data source model to get the strings from.</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3269948"></a><h2>See Also</h2>
<p>
<a href="GtkComboBox.html" title="GtkComboBox"><span class="type">GtkComboBox</span></a>
</p>
</div>
</div>
</body>
</html>