~ubuntu-branches/ubuntu/trusty/gimp/trusty

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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
<?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="libgimp-GimpItemComboBox">
<refmeta>
<refentrytitle role="top_of_page" id="libgimp-GimpItemComboBox.top_of_page">GimpItemComboBox</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GimpItemComboBox</refname>
<refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv id="libgimp-GimpItemComboBox.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="GimpDrawableComboBox"/><anchor id="GimpChannelComboBox"/><anchor id="GimpLayerComboBox"/><anchor id="GimpVectorsComboBox"/>
<synopsis>
<link linkend="gboolean">gboolean</link>            (<link linkend="GimpItemConstraintFunc">*GimpItemConstraintFunc</link>)           (<link linkend="gint32">gint32</link> image_id,
                                                         <link linkend="gint32">gint32</link> item_id,
                                                         <link linkend="gpointer">gpointer</link> data);
                    <link linkend="GimpDrawableComboBox-struct">GimpDrawableComboBox</link>;
typedef             <link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link>;
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-drawable-combo-box-new">gimp_drawable_combo_box_new</link>         (<link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link> constraint,
                                                         <link linkend="gpointer">gpointer</link> data);
                    <link linkend="GimpChannelComboBox-struct">GimpChannelComboBox</link>;
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-channel-combo-box-new">gimp_channel_combo_box_new</link>          (<link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link> constraint,
                                                         <link linkend="gpointer">gpointer</link> data);
                    <link linkend="GimpLayerComboBox-struct">GimpLayerComboBox</link>;
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-layer-combo-box-new">gimp_layer_combo_box_new</link>            (<link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link> constraint,
                                                         <link linkend="gpointer">gpointer</link> data);
                    <link linkend="GimpVectorsComboBox-struct">GimpVectorsComboBox</link>;
typedef             <link linkend="GimpVectorsConstraintFunc">GimpVectorsConstraintFunc</link>;
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-vectors-combo-box-new">gimp_vectors_combo_box_new</link>          (<link linkend="GimpVectorsConstraintFunc">GimpVectorsConstraintFunc</link> constraint,
                                                         <link linkend="gpointer">gpointer</link> data);
</synopsis>
</refsynopsisdiv>

<refsect1 id="libgimp-GimpItemComboBox.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkContainer">GtkContainer</link>
                           +----<link linkend="GtkBin">GtkBin</link>
                                 +----<link linkend="GtkComboBox">GtkComboBox</link>
                                       +----<link linkend="GimpIntComboBox">GimpIntComboBox</link>
                                             +----GimpDrawableComboBox
</synopsis>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkContainer">GtkContainer</link>
                           +----<link linkend="GtkBin">GtkBin</link>
                                 +----<link linkend="GtkComboBox">GtkComboBox</link>
                                       +----<link linkend="GimpIntComboBox">GimpIntComboBox</link>
                                             +----GimpChannelComboBox
</synopsis>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkContainer">GtkContainer</link>
                           +----<link linkend="GtkBin">GtkBin</link>
                                 +----<link linkend="GtkComboBox">GtkComboBox</link>
                                       +----<link linkend="GimpIntComboBox">GimpIntComboBox</link>
                                             +----GimpLayerComboBox
</synopsis>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkContainer">GtkContainer</link>
                           +----<link linkend="GtkBin">GtkBin</link>
                                 +----<link linkend="GtkComboBox">GtkComboBox</link>
                                       +----<link linkend="GimpIntComboBox">GimpIntComboBox</link>
                                             +----GimpVectorsComboBox
</synopsis>
</refsect1>



<refsect1 id="libgimp-GimpItemComboBox.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpDrawableComboBox implements
 <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="GtkCellLayout">GtkCellLayout</link>,  <link linkend="GtkCellEditable">GtkCellEditable</link> and  <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
<para>
GimpChannelComboBox implements
 <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="GtkCellLayout">GtkCellLayout</link>,  <link linkend="GtkCellEditable">GtkCellEditable</link> and  <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
<para>
GimpLayerComboBox implements
 <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="GtkCellLayout">GtkCellLayout</link>,  <link linkend="GtkCellEditable">GtkCellEditable</link> and  <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
<para>
GimpVectorsComboBox implements
 <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="GtkCellLayout">GtkCellLayout</link>,  <link linkend="GtkCellEditable">GtkCellEditable</link> and  <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
</refsect1>





<refsect1 id="libgimp-GimpItemComboBox.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>

<refsect1 id="libgimp-GimpItemComboBox.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GimpItemConstraintFunc" role="function">
<title>GimpItemConstraintFunc ()</title>
<indexterm zone="GimpItemConstraintFunc"><primary sortas="GimpItemConstraintFunc">GimpItemConstraintFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            (*GimpItemConstraintFunc)           (<link linkend="gint32">gint32</link> image_id,
                                                         <link linkend="gint32">gint32</link> item_id,
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_id</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>item_id</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="GimpDrawableComboBox-struct" role="struct">
<title>GimpDrawableComboBox</title>
<indexterm zone="GimpDrawableComboBox-struct"><primary sortas="GimpDrawableComboBox">GimpDrawableComboBox</primary></indexterm><programlisting>typedef struct _GimpDrawableComboBox GimpDrawableComboBox;</programlisting>
<para>
</para></refsect2>
<refsect2 id="GimpDrawableConstraintFunc" role="typedef">
<title>GimpDrawableConstraintFunc</title>
<indexterm zone="GimpDrawableConstraintFunc"><primary sortas="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</primary></indexterm><programlisting>typedef GimpItemConstraintFunc GimpDrawableConstraintFunc;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="gimp-drawable-combo-box-new" role="function" condition="since:GIMP 2.2">
<title>gimp_drawable_combo_box_new ()</title>
<indexterm zone="gimp-drawable-combo-box-new" role="GIMP 2.2"><primary sortas="gimp_drawable_combo_box_new">gimp_drawable_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_drawable_combo_box_new         (<link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link> constraint,
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Creates a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link> filled with all currently opened
drawables. If a <parameter>constraint</parameter> function is specified, it is called for
each drawable and only if the function returns <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>, the drawable
is added to the combobox.
</para>
<para>
You should use <link linkend="gimp-int-combo-box-connect"><function>gimp_int_combo_box_connect()</function></link> to initialize and connect
the combo.  Use <link linkend="gimp-int-combo-box-set-active"><function>gimp_int_combo_box_set_active()</function></link> to get the active
drawable ID and <link linkend="gimp-int-combo-box-get-active"><function>gimp_int_combo_box_get_active()</function></link> to retrieve the ID
of the selected drawable.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>constraint</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GimpDrawableConstraintFunc"><type>GimpDrawableConstraintFunc</type></link> or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&#160;:</term>
<listitem><simpara>       a pointer that is passed to <parameter>constraint</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
<refsect2 id="GimpChannelComboBox-struct" role="struct">
<title>GimpChannelComboBox</title>
<indexterm zone="GimpChannelComboBox-struct"><primary sortas="GimpChannelComboBox">GimpChannelComboBox</primary></indexterm><programlisting>typedef struct _GimpChannelComboBox GimpChannelComboBox;</programlisting>
<para>
</para></refsect2>
<refsect2 id="gimp-channel-combo-box-new" role="function" condition="since:GIMP 2.2">
<title>gimp_channel_combo_box_new ()</title>
<indexterm zone="gimp-channel-combo-box-new" role="GIMP 2.2"><primary sortas="gimp_channel_combo_box_new">gimp_channel_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_channel_combo_box_new          (<link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link> constraint,
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Creates a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link> filled with all currently opened
channels. See <link linkend="gimp-drawable-combo-box-new"><function>gimp_drawable_combo_box_new()</function></link> for more information.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>constraint</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GimpDrawableConstraintFunc"><type>GimpDrawableConstraintFunc</type></link> or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&#160;:</term>
<listitem><simpara>       a pointer that is passed to <parameter>constraint</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
<refsect2 id="GimpLayerComboBox-struct" role="struct">
<title>GimpLayerComboBox</title>
<indexterm zone="GimpLayerComboBox-struct"><primary sortas="GimpLayerComboBox">GimpLayerComboBox</primary></indexterm><programlisting>typedef struct _GimpLayerComboBox GimpLayerComboBox;</programlisting>
<para>
</para></refsect2>
<refsect2 id="gimp-layer-combo-box-new" role="function" condition="since:GIMP 2.2">
<title>gimp_layer_combo_box_new ()</title>
<indexterm zone="gimp-layer-combo-box-new" role="GIMP 2.2"><primary sortas="gimp_layer_combo_box_new">gimp_layer_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_layer_combo_box_new            (<link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link> constraint,
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Creates a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link> filled with all currently opened
layers. See <link linkend="gimp-drawable-combo-box-new"><function>gimp_drawable_combo_box_new()</function></link> for more information.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>constraint</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GimpDrawableConstraintFunc"><type>GimpDrawableConstraintFunc</type></link> or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&#160;:</term>
<listitem><simpara>       a pointer that is passed to <parameter>constraint</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
<refsect2 id="GimpVectorsComboBox-struct" role="struct">
<title>GimpVectorsComboBox</title>
<indexterm zone="GimpVectorsComboBox-struct"><primary sortas="GimpVectorsComboBox">GimpVectorsComboBox</primary></indexterm><programlisting>typedef struct _GimpVectorsComboBox GimpVectorsComboBox;</programlisting>
<para>
</para></refsect2>
<refsect2 id="GimpVectorsConstraintFunc" role="typedef">
<title>GimpVectorsConstraintFunc</title>
<indexterm zone="GimpVectorsConstraintFunc"><primary sortas="GimpVectorsConstraintFunc">GimpVectorsConstraintFunc</primary></indexterm><programlisting>typedef GimpItemConstraintFunc GimpVectorsConstraintFunc;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="gimp-vectors-combo-box-new" role="function" condition="since:GIMP 2.4">
<title>gimp_vectors_combo_box_new ()</title>
<indexterm zone="gimp-vectors-combo-box-new" role="GIMP 2.4"><primary sortas="gimp_vectors_combo_box_new">gimp_vectors_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_vectors_combo_box_new          (<link linkend="GimpVectorsConstraintFunc">GimpVectorsConstraintFunc</link> constraint,
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Creates a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link> filled with all currently opened
vectors objects. If a <parameter>constraint</parameter> function is specified, it is called for
each vectors object and only if the function returns <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>, the vectors
object is added to the combobox.
</para>
<para>
You should use <link linkend="gimp-int-combo-box-connect"><function>gimp_int_combo_box_connect()</function></link> to initialize and connect
the combo.  Use <link linkend="gimp-int-combo-box-set-active"><function>gimp_int_combo_box_set_active()</function></link> to set the active
vectors ID and <link linkend="gimp-int-combo-box-get-active"><function>gimp_int_combo_box_get_active()</function></link> to retrieve the ID
of the selected vectors object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>constraint</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GimpVectorsConstraintFunc"><type>GimpVectorsConstraintFunc</type></link> or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&#160;:</term>
<listitem><simpara>       a pointer that is passed to <parameter>constraint</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>

</refsect1>




</refentry>