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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>gtkmm: Gtk::IconInfo Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceGtk.html">Gtk</a>::<a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>
</div>
</div>
<div class="contents">
<h1>Gtk::IconInfo Class Reference</h1><!-- doxytag: class="Gtk::IconInfo" -->
<p><a href="classGtk_1_1IconInfo-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#ad000ee1d628f675910d434921a4bb4b4">IconInfo</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#ac5df0aa15650ffbbf7bf8560fb13df9c">IconInfo</a> (GtkIconInfo* gobject, bool make_a_copy=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#ab9bcacc37486ff2ded56ca4a6a9e2cac">IconInfo</a> (const <a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& other)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a97b873870f84ffc61d4539aa291be36e">operator=</a> (const <a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& other)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#ad404781178414d4f7ef9422fa04731b3">~IconInfo</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a88aac698e99e70ff2a87632debe26605">swap</a> (<a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& other)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkIconInfo* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a1159ab56328b1a410f06d86ef77d4ce1">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. <a href="#a1159ab56328b1a410f06d86ef77d4ce1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GtkIconInfo* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a3a935a8c376e729490ba66c0631685d8">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. <a href="#a3a935a8c376e729490ba66c0631685d8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkIconInfo* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a0bb1db80eedf7c85bd87a6f41ae59c5c">gobj_copy</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs. <a href="#a0bb1db80eedf7c85bd87a6f41ae59c5c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#ae0aa7f9a3058745cb147c511c97d9a99">IconInfo</a> (const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1IconTheme.html">IconTheme</a> >& icon_theme, const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> >& pixbuf)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a4e0ff5422c708a3a5e451786190a6f07">operator bool</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#adf705ebac396ef663775182f3f028b97">operator bool</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tests whether the <a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a> is valid. <a href="#adf705ebac396ef663775182f3f028b97"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a360b401f202d85266d14c357884bc9ca">get_base_size</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the base size for the icon. <a href="#a360b401f202d85266d14c357884bc9ca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a991fed1842e82757a693f6a607ce2150">get_filename</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the filename for the icon. <a href="#a991fed1842e82757a693f6a607ce2150"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#acbdf9a42ea5ae1a89bccd83719ecc3ed">get_builtin_pixbuf</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the built-in image for this icon, if any. <a href="#acbdf9a42ea5ae1a89bccd83719ecc3ed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a237c51033cff74382f35103b4e6579b8">get_builtin_pixbuf</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the built-in image for this icon, if any. <a href="#a237c51033cff74382f35103b4e6579b8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a5eec966046321610dba070b3c8d7e8e6">load_icon</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Renders an icon previously looked up in an icon theme using <a class="el" href="classGtk_1_1IconTheme.html#add25d62c56474a4c0d3530240061c82f" title="Looks up a named icon and returns a structure containing information such as the...">Gtk::IconTheme::lookup_icon()</a>; the size will be based on the size passed to <a class="el" href="classGtk_1_1IconTheme.html#add25d62c56474a4c0d3530240061c82f" title="Looks up a named icon and returns a structure containing information such as the...">Gtk::IconTheme::lookup_icon()</a>. <a href="#a5eec966046321610dba070b3c8d7e8e6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a529c4c1e8729c18e7c7b43feaaf63d67">set_raw_coordinates</a> (bool raw_coordinates=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the coordinates returned by <a class="el" href="classGtk_1_1IconInfo.html#a6737ad0cb2c087788393c6435570bfff" title="Gets the coordinates of a rectangle within the icon that can be used for display...">get_embedded_rect()</a> and <a class="el" href="classGtk_1_1IconInfo.html#ae6831618801c6e7771eaffcd6c79c902">get_attach_points()</a> should be returned in their original form as specified in the icon theme, instead of scaled appropriately for the pixbuf returned by <a class="el" href="classGtk_1_1IconInfo.html#a5eec966046321610dba070b3c8d7e8e6" title="Renders an icon previously looked up in an icon theme using Gtk::IconTheme::lookup_icon();...">load_icon()</a>. <a href="#a529c4c1e8729c18e7c7b43feaaf63d67"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a6737ad0cb2c087788393c6435570bfff">get_embedded_rect</a> (<a class="el" href="classGdk_1_1Rectangle.html">Gdk::Rectangle</a>& rectangle) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the coordinates of a rectangle within the icon that can be used for display of information such as a preview of the contents of a text file. <a href="#a6737ad0cb2c087788393c6435570bfff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#ae6831618801c6e7771eaffcd6c79c902">get_attach_points</a> (<a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< <a class="el" href="classGdk_1_1Point.html">Gdk::Point</a> >& points) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#af340104bf0354439311f197ce88065c1">get_display_name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the display name for an icon. <a href="#af340104bf0354439311f197ce88065c1"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkIconInfo* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#adb0929f2020199570662394b264e5086">gobject_</a></td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1IconInfo.html">Gtk::IconInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#acdc54b26a982305d52967d4c99c0a0d1">wrap</a> (GtkIconInfo* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#acdc54b26a982305d52967d4c99c0a0d1"></a><br/></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad000ee1d628f675910d434921a4bb4b4"></a><!-- doxytag: member="Gtk::IconInfo::IconInfo" ref="ad000ee1d628f675910d434921a4bb4b4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::IconInfo::IconInfo </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac5df0aa15650ffbbf7bf8560fb13df9c"></a><!-- doxytag: member="Gtk::IconInfo::IconInfo" ref="ac5df0aa15650ffbbf7bf8560fb13df9c" args="(GtkIconInfo *gobject, bool make_a_copy=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::IconInfo::IconInfo </td>
<td>(</td>
<td class="paramtype">GtkIconInfo * </td>
<td class="paramname"> <em>gobject</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>make_a_copy</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ab9bcacc37486ff2ded56ca4a6a9e2cac"></a><!-- doxytag: member="Gtk::IconInfo::IconInfo" ref="ab9bcacc37486ff2ded56ca4a6a9e2cac" args="(const IconInfo &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::IconInfo::IconInfo </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& </td>
<td class="paramname"> <em>other</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad404781178414d4f7ef9422fa04731b3"></a><!-- doxytag: member="Gtk::IconInfo::~IconInfo" ref="ad404781178414d4f7ef9422fa04731b3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::IconInfo::~IconInfo </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae0aa7f9a3058745cb147c511c97d9a99"></a><!-- doxytag: member="Gtk::IconInfo::IconInfo" ref="ae0aa7f9a3058745cb147c511c97d9a99" args="(const Glib::RefPtr< IconTheme > &icon_theme, const Glib::RefPtr< Gdk::Pixbuf > &pixbuf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::IconInfo::IconInfo </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1IconTheme.html">IconTheme</a> >& </td>
<td class="paramname"> <em>icon_theme</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> >& </td>
<td class="paramname"> <em>pixbuf</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae6831618801c6e7771eaffcd6c79c902"></a><!-- doxytag: member="Gtk::IconInfo::get_attach_points" ref="ae6831618801c6e7771eaffcd6c79c902" args="(Glib::ArrayHandle< Gdk::Point > &points) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gtk::IconInfo::get_attach_points </td>
<td>(</td>
<td class="paramtype"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< <a class="el" href="classGdk_1_1Point.html">Gdk::Point</a> >& </td>
<td class="paramname"> <em>points</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a360b401f202d85266d14c357884bc9ca"></a><!-- doxytag: member="Gtk::IconInfo::get_base_size" ref="a360b401f202d85266d14c357884bc9ca" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Gtk::IconInfo::get_base_size </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the base size for the icon. </p>
<p>The base size is a size for the icon that was specified by the icon theme creator. This may be different than the actual size of image; an example of this is small emblem icons that can be attached to a larger icon. These icons will be given the same base size as the larger icons to which they are attached.</p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000188">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The base size, or 0, if no base size is known for the icon. </dd></dl>
</div>
</div>
<a class="anchor" id="a237c51033cff74382f35103b4e6579b8"></a><!-- doxytag: member="Gtk::IconInfo::get_builtin_pixbuf" ref="a237c51033cff74382f35103b4e6579b8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>> Gtk::IconInfo::get_builtin_pixbuf </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the built-in image for this icon, if any. </p>
<p>To allow GTK+ to use built in icon images, you must pass the <a class="el" href="group__gtkmmEnums.html#gga6d0c2193613cfb97ab313746a5bacaa2a1cb5a2b192ca13e232b3b4fff832f1c6">Gtk::ICON_LOOKUP_USE_BUILTIN</a> to <a class="el" href="classGtk_1_1IconTheme.html#add25d62c56474a4c0d3530240061c82f" title="Looks up a named icon and returns a structure containing information such as the...">Gtk::IconTheme::lookup_icon()</a>.</p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000191">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The built-in image pixbuf, or <code>0</code>. The returned image must not be modified. </dd></dl>
</div>
</div>
<a class="anchor" id="acbdf9a42ea5ae1a89bccd83719ecc3ed"></a><!-- doxytag: member="Gtk::IconInfo::get_builtin_pixbuf" ref="acbdf9a42ea5ae1a89bccd83719ecc3ed" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>> Gtk::IconInfo::get_builtin_pixbuf </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the built-in image for this icon, if any. </p>
<p>To allow GTK+ to use built in icon images, you must pass the <a class="el" href="group__gtkmmEnums.html#gga6d0c2193613cfb97ab313746a5bacaa2a1cb5a2b192ca13e232b3b4fff832f1c6">Gtk::ICON_LOOKUP_USE_BUILTIN</a> to <a class="el" href="classGtk_1_1IconTheme.html#add25d62c56474a4c0d3530240061c82f" title="Looks up a named icon and returns a structure containing information such as the...">Gtk::IconTheme::lookup_icon()</a>.</p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000190">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The built-in image pixbuf, or <code>0</code>. The returned image must not be modified. </dd></dl>
</div>
</div>
<a class="anchor" id="af340104bf0354439311f197ce88065c1"></a><!-- doxytag: member="Gtk::IconInfo::get_display_name" ref="af340104bf0354439311f197ce88065c1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> Gtk::IconInfo::get_display_name </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the display name for an icon. </p>
<p>A display name is a string to be used in place of the icon name in a user visible context like a list of icons.</p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000195">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The display name for the icon or <code>0</code>, if the icon doesn't have a specified display name. This value is owned <em>icon_info</em> and must not be modified or free. </dd></dl>
</div>
</div>
<a class="anchor" id="a6737ad0cb2c087788393c6435570bfff"></a><!-- doxytag: member="Gtk::IconInfo::get_embedded_rect" ref="a6737ad0cb2c087788393c6435570bfff" args="(Gdk::Rectangle &rectangle) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gtk::IconInfo::get_embedded_rect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGdk_1_1Rectangle.html">Gdk::Rectangle</a>& </td>
<td class="paramname"> <em>rectangle</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the coordinates of a rectangle within the icon that can be used for display of information such as a preview of the contents of a text file. </p>
<p>See <a class="el" href="classGtk_1_1IconInfo.html#a529c4c1e8729c18e7c7b43feaaf63d67" title="Sets whether the coordinates returned by get_embedded_rect() and get_attach_points()...">set_raw_coordinates()</a> for further information about the coordinate system.</p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000194">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rectangle</em> </td><td><a class="el" href="classGdk_1_1Rectangle.html" title="Gdk::Rectangle is a structure holding the position and size of a rectangle.">Gdk::Rectangle</a> in which to store embedded rectangle coordinates; coordinates are only stored when this function returns <code>true</code>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the icon has an embedded rectangle. </dd></dl>
</div>
</div>
<a class="anchor" id="a991fed1842e82757a693f6a607ce2150"></a><!-- doxytag: member="Gtk::IconInfo::get_filename" ref="a991fed1842e82757a693f6a607ce2150" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> Gtk::IconInfo::get_filename </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the filename for the icon. </p>
<p>If the <a class="el" href="group__gtkmmEnums.html#gga6d0c2193613cfb97ab313746a5bacaa2a1cb5a2b192ca13e232b3b4fff832f1c6">Gtk::ICON_LOOKUP_USE_BUILTIN</a> flag was passed to <a class="el" href="classGtk_1_1IconTheme.html#add25d62c56474a4c0d3530240061c82f" title="Looks up a named icon and returns a structure containing information such as the...">Gtk::IconTheme::lookup_icon()</a>, there may be no filename if a builtin icon is returned; in this case, you should use <a class="el" href="classGtk_1_1IconInfo.html#acbdf9a42ea5ae1a89bccd83719ecc3ed" title="Gets the built-in image for this icon, if any.">get_builtin_pixbuf()</a>.</p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000189">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The filename for the icon, or <code>0</code> if <a class="el" href="classGtk_1_1IconInfo.html#acbdf9a42ea5ae1a89bccd83719ecc3ed" title="Gets the built-in image for this icon, if any.">get_builtin_pixbuf()</a> should be used instead. </dd></dl>
</div>
</div>
<a class="anchor" id="a3a935a8c376e729490ba66c0631685d8"></a><!-- doxytag: member="Gtk::IconInfo::gobj" ref="a3a935a8c376e729490ba66c0631685d8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GtkIconInfo* Gtk::IconInfo::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C instance. </p>
</div>
</div>
<a class="anchor" id="a1159ab56328b1a410f06d86ef77d4ce1"></a><!-- doxytag: member="Gtk::IconInfo::gobj" ref="a1159ab56328b1a410f06d86ef77d4ce1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkIconInfo* Gtk::IconInfo::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C instance. </p>
</div>
</div>
<a class="anchor" id="a0bb1db80eedf7c85bd87a6f41ae59c5c"></a><!-- doxytag: member="Gtk::IconInfo::gobj_copy" ref="a0bb1db80eedf7c85bd87a6f41ae59c5c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkIconInfo* Gtk::IconInfo::gobj_copy </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs. </p>
</div>
</div>
<a class="anchor" id="a5eec966046321610dba070b3c8d7e8e6"></a><!-- doxytag: member="Gtk::IconInfo::load_icon" ref="a5eec966046321610dba070b3c8d7e8e6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>> Gtk::IconInfo::load_icon </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Renders an icon previously looked up in an icon theme using <a class="el" href="classGtk_1_1IconTheme.html#add25d62c56474a4c0d3530240061c82f" title="Looks up a named icon and returns a structure containing information such as the...">Gtk::IconTheme::lookup_icon()</a>; the size will be based on the size passed to <a class="el" href="classGtk_1_1IconTheme.html#add25d62c56474a4c0d3530240061c82f" title="Looks up a named icon and returns a structure containing information such as the...">Gtk::IconTheme::lookup_icon()</a>. </p>
<p>Note that the resulting pixbuf may not be exactly this size; an icon theme may have icons that differ slightly from their nominal sizes, and in addition GTK+ will avoid scaling icons that it considers sufficiently close to the requested size or for which the source image would have to be scaled up too far. (This maintains sharpness.). This behaviour can be changed by passing the <a class="el" href="group__gtkmmEnums.html#gga6d0c2193613cfb97ab313746a5bacaa2a9ce2f041e74f7eea98c481f50457b89c">Gtk::ICON_LOOKUP_FORCE_SIZE</a> flag when obtaining the <a class="el" href="classGtk_1_1IconInfo.html">Gtk::IconInfo</a>. If this flag has been specified, the pixbuf returned by this function will be scaled to the exact size.</p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000192">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The rendered icon; this may be a newly created icon or a new reference to an internal icon, so you must not modify the icon. Use Glib::object_unref() to release your reference to the icon. </dd></dl>
</div>
</div>
<a class="anchor" id="adf705ebac396ef663775182f3f028b97"></a><!-- doxytag: member="Gtk::IconInfo::operator bool" ref="adf705ebac396ef663775182f3f028b97" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::IconInfo::operator bool </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tests whether the <a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a> is valid. </p>
</div>
</div>
<a class="anchor" id="a4e0ff5422c708a3a5e451786190a6f07"></a><!-- doxytag: member="Gtk::IconInfo::operator bool" ref="a4e0ff5422c708a3a5e451786190a6f07" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::IconInfo::operator bool </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000036">Deprecated:</a></b></dt><dd>Use the const version. </dd></dl>
</div>
</div>
<a class="anchor" id="a97b873870f84ffc61d4539aa291be36e"></a><!-- doxytag: member="Gtk::IconInfo::operator=" ref="a97b873870f84ffc61d4539aa291be36e" args="(const IconInfo &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& Gtk::IconInfo::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& </td>
<td class="paramname"> <em>other</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a529c4c1e8729c18e7c7b43feaaf63d67"></a><!-- doxytag: member="Gtk::IconInfo::set_raw_coordinates" ref="a529c4c1e8729c18e7c7b43feaaf63d67" args="(bool raw_coordinates=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::IconInfo::set_raw_coordinates </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>raw_coordinates</em> = <code>true</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets whether the coordinates returned by <a class="el" href="classGtk_1_1IconInfo.html#a6737ad0cb2c087788393c6435570bfff" title="Gets the coordinates of a rectangle within the icon that can be used for display...">get_embedded_rect()</a> and <a class="el" href="classGtk_1_1IconInfo.html#ae6831618801c6e7771eaffcd6c79c902">get_attach_points()</a> should be returned in their original form as specified in the icon theme, instead of scaled appropriately for the pixbuf returned by <a class="el" href="classGtk_1_1IconInfo.html#a5eec966046321610dba070b3c8d7e8e6" title="Renders an icon previously looked up in an icon theme using Gtk::IconTheme::lookup_icon();...">load_icon()</a>. </p>
<p>Raw coordinates are somewhat strange; they are specified to be with respect to the unscaled pixmap for PNG and XPM icons, but for SVG icons, they are in a 1000x1000 coordinate space that is scaled to the final size of the icon. You can determine if the icon is an SVG icon by using <a class="el" href="classGtk_1_1IconInfo.html#a991fed1842e82757a693f6a607ce2150" title="Gets the filename for the icon.">get_filename()</a>, and seeing if it is non-<code>0</code> and ends in '.svg'.</p>
<p>This function is provided primarily to allow compatibility wrappers for older API's, and is not expected to be useful for applications.</p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000193">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>raw_coordinates</em> </td><td>Whether the coordinates of embedded rectangles and attached points should be returned in their original (unscaled) form. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a88aac698e99e70ff2a87632debe26605"></a><!-- doxytag: member="Gtk::IconInfo::swap" ref="a88aac698e99e70ff2a87632debe26605" args="(IconInfo &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::IconInfo::swap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& </td>
<td class="paramname"> <em>other</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="acdc54b26a982305d52967d4c99c0a0d1"></a><!-- doxytag: member="Gtk::IconInfo::wrap" ref="acdc54b26a982305d52967d4c99c0a0d1" args="(GtkIconInfo *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1IconInfo.html">Gtk::IconInfo</a> wrap </td>
<td>(</td>
<td class="paramtype">GtkIconInfo * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="adb0929f2020199570662394b264e5086"></a><!-- doxytag: member="Gtk::IconInfo::gobject_" ref="adb0929f2020199570662394b264e5086" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkIconInfo* <a class="el" href="classGtk_1_1IconInfo.html#adb0929f2020199570662394b264e5086">Gtk::IconInfo::gobject_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>gtkmm/iconinfo.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 13:21:53 2010 for gtkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|
