Files
gimp/devel-docs/libgimpwidgets/html/GimpIntStore.html
2010-08-11 01:21:39 -04:00

219 lines
9.0 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GimpIntStore</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
<link rel="up" href="libgimpwidgets-widgets.html" title="Part&#160;I.&#160;GIMP Widgets">
<link rel="prev" href="GimpIntComboBox.html" title="GimpIntComboBox">
<link rel="next" href="GimpMemsizeEntry.html" title="GimpMemsizeEntry">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpwidgets-widgets.html" title="Part&#160;I.&#160;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&#160;II.&#160;GIMP Display Filters">
<link rel="part" href="libgimpwidgets-colorselector.html" title="Part&#160;III.&#160;GIMP Color Selectors">
<link rel="part" href="libgimpwidgets-controller.html" title="Part&#160;IV.&#160;GIMP Controllers">
<link rel="part" href="libgimpwidgets-utils.html" title="Part&#160;V.&#160;GIMP Widgets Utilities">
<link rel="part" href="libgimpwidgets-deprecated.html" title="Part&#160;VI.&#160;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-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="GimpIntComboBox.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="GimpMemsizeEntry.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="#id2585239" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2610526" class="shortcut">Description</a>
&#160;|&#160;
<a href="#id2610417" class="shortcut">Object Hierarchy</a>
&#160;|&#160;
<a href="#id2610455" class="shortcut">Implemented Interfaces</a>
&#160;|&#160;
<a href="#id2610495" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GimpIntStore"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2585239"></a><span class="refentrytitle">GimpIntStore</span>
</h2>
<p>GimpIntStore &#8212; A model for integer based name-value pairs (e.g. enums)</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="GimpIntStore.html#GimpIntStore-struct">GimpIntStore</a>;
enum <a href="GimpIntStore.html#GimpIntStoreColumns">GimpIntStoreColumns</a>;
GtkListStore* <a href="GimpIntStore.html#gimp-int-store-new">gimp_int_store_new</a> (void);
gboolean <a href="GimpIntStore.html#gimp-int-store-lookup-by-value">gimp_int_store_lookup_by_value</a> (GtkTreeModel *model,
gint value,
GtkTreeIter *iter);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2610417"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GtkListStore
+----GimpIntStore
+----<a href="GimpEnumStore.html" title="GimpEnumStore">GimpEnumStore</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2610455"></a><h2>Implemented Interfaces</h2>
<p>
GimpIntStore implements
GtkTreeModel, GtkTreeDragSource, GtkTreeDragDest and GtkTreeSortable.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2610495"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GimpIntStore.html#GimpIntStore--user-data-type">user-data-type</a>" GType : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2610526"></a><h2>Description</h2>
<p>
A model for integer based name-value pairs (e.g. enums)
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2596362"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2596372"></a><h3>
<a name="GimpIntStore-struct"></a>GimpIntStore</h3>
<a class="indexterm" name="id2596385"></a><pre class="programlisting">typedef struct _GimpIntStore GimpIntStore;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2596400"></a><h3>
<a name="GimpIntStoreColumns"></a>enum GimpIntStoreColumns</h3>
<a class="indexterm" name="id2596413"></a><pre class="programlisting">typedef enum
{
GIMP_INT_STORE_VALUE,
GIMP_INT_STORE_LABEL,
GIMP_INT_STORE_STOCK_ID,
GIMP_INT_STORE_PIXBUF,
GIMP_INT_STORE_USER_DATA,
GIMP_INT_STORE_NUM_COLUMNS
} GimpIntStoreColumns;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2596431"></a><h3>
<a name="gimp-int-store-new"></a>gimp_int_store_new ()</h3>
<a class="indexterm" name="id2596446"></a><pre class="programlisting">GtkListStore* gimp_int_store_new (void);</pre>
<p>
Creates a <span class="type">GtkListStore</span> with a number of useful columns.
<a href="GimpIntStore.html" title="GimpIntStore"><span class="type">GimpIntStore</span></a> is especially useful if the items you want to store
are identified using an integer value.</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>&#160;:</span></td>
<td> a new <a href="GimpIntStore.html" title="GimpIntStore"><span class="type">GimpIntStore</span></a>.
</td>
</tr></tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2596516"></a><h3>
<a name="gimp-int-store-lookup-by-value"></a>gimp_int_store_lookup_by_value ()</h3>
<a class="indexterm" name="id2612869"></a><pre class="programlisting">gboolean gimp_int_store_lookup_by_value (GtkTreeModel *model,
gint value,
GtkTreeIter *iter);</pre>
<p>
Iterate over the <em class="parameter"><code>model</code></em> looking for <em class="parameter"><code>value</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>model</code></em>&#160;:</span></td>
<td> a <a href="GimpIntStore.html" title="GimpIntStore"><span class="type">GimpIntStore</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> an integer value to lookup in the <em class="parameter"><code>model</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>iter</code></em>&#160;:</span></td>
<td> return location for the iter of the given <em class="parameter"><code>value</code></em>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if the value has been located and <em class="parameter"><code>iter</code></em> is
valid, <code class="literal">FALSE</code> otherwise.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2613037"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2613047"></a><h3>
<a name="GimpIntStore--user-data-type"></a>The "<code class="literal">user-data-type</code>" property</h3>
<a class="indexterm" name="id2613061"></a><pre class="programlisting"> "user-data-type" GType : Read / Write / Construct Only</pre>
<p>
Allows to set the <span class="type">GType</span> for the GIMP_INT_STORE_USER_DATA column.
</p>
<p>
You need to set this property when constructing the store if you want
to use the GIMP_INT_STORE_USER_DATA column and want to have the store
handle ref-counting of your user data.</p>
<p>
</p>
<p>Since GIMP 2.4
</p>
</div>
</div>
</div>
</body>
</html>