← Back to branch summary

~ubuntu-branches/ubuntu/precise/gtk+2.0/precise-updates

« back to all changes in this revision

Viewing changes to docs/reference/gtk/tmpl/gtkiconfactory.sgml

  • Committer: Package Import Robot
  • Author(s): Ken VanDine
  • Date: 2011-12-01 11:40:06 UTC
  • mfrom: (1.14.11)
  • Revision ID: package-import@ubuntu.com-20111201114006-nrmf6qu3pg512veo
Tags: 2.24.8-0ubuntu1
https://launchpad.net/bugs/189494
https://launchpad.net/bugs/889019
* New upstream release 
  - gtkfilechooser should be more robust to malformed URIs
    in .gtk-bookmarks (LP: #189494)
* debian/patches/010_make_bg_changes_queue_repaint.patch
  - dropped it introduces performance regressions in some gtk2 
    apps (LP: #889019)
* 101_filechooser.patch, 000git_file_chooser.patch: dropped, upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gtk/tmpl/gtkiconfactory.sgml
1
 
<!-- ##### SECTION Title ##### -->
2
 
Themeable Stock Images
3
 
 
4
 
<!-- ##### SECTION Short_Description ##### -->
5
 
 
6
 
Manipulating stock icons
7
 
 
8
 
<!-- ##### SECTION Long_Description ##### -->
9
 
 
10
 
 
11
 
<para>
12
 
Browse the available stock icons in the list of stock IDs found <link
13
 
linkend="gtk-Stock-Items">here</link>. You can also use 
14
 
the <application>gtk-demo</application> application for this purpose.
15
 
</para>
16
 
 
17
 
<para>
18
 
 An icon factory manages a collection of #GtkIconSet; a #GtkIconSet manages a
19
 
 set of variants of a particular icon (i.e. a #GtkIconSet contains variants for
20
 
 different sizes and widget states). Icons in an icon factory are named by a
21
 
 stock ID, which is a simple string identifying the icon. Each #GtkStyle has a
22
 
 list of #GtkIconFactory derived from the current theme; those icon factories
23
 
 are consulted first when searching for an icon. If the theme doesn't set a
24
 
 particular icon, GTK+ looks for the icon in a list of default icon factories,
25
 
 maintained by gtk_icon_factory_add_default() and
26
 
 gtk_icon_factory_remove_default(). Applications with icons should add a default
27
 
 icon factory with their icons, which will allow themes to override the icons
28
 
 for the application.
29
 
</para>
30
 
 
31
 
<para>
32
 
To display an icon, always use gtk_style_lookup_icon_set() on the widget that
33
 
will display the icon, or the convenience function
34
 
gtk_widget_render_icon(). These functions take the theme into account when
35
 
looking up the icon to use for a given stock ID.
36
 
</para>
37
 
 
38
 
<refsect2 id="GtkIconFactory-BUILDER-UI"><title>GtkIconFactory as GtkBuildable</title>
39
 
<para>
40
 
GtkIconFactory supports a custom &lt;sources&gt; element, which 
41
 
can contain multiple &lt;source&gt; elements. 
42
 
The following attributes are allowed:
43
 
<variablelist>
44
 
 
45
 
<varlistentry>
46
 
<term>stock-id</term>
47
 
<listitem><para>The stock id of the source, a string.
48
 
This attribute is mandatory</para></listitem>
49
 
</varlistentry>
50
 
 
51
 
<varlistentry>
52
 
<term>filename</term>
53
 
<listitem><para>The filename of the source, a string.
54
 
This attribute is optional</para>
55
 
</listitem>
56
 
</varlistentry>
57
 
 
58
 
<varlistentry>
59
 
<term>icon-name</term>
60
 
<listitem><para>The icon name for the source, a string.
61
 
This attribute is optional.</para>
62
 
</listitem>
63
 
</varlistentry>
64
 
 
65
 
<varlistentry>
66
 
<term>size</term>
67
 
<listitem><para>Size of the icon, a #GtkIconSize enum value. 
68
 
This attribute is optional.</para>
69
 
</listitem>
70
 
</varlistentry>
71
 
 
72
 
<varlistentry>
73
 
<term>direction</term>
74
 
<listitem><para>Direction of the source, a #GtkTextDirection enum value.
75
 
This attribute is optional.</para>
76
 
</listitem>
77
 
</varlistentry>
78
 
 
79
 
<varlistentry>
80
 
<term>state</term>
81
 
<listitem><para>State of the source, a #GtkStateType enum value.
82
 
This attribute is optional.</para>
83
 
</listitem>
84
 
</varlistentry>
85
 
 
86
 
</variablelist>
87
 
 
88
 
</para>
89
 
<example>
90
 
<title>A <structname>GtkIconFactory</structname> UI definition fragment.</title>
91
 
<programlisting><![CDATA[
92
 
<object class="GtkIconFactory" id="iconfactory1">
93
 
  <sources>
94
 
    <source stock-id="apple-red" filename="apple-red.png"/>
95
 
  </sources>
96
 
</object>
97
 
<object class="GtkWindow" id="window1">
98
 
  <child>
99
 
    <object class="GtkButton" id="apple_button">
100
 
      <property name="label">apple-red</property>
101
 
      <property name="use-stock">True</property>
102
 
    </object>
103
 
  </child>
104
 
</object>
105
 
]]></programlisting>
106
 
</example>
107
 
</refsect2>
108
 
 
109
 
<!-- ##### SECTION See_Also ##### -->
110
 
<para>
111
 
 
112
 
</para>
113
 
 
114
 
<!-- ##### SECTION Stability_Level ##### -->
115
 
 
116
 
 
117
 
<!-- ##### SECTION Image ##### -->
118
 
 
119
 
 
120
 
<!-- ##### STRUCT GtkIconSource ##### -->
121
 
<para>
122
 
 
123
 
</para>
124
 
 
125
 
 
126
 
<!-- ##### STRUCT GtkIconFactory ##### -->
127
 
<para>
128
 
 
129
 
</para>
130
 
 
131
 
 
132
 
<!-- ##### STRUCT GtkIconSet ##### -->
133
 
<para>
134
 
 
135
 
</para>
136
 
 
137
 
 
138
 
<!-- ##### ENUM GtkIconSize ##### -->
139
 
<para>
140
 
 
141
 
</para>
142
 
 
143
 
@GTK_ICON_SIZE_INVALID: 
144
 
@GTK_ICON_SIZE_MENU: 
145
 
@GTK_ICON_SIZE_SMALL_TOOLBAR: 
146
 
@GTK_ICON_SIZE_LARGE_TOOLBAR: 
147
 
@GTK_ICON_SIZE_BUTTON: 
148
 
@GTK_ICON_SIZE_DND: 
149
 
@GTK_ICON_SIZE_DIALOG: 
150
 
 
151
 
<!-- ##### FUNCTION gtk_icon_source_copy ##### -->
152
 
<para>
153
 
 
154
 
</para>
155
 
 
156
 
@source: 
157
 
@Returns: 
158
 
 
159
 
 
160
 
<!-- ##### FUNCTION gtk_icon_source_free ##### -->
161
 
<para>
162
 
 
163
 
</para>
164
 
 
165
 
@source: 
166
 
 
167
 
 
168
 
<!-- ##### FUNCTION gtk_icon_factory_add ##### -->
169
 
<para>
170
 
 
171
 
</para>
172
 
 
173
 
@factory: 
174
 
@stock_id: 
175
 
@icon_set: 
176
 
 
177
 
 
178
 
<!-- ##### FUNCTION gtk_icon_factory_add_default ##### -->
179
 
<para>
180
 
 
181
 
</para>
182
 
 
183
 
@factory: 
184
 
 
185
 
 
186
 
<!-- ##### FUNCTION gtk_icon_factory_lookup ##### -->
187
 
<para>
188
 
 
189
 
</para>
190
 
 
191
 
@factory: 
192
 
@stock_id: 
193
 
@Returns: 
194
 
 
195
 
 
196
 
<!-- ##### FUNCTION gtk_icon_factory_lookup_default ##### -->
197
 
<para>
198
 
 
199
 
</para>
200
 
 
201
 
@stock_id: 
202
 
@Returns: 
203
 
 
204
 
 
205
 
<!-- ##### FUNCTION gtk_icon_factory_new ##### -->
206
 
<para>
207
 
 
208
 
</para>
209
 
 
210
 
@void: 
211
 
@Returns: 
212
 
 
213
 
 
214
 
<!-- ##### FUNCTION gtk_icon_factory_remove_default ##### -->
215
 
<para>
216
 
 
217
 
</para>
218
 
 
219
 
@factory: 
220
 
 
221
 
 
222
 
<!-- ##### FUNCTION gtk_icon_set_add_source ##### -->
223
 
<para>
224
 
 
225
 
</para>
226
 
 
227
 
@icon_set: 
228
 
@source: 
229
 
 
230
 
 
231
 
<!-- ##### FUNCTION gtk_icon_set_copy ##### -->
232
 
<para>
233
 
 
234
 
</para>
235
 
 
236
 
@icon_set: 
237
 
@Returns: 
238
 
 
239
 
 
240
 
<!-- ##### FUNCTION gtk_icon_set_new ##### -->
241
 
<para>
242
 
 
243
 
</para>
244
 
 
245
 
@void: 
246
 
@Returns: 
247
 
 
248
 
 
249
 
<!-- ##### FUNCTION gtk_icon_set_new_from_pixbuf ##### -->
250
 
<para>
251
 
 
252
 
</para>
253
 
 
254
 
@pixbuf: 
255
 
@Returns: 
256
 
 
257
 
 
258
 
<!-- ##### FUNCTION gtk_icon_set_ref ##### -->
259
 
<para>
260
 
 
261
 
</para>
262
 
 
263
 
@icon_set: 
264
 
@Returns: 
265
 
 
266
 
 
267
 
<!-- ##### FUNCTION gtk_icon_set_render_icon ##### -->
268
 
<para>
269
 
 
270
 
</para>
271
 
 
272
 
@icon_set: 
273
 
@style: 
274
 
@direction: 
275
 
@state: 
276
 
@size: 
277
 
@widget: 
278
 
@detail: 
279
 
@Returns: 
280
 
 
281
 
 
282
 
<!-- ##### FUNCTION gtk_icon_set_unref ##### -->
283
 
<para>
284
 
 
285
 
</para>
286
 
 
287
 
@icon_set: 
288
 
 
289
 
 
290
 
<!-- ##### FUNCTION gtk_icon_size_lookup ##### -->
291
 
<para>
292
 
 
293
 
</para>
294
 
 
295
 
@size: 
296
 
@width: 
297
 
@height: 
298
 
@Returns: 
299
 
 
300
 
 
301
 
<!-- ##### FUNCTION gtk_icon_size_lookup_for_settings ##### -->
302
 
<para>
303
 
 
304
 
</para>
305
 
 
306
 
@settings: 
307
 
@size: 
308
 
@width: 
309
 
@height: 
310
 
@Returns: 
311
 
 
312
 
 
313
 
<!-- ##### FUNCTION gtk_icon_size_register ##### -->
314
 
<para>
315
 
 
316
 
</para>
317
 
 
318
 
@name: 
319
 
@width: 
320
 
@height: 
321
 
@Returns: 
322
 
 
323
 
 
324
 
<!-- ##### FUNCTION gtk_icon_size_register_alias ##### -->
325
 
<para>
326
 
 
327
 
</para>
328
 
 
329
 
@alias: 
330
 
@target: 
331
 
 
332
 
 
333
 
<!-- ##### FUNCTION gtk_icon_size_from_name ##### -->
334
 
<para>
335
 
 
336
 
</para>
337
 
 
338
 
@name: 
339
 
@Returns: 
340
 
 
341
 
 
342
 
<!-- ##### FUNCTION gtk_icon_size_get_name ##### -->
343
 
<para>
344
 
 
345
 
</para>
346
 
 
347
 
@size: 
348
 
@Returns: 
349
 
 
350
 
 
351
 
<!-- ##### FUNCTION gtk_icon_set_get_sizes ##### -->
352
 
<para>
353
 
 
354
 
</para>
355
 
 
356
 
@icon_set: 
357
 
@sizes: 
358
 
@n_sizes: 
359
 
 
360
 
 
361
 
<!-- ##### FUNCTION gtk_icon_source_get_direction ##### -->
362
 
<para>
363
 
 
364
 
</para>
365
 
 
366
 
@source: 
367
 
@Returns: 
368
 
 
369
 
 
370
 
<!-- ##### FUNCTION gtk_icon_source_get_direction_wildcarded ##### -->
371
 
<para>
372
 
 
373
 
</para>
374
 
 
375
 
@source: 
376
 
@Returns: 
377
 
 
378
 
 
379
 
<!-- ##### MACRO gtk_icon_source_get_filename ##### -->
380
 
<para>
381
 
 
382
 
</para>
383
 
 
384
 
@Returns: 
385
 
 
386
 
 
387
 
<!-- ##### FUNCTION gtk_icon_source_get_pixbuf ##### -->
388
 
<para>
389
 
 
390
 
</para>
391
 
 
392
 
@source: 
393
 
@Returns: 
394
 
 
395
 
 
396
 
<!-- ##### FUNCTION gtk_icon_source_get_icon_name ##### -->
397
 
<para>
398
 
 
399
 
</para>
400
 
 
401
 
@source: 
402
 
@Returns: 
403
 
 
404
 
 
405
 
<!-- ##### FUNCTION gtk_icon_source_get_size ##### -->
406
 
<para>
407
 
 
408
 
</para>
409
 
 
410
 
@source: 
411
 
@Returns: 
412
 
 
413
 
 
414
 
<!-- ##### FUNCTION gtk_icon_source_get_size_wildcarded ##### -->
415
 
<para>
416
 
 
417
 
</para>
418
 
 
419
 
@source: 
420
 
@Returns: 
421
 
 
422
 
 
423
 
<!-- ##### FUNCTION gtk_icon_source_get_state ##### -->
424
 
<para>
425
 
 
426
 
</para>
427
 
 
428
 
@source: 
429
 
@Returns: 
430
 
 
431
 
 
432
 
<!-- ##### FUNCTION gtk_icon_source_get_state_wildcarded ##### -->
433
 
<para>
434
 
 
435
 
</para>
436
 
 
437
 
@source: 
438
 
@Returns: 
439
 
 
440
 
 
441
 
<!-- ##### FUNCTION gtk_icon_source_new ##### -->
442
 
<para>
443
 
 
444
 
</para>
445
 
 
446
 
@void: 
447
 
@Returns: 
448
 
 
449
 
 
450
 
<!-- ##### FUNCTION gtk_icon_source_set_direction ##### -->
451
 
<para>
452
 
 
453
 
</para>
454
 
 
455
 
@source: 
456
 
@direction: 
457
 
 
458
 
 
459
 
<!-- ##### FUNCTION gtk_icon_source_set_direction_wildcarded ##### -->
460
 
<para>
461
 
 
462
 
</para>
463
 
 
464
 
@source: 
465
 
@setting: 
466
 
 
467
 
 
468
 
<!-- ##### MACRO gtk_icon_source_set_filename ##### -->
469
 
<para>
470
 
 
471
 
</para>
472
 
 
473
 
 
474
 
 
475
 
<!-- ##### FUNCTION gtk_icon_source_set_pixbuf ##### -->
476
 
<para>
477
 
 
478
 
</para>
479
 
 
480
 
@source: 
481
 
@pixbuf: 
482
 
 
483
 
 
484
 
<!-- ##### FUNCTION gtk_icon_source_set_icon_name ##### -->
485
 
<para>
486
 
 
487
 
</para>
488
 
 
489
 
@source: 
490
 
@icon_name: 
491
 
 
492
 
 
493
 
<!-- ##### FUNCTION gtk_icon_source_set_size ##### -->
494
 
<para>
495
 
 
496
 
</para>
497
 
 
498
 
@source: 
499
 
@size: 
500
 
 
501
 
 
502
 
<!-- ##### FUNCTION gtk_icon_source_set_size_wildcarded ##### -->
503
 
<para>
504
 
 
505
 
</para>
506
 
 
507
 
@source: 
508
 
@setting: 
509
 
 
510
 
 
511
 
<!-- ##### FUNCTION gtk_icon_source_set_state ##### -->
512
 
<para>
513
 
 
514
 
</para>
515
 
 
516
 
@source: 
517
 
@state: 
518
 
 
519
 
 
520
 
<!-- ##### FUNCTION gtk_icon_source_set_state_wildcarded ##### -->
521
 
<para>
522
 
 
523
 
</para>
524
 
 
525
 
@source: 
526
 
@setting: 
527
 
 
528