1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="GimpIntStore">
<refmeta>
<refentrytitle id="top_of_page">GimpIntStore</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpIntStore</refname>
<refpurpose>A model for integer based name-value pairs (e.g. enums)</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GimpIntStore-struct">GimpIntStore</link>;
enum <link linkend="GimpIntStoreColumns">GimpIntStoreColumns</link>;
<link linkend="GtkListStore">GtkListStore</link>* <link linkend="gimp-int-store-new">gimp_int_store_new</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-int-store-lookup-by-value">gimp_int_store_lookup_by_value</link> (<link linkend="GtkTreeModel">GtkTreeModel</link> *model,
<link linkend="gint">gint</link> value,
<link linkend="GtkTreeIter">GtkTreeIter</link> *iter);
</synopsis>
</refsynopsisdiv>
<refsect1 id="object_hierarchy">
<title id="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GtkListStore">GtkListStore</link>
+----GimpIntStore
</synopsis>
</refsect1>
<refsect1 id="impl_interfaces">
<title id="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpIntStore implements
<link linkend="GtkTreeModel">GtkTreeModel</link>, <link linkend="GtkTreeDragSource">GtkTreeDragSource</link>, <link linkend="GtkTreeDragDest">GtkTreeDragDest</link> and <link linkend="GtkTreeSortable">GtkTreeSortable</link>.</para>
</refsect1>
<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>
A model for integer based name-value pairs (e.g. enums)
</para>
</refsect1>
<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="GimpIntStore-struct" role="struct"/>GimpIntStore</title>
<indexterm><primary>GimpIntStore</primary></indexterm><programlisting>typedef struct _GimpIntStore GimpIntStore;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpIntStoreColumns" role="enum"/>enum GimpIntStoreColumns</title>
<indexterm><primary>GimpIntStoreColumns</primary></indexterm><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;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gimp-int-store-new" role="function" condition="since:GIMP 2.2"/>gimp_int_store_new ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_int_store_new</primary></indexterm><programlisting><link linkend="GtkListStore">GtkListStore</link>* gimp_int_store_new (void);</programlisting>
<para>
Creates a <link linkend="GtkListStore"><type>GtkListStore</type></link> with a number of useful columns.
<link linkend="GimpIntStore"><type>GimpIntStore</type></link> is especially useful if the items you want to store
are identified using an integer value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpIntStore"><type>GimpIntStore</type></link>.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-int-store-lookup-by-value" role="function" condition="since:GIMP 2.2"/>gimp_int_store_lookup_by_value ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_int_store_lookup_by_value</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_int_store_lookup_by_value (<link linkend="GtkTreeModel">GtkTreeModel</link> *model,
<link linkend="gint">gint</link> value,
<link linkend="GtkTreeIter">GtkTreeIter</link> *iter);</programlisting>
<para>
Iterate over the <parameter>model</parameter> looking for <parameter>value</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>model</parameter> :</term>
<listitem><simpara> a <link linkend="GimpIntStore"><type>GimpIntStore</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> an integer value to lookup in the <parameter>model</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>iter</parameter> :</term>
<listitem><simpara> return location for the iter of the given <parameter>value</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the value has been located and <parameter>iter</parameter> is
valid, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
</refsect1>
</refentry>
|
