~bratsche/ubuntu/maverick/gtk+2.0/menu-activation-fix

« back to all changes in this revision

Viewing changes to docs/reference/gtk/html/GtkBuilder.html

Import upstream version 2.17.11

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>GtkBuilder</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.2">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="GTK+ Reference Manual">
8
8
<link rel="up" href="Builder.html" title="Interface builder">
9
9
<link rel="prev" href="gtk-gtkbuildable.html" title="GtkBuildable">
49
49
<link rel="chapter" href="gtk-migrating-GtkBuilder.html" title="Migrating from libglade to GtkBuilder">
50
50
<link rel="chapter" href="gtk-migrating-tooltips.html" title="Migrating from GtkTooltips to GtkTooltip">
51
51
<link rel="chapter" href="gtk-migrating-entry-icons.html" title="Migrating from SexyIconEntry to GtkEntry">
 
52
<link rel="chapter" href="gtk-migrating-label-links.html" title="Migrating from SexyUrlLabel to GtkLabel">
 
53
<link rel="chapter" href="gtk-migrating-ClientSideWindows.html" title="Migrating to client-side windows">
52
54
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
53
55
<link rel="glossary" href="glossary.html" title="Glossary">
54
56
<link rel="index" href="api-index-full.html" title="Index of all symbols">
61
63
<link rel="index" href="api-index-2-12.html" title="Index of new symbols in 2.12">
62
64
<link rel="index" href="api-index-2-14.html" title="Index of new symbols in 2.14">
63
65
<link rel="index" href="api-index-2-16.html" title="Index of new symbols in 2.16">
 
66
<link rel="index" href="api-index-2-18.html" title="Index of new symbols in 2.18">
64
67
</head>
65
68
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
66
69
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
81
84
                <a href="#GtkBuilder.properties" class="shortcut">Properties</a>
82
85
</td></tr>
83
86
</table>
84
 
<div class="refentry" lang="en">
 
87
<div class="refentry" title="GtkBuilder">
85
88
<a name="GtkBuilder"></a><div class="titlepage"></div>
86
89
<div class="refnamediv"><table width="100%"><tr>
87
90
<td valign="top">
90
93
</td>
91
94
<td valign="top" align="right"></td>
92
95
</tr></table></div>
93
 
<div class="refsynopsisdiv">
 
96
<div class="refsynopsisdiv" title="Synopsis">
94
97
<a name="GtkBuilder.synopsis"></a><h2>Synopsis</h2>
95
98
<pre class="synopsis">
96
99
 
229
232
#define             <a class="link" href="GtkBuilder.html#GTK-BUILDER-ERROR--CAPS" title="GTK_BUILDER_ERROR">GTK_BUILDER_ERROR</a>
230
233
</pre>
231
234
</div>
232
 
<div class="refsect1" lang="en">
 
235
<div class="refsect1" title="Object Hierarchy">
233
236
<a name="GtkBuilder.object-hierarchy"></a><h2>Object Hierarchy</h2>
234
237
<pre class="synopsis">
235
238
  <a
238
241
   +----GtkBuilder
239
242
</pre>
240
243
</div>
241
 
<div class="refsect1" lang="en">
 
244
<div class="refsect1" title="Properties">
242
245
<a name="GtkBuilder.properties"></a><h2>Properties</h2>
243
246
<pre class="synopsis">
244
247
  "<a class="link" href="GtkBuilder.html#GtkBuilder--translation-domain" title='The "translation-domain" property'>translation-domain</a>"       <a
246
249
>gchar</a>*                : Read / Write
247
250
</pre>
248
251
</div>
249
 
<div class="refsect1" lang="en">
 
252
<div class="refsect1" title="Description">
250
253
<a name="GtkBuilder.description"></a><h2>Description</h2>
251
254
<p>
252
255
A GtkBuilder is an auxiliary object that reads textual descriptions
273
276
not have to worry about their lifecycle), or without a parent, in which
274
277
case they have to be added to some container to make use of them.
275
278
Non-widget objects need to be reffed with <a
276
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-ref"
 
279
href="/usr/share/gtk-doc/html/libmissioncontrol-server/libmissioncontrol-server-mcd-debug.html#g-object-ref"
277
280
><code class="function">g_object_ref()</code></a> to keep them
278
281
beyond the lifespan of the builder.
279
282
</p>
281
284
The function <a class="link" href="GtkBuilder.html#gtk-builder-connect-signals" title="gtk_builder_connect_signals ()"><code class="function">gtk_builder_connect_signals()</code></a> and variants thereof can be
282
285
used to connect handlers to the named signals in the description.
283
286
</p>
284
 
<div class="refsect2" lang="en">
 
287
<div class="refsect2" title="GtkBuilder UI Definitions">
285
288
<a name="BUILDER-UI"></a><h3>GtkBuilder UI Definitions</h3>
286
289
<p>
287
290
GtkBuilder parses textual descriptions of user interfaces which
438
441
the sections describing the widget-specific portions of UI definitions.
439
442
</p>
440
443
<div class="example">
441
 
<a name="id1308614"></a><p class="title"><b>Example 57. A GtkBuilder UI Definition</b></p>
 
444
<a name="id1176497"></a><p class="title"><b>Example 58. A GtkBuilder UI Definition</b></p>
442
445
<div class="example-contents"><pre class="programlisting">
443
446
&lt;interface&gt;
444
447
  &lt;object class="GtkDialog" id="dialog1"&gt;
492
495
<a class="link" href="GtkTreeView.html#GtkTreeView-BUILDER-UI" title="GtkTreeView as GtkBuildable">GtkTreeView</a>,
493
496
<a class="link" href="GtkUIManager.html#GtkUIManager-BUILDER-UI" title="GtkUIManager as GtkBuildable">GtkUIManager</a>,
494
497
<a class="link" href="GtkActionGroup.html#GtkActionGroup-BUILDER-UI" title="GtkActionGroup as GtkBuildable">GtkActionGroup</a>.
495
 
<a class="link" href="GtkMenuItem.html#GtkMenuItem-BUILDER-UI" title="GtkMenuItem as GtkBuildable">GtkMenuItem</a>.
 
498
<a class="link" href="GtkMenuItem.html#GtkMenuItem-BUILDER-UI" title="GtkMenuItem as GtkBuildable">GtkMenuItem</a>,
 
499
<a class="link" href="GtkAssistant.html#GtkAssistant-BUILDER-UI" title="GtkAssistant as GtkBuildable">GtkAssistant</a>,
 
500
<a class="link" href="GtkScale.html#GtkScale-BUILDER-UI" title="GtkScale as GtkBuildable">GtkScale</a>.
496
501
</p>
497
502
</div>
498
503
</div>
499
 
<div class="refsect1" lang="en">
 
504
<div class="refsect1" title="Details">
500
505
<a name="GtkBuilder.details"></a><h2>Details</h2>
501
 
<div class="refsect2" lang="en">
 
506
<div class="refsect2" title="GtkBuilder">
502
507
<a name="GtkBuilder-struct"></a><h3>GtkBuilder</h3>
503
508
<pre class="programlisting">typedef struct _GtkBuilder GtkBuilder;</pre>
504
509
<p>
505
510
</p>
506
511
</div>
507
512
<hr>
508
 
<div class="refsect2" lang="en">
 
513
<div class="refsect2" title="GtkBuilderConnectFunc ()">
509
514
<a name="GtkBuilderConnectFunc"></a><h3>GtkBuilderConnectFunc ()</h3>
510
515
<pre class="programlisting">void                (*GtkBuilderConnectFunc)            (<a class="link" href="GtkBuilder.html" title="GtkBuilder">GtkBuilder</a> *builder,
511
516
                                                         <a
585
590
<p class="since">Since 2.12</p>
586
591
</div>
587
592
<hr>
588
 
<div class="refsect2" lang="en">
 
593
<div class="refsect2" title="enum GtkBuilderError">
589
594
<a name="GtkBuilderError"></a><h3>enum GtkBuilderError</h3>
590
595
<pre class="programlisting">typedef enum
591
596
{
596
601
  GTK_BUILDER_ERROR_INVALID_TAG,
597
602
  GTK_BUILDER_ERROR_MISSING_PROPERTY_VALUE,
598
603
  GTK_BUILDER_ERROR_INVALID_VALUE,
599
 
  GTK_BUILDER_ERROR_VERSION_MISMATCH
 
604
  GTK_BUILDER_ERROR_VERSION_MISMATCH,
 
605
  GTK_BUILDER_ERROR_DUPLICATE_ID
600
606
} GtkBuilderError;
601
607
</pre>
602
608
<p>
656
662
    of GTK+.
657
663
</td>
658
664
</tr>
 
665
<tr>
 
666
<td><p><a name="GTK-BUILDER-ERROR-DUPLICATE-ID--CAPS"></a><span class="term"><code class="literal">GTK_BUILDER_ERROR_DUPLICATE_ID</code></span></p></td>
 
667
<td>An object id occurred twice.
 
668
</td>
 
669
</tr>
659
670
</tbody>
660
671
</table></div>
661
672
</div>
662
673
<hr>
663
 
<div class="refsect2" lang="en">
 
674
<div class="refsect2" title="gtk_builder_new ()">
664
675
<a name="gtk-builder-new"></a><h3>gtk_builder_new ()</h3>
665
676
<pre class="programlisting"><a class="link" href="GtkBuilder.html" title="GtkBuilder">GtkBuilder</a>*         gtk_builder_new                     (void);</pre>
666
677
<p>
679
690
<p class="since">Since 2.12</p>
680
691
</div>
681
692
<hr>
682
 
<div class="refsect2" lang="en">
 
693
<div class="refsect2" title="gtk_builder_add_from_file ()">
683
694
<a name="gtk-builder-add-from-file"></a><h3>gtk_builder_add_from_file ()</h3>
684
695
<pre class="programlisting"><a
685
696
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
726
737
<p class="since">Since 2.12</p>
727
738
</div>
728
739
<hr>
729
 
<div class="refsect2" lang="en">
 
740
<div class="refsect2" title="gtk_builder_add_from_string ()">
730
741
<a name="gtk-builder-add-from-string"></a><h3>gtk_builder_add_from_string ()</h3>
731
742
<pre class="programlisting"><a
732
743
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
781
792
<p class="since">Since 2.12</p>
782
793
</div>
783
794
<hr>
784
 
<div class="refsect2" lang="en">
 
795
<div class="refsect2" title="gtk_builder_add_objects_from_file ()">
785
796
<a name="gtk-builder-add-objects-from-file"></a><h3>gtk_builder_add_objects_from_file ()</h3>
786
797
<pre class="programlisting"><a
787
798
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
802
813
</p>
803
814
<p>
804
815
</p>
805
 
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 
816
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
806
817
<h3 class="title">Note</h3>
807
818
<p>
808
819
If you are adding an object that depends on an object that is not 
848
859
<p class="since">Since 2.14</p>
849
860
</div>
850
861
<hr>
851
 
<div class="refsect2" lang="en">
 
862
<div class="refsect2" title="gtk_builder_add_objects_from_string ()">
852
863
<a name="gtk-builder-add-objects-from-string"></a><h3>gtk_builder_add_objects_from_string ()</h3>
853
864
<pre class="programlisting"><a
854
865
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
872
883
</p>
873
884
<p>
874
885
</p>
875
 
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 
886
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
876
887
<h3 class="title">Note</h3>
877
888
<p>
878
889
If you are adding an object that depends on an object that is not 
923
934
<p class="since">Since 2.14</p>
924
935
</div>
925
936
<hr>
926
 
<div class="refsect2" lang="en">
 
937
<div class="refsect2" title="gtk_builder_get_object ()">
927
938
<a name="gtk-builder-get-object"></a><h3>gtk_builder_get_object ()</h3>
928
939
<pre class="programlisting"><a
929
940
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
963
974
<p class="since">Since 2.12</p>
964
975
</div>
965
976
<hr>
966
 
<div class="refsect2" lang="en">
 
977
<div class="refsect2" title="gtk_builder_get_objects ()">
967
978
<a name="gtk-builder-get-objects"></a><h3>gtk_builder_get_objects ()</h3>
968
979
<pre class="programlisting"><a
969
980
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
999
1010
<p class="since">Since 2.12</p>
1000
1011
</div>
1001
1012
<hr>
1002
 
<div class="refsect2" lang="en">
 
1013
<div class="refsect2" title="gtk_builder_connect_signals ()">
1003
1014
<a name="gtk-builder-connect-signals"></a><h3>gtk_builder_connect_signals ()</h3>
1004
1015
<pre class="programlisting">void                gtk_builder_connect_signals         (<a class="link" href="GtkBuilder.html" title="GtkBuilder">GtkBuilder</a> *builder,
1005
1016
                                                         <a
1050
1061
<p class="since">Since 2.12</p>
1051
1062
</div>
1052
1063
<hr>
1053
 
<div class="refsect2" lang="en">
 
1064
<div class="refsect2" title="gtk_builder_connect_signals_full ()">
1054
1065
<a name="gtk-builder-connect-signals-full"></a><h3>gtk_builder_connect_signals_full ()</h3>
1055
1066
<pre class="programlisting">void                gtk_builder_connect_signals_full    (<a class="link" href="GtkBuilder.html" title="GtkBuilder">GtkBuilder</a> *builder,
1056
1067
                                                         <a class="link" href="GtkBuilder.html#GtkBuilderConnectFunc" title="GtkBuilderConnectFunc ()">GtkBuilderConnectFunc</a> func,
1086
1097
<p class="since">Since 2.12</p>
1087
1098
</div>
1088
1099
<hr>
1089
 
<div class="refsect2" lang="en">
 
1100
<div class="refsect2" title="gtk_builder_set_translation_domain ()">
1090
1101
<a name="gtk-builder-set-translation-domain"></a><h3>gtk_builder_set_translation_domain ()</h3>
1091
1102
<pre class="programlisting">void                gtk_builder_set_translation_domain  (<a class="link" href="GtkBuilder.html" title="GtkBuilder">GtkBuilder</a> *builder,
1092
1103
                                                         const <a
1117
1128
<p class="since">Since 2.12</p>
1118
1129
</div>
1119
1130
<hr>
1120
 
<div class="refsect2" lang="en">
 
1131
<div class="refsect2" title="gtk_builder_get_translation_domain ()">
1121
1132
<a name="gtk-builder-get-translation-domain"></a><h3>gtk_builder_get_translation_domain ()</h3>
1122
1133
<pre class="programlisting">const <a
1123
1134
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1146
1157
<p class="since">Since 2.12</p>
1147
1158
</div>
1148
1159
<hr>
1149
 
<div class="refsect2" lang="en">
 
1160
<div class="refsect2" title="gtk_builder_get_type_from_name ()">
1150
1161
<a name="gtk-builder-get-type-from-name"></a><h3>gtk_builder_get_type_from_name ()</h3>
1151
1162
<pre class="programlisting"><a
1152
1163
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
1187
1198
<p class="since">Since 2.12</p>
1188
1199
</div>
1189
1200
<hr>
1190
 
<div class="refsect2" lang="en">
 
1201
<div class="refsect2" title="gtk_builder_value_from_string ()">
1191
1202
<a name="gtk-builder-value-from-string"></a><h3>gtk_builder_value_from_string ()</h3>
1192
1203
<pre class="programlisting"><a
1193
1204
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1267
1278
<p class="since">Since 2.12</p>
1268
1279
</div>
1269
1280
<hr>
1270
 
<div class="refsect2" lang="en">
 
1281
<div class="refsect2" title="gtk_builder_value_from_string_type ()">
1271
1282
<a name="gtk-builder-value-from-string-type"></a><h3>gtk_builder_value_from_string_type ()</h3>
1272
1283
<pre class="programlisting"><a
1273
1284
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1344
1355
<p class="since">Since 2.12</p>
1345
1356
</div>
1346
1357
<hr>
1347
 
<div class="refsect2" lang="en">
 
1358
<div class="refsect2" title="GTK_BUILDER_WARN_INVALID_CHILD_TYPE()">
1348
1359
<a name="GTK-BUILDER-WARN-INVALID-CHILD-TYPE--CAPS"></a><h3>GTK_BUILDER_WARN_INVALID_CHILD_TYPE()</h3>
1349
1360
<pre class="programlisting">#define             GTK_BUILDER_WARN_INVALID_CHILD_TYPE(object, type)</pre>
1350
1361
<p>
1368
1379
</table></div>
1369
1380
</div>
1370
1381
<hr>
1371
 
<div class="refsect2" lang="en">
 
1382
<div class="refsect2" title="GTK_BUILDER_ERROR">
1372
1383
<a name="GTK-BUILDER-ERROR--CAPS"></a><h3>GTK_BUILDER_ERROR</h3>
1373
1384
<pre class="programlisting">#define GTK_BUILDER_ERROR                (gtk_builder_error_quark ())
1374
1385
</pre>
1379
1390
</p>
1380
1391
</div>
1381
1392
</div>
1382
 
<div class="refsect1" lang="en">
 
1393
<div class="refsect1" title="Property Details">
1383
1394
<a name="GtkBuilder.property-details"></a><h2>Property Details</h2>
1384
 
<div class="refsect2" lang="en">
 
1395
<div class="refsect2" title='The "translation-domain" property'>
1385
1396
<a name="GtkBuilder--translation-domain"></a><h3>The <code class="literal">"translation-domain"</code> property</h3>
1386
1397
<pre class="programlisting">  "translation-domain"       <a
1387
1398
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"