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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GnomeIconSelection</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GNOME UI Library Reference Manual">
<link rel="up" href="fixme.html" title="Miscellaneous Widgets">
<link rel="prev" href="libgnomeui-GnomeIconLookup.html" title="GnomeIconLookup">
<link rel="next" href="libgnomeui-GnomeThumbnail.html" title="GnomeThumbnail">
<meta name="generator" content="GTK-Doc V1.16 (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="libgnomeui-GnomeIconLookup.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="fixme.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">GNOME UI Library Reference Manual</th>
<td><a accesskey="n" href="libgnomeui-GnomeThumbnail.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GnomeIconSelection.synopsis" class="shortcut">Top</a>
|
<a href="#GnomeIconSelection.description" class="shortcut">Description</a>
|
<a href="#GnomeIconSelection.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GnomeIconSelection.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
</td></tr>
</table>
<div class="refentry">
<a name="GnomeIconSelection"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GnomeIconSelection.top_of_page"></a>GnomeIconSelection</span></h2>
<p>GnomeIconSelection</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GnomeIconSelection.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgnomeui/libgnomeui.h>
struct <a class="link" href="GnomeIconSelection.html#GnomeIconSelection-struct" title="struct GnomeIconSelection">GnomeIconSelection</a>;
<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GnomeIconSelection.html#gnome-icon-selection-new" title="gnome_icon_selection_new ()">gnome_icon_selection_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="GnomeIconSelection.html#gnome-icon-selection-add-defaults" title="gnome_icon_selection_add_defaults ()">gnome_icon_selection_add_defaults</a> (<em class="parameter"><code><a class="link" href="GnomeIconSelection.html" title="GnomeIconSelection"><span class="type">GnomeIconSelection</span></a> *gis</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GnomeIconSelection.html#gnome-icon-selection-add-directory" title="gnome_icon_selection_add_directory ()">gnome_icon_selection_add_directory</a> (<em class="parameter"><code><a class="link" href="GnomeIconSelection.html" title="GnomeIconSelection"><span class="type">GnomeIconSelection</span></a> *gis</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dir</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GnomeIconSelection.html#gnome-icon-selection-show-icons" title="gnome_icon_selection_show_icons ()">gnome_icon_selection_show_icons</a> (<em class="parameter"><code><a class="link" href="GnomeIconSelection.html" title="GnomeIconSelection"><span class="type">GnomeIconSelection</span></a> *gis</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GnomeIconSelection.html#gnome-icon-selection-clear" title="gnome_icon_selection_clear ()">gnome_icon_selection_clear</a> (<em class="parameter"><code><a class="link" href="GnomeIconSelection.html" title="GnomeIconSelection"><span class="type">GnomeIconSelection</span></a> *gis</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> not_shown</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GnomeIconSelection.html#gnome-icon-selection-get-icon" title="gnome_icon_selection_get_icon ()">gnome_icon_selection_get_icon</a> (<em class="parameter"><code><a class="link" href="GnomeIconSelection.html" title="GnomeIconSelection"><span class="type">GnomeIconSelection</span></a> *gis</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> full_path</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GnomeIconSelection.html#gnome-icon-selection-select-icon" title="gnome_icon_selection_select_icon ()">gnome_icon_selection_select_icon</a> (<em class="parameter"><code><a class="link" href="GnomeIconSelection.html" title="GnomeIconSelection"><span class="type">GnomeIconSelection</span></a> *gis</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GnomeIconSelection.html#gnome-icon-selection-stop-loading" title="gnome_icon_selection_stop_loading ()">gnome_icon_selection_stop_loading</a> (<em class="parameter"><code><a class="link" href="GnomeIconSelection.html" title="GnomeIconSelection"><span class="type">GnomeIconSelection</span></a> *gis</code></em>);
<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GnomeIconSelection.html#gnome-icon-selection-get-gil" title="gnome_icon_selection_get_gil ()">gnome_icon_selection_get_gil</a> (<em class="parameter"><code><a class="link" href="GnomeIconSelection.html" title="GnomeIconSelection"><span class="type">GnomeIconSelection</span></a> *gis</code></em>);
<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GnomeIconSelection.html#gnome-icon-selection-get-box" title="gnome_icon_selection_get_box ()">gnome_icon_selection_get_box</a> (<em class="parameter"><code><a class="link" href="GnomeIconSelection.html" title="GnomeIconSelection"><span class="type">GnomeIconSelection</span></a> *gis</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GnomeIconSelection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html">GtkObject</a>
+----<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html">GtkWidget</a>
+----<a href="http://library.gnome.org/devel/gtk/unstable/GtkContainer.html">GtkContainer</a>
+----<a href="http://library.gnome.org/devel/gtk/unstable/GtkBox.html">GtkBox</a>
+----<a href="http://library.gnome.org/devel/gtk/unstable/GtkVBox.html">GtkVBox</a>
+----GnomeIconSelection
</pre>
</div>
<div class="refsect1">
<a name="GnomeIconSelection.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GnomeIconSelection implements
AtkImplementorIface, <a href="http://library.gnome.org/devel/gtk/unstable/GtkBuildable.html">GtkBuildable</a> and <a href="http://library.gnome.org/devel/gtk/unstable/gtk-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="GnomeIconSelection.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="GnomeIconSelection.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GnomeIconSelection-struct"></a><h3>struct GnomeIconSelection</h3>
<pre class="programlisting">struct GnomeIconSelection;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gnome-icon-selection-new"></a><h3>gnome_icon_selection_new ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gnome_icon_selection_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new icon selection widget, it uses GnomeIconList
for the listing of icons
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Returns the new object</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-icon-selection-add-defaults"></a><h3>gnome_icon_selection_add_defaults ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_icon_selection_add_defaults (<em class="parameter"><code><a class="link" href="GnomeIconSelection.html" title="GnomeIconSelection"><span class="type">GnomeIconSelection</span></a> *gis</code></em>);</pre>
<p>
Adds the default pixmap directory into the selection
widget. It doesn't show the icons in the selection until you
do <a class="link" href="GnomeIconSelection.html#gnome-icon-selection-show-icons" title="gnome_icon_selection_show_icons ()"><span class="type">gnome_icon_selection_show_icons</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>gis</code></em> :</span></p></td>
<td>GnomeIconSelection to work with</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-icon-selection-add-directory"></a><h3>gnome_icon_selection_add_directory ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_icon_selection_add_directory (<em class="parameter"><code><a class="link" href="GnomeIconSelection.html" title="GnomeIconSelection"><span class="type">GnomeIconSelection</span></a> *gis</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dir</code></em>);</pre>
<p>
Adds the icons from the directory <em class="parameter"><code>dir</code></em> to the
selection widget. It doesn't show the icons in the selection
until you do <a class="link" href="GnomeIconSelection.html#gnome-icon-selection-show-icons" title="gnome_icon_selection_show_icons ()"><span class="type">gnome_icon_selection_show_icons</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gis</code></em> :</span></p></td>
<td>GnomeIconSelection to work with</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dir</code></em> :</span></p></td>
<td>directory with pixmaps</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-icon-selection-show-icons"></a><h3>gnome_icon_selection_show_icons ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_icon_selection_show_icons (<em class="parameter"><code><a class="link" href="GnomeIconSelection.html" title="GnomeIconSelection"><span class="type">GnomeIconSelection</span></a> *gis</code></em>);</pre>
<p>
Shows the icons inside the widget that
were added with <a class="link" href="GnomeIconSelection.html#gnome-icon-selection-add-defaults" title="gnome_icon_selection_add_defaults ()"><span class="type">gnome_icon_selection_add_defaults</span></a> and
<a class="link" href="GnomeIconSelection.html#gnome-icon-selection-add-directory" title="gnome_icon_selection_add_directory ()"><span class="type">gnome_icon_selection_add_directory</span></a>. Before this function
is called the icons aren't actually added to the listing
and can't be picked by the user.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>gis</code></em> :</span></p></td>
<td>GnomeIconSelection to work with</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-icon-selection-clear"></a><h3>gnome_icon_selection_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_icon_selection_clear (<em class="parameter"><code><a class="link" href="GnomeIconSelection.html" title="GnomeIconSelection"><span class="type">GnomeIconSelection</span></a> *gis</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> not_shown</code></em>);</pre>
<p>
Clear the currently shown icons, the ones
that weren't shown yet are not cleared unless the not_shown
parameter is given, in which case even those are cleared.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gis</code></em> :</span></p></td>
<td>GnomeIconSelection to work with</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>not_shown</code></em> :</span></p></td>
<td>boolean</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-icon-selection-get-icon"></a><h3>gnome_icon_selection_get_icon ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gnome_icon_selection_get_icon (<em class="parameter"><code><a class="link" href="GnomeIconSelection.html" title="GnomeIconSelection"><span class="type">GnomeIconSelection</span></a> *gis</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> full_path</code></em>);</pre>
<p>
Gets the currently selected icon name, if
full_path is true, it returns the full path to the icon,
if none is selected it returns NULL
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gis</code></em> :</span></p></td>
<td>GnomeIconSelection to work with</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>full_path</code></em> :</span></p></td>
<td>boolean</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>internal string, it must not be changed or freed
or NULL</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-icon-selection-select-icon"></a><h3>gnome_icon_selection_select_icon ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_icon_selection_select_icon (<em class="parameter"><code><a class="link" href="GnomeIconSelection.html" title="GnomeIconSelection"><span class="type">GnomeIconSelection</span></a> *gis</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
<p>
Selects the icon <em class="parameter"><code>filename</code></em>. This icon must have
already been added and shown * (see <em class="parameter"><code>gnome_icon_selection_show_icons</code></em>)
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gis</code></em> :</span></p></td>
<td>GnomeIconSelection to work with</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>icon filename</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-icon-selection-stop-loading"></a><h3>gnome_icon_selection_stop_loading ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_icon_selection_stop_loading (<em class="parameter"><code><a class="link" href="GnomeIconSelection.html" title="GnomeIconSelection"><span class="type">GnomeIconSelection</span></a> *gis</code></em>);</pre>
<p>
Stop the loading of images when we are in
the loop in show_icons, otherwise it does nothing and is
harmless, it should be used say if the dialog was hidden
or when we want to quickly stop loading the images to do
something else without destroying the icon selection object.
The remaining icons can be shown by
<a class="link" href="GnomeIconSelection.html#gnome-icon-selection-show-icons" title="gnome_icon_selection_show_icons ()"><span class="type">gnome_icon_selection_show_icons</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>gis</code></em> :</span></p></td>
<td>GnomeIconSelection to work with</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-icon-selection-get-gil"></a><h3>gnome_icon_selection_get_gil ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gnome_icon_selection_get_gil (<em class="parameter"><code><a class="link" href="GnomeIconSelection.html" title="GnomeIconSelection"><span class="type">GnomeIconSelection</span></a> *gis</code></em>);</pre>
<p>
Gets the <a class="link" href="libgnomeui-gnome-icon-list.html#GnomeIconList"><span class="type">GnomeIconList</span></a> widget that is
used for the display of icons
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gis</code></em> :</span></p></td>
<td>GnomeIconSelection to work with</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> pointer to the interal widget</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-icon-selection-get-box"></a><h3>gnome_icon_selection_get_box ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gnome_icon_selection_get_box (<em class="parameter"><code><a class="link" href="GnomeIconSelection.html" title="GnomeIconSelection"><span class="type">GnomeIconSelection</span></a> *gis</code></em>);</pre>
<p>
Gets the <a href="http://library.gnome.org/devel/gtk/unstable/GtkVBox.html"><span class="type">GtkVBox</span></a> widget that is
used to pack the different elements of the selection
into.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gis</code></em> :</span></p></td>
<td>GnomeIconSelection to work with</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> pointer to the interal widget</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.16</div>
</body>
</html>
|
