Files
gimp/devel-docs/libgimpwidgets/html/GimpStringComboBox.html
2010-08-11 01:27:19 -04:00

317 lines
15 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GimpStringComboBox</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual">
<link rel="up" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
<link rel="prev" href="GimpSizeEntry.html" title="GimpSizeEntry">
<link rel="next" href="GimpUnitMenu.html" title="GimpUnitMenu">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
<link rel="chapter" href="libgimpwidgets-gallery.html" title="Widget Gallery">
<link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView">
<link rel="part" href="libgimpwidgets-colordisplay.html" title="Part II. GIMP Display Filters">
<link rel="part" href="libgimpwidgets-colorselector.html" title="Part III. GIMP Color Selectors">
<link rel="part" href="libgimpwidgets-controller.html" title="Part IV. GIMP Controllers">
<link rel="part" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
<link rel="part" href="libgimpwidgets-deprecated.html" title="Part VI. Deprecated API">
<link rel="index" href="libgimpwidgets-index.html" title="Index">
<link rel="index" href="libgimpwidgets-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimpwidgets-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimpwidgets-index-new-in-2-6.html" title="Index of new symbols in GIMP 2.6">
<link rel="index" href="libgimpwidgets-index-deprecated.html" title="Index of deprecated symbols">
</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="GimpSizeEntry.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpwidgets-widgets.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">GIMP Widgets Library Reference Manual</th>
<td><a accesskey="n" href="GimpUnitMenu.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GimpStringComboBox.synopsis" class="shortcut">Top</a>
 | 
<a href="#GimpStringComboBox.description" class="shortcut">Description</a>
 | 
<a href="#GimpStringComboBox.object-hierarchy" class="shortcut">Object Hierarchy</a>
 | 
<a href="#GimpStringComboBox.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#GimpStringComboBox.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="GimpStringComboBox">
<a name="GimpStringComboBox"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GimpStringComboBox.top_of_page"></a>GimpStringComboBox</span></h2>
<p>GimpStringComboBox</p>
</td>
<td valign="top" align="right"><img src="gimp-string-combo-box.png"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="GimpStringComboBox.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="GimpStringComboBox.html#GimpStringComboBox-struct" title="GimpStringComboBox">GimpStringComboBox</a>;
<a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
>GtkWidget</a> * <a class="link" href="GimpStringComboBox.html#gimp-string-combo-box-new" title="gimp_string_combo_box_new ()">gimp_string_combo_box_new</a> (<a
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html"
>GtkTreeModel</a> *model,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> id_column,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> label_column);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="GimpStringComboBox.html#gimp-string-combo-box-set-active" title="gimp_string_combo_box_set_active ()">gimp_string_combo_box_set_active</a> (<a class="link" href="GimpStringComboBox.html" title="GimpStringComboBox">GimpStringComboBox</a> *combo_box,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *id);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> * <a class="link" href="GimpStringComboBox.html#gimp-string-combo-box-get-active" title="gimp_string_combo_box_get_active ()">gimp_string_combo_box_get_active</a> (<a class="link" href="GimpStringComboBox.html" title="GimpStringComboBox">GimpStringComboBox</a> *combo_box);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="GimpStringComboBox.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a
href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html"
>GtkObject</a>
+----<a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
>GtkWidget</a>
+----<a
href="http://library.gnome.org/devel/gtk/unstable/GtkContainer.html"
>GtkContainer</a>
+----<a
href="http://library.gnome.org/devel/gtk/unstable/GtkBin.html"
>GtkBin</a>
+----<a
href="http://library.gnome.org/devel/gtk/unstable/GtkComboBox.html"
>GtkComboBox</a>
+----GimpStringComboBox
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="GimpStringComboBox.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GimpStringComboBox implements
<a
href="http://library.gnome.org/devel/gtk/unstable/gtk-gtkbuildable.html#GtkBuildable"
>GtkBuildable</a>, AtkImplementorIface, <a
href="http://library.gnome.org/devel/gtk/unstable/GtkCellEditable.html"
>GtkCellEditable</a> and <a
href="http://library.gnome.org/devel/gtk/unstable/GtkCellLayout.html"
>GtkCellLayout</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="GimpStringComboBox.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GimpStringComboBox.html#GimpStringComboBox--ellipsize" title='The "ellipsize" property'>ellipsize</a>" <a
href="/usr/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"
>PangoEllipsizeMode</a> : Read / Write
"<a class="link" href="GimpStringComboBox.html#GimpStringComboBox--id-column" title='The "id-column" property'>id-column</a>" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> : Read / Write / Construct Only
"<a class="link" href="GimpStringComboBox.html#GimpStringComboBox--label-column" title='The "label-column" property'>label-column</a>" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" title="Description">
<a name="GimpStringComboBox.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="GimpStringComboBox.details"></a><h2>Details</h2>
<div class="refsect2" title="GimpStringComboBox">
<a name="GimpStringComboBox-struct"></a><h3>GimpStringComboBox</h3>
<pre class="programlisting">typedef struct _GimpStringComboBox GimpStringComboBox;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="gimp_string_combo_box_new ()">
<a name="gimp-string-combo-box-new"></a><h3>gimp_string_combo_box_new ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
>GtkWidget</a> * gimp_string_combo_box_new (<a
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html"
>GtkTreeModel</a> *model,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> id_column,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> label_column);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id_column</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>label_column</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="GimpStringComboBox.html" title="GimpStringComboBox"><span class="type">GimpStringComboBox</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2" title="gimp_string_combo_box_set_active ()">
<a name="gimp-string-combo-box-set-active"></a><h3>gimp_string_combo_box_set_active ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_string_combo_box_set_active (<a class="link" href="GimpStringComboBox.html" title="GimpStringComboBox">GimpStringComboBox</a> *combo_box,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *id);</pre>
<p>
Looks up the item that belongs to the given <em class="parameter"><code>id</code></em> and makes it the
selected item in the <em class="parameter"><code>combo_box</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>combo_box</code></em> :</span></p></td>
<td> a <a class="link" href="GimpStringComboBox.html" title="GimpStringComboBox"><span class="type">GimpStringComboBox</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
><code class="literal">TRUE</code></a> on success or <a
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
><code class="literal">FALSE</code></a> if there was no item for
this value.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2" title="gimp_string_combo_box_get_active ()">
<a name="gimp-string-combo-box-get-active"></a><h3>gimp_string_combo_box_get_active ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> * gimp_string_combo_box_get_active (<a class="link" href="GimpStringComboBox.html" title="GimpStringComboBox">GimpStringComboBox</a> *combo_box);</pre>
<p>
Retrieves the value of the selected (active) item in the <em class="parameter"><code>combo_box</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>combo_box</code></em> :</span></p></td>
<td> a <a class="link" href="GimpStringComboBox.html" title="GimpStringComboBox"><span class="type">GimpStringComboBox</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> newly allocated ID string or <a
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a> if nothing was selected
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="GimpStringComboBox.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "ellipsize" property'>
<a name="GimpStringComboBox--ellipsize"></a><h3>The <code class="literal">"ellipsize"</code> property</h3>
<pre class="programlisting"> "ellipsize" <a
href="/usr/share/gtk-doc/html/pango/pango-Layout-Objects.html#PangoEllipsizeMode"
>PangoEllipsizeMode</a> : Read / Write</pre>
<p>
Specifies the preferred place to ellipsize text in the combo-box,
if the cell renderer does not have enough room to display the
entire string.</p>
<p>
</p>
<p>Default value: PANGO_ELLIPSIZE_NONE</p>
<p>Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2" title='The "id-column" property'>
<a name="GimpStringComboBox--id-column"></a><h3>The <code class="literal">"id-column"</code> property</h3>
<pre class="programlisting"> "id-column" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> : Read / Write / Construct Only</pre>
<p>
The column in the associated GtkTreeModel that holds strings to
be used as labels in the combo-box.</p>
<p>
</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 0</p>
<p>Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2" title='The "label-column" property'>
<a name="GimpStringComboBox--label-column"></a><h3>The <code class="literal">"label-column"</code> property</h3>
<pre class="programlisting"> "label-column" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> : Read / Write / Construct Only</pre>
<p></p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>