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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>gtkmm 2.4: Gtk::Builder Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
<td width="10%" height="40"><img src="../../images/gtkmm_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
<td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
<a class="qindex" href="../../index.html">Main Page</a>
<a href="group__Widgets.html">Widgets</a>
<a class="qindex" href="namespaces.html"> Namespaces</a>
<a href="../../tutorial/html/index.html"> Book</a>
</center>
<hr width="100%"/>
<!-- begin main content -->
<div id="content">
<!-- Generated by Doxygen 1.5.1 -->
<div class="nav">
<a class="el" href="namespaceGtk.html">Gtk</a>::<a class="el" href="classGtk_1_1Builder.html">Builder</a></div>
<h1>Gtk::Builder Class Reference</h1><!-- doxytag: class="Gtk::Builder" --><!-- doxytag: inherits="Glib::Object" -->Inheritance diagram for Gtk::Builder:<p><center><img src="classGtk_1_1Builder__inherit__graph.png" border="0" usemap="#Gtk_1_1Builder__inherit__map" alt="Inheritance graph"></center>
<map name="Gtk_1_1Builder__inherit__map">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1Object.html" shape="rect" coords="21,161,115,188" alt="">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ObjectBase.html" shape="rect" coords="5,84,131,111" alt="">
<area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classsigc_1_1trackable.html" shape="rect" coords="12,7,124,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classGtk_1_1Builder-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Build an interface from a UI definition description.
<p>
This object represents an `instantiation' of an UI definition description. When one of these objects is created, the XML file is read, and the interface is created. The <a class="el" href="classGtk_1_1Builder.html">Gtk::Builder</a> object then provides an interface for accessing the widgets in the interface by the names assigned to them inside the UI description.<p>
<dl compact><dt><b><a class="el" href="newin2p12s.html#_newin2p12s000020">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#a3f4af4e7eaf7861c8283dc0dbd5254c">add_from_file</a> (const std::string& filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses a file containing a GtkBuilder UI definition and merges it with the current contents of <em>builder</em> . <a href="#a3f4af4e7eaf7861c8283dc0dbd5254c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#b8c6679c1296d6c4d8590ef907de4d5a">add_from_string</a> (const char* buffer, gsize length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses a string containing a GtkBuilder UI definition and merges it with the current contents of <em>builder</em> . <a href="#b8c6679c1296d6c4d8590ef907de4d5a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#e3520ee31a98ac30b728f93522de8df5">add_from_string</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& buffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses a string containing a GtkBuilder UI definition and merges it with the current contents of the builder. <a href="#e3520ee31a98ac30b728f93522de8df5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1Object.html">Glib::Object</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#2e2dfd63721cf7dd648e262ed6630f0c">get_object</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the object named <em>name</em> . <a href="#2e2dfd63721cf7dd648e262ed6630f0c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#db14b2699ed40d46a47d03885d968f76">get_translation_domain</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the translation domain of <em>builder</em> . <a href="#db14b2699ed40d46a47d03885d968f76"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<class T_Widget> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#6604abee829e66e0d5d97072227e7cd3">get_widget</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name, T_Widget*& widget)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a widget from the <a class="el" href="classGtk_1_1Builder.html">Builder</a> file. <a href="#6604abee829e66e0d5d97072227e7cd3"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<class T_Widget> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#945dbd52e16b13a3c46809572e5a2877">get_widget_derived</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name, T_Widget*& widget)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This provides a pointer to a widget whose details are specified in the GtkBuilder file, but which is implemented by your own derived class. <a href="#945dbd52e16b13a3c46809572e5a2877"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const GtkBuilder* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#9fb98b415b7d3f3e62c4e363c516e1c1">gobj</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#9fb98b415b7d3f3e62c4e363c516e1c1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GtkBuilder* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#16ab17cd36e636c3f1495ca2ef2a4f49">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#16ab17cd36e636c3f1495ca2ef2a4f49"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GtkBuilder* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#43185cdda8ad880fab2b3a9a2c1332d6">gobj_copy</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#43185cdda8ad880fab2b3a9a2c1332d6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#9f696bcf8d214f38d61d0d558d641245">set_translation_domain</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& domain)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the translation domain of <em>builder</em> . <a href="#9f696bcf8d214f38d61d0d558d641245"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#ff47bcf93d49acef9de2c697774cd53b">~Builder</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1Builder.html">Builder</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#3e7bd7f95c1ea1f06b4c2c16458403ce">create</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new builder object. <a href="#3e7bd7f95c1ea1f06b4c2c16458403ce"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1Builder.html">Builder</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#6c5ea61bdb933606650e7f437d544edd">create_from_file</a> (const std::string& filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses a file containing a GtkBuilder UI definition. <a href="#6c5ea61bdb933606650e7f437d544edd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1Builder.html">Builder</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#05f80c899de87e17683af6e5efcb4b41">create_from_string</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& buffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses a string containing a GtkBuilder UI definition. <a href="#05f80c899de87e17683af6e5efcb4b41"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#0ba100f27aca463391d4399f6f1880ab">Builder</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GtkWidget* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#94c23a6163a95da0cb5184dcf2544d4a">get_cwidget</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGtk_1_1Widget.html">Gtk::Widget</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#ff746219ab6618caab01984c57ee0161">get_widget_checked</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name, GType type)</td></tr>
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1Builder.html">Gtk::Builder</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Builder.html#0eed615bfe0b8ce06257406172956946">wrap</a> (GtkBuilder* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#0eed615bfe0b8ce06257406172956946"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="ff47bcf93d49acef9de2c697774cd53b"></a><!-- doxytag: member="Gtk::Builder::~Builder" ref="ff47bcf93d49acef9de2c697774cd53b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gtk::Builder::~Builder </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="0ba100f27aca463391d4399f6f1880ab"></a><!-- doxytag: member="Gtk::Builder::Builder" ref="0ba100f27aca463391d4399f6f1880ab" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::Builder::Builder </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a3f4af4e7eaf7861c8283dc0dbd5254c"></a><!-- doxytag: member="Gtk::Builder::add_from_file" ref="a3f4af4e7eaf7861c8283dc0dbd5254c" args="(const std::string &filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gtk::Builder::add_from_file </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>filename</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parses a file containing a GtkBuilder UI definition and merges it with the current contents of <em>builder</em> .
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>The name of the file to parse. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>error</em> </td><td>Return location for an error, or <code>0</code>. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A positive value on success, 0 if an error occurred</dd></dl>
<dl compact><dt><b><a class="el" href="newin2p12s.html#_newin2p12s000023">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
</div>
</div><p>
<a class="anchor" name="b8c6679c1296d6c4d8590ef907de4d5a"></a><!-- doxytag: member="Gtk::Builder::add_from_string" ref="b8c6679c1296d6c4d8590ef907de4d5a" args="(const char *buffer, gsize length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gtk::Builder::add_from_string </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gsize </td>
<td class="paramname"> <em>length</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parses a string containing a GtkBuilder UI definition and merges it with the current contents of <em>builder</em> .
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>The string to parse. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>The length of <em>buffer</em> (may be -1 if <em>buffer</em> is nul-terminated). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>error</em> </td><td>Return location for an error, or <code>0</code>. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A positive value on success, 0 if an error occurred</dd></dl>
<dl compact><dt><b><a class="el" href="newin2p12s.html#_newin2p12s000025">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
</div>
</div><p>
<a class="anchor" name="e3520ee31a98ac30b728f93522de8df5"></a><!-- doxytag: member="Gtk::Builder::add_from_string" ref="e3520ee31a98ac30b728f93522de8df5" args="(const Glib::ustring &buffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gtk::Builder::add_from_string </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>buffer</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parses a string containing a GtkBuilder UI definition and merges it with the current contents of the builder.
<p>
: the string to parse <dl class="return" compact><dt><b>Returns:</b></dt><dd>true on success or false if an error occurred. </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1MarkupError.html">Glib::MarkupError</a></em> </td><td></td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="newin2p12s.html#_newin2p12s000024">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
</div>
</div><p>
<a class="anchor" name="3e7bd7f95c1ea1f06b4c2c16458403ce"></a><!-- doxytag: member="Gtk::Builder::create" ref="3e7bd7f95c1ea1f06b4c2c16458403ce" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1Builder.html">Builder</a>> Gtk::Builder::create </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a new builder object.
<p>
</div>
</div><p>
<a class="anchor" name="6c5ea61bdb933606650e7f437d544edd"></a><!-- doxytag: member="Gtk::Builder::create_from_file" ref="6c5ea61bdb933606650e7f437d544edd" args="(const std::string &filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1Builder.html">Builder</a>> Gtk::Builder::create_from_file </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>filename</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parses a file containing a GtkBuilder UI definition.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>the name of the file to parse. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A new <a class="el" href="classGtk_1_1Builder.html">Builder</a> object, or a null pointer if an error occurred. </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1FileError.html">Glib::FileError</a>,<a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1MarkupError.html">Glib::MarkupError</a></em> </td><td></td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="newin2p12s.html#_newin2p12s000021">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
</div>
</div><p>
<a class="anchor" name="05f80c899de87e17683af6e5efcb4b41"></a><!-- doxytag: member="Gtk::Builder::create_from_string" ref="05f80c899de87e17683af6e5efcb4b41" args="(const Glib::ustring &buffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1Builder.html">Builder</a>> Gtk::Builder::create_from_string </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>buffer</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parses a string containing a GtkBuilder UI definition.
<p>
: the string to parse <dl class="return" compact><dt><b>Returns:</b></dt><dd>A new <a class="el" href="classGtk_1_1Builder.html">Builder</a> object, or a null pointer if an error occurred. </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1MarkupError.html">Glib::MarkupError</a></em> </td><td></td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="newin2p12s.html#_newin2p12s000022">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
</div>
</div><p>
<a class="anchor" name="94c23a6163a95da0cb5184dcf2544d4a"></a><!-- doxytag: member="Gtk::Builder::get_cwidget" ref="94c23a6163a95da0cb5184dcf2544d4a" args="(const Glib::ustring &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkWidget* Gtk::Builder::get_cwidget </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="2e2dfd63721cf7dd648e262ed6630f0c"></a><!-- doxytag: member="Gtk::Builder::get_object" ref="2e2dfd63721cf7dd648e262ed6630f0c" args="(const Glib::ustring &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1Object.html">Glib::Object</a>> Gtk::Builder::get_object </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the object named <em>name</em> .
<p>
Note that this function does not increment the reference count of the returned object. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of object to get. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The object named <em>name</em> or <code>0</code> if it could not be found in the object tree.</dd></dl>
<dl compact><dt><b><a class="el" href="newin2p12s.html#_newin2p12s000026">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
</div>
</div><p>
<a class="anchor" name="db14b2699ed40d46a47d03885d968f76"></a><!-- doxytag: member="Gtk::Builder::get_translation_domain" ref="db14b2699ed40d46a47d03885d968f76" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Gtk::Builder::get_translation_domain </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the translation domain of <em>builder</em> .
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The translation domain. This string is owned by the builder object and must not be modified or freed.</dd></dl>
<dl compact><dt><b><a class="el" href="newin2p12s.html#_newin2p12s000028">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
</div>
</div><p>
<a class="anchor" name="6604abee829e66e0d5d97072227e7cd3"></a><!-- doxytag: member="Gtk::Builder::get_widget" ref="6604abee829e66e0d5d97072227e7cd3" args="(const Glib::ustring &name, T_Widget *&widget)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template <class T_Widget> </div>
<table class="memname">
<tr>
<td class="memname">void Gtk::Builder::get_widget </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T_Widget *& </td>
<td class="paramname"> <em>widget</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a widget from the <a class="el" href="classGtk_1_1Builder.html">Builder</a> file.
<p>
For instance: <div class="fragment"><pre class="fragment"> <a class="code" href="classGtk_1_1Table.html">Gtk::Table</a>* pTable = 0;
refXml->get_widget(<span class="stringliteral">"mytable"</span>, pTable);
</pre></div> This method prints a warning message to the console if the widget doesn't exist or has the wrong type, so you don't need to check that manually.<p>
Note that you are responsible for deleting top-level widgets (windows and dialogs) instantiated by the <a class="el" href="classGtk_1_1Builder.html">Builder</a> object. Other widgets are instantiated as managed so they will be deleted automatically if you add them to a container widget.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the widget. </td></tr>
</table>
</dl>
<dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>widget</em> </td><td>A pointer to the widget, or <code>0</code> on failure. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="ff746219ab6618caab01984c57ee0161"></a><!-- doxytag: member="Gtk::Builder::get_widget_checked" ref="ff746219ab6618caab01984c57ee0161" args="(const Glib::ustring &name, GType type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1Widget.html">Gtk::Widget</a>* Gtk::Builder::get_widget_checked </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GType </td>
<td class="paramname"> <em>type</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="945dbd52e16b13a3c46809572e5a2877"></a><!-- doxytag: member="Gtk::Builder::get_widget_derived" ref="945dbd52e16b13a3c46809572e5a2877" args="(const Glib::ustring &name, T_Widget *&widget)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template <class T_Widget> </div>
<table class="memname">
<tr>
<td class="memname">void Gtk::Builder::get_widget_derived </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T_Widget *& </td>
<td class="paramname"> <em>widget</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This provides a pointer to a widget whose details are specified in the GtkBuilder file, but which is implemented by your own derived class.
<p>
Your class must have a constructor like so: <div class="fragment"><pre class="fragment"> DerivedDialog::DerivedDialog(BaseObjectType* cobject, <span class="keyword">const</span> <a class="codeRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr<Gtk::Builder></a>& refBuilder)
: Gtk::Dialog(cobject) <span class="comment">//Calls the base class constructor</span>
</pre></div><p>
For instance: <div class="fragment"><pre class="fragment"> Gtk::DerivedBox* pBox = 0;
refXml->get_widget_derived(<span class="stringliteral">"mybox"</span>, pBox);
</pre></div><p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the widget. </td></tr>
</table>
</dl>
<dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>widget</em> </td><td>A pointer to the widget, or <code>0</code> on failure. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="9fb98b415b7d3f3e62c4e363c516e1c1"></a><!-- doxytag: member="Gtk::Builder::gobj" ref="9fb98b415b7d3f3e62c4e363c516e1c1" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GtkBuilder* Gtk::Builder::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C GObject.
<p>
<p>
Reimplemented from <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ObjectBase.html#2b7010748d60e770e9e0b3d65c100cf2">Glib::ObjectBase</a>.
</div>
</div><p>
<a class="anchor" name="16ab17cd36e636c3f1495ca2ef2a4f49"></a><!-- doxytag: member="Gtk::Builder::gobj" ref="16ab17cd36e636c3f1495ca2ef2a4f49" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkBuilder* Gtk::Builder::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C GObject.
<p>
<p>
Reimplemented from <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ObjectBase.html#4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.
</div>
</div><p>
<a class="anchor" name="43185cdda8ad880fab2b3a9a2c1332d6"></a><!-- doxytag: member="Gtk::Builder::gobj_copy" ref="43185cdda8ad880fab2b3a9a2c1332d6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkBuilder* Gtk::Builder::gobj_copy </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
<p>
</div>
</div><p>
<a class="anchor" name="9f696bcf8d214f38d61d0d558d641245"></a><!-- doxytag: member="Gtk::Builder::set_translation_domain" ref="9f696bcf8d214f38d61d0d558d641245" args="(const Glib::ustring &domain)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Builder::set_translation_domain </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>domain</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the translation domain of <em>builder</em> .
<p>
See <a class="el" href="classGtk_1_1Builder.html">Gtk::Builder</a>:translation-domain.<p>
<dl compact><dt><b><a class="el" href="newin2p12s.html#_newin2p12s000027">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>domain</em> </td><td>The translation domain or <code>0</code>. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="0eed615bfe0b8ce06257406172956946"></a><!-- doxytag: member="Gtk::Builder::wrap" ref="0eed615bfe0b8ce06257406172956946" args="(GtkBuilder *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1Builder.html">Gtk::Builder</a>> wrap </td>
<td>(</td>
<td class="paramtype">GtkBuilder * </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 width="100%"><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object.
<p>
<dl compact><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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="builder_8h.html">builder.h</a></ul>
</div>
<!-- end main content -->
<hr><address><small>
Generated for gtkmm 2.4 by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.5.1 © 1997-2001</small></address>
</body>
</html>
|
