summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtkiconfactory.sgml
blob: bca3a9cd7b0695447de9baee87d4fd8931537a0c (plain)
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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
<!-- ##### SECTION Title ##### -->
Themeable Stock Images

<!-- ##### SECTION Short_Description ##### -->

Manipulating stock icons

<!-- ##### SECTION Long_Description ##### -->


<para>
Browse the available stock icons in the list of stock IDs found <link
linkend="gtk-Stock-Items">here</link>. You can also use 
the <application>gtk-demo</application> application for this purpose.
</para>

<para>
 An icon factory manages a collection of #GtkIconSet; a #GtkIconSet manages a
 set of variants of a particular icon (i.e. a #GtkIconSet contains variants for
 different sizes and widget states). Icons in an icon factory are named by a
 stock ID, which is a simple string identifying the icon. Each #GtkStyle has a
 list of #GtkIconFactory derived from the current theme; those icon factories
 are consulted first when searching for an icon. If the theme doesn't set a
 particular icon, GTK+ looks for the icon in a list of default icon factories,
 maintained by gtk_icon_factory_add_default() and
 gtk_icon_factory_remove_default(). Applications with icons should add a default
 icon factory with their icons, which will allow themes to override the icons
 for the application.
</para>

<para>
To display an icon, always use gtk_style_lookup_icon_set() on the widget that
will display the icon, or the convenience function
gtk_widget_render_icon(). These functions take the theme into account when
looking up the icon to use for a given stock ID.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### STRUCT GtkIconSource ##### -->
<para>

</para>


<!-- ##### STRUCT GtkIconFactory ##### -->
<para>

</para>


<!-- ##### STRUCT GtkIconSet ##### -->
<para>

</para>


<!-- ##### ENUM GtkIconSize ##### -->
<para>

</para>

@GTK_ICON_SIZE_INVALID: 
@GTK_ICON_SIZE_MENU: 
@GTK_ICON_SIZE_SMALL_TOOLBAR: 
@GTK_ICON_SIZE_LARGE_TOOLBAR: 
@GTK_ICON_SIZE_BUTTON: 
@GTK_ICON_SIZE_DND: 
@GTK_ICON_SIZE_DIALOG: 

<!-- ##### FUNCTION gtk_icon_source_copy ##### -->
<para>

</para>

@source: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_source_free ##### -->
<para>

</para>

@source: 


<!-- ##### FUNCTION gtk_icon_factory_add ##### -->
<para>

</para>

@factory: 
@stock_id: 
@icon_set: 


<!-- ##### FUNCTION gtk_icon_factory_add_default ##### -->
<para>

</para>

@factory: 


<!-- ##### FUNCTION gtk_icon_factory_lookup ##### -->
<para>

</para>

@factory: 
@stock_id: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_factory_lookup_default ##### -->
<para>

</para>

@stock_id: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_factory_new ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION gtk_icon_factory_remove_default ##### -->
<para>

</para>

@factory: 


<!-- ##### FUNCTION gtk_icon_set_add_source ##### -->
<para>

</para>

@icon_set: 
@source: 


<!-- ##### FUNCTION gtk_icon_set_copy ##### -->
<para>

</para>

@icon_set: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_set_new ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION gtk_icon_set_new_from_pixbuf ##### -->
<para>

</para>

@pixbuf: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_set_ref ##### -->
<para>

</para>

@icon_set: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_set_render_icon ##### -->
<para>

</para>

@icon_set: 
@style: 
@direction: 
@state: 
@size: 
@widget: 
@detail: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_set_unref ##### -->
<para>

</para>

@icon_set: 


<!-- ##### FUNCTION gtk_icon_size_lookup ##### -->
<para>

</para>

@size: 
@width: 
@height: 
@Returns: 
<!-- # Unused Parameters # -->
@alias: 


<!-- ##### FUNCTION gtk_icon_size_lookup_for_settings ##### -->
<para>

</para>

@settings: 
@size: 
@width: 
@height: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_size_register ##### -->
<para>

</para>

@name: 
@width: 
@height: 
@Returns: 
<!-- # Unused Parameters # -->
@alias: 


<!-- ##### FUNCTION gtk_icon_size_register_alias ##### -->
<para>

</para>

@alias: 
@target: 


<!-- ##### FUNCTION gtk_icon_size_from_name ##### -->
<para>

</para>

@name: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_size_get_name ##### -->
<para>

</para>

@size: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_set_get_sizes ##### -->
<para>

</para>

@icon_set: 
@sizes: 
@n_sizes: 


<!-- ##### FUNCTION gtk_icon_source_get_direction ##### -->
<para>

</para>

@source: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_source_get_direction_wildcarded ##### -->
<para>

</para>

@source: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_source_get_filename ##### -->
<para>

</para>

@source: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_source_get_pixbuf ##### -->
<para>

</para>

@source: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_source_get_icon_name ##### -->
<para>

</para>

@source: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_source_get_size ##### -->
<para>

</para>

@source: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_source_get_size_wildcarded ##### -->
<para>

</para>

@source: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_source_get_state ##### -->
<para>

</para>

@source: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_source_get_state_wildcarded ##### -->
<para>

</para>

@source: 
@Returns: 


<!-- ##### FUNCTION gtk_icon_source_new ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION gtk_icon_source_set_direction ##### -->
<para>

</para>

@source: 
@direction: 


<!-- ##### FUNCTION gtk_icon_source_set_direction_wildcarded ##### -->
<para>

</para>

@source: 
@setting: 


<!-- ##### FUNCTION gtk_icon_source_set_filename ##### -->
<para>

</para>

@source: 
@filename: 


<!-- ##### FUNCTION gtk_icon_source_set_pixbuf ##### -->
<para>

</para>

@source: 
@pixbuf: 


<!-- ##### FUNCTION gtk_icon_source_set_icon_name ##### -->
<para>

</para>

@source: 
@icon_name: 


<!-- ##### FUNCTION gtk_icon_source_set_size ##### -->
<para>

</para>

@source: 
@size: 


<!-- ##### FUNCTION gtk_icon_source_set_size_wildcarded ##### -->
<para>

</para>

@source: 
@setting: 


<!-- ##### FUNCTION gtk_icon_source_set_state ##### -->
<para>

</para>

@source: 
@state: 


<!-- ##### FUNCTION gtk_icon_source_set_state_wildcarded ##### -->
<para>

</para>

@source: 
@setting: