callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Imported Upstream version 2.8.14

Browse Source
This commit is contained in:
Ari Pollak
2014-09-20 13:16:57 -04:00
parent b8aa0b67d1
commit bf2f572083
929 changed files with 308006 additions and 240437 deletions
Download Patch File Download Diff File Expand all files Collapse all files

330
devel-docs/libgimpwidgets/html/GimpIntStore.html
View File

@ -2,36 +2,29 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GimpIntStore</title>
<title>GIMP Widgets Library Reference Manual: GimpIntStore</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<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="GimpIntComboBox.html" title="GimpIntComboBox">
<link rel="next" href="GimpMemsizeEntry.html" title="GimpMemSizeEntry">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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">
<a href="#GimpIntStore.synopsis" class="shortcut">Top</a>
 | 
<a href="#GimpIntStore.description" class="shortcut">Description</a>
 | 
<a href="#GimpIntStore.object-hierarchy" class="shortcut">Object Hierarchy</a>
 | 
<a href="#GimpIntStore.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#GimpIntStore.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#GimpIntStore.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
<a href="#GimpIntStore.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
<a href="#GimpIntStore.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
<a href="#GimpIntStore.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimpwidgets-widgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GimpIntComboBox.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GimpMemsizeEntry.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GimpIntStore"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
@ -40,25 +33,76 @@
<p>GimpIntStore — A model for integer based name-value pairs
(e.g. enums)</p>
</td>
<td valign="top" align="right"></td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GimpIntStore.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="GimpIntStore.html#GimpIntStore-struct" title="GimpIntStore">GimpIntStore</a>;
enum <a class="link" href="GimpIntStore.html#GimpIntStoreColumns" title="enum GimpIntStoreColumns">GimpIntStoreColumns</a>;
<span class="returnvalue">GtkListStore</span> * <a class="link" href="GimpIntStore.html#gimp-int-store-new" title="gimp_int_store_new ()">gimp_int_store_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="GimpIntStore.html#gimp-int-store-lookup-by-value" title="gimp_int_store_lookup_by_value ()">gimp_int_store_lookup_by_value</a> (<em class="parameter"><code><span class="type">GtkTreeModel</span> *model</code></em>,
<em class="parameter"><code><span class="type">gint</span> value</code></em>,
<em class="parameter"><code><span class="type">GtkTreeIter</span> *iter</code></em>);
</pre>
<div class="refsect1">
<a name="GimpIntStore.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GtkListStore</span> *
</td>
<td class="function_name">
<a class="link" href="GimpIntStore.html#gimp-int-store-new" title="gimp_int_store_new ()">gimp_int_store_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GimpIntStore.html#gimp-int-store-lookup-by-value" title="gimp_int_store_lookup_by_value ()">gimp_int_store_lookup_by_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpIntStore.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<span class="type">GType</span> *</td>
<td class="property_name"><a class="link" href="GimpIntStore.html#GimpIntStore--user-data-type" title="The “user-data-type” property">user-data-type</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpIntStore.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GimpIntStore.html#GimpIntStore-struct" title="GimpIntStore">GimpIntStore</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GimpIntStore.html#GimpIntStoreColumns" title="enum GimpIntStoreColumns">GimpIntStoreColumns</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpIntStore.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GtkListStore
+----GimpIntStore
+----<a class="link" href="GimpEnumStore.html" title="GimpEnumStore">GimpEnumStore</a>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GtkListStore
<span class="lineart">╰──</span> GimpIntStore
<span class="lineart">╰──</span> <a class="link" href="GimpEnumStore.html" title="GimpEnumStore">GimpEnumStore</a>
</pre>
</div>
<div class="refsect1">
@ -68,19 +112,76 @@ GimpIntStore implements
GtkTreeModel, GtkTreeDragSource, GtkTreeDragDest, GtkTreeSortable and GtkBuildable.</p>
</div>
<div class="refsect1">
<a name="GimpIntStore.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GimpIntStore.html#GimpIntStore--user-data-type" title='The "user-data-type" property'>user-data-type</a>" <span class="type">GType</span>* : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="GimpIntStore.description"></a><h2>Description</h2>
<p>
A model for integer based name-value pairs (e.g. enums)
</p>
<p>A model for integer based name-value pairs (e.g. enums)</p>
</div>
<div class="refsect1">
<a name="GimpIntStore.details"></a><h2>Details</h2>
<a name="GimpIntStore.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-int-store-new"></a><h3>gimp_int_store_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkListStore</span> *
gimp_int_store_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a <span class="type">GtkListStore</span> with a number of useful columns.
<a class="link" 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>
<div class="refsect3">
<a name="id-1.2.22.9.2.5"></a><h4>Returns</h4>
<p> a new <a class="link" href="GimpIntStore.html" title="GimpIntStore"><span class="type">GimpIntStore</span></a>.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-int-store-lookup-by-value"></a><h3>gimp_int_store_lookup_by_value ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_int_store_lookup_by_value (<em class="parameter"><code><span class="type">GtkTreeModel</span> *model</code></em>,
<em class="parameter"><code><span class="type">gint</span> value</code></em>,
<em class="parameter"><code><span class="type">GtkTreeIter</span> *iter</code></em>);</pre>
<p>Iterate over the <em class="parameter"><code>model</code></em>
looking for <em class="parameter"><code>value</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.22.9.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>model</p></td>
<td class="parameter_description"><p>a <a class="link" href="GimpIntStore.html" title="GimpIntStore"><span class="type">GimpIntStore</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>an integer value to lookup in the <em class="parameter"><code>model</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>return location for the iter of the given <em class="parameter"><code>value</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.22.9.3.6"></a><h4>Returns</h4>
<p> <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.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.2</p>
</div>
</div>
<div class="refsect1">
<a name="GimpIntStore.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GimpIntStore-struct"></a><h3>GimpIntStore</h3>
<pre class="programlisting">typedef struct _GimpIntStore GimpIntStore;</pre>
@ -90,132 +191,73 @@ A model for integer based name-value pairs (e.g. enums)
<hr>
<div class="refsect2">
<a name="GimpIntStoreColumns"></a><h3>enum GimpIntStoreColumns</h3>
<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>
The column types of <a class="link" href="GimpIntStore.html" title="GimpIntStore"><span class="type">GimpIntStore</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<p>The column types of <a class="link" href="GimpIntStore.html" title="GimpIntStore"><span class="type">GimpIntStore</span></a>.</p>
<div class="refsect3">
<a name="id-1.2.22.10.3.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col align="left" valign="top">
<col>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td><p><a name="GIMP-INT-STORE-VALUE:CAPS"></a><span class="term"><code class="literal">GIMP_INT_STORE_VALUE</code></span></p></td>
<td>the integer value
<td class="enum_member_name"><p><a name="GIMP-INT-STORE-VALUE:CAPS"></a>GIMP_INT_STORE_VALUE</p></td>
<td class="enum_member_description">
<p>the integer value</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td><p><a name="GIMP-INT-STORE-LABEL:CAPS"></a><span class="term"><code class="literal">GIMP_INT_STORE_LABEL</code></span></p></td>
<td>a human-readable label
<td class="enum_member_name"><p><a name="GIMP-INT-STORE-LABEL:CAPS"></a>GIMP_INT_STORE_LABEL</p></td>
<td class="enum_member_description">
<p>a human-readable label</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td><p><a name="GIMP-INT-STORE-STOCK-ID:CAPS"></a><span class="term"><code class="literal">GIMP_INT_STORE_STOCK_ID</code></span></p></td>
<td>a stock ID
<td class="enum_member_name"><p><a name="GIMP-INT-STORE-STOCK-ID:CAPS"></a>GIMP_INT_STORE_STOCK_ID</p></td>
<td class="enum_member_description">
<p>a stock ID</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td><p><a name="GIMP-INT-STORE-PIXBUF:CAPS"></a><span class="term"><code class="literal">GIMP_INT_STORE_PIXBUF</code></span></p></td>
<td>a <span class="type">GdkPixbuf</span>
<td class="enum_member_name"><p><a name="GIMP-INT-STORE-PIXBUF:CAPS"></a>GIMP_INT_STORE_PIXBUF</p></td>
<td class="enum_member_description">
<p>a <span class="type">GdkPixbuf</span></p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td><p><a name="GIMP-INT-STORE-USER-DATA:CAPS"></a><span class="term"><code class="literal">GIMP_INT_STORE_USER_DATA</code></span></p></td>
<td>arbitrary user data
<td class="enum_member_name"><p><a name="GIMP-INT-STORE-USER-DATA:CAPS"></a>GIMP_INT_STORE_USER_DATA</p></td>
<td class="enum_member_description">
<p>arbitrary user data</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td><p><a name="GIMP-INT-STORE-NUM-COLUMNS:CAPS"></a><span class="term"><code class="literal">GIMP_INT_STORE_NUM_COLUMNS</code></span></p></td>
<td>the number of columns
<td class="enum_member_name"><p><a name="GIMP-INT-STORE-NUM-COLUMNS:CAPS"></a>GIMP_INT_STORE_NUM_COLUMNS</p></td>
<td class="enum_member_description">
<p>the number of columns</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-int-store-new"></a><h3>gimp_int_store_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkListStore</span> * gimp_int_store_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a <span class="type">GtkListStore</span> with a number of useful columns.
<a class="link" 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>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" 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">
<a name="gimp-int-store-lookup-by-value"></a><h3>gimp_int_store_lookup_by_value ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_int_store_lookup_by_value (<em class="parameter"><code><span class="type">GtkTreeModel</span> *model</code></em>,
<em class="parameter"><code><span class="type">gint</span> value</code></em>,
<em class="parameter"><code><span class="type">GtkTreeIter</span> *iter</code></em>);</pre>
<p>
Iterate over the <em class="parameter"><code>model</code></em> looking for <em class="parameter"><code>value</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td>a <a class="link" href="GimpIntStore.html" title="GimpIntStore"><span class="type">GimpIntStore</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>an integer value to lookup in the <em class="parameter"><code>model</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>return location for the iter of the given <em class="parameter"><code>value</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></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">
<a name="GimpIntStore.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GimpIntStore--user-data-type"></a><h3>The <code class="literal">"user-data-type"</code> property</h3>
<pre class="programlisting"> "user-data-type" <span class="type">GType</span>* : 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
<a name="GimpIntStore--user-data-type"></a><h3>The <code class="literal">“user-data-type”</code> property</h3>
<pre class="programlisting"> “user-data-type” <span class="type">GType</span> *</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>
handle ref-counting of your user data.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Allowed values: void</p>
<p class="since">Since GIMP 2.4</p>
</div>
@ -223,6 +265,6 @@ handle ref-counting of your user data.
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
Generated by GTK-Doc V1.21</div>
</body>
</html>