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

228 lines
9.8 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>gimpimagecombobox</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimpui.html" title="Part II. GIMP User Interface Library">
<link rel="prev" href="libgimp-GimpItemComboBox.html" title="GimpItemComboBox">
<link rel="next" href="libgimp-gimppixbuf.html" title="gimppixbuf">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimp.html" title="Part I. GIMP Library">
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="part" href="libgimpui.html" title="Part II. GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="libgimp-index.html" title="Index">
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimp-index-new-in-2-6.html" title="Index of new symbols in GIMP 2.6">
<link rel="index" href="libgimp-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="libgimp-GimpItemComboBox.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpui.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 Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimppixbuf.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="#GimpImageComboBox.synopsis" class="shortcut">Top</a>
 | 
<a href="#GimpImageComboBox.description" class="shortcut">Description</a>
 | 
<a href="#GimpImageComboBox.object-hierarchy" class="shortcut">Object Hierarchy</a>
 | 
<a href="#GimpImageComboBox.implemented-interfaces" class="shortcut">Implemented Interfaces</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GimpImageComboBox"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GimpImageComboBox.top_of_page"></a>gimpimagecombobox</span></h2>
<p>gimpimagecombobox — A widget providing a popup menu of images.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GimpImageComboBox.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="GimpImageComboBox.html#GimpImageComboBox-struct" title="GimpImageComboBox">GimpImageComboBox</a>;
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> (<a class="link" href="GimpImageComboBox.html#GimpImageConstraintFunc" title="GimpImageConstraintFunc ()">*GimpImageConstraintFunc</a>) (gint32 image_id,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* <a class="link" href="GimpImageComboBox.html#gimp-image-combo-box-new" title="gimp_image_combo_box_new ()">gimp_image_combo_box_new</a> (<a class="link" href="GimpImageComboBox.html#GimpImageConstraintFunc" title="GimpImageConstraintFunc ()">GimpImageConstraintFunc</a> constraint,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GimpImageComboBox.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
href="../libgimpwidgets/GimpIntComboBox.html"
>GimpIntComboBox</a>
+----GimpImageComboBox
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GimpImageComboBox.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GimpImageComboBox implements
AtkImplementorIface, <a
href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable"
>GtkBuildable</a>, <a
href="/usr/share/gtk-doc/html/gtk/GtkCellLayout.html"
>GtkCellLayout</a> and <a
href="/usr/share/gtk-doc/html/gtk/GtkCellEditable.html"
>GtkCellEditable</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="GimpImageComboBox.description"></a><h2>Description</h2>
<p>
A widget providing a popup menu of images.
</p>
</div>
<div class="refsect1" lang="en">
<a name="GimpImageComboBox.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GimpImageComboBox-struct"></a><h3>GimpImageComboBox</h3>
<pre class="programlisting">typedef struct _GimpImageComboBox GimpImageComboBox;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpImageConstraintFunc"></a><h3>GimpImageConstraintFunc ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> (*GimpImageConstraintFunc) (gint32 image_id,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_id</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</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>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gimp-image-combo-box-new"></a><h3>gimp_image_combo_box_new ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* gimp_image_combo_box_new (<a class="link" href="GimpImageComboBox.html#GimpImageConstraintFunc" title="GimpImageConstraintFunc ()">GimpImageConstraintFunc</a> constraint,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);</pre>
<p>
Creates a new <a
href="../libgimpwidgets/GimpIntComboBox.html"
><span class="type">GimpIntComboBox</span></a> filled with all currently opened
images. If a <em class="parameter"><code>constraint</code></em> function is specified, it is called for
each image and only if the function returns <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>, the image is
added to the combobox.
</p>
<p>
You should use <code class="function">gimp_int_combo_connect()</code> to initialize and connect
the combo. Use <a
href="../libgimpwidgets/GimpIntComboBox.html#gimp-int-combo-box-set-active"
><code class="function">gimp_int_combo_box_set_active()</code></a> to get the active
image ID and <a
href="../libgimpwidgets/GimpIntComboBox.html#gimp-int-combo-box-get-active"
><code class="function">gimp_int_combo_box_get_active()</code></a> to retrieve the ID of
the selected image.</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>constraint</code></em> :</span></p></td>
<td> a <a class="link" href="GimpImageComboBox.html#GimpImageConstraintFunc" title="GimpImageConstraintFunc ()"><span class="type">GimpImageConstraintFunc</span></a> or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td> a pointer that is passed to <em class="parameter"><code>constraint</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a
href="../libgimpwidgets/GimpIntComboBox.html"
><span class="type">GimpIntComboBox</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>