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
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Gtk::IconSource Class Reference</h1>A GtkIconSource C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="iconfactory_8hh-source.html">gfc/gtk/iconfactory.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gtk::IconSource:
<p><center><img src="classGFC_1_1Gtk_1_1IconSource.png" usemap="#GFC::Gtk::IconSource_map" border="0" alt=""></center>
<map name="GFC::Gtk::IconSource_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Boxed.html" alt="GFC::G::Boxed" shape="rect" coords="0,112,133,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1Object.html" alt="GFC::Object" shape="rect" coords="0,56,133,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,133,24">
</map>
<a href="classGFC_1_1Gtk_1_1IconSource-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z581_0" doxytag="GFC::Gtk::IconSource::IconSource" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z581_0">IconSource</a> ()
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html">IconSource</a>. <br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z581_1">IconSource</a> (GtkIconSource *source)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html">IconSource</a> from an existing GtkIconSource. <a href="#z581_1"></a><br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z581_2">IconSource</a> (GtkIconSource *source, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Boxed.html#z5_0">copy</a>)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html">IconSource</a> from an existing GtkIconSource. <a href="#z581_2"></a><br></dl><li><a class="anchor" name="z581_3" doxytag="GFC::Gtk::IconSource::IconSource" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z581_3">IconSource</a> (const <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html">IconSource</a> &src)
<dl class="el"><dd class="mdescRight">Copy constructor. <br></dl><li><a class="anchor" name="z581_4" doxytag="GFC::Gtk::IconSource::~IconSource" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z581_4">~IconSource</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl><li><a class="anchor" name="z581_5" doxytag="GFC::Gtk::IconSource::operator=" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1IconSource.html">IconSource</a> & <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z581_5">operator=</a> (const <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html">IconSource</a> &src)
<dl class="el"><dd class="mdescRight">Assignment operator. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z582_0" doxytag="GFC::Gtk::IconSource::gtk_icon_source" ></a>
GtkIconSource * <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z582_0">gtk_icon_source</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkIconSource structure. <br></dl><li><a class="anchor" name="z582_1" doxytag="GFC::Gtk::IconSource::operator GtkIconSource *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z582_1">operator GtkIconSource *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts an <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html">IconSource</a> to a GtkIconSource pointer. <br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z582_2">get_filename</a> () const
<dl class="el"><dd class="mdescRight">Retrieves the source filename. <a href="#z582_2"></a><br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z582_3">get_icon_name</a> () const
<dl class="el"><dd class="mdescRight">Retrieves the source icon name, or null if none is set. <a href="#z582_3"></a><br></dl><li><a class="el" href="classGFC_1_1Gdk_1_1Pixbuf.html">Gdk::Pixbuf</a> * <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z582_4">get_pixbuf</a> () const
<dl class="el"><dd class="mdescRight">Retrieves the source pixbuf, or null if none is set. <a href="#z582_4"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z582_5">get_size_wildcarded</a> () const
<dl class="el"><dd class="mdescRight">Gets the value set by <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_7">set_size_wildcarded()</a>. <a href="#z582_5"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z582_6">get_state_wildcarded</a> () const
<dl class="el"><dd class="mdescRight">Gets the value set by <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_6">set_state_wildcarded()</a>. <a href="#z582_6"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z582_7">get_direction_wildcarded</a> () const
<dl class="el"><dd class="mdescRight">Gets the value set by <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_5">set_direction_wildcarded()</a>. <a href="#z582_7"></a><br></dl><li><a class="el" href="namespaceGFC_1_1Gtk.html#a341">TextDirection</a> <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z582_8">get_direction</a> () const
<dl class="el"><dd class="mdescRight">Obtains the text direction this icon source applies to. <a href="#z582_8"></a><br></dl><li><a class="el" href="namespaceGFC_1_1Gtk.html#a340">StateType</a> <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z582_9">get_state</a> () const
<dl class="el"><dd class="mdescRight">Obtains the widget state this icon source applies to. <a href="#z582_9"></a><br></dl><li><a class="el" href="namespaceGFC_1_1Gtk.html#a325">IconSize</a> <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z582_10">get_size</a> () const
<dl class="el"><dd class="mdescRight">Obtains the icon size this icon source applies to. <a href="#z582_10"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>void <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_1">set_filename</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &filename)
<dl class="el"><dd class="mdescRight">Sets the name of an image file to use as a base image when creating icon variants for <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a>. <a href="#z583_1"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_3">set_icon_name</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &icon_name)
<dl class="el"><dd class="mdescRight">Sets the name of an icon to look up in the current icon theme, to use as a base image when creating icon variants for <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">Gtk::IconSet</a>. <a href="#z583_3"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_4">set_pixbuf</a> (<a class="el" href="classGFC_1_1Gdk_1_1Pixbuf.html">Gdk::Pixbuf</a> *pixbuf)
<dl class="el"><dd class="mdescRight">Sets a pixbuf to use as a base image when creating icon variants for <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a>. <a href="#z583_4"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_5">set_direction_wildcarded</a> (bool setting)
<dl class="el"><dd class="mdescRight">If the text direction is wildcarded, this source can be used as the base image for an icon in any TextDirection. <a href="#z583_5"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_6">set_state_wildcarded</a> (bool setting)
<dl class="el"><dd class="mdescRight">If the widget state is wildcarded, this source can be used as the base image for an icon in any StateType. <a href="#z583_6"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_7">set_size_wildcarded</a> (bool setting)
<dl class="el"><dd class="mdescRight">If the icon size is wildcarded, this source can be used as the base image for an icon of any size. <a href="#z583_7"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_8">set_direction</a> (<a class="el" href="namespaceGFC_1_1Gtk.html#a341">TextDirection</a> direction)
<dl class="el"><dd class="mdescRight">Sets the text direction this icon source is intended to be used with. <a href="#z583_8"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_9">set_state</a> (<a class="el" href="namespaceGFC_1_1Gtk.html#a340">StateType</a> state)
<dl class="el"><dd class="mdescRight">Sets the widget state this icon source is intended to be used with. <a href="#z583_9"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_10">set_size</a> (<a class="el" href="namespaceGFC_1_1Gtk.html#a325">IconSize</a> size)
<dl class="el"><dd class="mdescRight">Sets the icon size this icon source is intended to be used with. <a href="#z583_10"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkIconSource C++ wrapper class.
<p>
An <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html">IconSource</a> contains a <a class="el" href="classGFC_1_1Gdk_1_1Pixbuf.html">Gdk::Pixbuf</a> (or image filename) that serves as the base image for one or more of the icons in an <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a>, along with a specification for which icons in the icon set will be based on that pixbuf or image file. An icon set contains a set of icons that represent "the same" logical concept in different states, different global text directions, and different sizes.<p>
So for example a web browser's "Back to Previous Page" icon might point in a different direction in Hebrew and in English; it might look different when insensitive; and it might change size depending on toolbar mode (small/large icons). So a single icon set would contain all those variants of the icon. <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a> contains a list of <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html">IconSource</a> from which it can derive specific icon variants in the set.<p>
In the simplest case, <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a> contains one source pixbuf from which it derives all variants. The constructor IconSource(Gdk::Pixbuf&) handles this case; if you only have one source pixbuf, just use that constructor. If you want to use a different base pixbuf for different icon variants, you create multiple icon sources, mark which variants they'll be used to create, and add them to the icon set with <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html#z580_1">Gtk::IconSet::add_source()</a>. By default, the icon source has all parameters wildcarded. That is, the icon source will be used as the base icon for any desired text direction, widget state, or icon size.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z581_1" doxytag="GFC::Gtk::IconSource::IconSource" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Gtk::IconSource::IconSource </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkIconSource * </td>
<td class="mdname1" valign="top" nowrap> <em>source</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [explicit]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html">IconSource</a> from an existing GtkIconSource.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>source</em> </td><td>A GtkIconSource.</td></tr>
</table>
</dl>
<br>
This constructor creates a temporary wrapper for a GtkIconSource. It neither copies the GtkIconSource or takes over its ownership. </td>
</tr>
</table>
<a class="anchor" name="z581_2" doxytag="GFC::Gtk::IconSource::IconSource" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Gtk::IconSource::IconSource </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkIconSource * </td>
<td class="mdname" nowrap> <em>source</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>copy</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html">IconSource</a> from an existing GtkIconSource.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>source</em> </td><td>A GtkIconSource. </td></tr>
<tr><td></td><td valign=top><em>copy</em> </td><td><em>true</em> if a copy of GtkIconSource should be made.</td></tr>
</table>
</dl>
<br>
This constructor either takes over the ownership of the GtkIconSource, or makes a copy of the GtkIconSource. It is primarily intended for use by the <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Boxed.html#z6_0">G::Boxed::wrap()</a> method. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z582_8" doxytag="GFC::Gtk::IconSource::get_direction" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceGFC_1_1Gtk.html#a341">TextDirection</a> GFC::Gtk::IconSource::get_direction </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Obtains the text direction this icon source applies to.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The text direction this source matches.</dd></dl>
<br>
The return value is only useful/meaningful if the text direction is not wildcarded. </td>
</tr>
</table>
<a class="anchor" name="z582_7" doxytag="GFC::Gtk::IconSource::get_direction_wildcarded" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gtk::IconSource::get_direction_wildcarded </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the value set by <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_5">set_direction_wildcarded()</a>.
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if this icon source is a base for any text direction variant. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z582_2" doxytag="GFC::Gtk::IconSource::get_filename" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> GFC::Gtk::IconSource::get_filename </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the source filename.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The source filename or a null <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> if none is set. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z582_3" doxytag="GFC::Gtk::IconSource::get_icon_name" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> GFC::Gtk::IconSource::get_icon_name </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the source icon name, or null if none is set.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The icon name. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z582_4" doxytag="GFC::Gtk::IconSource::get_pixbuf" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classGFC_1_1Gdk_1_1Pixbuf.html">Gdk::Pixbuf</a>* GFC::Gtk::IconSource::get_pixbuf </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the source pixbuf, or null if none is set.
<p>
The reference count on the pixbuf is not incremented. </td>
</tr>
</table>
<a class="anchor" name="z582_10" doxytag="GFC::Gtk::IconSource::get_size" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceGFC_1_1Gtk.html#a325">IconSize</a> GFC::Gtk::IconSource::get_size </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Obtains the icon size this icon source applies to.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The icon size this source matches.</dd></dl>
<br>
The return value is only useful/meaningful if the icon size is not wildcarded. </td>
</tr>
</table>
<a class="anchor" name="z582_5" doxytag="GFC::Gtk::IconSource::get_size_wildcarded" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gtk::IconSource::get_size_wildcarded </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the value set by <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_7">set_size_wildcarded()</a>.
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if this icon source is a base for any icon size variant. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z582_9" doxytag="GFC::Gtk::IconSource::get_state" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceGFC_1_1Gtk.html#a340">StateType</a> GFC::Gtk::IconSource::get_state </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Obtains the widget state this icon source applies to.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The widget state this source matches.</dd></dl>
<br>
The return value is only useful/meaningful if the widget state is not wildcarded. </td>
</tr>
</table>
<a class="anchor" name="z582_6" doxytag="GFC::Gtk::IconSource::get_state_wildcarded" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gtk::IconSource::get_state_wildcarded </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the value set by <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_6">set_state_wildcarded()</a>.
<p>
return <em>true</em> if this icon source is a base for any widget state variant. </td>
</tr>
</table>
<a class="anchor" name="z583_8" doxytag="GFC::Gtk::IconSource::set_direction" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::IconSource::set_direction </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Gtk.html#a341">TextDirection</a> </td>
<td class="mdname1" valign="top" nowrap> <em>direction</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the text direction this icon source is intended to be used with.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>direction</em> </td><td>The text direction this source applies to.</td></tr>
</table>
</dl>
<br>
Setting the text direction on an icon source makes no difference if the text direction is wildcarded. Therefore, you should usually call <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_5">set_direction_wildcarded()</a> to un-wildcard it in addition to calling this method. </td>
</tr>
</table>
<a class="anchor" name="z583_5" doxytag="GFC::Gtk::IconSource::set_direction_wildcarded" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::IconSource::set_direction_wildcarded </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>setting</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
If the text direction is wildcarded, this source can be used as the base image for an icon in any TextDirection.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>setting</em> </td><td><em>true</em> to wildcard the text direction.</td></tr>
</table>
</dl>
<br>
If the text direction is not wildcarded, then the text direction the icon source applies to should be set with <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_8">set_direction()</a>, and the icon source will only be used with that text direction. <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a> prefers non-wildcarded sources (exact matches) over wildcarded sources, and will use an exact match when possible. </td>
</tr>
</table>
<a class="anchor" name="z583_1" doxytag="GFC::Gtk::IconSource::set_filename" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::IconSource::set_filename </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>filename</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the name of an image file to use as a base image when creating icon variants for <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>filename</em> </td><td>The image file to use.</td></tr>
</table>
</dl>
<br>
The filename must be absolute. </td>
</tr>
</table>
<a class="anchor" name="z583_3" doxytag="GFC::Gtk::IconSource::set_icon_name" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::IconSource::set_icon_name </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>icon_name</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the name of an icon to look up in the current icon theme, to use as a base image when creating icon variants for <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">Gtk::IconSet</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>icon_name</em> </td><td>The name of icon to use. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z583_4" doxytag="GFC::Gtk::IconSource::set_pixbuf" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::IconSource::set_pixbuf </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Gdk_1_1Pixbuf.html">Gdk::Pixbuf</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>pixbuf</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets a pixbuf to use as a base image when creating icon variants for <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>pixbuf</em> </td><td>The pixbuf to use as a source.</td></tr>
</table>
</dl>
<br>
If an icon source has both a filename and a pixbuf set, the pixbuf will take priority. </td>
</tr>
</table>
<a class="anchor" name="z583_10" doxytag="GFC::Gtk::IconSource::set_size" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::IconSource::set_size </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Gtk.html#a325">IconSize</a> </td>
<td class="mdname1" valign="top" nowrap> <em>size</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the icon size this icon source is intended to be used with.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>size</em> </td><td>The icon size this source applies to.</td></tr>
</table>
</dl>
<br>
Setting the icon size on an icon source makes no difference if the size is wildcarded. Therefore, you should usually call <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_7">set_size_wildcarded()</a> to un-wildcard it in addition to calling this method. </td>
</tr>
</table>
<a class="anchor" name="z583_7" doxytag="GFC::Gtk::IconSource::set_size_wildcarded" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::IconSource::set_size_wildcarded </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>setting</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
If the icon size is wildcarded, this source can be used as the base image for an icon of any size.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>setting</em> </td><td><em>true</em> to wildcard the icon size.</td></tr>
</table>
</dl>
<br>
If the size is not wildcarded, then the size the source applies to should be set with <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_10">set_size()</a> and the icon source will only be used with that specific size. <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a> prefers non-wildcarded sources (exact matches) over wildcarded sources, and will use an exact match when possible. <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a> will normally scale wildcarded source images to produce an appropriate icon at a given size, but will not change the size of source images that match exactly. </td>
</tr>
</table>
<a class="anchor" name="z583_9" doxytag="GFC::Gtk::IconSource::set_state" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::IconSource::set_state </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Gtk.html#a340">StateType</a> </td>
<td class="mdname1" valign="top" nowrap> <em>state</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the widget state this icon source is intended to be used with.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>state</em> </td><td>The widget state this source applies to.</td></tr>
</table>
</dl>
<br>
Setting the widget state on an icon source makes no difference if the state is wildcarded. Therefore, you should usually call <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_6">set_state_wildcarded()</a> to un-wildcard it in addition to calling this method. </td>
</tr>
</table>
<a class="anchor" name="z583_6" doxytag="GFC::Gtk::IconSource::set_state_wildcarded" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::IconSource::set_state_wildcarded </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>setting</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
If the widget state is wildcarded, this source can be used as the base image for an icon in any StateType.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>setting</em> </td><td><em>true</em> to wildcard the widget state.</td></tr>
</table>
</dl>
<br>
If the widget state is not wildcarded, then the state the source applies to should be set with <a class="el" href="classGFC_1_1Gtk_1_1IconSource.html#z583_9">set_state()</a> and the icon source will only be used with that specific state. <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a> prefers non-wildcarded sources (exact matches) over wildcarded sources, and will use an exact match when possible. <a class="el" href="classGFC_1_1Gtk_1_1IconSet.html">IconSet</a> will normally transform wildcarded source images to produce an appropriate icon for a given state, for example lightening an image on prelight, but will not modify source images that match exactly. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="iconsource_8hh-source.html">iconsource.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:40 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
