Files
gimp/devel-docs/libgimpwidgets/html/GimpEnumComboBox.html
2010-08-11 01:26:23 -04:00

262 lines
12 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>GimpEnumComboBox</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" 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="GimpEnumStore.html" title="GimpEnumStore">
<link rel="next" href="GimpEnumLabel.html" title="GimpEnumLabel">
<meta name="generator" content="GTK-Doc V1.10 (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="GimpEnumStore.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="GimpEnumLabel.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="#GimpEnumComboBox.synopsis" class="shortcut">Top</a>
 | 
<a href="#GimpEnumComboBox.description" class="shortcut">Description</a>
 | 
<a href="#GimpEnumComboBox.object-hierarchy" class="shortcut">Object Hierarchy</a>
 | 
<a href="#GimpEnumComboBox.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#GimpEnumComboBox.properties" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GimpEnumComboBox"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GimpEnumComboBox.top_of_page"></a>GimpEnumComboBox</span></h2>
<p>GimpEnumComboBox</p>
</td>
<td valign="top" align="right"><img src="gimp-enum-combo-box.png"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GimpEnumComboBox.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="GimpEnumComboBox.html#GimpEnumComboBox-struct" title="GimpEnumComboBox">GimpEnumComboBox</a>;
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* <a class="link" href="GimpEnumComboBox.html#gimp-enum-combo-box-new" title="gimp_enum_combo_box_new ()">gimp_enum_combo_box_new</a> (<a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
>GType</a> enum_type);
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* <a class="link" href="GimpEnumComboBox.html#gimp-enum-combo-box-new-with-model" title="gimp_enum_combo_box_new_with_model ()">gimp_enum_combo_box_new_with_model</a> (<a class="link" href="GimpEnumStore.html" title="GimpEnumStore">GimpEnumStore</a> *enum_store);
void <a class="link" href="GimpEnumComboBox.html#gimp-enum-combo-box-set-stock-prefix" title="gimp_enum_combo_box_set_stock_prefix ()">gimp_enum_combo_box_set_stock_prefix</a>
(<a class="link" href="GimpEnumComboBox.html" title="GimpEnumComboBox">GimpEnumComboBox</a> *combo_box,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *stock_prefix);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GimpEnumComboBox.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
>GtkObject</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkContainer.html"
>GtkContainer</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkBin.html"
>GtkBin</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkComboBox.html"
>GtkComboBox</a>
+----<a class="link" href="GimpIntComboBox.html" title="GimpIntComboBox">GimpIntComboBox</a>
+----GimpEnumComboBox
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GimpEnumComboBox.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GimpEnumComboBox implements
AtkImplementorIface, <a
href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable"
>GtkBuildable</a>, <a
href="/usr/share/gtk-doc/html/gtk/GtkCellEditable.html"
>GtkCellEditable</a> and <a
href="/usr/share/gtk-doc/html/gtk/GtkCellLayout.html"
>GtkCellLayout</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="GimpEnumComboBox.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GimpEnumComboBox.html#GimpEnumComboBox--model" title='The "model" property'>model</a>" <a class="link" href="GimpEnumStore.html" title="GimpEnumStore">GimpEnumStore</a>* : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GimpEnumComboBox.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="GimpEnumComboBox.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GimpEnumComboBox-struct"></a><h3>GimpEnumComboBox</h3>
<pre class="programlisting">typedef struct _GimpEnumComboBox GimpEnumComboBox;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gimp-enum-combo-box-new"></a><h3>gimp_enum_combo_box_new ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* gimp_enum_combo_box_new (<a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
>GType</a> enum_type);</pre>
<p>
Creates a <a
href="/usr/share/gtk-doc/html/gtk/GtkComboBox.html"
><span class="type">GtkComboBox</span></a> readily filled with all enum values from a
given <em class="parameter"><code>enum_type</code></em>. The enum needs to be registered to the type
system. It should also have <a
href="../libgimpbase/libgimpbase-gimpbasetypes.html#GimpEnumDesc"
><code class="literal">GimpEnumDesc</code></a> descriptions registered
that contain translatable value names. This is the case for the
enums used in the GIMP PDB functions.
</p>
<p>
This is just a convenience function. If you need more control over
the enum values that appear in the combo_box, you can create your
own <a class="link" href="GimpEnumStore.html" title="GimpEnumStore"><span class="type">GimpEnumStore</span></a> and use <a class="link" href="GimpEnumComboBox.html#gimp-enum-combo-box-new-with-model" title="gimp_enum_combo_box_new_with_model ()"><code class="function">gimp_enum_combo_box_new_with_model()</code></a>.</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>enum_type</code></em> :</span></p></td>
<td> the <a
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
><span class="type">GType</span></a> of an enum.
</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="GimpEnumComboBox.html" title="GimpEnumComboBox"><span class="type">GimpEnumComboBox</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gimp-enum-combo-box-new-with-model"></a><h3>gimp_enum_combo_box_new_with_model ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* gimp_enum_combo_box_new_with_model (<a class="link" href="GimpEnumStore.html" title="GimpEnumStore">GimpEnumStore</a> *enum_store);</pre>
<p>
Creates a <a
href="/usr/share/gtk-doc/html/gtk/GtkComboBox.html"
><span class="type">GtkComboBox</span></a> for the given <em class="parameter"><code>enum_store</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>enum_store</code></em> :</span></p></td>
<td> a <a class="link" href="GimpEnumStore.html" title="GimpEnumStore"><span class="type">GimpEnumStore</span></a> to use as the model
</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="GimpEnumComboBox.html" title="GimpEnumComboBox"><span class="type">GimpEnumComboBox</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gimp-enum-combo-box-set-stock-prefix"></a><h3>gimp_enum_combo_box_set_stock_prefix ()</h3>
<pre class="programlisting">void gimp_enum_combo_box_set_stock_prefix
(<a class="link" href="GimpEnumComboBox.html" title="GimpEnumComboBox">GimpEnumComboBox</a> *combo_box,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *stock_prefix);</pre>
<p>
Attempts to create stock icons for all items in the <em class="parameter"><code>combo_box</code></em>. See
<code class="function">gimp_enum_store_set_icons()</code> to find out what to use as <em class="parameter"><code>stock_prefix</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="GimpEnumComboBox.html" title="GimpEnumComboBox"><span class="type">GimpEnumComboBox</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>stock_prefix</code></em> :</span></p></td>
<td> a prefix to create icon stock ID from enum values
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="GimpEnumComboBox.property-details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="GimpEnumComboBox--model"></a><h3>The <code class="literal">"model"</code> property</h3>
<pre class="programlisting"> "model" <a class="link" href="GimpEnumStore.html" title="GimpEnumStore">GimpEnumStore</a>* : Read / Write</pre>
<p></p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>