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
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gtkbuildable">
<refnamediv>
<refname>gtk.Buildable</refname>
<refpurpose>Interface for objects that can be built by GtkBuilder.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.Buildable</classname></ooclass>
<ooclass><classname><link linkend="class-ginterface">gobject.GInterface</link></classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkbuildable--add-child">add_child</link></methodname>
<methodparam><parameter role="keyword">builder</parameter></methodparam>
<methodparam><parameter role="keyword">child</parameter></methodparam>
<methodparam><parameter role="keyword">type</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkbuildable--construct-child">construct_child</link></methodname>
<methodparam><parameter role="keyword">builder</parameter></methodparam>
<methodparam><parameter role="keyword">name</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkbuildable--get-internal-child">get_internal_child</link></methodname>
<methodparam><parameter role="keyword">builder</parameter></methodparam>
<methodparam><parameter role="keyword">childname</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkbuildable--get-name">get_name</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkbuildable--parser-finished">parser_finished</link></methodname>
<methodparam><parameter role="keyword">builder</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkbuildable--set-name">set_name</link></methodname>
<methodparam><parameter role="keyword">name</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-ginterface">gobject.GInterface</link>
+-- <link linkend="class-gtkbuildable">gtk.Buildable</link>
</synopsis>
</refsect1>
<refsect1>
<title>Known Implementation</title>
<para>
<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
is implementated by
<link linkend="class-gtkbin"><classname>gtk.Bin</classname></link>,
<link linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>,
<link linkend="class-gtkbuttonbox"><classname>gtk.ButtonBox</classname></link>,
<link linkend="class-gtkpaned"><classname>gtk.Paned</classname></link>,
<link linkend="class-gtkcolorselectiondialog"><classname>gtk.ColorSelectionDialog</classname></link>,
<link linkend="class-gtkvbuttonbox"><classname>gtk.VButtonBox</classname></link>,
<link linkend="class-gtktearoffmenuitem"><classname>gtk.TearoffMenuItem</classname></link>,
<link linkend="class-gtkentry"><classname>gtk.Entry</classname></link>,
<link linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>,
<link linkend="class-gtkimage"><classname>gtk.Image</classname></link>,
<link linkend="class-gtkcalendar"><classname>gtk.Calendar</classname></link>,
<link linkend="class-gtkfixed"><classname>gtk.Fixed</classname></link>,
<link linkend="class-gtklinkbutton"><classname>gtk.LinkButton</classname></link>,
<link linkend="class-gtkhbuttonbox"><classname>gtk.HButtonBox</classname></link>,
<link linkend="class-gtkinputdialog"><classname>gtk.InputDialog</classname></link>,
<link linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>,
<link linkend="class-gtkvruler"><classname>gtk.VRuler</classname></link>,
<link linkend="class-gtkvseparator"><classname>gtk.VSeparator</classname></link>,
<link linkend="class-gtkvbox"><classname>gtk.VBox</classname></link>,
<link linkend="class-gtkcurve"><classname>gtk.Curve</classname></link>,
<link linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>,
<link linkend="class-gtkhruler"><classname>gtk.HRuler</classname></link>,
<link linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>,
<link linkend="class-gtkseparatormenuitem"><classname>gtk.SeparatorMenuItem</classname></link>,
<link linkend="class-gtkhscale"><classname>gtk.HScale</classname></link>,
<link linkend="class-gtktable"><classname>gtk.Table</classname></link>,
<link linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>,
<link linkend="class-gtkimagemenuitem"><classname>gtk.ImageMenuItem</classname></link>,
<link linkend="class-gtkfilechooserbutton"><classname>gtk.FileChooserButton</classname></link>,
<link linkend="class-gtkcheckbutton"><classname>gtk.CheckButton</classname></link>,
<link linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>,
<link linkend="class-gtkmenushell"><classname>gtk.MenuShell</classname></link>,
<link linkend="class-gtkstatusbar"><classname>gtk.StatusBar</classname></link>,
<link linkend="class-gtkdrawingarea"><classname>gtk.DrawingArea</classname></link>,
<link linkend="class-gtkbutton"><classname>gtk.Button</classname></link>,
<link linkend="class-gtkiconview"><classname>gtk.IconView</classname></link>,
<link linkend="class-gtknotebook"><classname>gtk.Notebook</classname></link>,
<link linkend="class-gtkuimanager"><classname>gtk.UIManager</classname></link>,
<link linkend="class-gtksocket"><classname>gtk.Socket</classname></link>,
<link linkend="class-gtkvscale"><classname>gtk.VScale</classname></link>,
<link linkend="class-gtkgammacurve"><classname>gtk.GammaCurve</classname></link>,
<link linkend="class-gtkalignment"><classname>gtk.Alignment</classname></link>,
<link linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link>,
<link linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>,
<link linkend="class-gtkpagesetupunixdialog"><classname>gtk.PageSetupUnixDialog</classname></link>,
<link linkend="class-gtkrecentchoosermenu"><classname>gtk.RecentChooserMenu</classname></link>,
<link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>,
<link linkend="class-gtkhseparator"><classname>gtk.HSeparator</classname></link>,
<link linkend="class-gtkprogressbar"><classname>gtk.ProgressBar</classname></link>,
<link linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link>,
<link linkend="class-gtkrange"><classname>gtk.Range</classname></link>,
<link linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>,
<link linkend="class-gtkfileselection"><classname>gtk.FileSelection</classname></link>,
<link linkend="class-gtktoolbar"><classname>gtk.ToolBar</classname></link>,
<link linkend="class-gtkaccellabel"><classname>gtk.AccellLabel</classname></link>,
<link linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link>,
<link linkend="class-gtkexpander"><classname>gtk.Expander</classname></link>,
<link linkend="class-gtkscale"><classname>gtk.Scale</classname></link>,
<link linkend="class-gtktreestore"><classname>gtk.TreeStore</classname></link>,
<link linkend="class-gtkmessagedialog"><classname>gtk.MessageDialog</classname></link>,
<link linkend="class-gtkseparator"><classname>gtk.Separator</classname></link>,
<link linkend="class-gtklayout"><classname>gtk.Layout</classname></link>,
<link linkend="class-gtkfontselection"><classname>gtk.FontSelection</classname></link>,
<link linkend="class-gtkcellview"><classname>gtk.CellView</classname></link>,
<link linkend="class-gtkinvisible"><classname>gtk.Invisible</classname></link>,
<link linkend="class-gtkwindow"><classname>gtk.Window</classname></link>,
<link linkend="class-gtkseparatortoolitem"><classname>gtk.SeparatorToolItem</classname></link>,
<link linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link>,
<link linkend="class-gtkcheckmenuitem"><classname>gtk.CheckMenuItem</classname></link>,
<link linkend="class-gtktoolbutton"><classname>gtk.ToolButton</classname></link>,
<link linkend="class-gtkmisc"><classname>gtk.Misc</classname></link>,
<link linkend="class-gtkeventbox"><classname>gtk.EventBox</classname></link>,
<link linkend="class-gtkfontbutton"><classname>gtkFontButton.</classname></link>,
<link linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>,
<link linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link>,
<link linkend="class-gtkhbox"><classname>gtk.HBox</classname></link>,
<link linkend="class-gtkcombo"><classname>gtk.Combo</classname></link>,
<link linkend="class-gtkaspectframe"><classname>gtk.AspectFrame</classname></link>,
<link linkend="class-gtkaboutdialog"><classname>gtk.AboutDialog</classname></link>,
<link linkend="class-gtkhscrollbar"><classname>gtk.HScrollBar</classname></link>,
<link linkend="class-gtkliststore"><classname>gtk.Liststore</classname></link>,
<link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>,
<link linkend="class-gtkrecentchooserwidget"><classname>gtk.RecentChooserWidget</classname></link>,
<link linkend="class-gtktoggletoolbutton"><classname>gtk.ToggleToolButton</classname></link>,
<link linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>,
<link linkend="class-gtkvscrollbar"><classname>gtk.VScrollBar</classname></link>,
<link linkend="class-gtkframe"><classname>gtk.Frame</classname></link>,
<link linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>,
<link linkend="class-gtklabel"><classname>gtk.Label</classname></link>,
<link linkend="class-gtkfontselectiondialog"><classname>gtk.FontSelectionDialog</classname></link>,
<link linkend="class-gtkcolorselection"><classname>gtk.ColorSelection</classname></link>,
<link linkend="class-gtkitem"><classname>gtk.Item</classname></link>,
<link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>,
<link linkend="class-gtkrecentaction"><classname>gtk.RecentAction</classname></link>,
<link linkend="class-gtkvolumebutton"><classname>gtk.VolumeButton</classname></link>,
<link linkend="class-gtkmenubar"><classname>gtk.MenuBar</classname></link>,
<link linkend="class-gtktextview"><classname>gtk.TextView</classname></link>,
<link linkend="class-gtkarrow"><classname>gtk.Arrow</classname></link>,
<link linkend="class-gtktoggleaction"><classname>gtk.ToggleAction</classname></link>,
<link linkend="class-gtkradioaction"><classname>gtk.RadioAction</classname></link>,
<link linkend="class-gtkplug"><classname>gtk.Plug</classname></link>,
<link linkend="class-gtkhpaned"><classname>gtk.HPaned</classname></link>,
<link linkend="class-gtkbox"><classname>gtk.Box</classname></link>,
<link linkend="class-gtkmenu"><classname>gtk.Menu</classname></link>,
<link linkend="class-gtkaction"><classname>gtk.Action</classname></link>,
<link linkend="class-gtkprintunixdialog"><classname>gtk.PrintUnixDialog</classname></link>,
<link linkend="class-gtkcomboboxentry"><classname>gtk.ComboBoxEntry</classname></link>,
<link linkend="class-gtkcolorbutton"><classname>gtk.ColorButton</classname></link>,
<link linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>,
<link linkend="class-gtkruler"><classname>gtk.Ruler</classname></link>,
<link linkend="class-gtkvpaned"><classname>gtk.VPaned</classname></link>,
<link linkend="class-gtkhandlebox"><classname>gtk.HandleBox</classname></link>,
<link linkend="class-gtkscrollbar"><classname>gtk.Srollbar</classname></link>,
<link linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>,
<link linkend="class-gtksizegroup"><classname>gtk.SizeGroup</classname></link>,
<link linkend="class-gtkviewport"><classname>gtk.ViewPort</classname></link>,
<link linkend="class-gtkscrolledwindow"><classname>gtk.ScrolledWindow</classname></link>,
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
In order to allow construction from a <link linkend="gtkbuilder-ui-definition">GtkBuilder UI description</link>,
an object class must implement the GtkBuildable interface. The interface includes methods for setting
names and properties of objects, parsing custom tags, constructing child objects.
</para>
<para>
The GtkBuildable interface is implemented by all widgets and many of the non-widget objects that are provided
by GTK+. The main user of this interface is GtkBuilder, there should be very little need for applications to
call any gtk.Buildable methods.
</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkbuildable--add-child">
<title>gtk.Buildable.add_child</title>
<programlisting><methodsynopsis language="python">
<methodname>add_child</methodname>
<methodparam><parameter>builder</parameter></methodparam>
<methodparam><parameter>child</parameter></methodparam>
<methodparam><parameter>type</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">builder</parameter> :</term>
<listitem><simpara>
A <link linkend="class-gtkbuilder"><classname>gtk.Builder</classname></link>
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">child</parameter> :</term>
<listitem><simpara>The child to add.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">type</parameter> :</term>
<listitem><simpara>
The kind of <parameter>child</parameter> or <literal>None</literal>.
</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.12 and above.</para>
</note>
<para>
The <methodname>add_child</methodname>() method adds a child to buildable. type is an
optional string describing how the child should be added.
</para>
</refsect2>
<refsect2 id="method-gtkbuildable--construct-child">
<title>gtk.Buildable.construct_child</title>
<programlisting><methodsynopsis language="python">
<methodname>construct_child</methodname>
<methodparam><parameter>builder</parameter></methodparam>
<methodparam><parameter>name</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">builder</parameter> :</term>
<listitem><simpara>
A <link linkend="class-gtkbuilder"><classname>gtk.Builder</classname></link>
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">name</parameter> :</term>
<listitem><simpara>The name of child to construct.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>The constructed child.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.12 and above.</para>
</note>
<para>
The <methodname>construct_child</methodname>() method constructs a child of buildable
with the name <parameter>name</parameter>.
</para>
<para>
GtkBuilder calls this function if a "constructor" has been specified in the UI definition.
</para>
</refsect2>
<refsect2 id="method-gtkbuildable--get-internal-child">
<title>gtk.Buildable.get_internal_child</title>
<programlisting><methodsynopsis language="python">
<methodname>get_internal_child</methodname>
<methodparam><parameter>builder</parameter></methodparam>
<methodparam><parameter>childname</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">builder</parameter> :</term>
<listitem><simpara>
A <link linkend="class-gtkbuilder"><classname>gtk.Builder</classname></link>
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">childname</parameter> :</term>
<listitem><simpara>The name of child.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>The internal child of the buildable object.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.12 and above.</para>
</note>
<para>
The <methodname>get_internal_child</methodname>() method gets the internal child
called childname of the buildable object.
</para>
</refsect2>
<refsect2 id="method-gtkbuildable--get-name">
<title>gtk.Buildable.get_name</title>
<programlisting><methodsynopsis language="python">
<methodname>get_name</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>
The name set with
<methodname><link linkend="method-gtkbuildable--set-name">set_name</link></methodname>
</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.12 and above.</para>
</note>
<para>
The <methodname>get_name</methodname>() method gets the name of the buildable object.
</para>
<para>
GtkBuilder sets the name based on the the
<link linkend="gtkbuilder-ui-definition">GtkBuilder UI description</link>
used to construct the buildable.
</para>
</refsect2>
<refsect2 id="method-gtkbuildable--parser-finished">
<title>gtk.Buildable.parser_finished</title>
<programlisting><methodsynopsis language="python">
<methodname>parser_finished</methodname>
<methodparam><parameter>builder</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">builder</parameter> :</term>
<listitem><simpara>
A <link linkend="class-gtkbuilder"><classname>gtk.Builder</classname></link>
</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.12 and above.</para>
</note>
<para>
The <methodname>parser_finished</methodname>() method is called when the builder finishes
the parsing of a GtkBuilder UI definition. Note that this will be called once for each
time <methodname><link linkend="method-gtkbuilder--add-from-file">add_from_file</link></methodname>
or <methodname><link linkend="method-gtkbuilder--add-from-string">add_from_string</link></methodname>
is called on a builder.
</para>
</refsect2>
<refsect2 id="method-gtkbuildable--set-name">
<title>gtk.Buildable.set_name</title>
<programlisting><methodsynopsis language="python">
<methodname>set_name</methodname>
<methodparam><parameter>name</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">name</parameter> :</term>
<listitem><simpara>The name to set.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.12 and above.</para>
</note>
<para>
The <methodname>set_name</methodname>() method sets the name of the buildable object.
</para>
</refsect2>
</refsect1>
</refentry>
|
