~ubuntu-branches/ubuntu/precise/libglade2/precise-proposed

« back to all changes in this revision

Viewing changes to doc/html/libglade-dtd.html

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Rottmann
  • Date: 2005-02-28 14:33:01 UTC
  • mfrom: (1.2.1 upstream) (2.1.1 warty)
  • Revision ID: james.westby@ubuntu.com-20050228143301-eroxclsw3tlhg20p
Tags: 1:2.4.2-2
Included manpage for libglade-convert (closes: #294254, thanks to
Margarita Manterola).

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<HTML
2
 
><HEAD
3
 
><TITLE
4
 
>Glade 2.0 File Format</TITLE
5
 
><META
6
 
NAME="GENERATOR"
7
 
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8
 
"><LINK
9
 
REL="HOME"
10
 
TITLE="Libglade Reference Manual"
11
 
HREF="libglade.html"><LINK
12
 
REL="PREVIOUS"
13
 
TITLE="Libglade Build"
14
 
HREF="libglade-libglade-build.html"><LINK
15
 
REL="NEXT"
16
 
TITLE="Exceptions"
17
 
HREF="libglade-dtd-exceptions.html"></HEAD
18
 
><BODY
19
 
CLASS="CHAPTER"
20
 
BGCOLOR="#FFFFFF"
21
 
TEXT="#000000"
22
 
LINK="#0000FF"
23
 
VLINK="#840084"
24
 
ALINK="#0000FF"
25
 
><DIV
26
 
CLASS="NAVHEADER"
27
 
><TABLE
28
 
WIDTH="100%"
29
 
BORDER="0"
30
 
BGCOLOR="#000000"
31
 
CELLPADDING="1"
32
 
CELLSPACING="0"
33
 
><TR
34
 
><TH
35
 
COLSPAN="4"
36
 
ALIGN="center"
37
 
><FONT
38
 
COLOR="#FFFFFF"
39
 
SIZE="5"
40
 
>Libglade Reference Manual</FONT
41
 
></TH
42
 
></TR
43
 
><TR
44
 
><TD
45
 
WIDTH="25%"
46
 
BGCOLOR="#C00000"
47
 
ALIGN="left"
48
 
><A
49
 
HREF="libglade-libglade-build.html"
50
 
><FONT
51
 
COLOR="#FFFFFF"
52
 
SIZE="3"
53
 
><B
54
 
>&#60;&#60;&#60; Previous Page</B
55
 
></FONT
56
 
></A
57
 
></TD
58
 
><TD
59
 
WIDTH="25%"
60
 
BGCOLOR="#0000C0"
61
 
ALIGN="center"
62
 
><FONT
63
 
COLOR="#FFFFFF"
64
 
SIZE="3"
65
 
><B
66
 
><A
67
 
HREF="libglade.html"
68
 
><FONT
69
 
COLOR="#FFFFFF"
70
 
SIZE="3"
71
 
><B
72
 
>Home</B
73
 
></FONT
74
 
></A
75
 
></B
76
 
></FONT
77
 
></TD
78
 
><TD
79
 
WIDTH="25%"
80
 
BGCOLOR="#00C000"
81
 
ALIGN="center"
82
 
><FONT
83
 
COLOR="#FFFFFF"
84
 
SIZE="3"
85
 
><B
86
 
>&nbsp;</B
87
 
></FONT
88
 
></TD
89
 
><TD
90
 
WIDTH="25%"
91
 
BGCOLOR="#C00000"
92
 
ALIGN="right"
93
 
><A
94
 
HREF="libglade-dtd-exceptions.html"
95
 
><FONT
96
 
COLOR="#FFFFFF"
97
 
SIZE="3"
98
 
><B
99
 
>Next Page &#62;&#62;&#62;</B
100
 
></FONT
101
 
></A
102
 
></TD
103
 
></TR
104
 
></TABLE
105
 
></DIV
106
 
><DIV
107
 
CLASS="CHAPTER"
108
 
><H1
109
 
><A
110
 
NAME="LIBGLADE-DTD">Glade 2.0 File Format</H1
111
 
><DIV
112
 
CLASS="TOC"
113
 
><DL
114
 
><DT
115
 
><B
116
 
>Table of Contents</B
117
 
></DT
118
 
><DT
119
 
><A
120
 
HREF="libglade-dtd.html#PROPERTY-REPRESENTATIONS"
121
 
>Property Representations</A
122
 
></DT
123
 
><DT
124
 
><A
125
 
HREF="libglade-dtd-exceptions.html"
126
 
>Exceptions</A
127
 
></DT
128
 
></DL
129
 
></DIV
130
 
><P
131
 
>Libglade 2.0 introduces a new file format for storing the
 
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Glade 2.0 File Format</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="Libglade Reference Manual"><link rel="up" href="index.html" title="Libglade Reference Manual"><link rel="prev" href="libglade-embedding.html" title="Embedding Libglade Interfaces"><link rel="next" href="libglade-dtd-exceptions.html" title="Exceptions"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="chapter" href="libglade-notes.html" title="Libglade Programming Notes"><link rel="chapter" href="libglade-dtd.html" title="Glade 2.0 File Format"><link rel="part" href="libglade-lib.html" title="Part�I.�Libglade Library Reference"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libglade-embedding.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">Libglade Reference Manual</th><td><a accesskey="n" href="libglade-dtd-exceptions.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="libglade-dtd"></a>Glade 2.0 File Format</h2></div></div></div><div class="toc"><dl><dt><span class="sect1"><a href="libglade-dtd.html#property-representations">Property Representations</a></span></dt><dt><span class="sect1"><a href="libglade-dtd-exceptions.html">Exceptions</a></span></dt></dl></div><p>Libglade 2.0 introduces a new file format for storing the
132
2
    user interface.  Unlike the previous format, this one does not
133
3
    introduce a new element for each new property.  This was done so
134
 
    that the format could be described with a fairly small DTD:</P
135
 
><TABLE
136
 
BORDER="0"
137
 
BGCOLOR="#D6E8FF"
138
 
WIDTH="100%"
139
 
CELLPADDING="6"
140
 
><TR
141
 
><TD
142
 
><PRE
143
 
CLASS="PROGRAMLISTING"
144
 
>&#60;!-- proposed DTD for new glade format --&#62;
145
 
 
146
 
&#60;!ELEMENT glade-interface (requires*, widget*) &#62;
147
 
&#60;!ATTLIST glade-interface
148
 
  xmlns CDATA #FIXED 'http://glade.gnome.org/glade-2.0.dtd' &#62;
149
 
 
150
 
&#60;!ELEMENT requires EMPTY &#62;
151
 
&#60;!ATTLIST requires
152
 
  lib CDATA #REQUIRED &#62;
153
 
 
154
 
&#60;!ELEMENT widget (property*, accessibility?, signal*, accelerator*, child*) &#62;
155
 
&#60;!ATTLIST widget
 
4
    that the format could be described with a fairly small DTD:</p><pre class="programlisting">&lt;!-- proposed DTD for new glade format --&gt;
 
5
 
 
6
&lt;!ELEMENT glade-interface (requires*, widget*) &gt;
 
7
&lt;!ATTLIST glade-interface
 
8
  xmlns CDATA #FIXED 'http://glade.gnome.org/glade-2.0.dtd' &gt;
 
9
 
 
10
&lt;!ELEMENT requires EMPTY &gt;
 
11
&lt;!ATTLIST requires
 
12
  lib CDATA #REQUIRED &gt;
 
13
 
 
14
&lt;!ELEMENT widget (property*, accessibility?, signal*, accelerator*, child*) &gt;
 
15
&lt;!ATTLIST widget
156
16
  class CDATA #REQUIRED
157
 
  id ID #REQUIRED &#62;
158
 
 
159
 
&#60;!ELEMENT property (#PCDATA) &#62;
160
 
&#60;!-- type is an optional tag, and should be the string name of the
161
 
     GType for the property --&#62;
162
 
&#60;!-- translatable specifies whether the property should be translated
163
 
     before use. --&#62;
164
 
&#60;!ATTLIST property
165
 
  name CDATA #REQUIRED
166
 
  type CDATA #IMPLIED
167
 
  translatable (yes|no) 'no'
168
 
  agent CDATA #IMPLIED &#62;
169
 
 
170
 
&#60;!ELEMENT atkproperty (#PCDATA | accessibility)* &#62;
171
 
&#60;!ATTLIST atkproperty
172
 
  name CDATA #REQUIRED
173
 
  type CDATA #IMPLIED &#62;
174
 
 
175
 
&#60;!ELEMENT atkrelation EMPTY &#62;
176
 
&#60;!ATTLIST atkrelation
 
17
  id ID #REQUIRED &gt;
 
18
 
 
19
&lt;!ELEMENT property (#PCDATA) &gt;
 
20
&lt;!-- type is an optional tag, and should be the string name of the
 
21
     GType for the property --&gt;
 
22
&lt;!-- translatable specifies whether the property should be translated
 
23
     before use. --&gt;
 
24
&lt;!-- context indicates that the value has a |-separated 
 
25
     context which must be stripped before use, look up g_strip_context() 
 
26
     in the GLib API documentation for details.--&gt;
 
27
&lt;!ATTLIST property
 
28
  name CDATA #REQUIRED
 
29
  type CDATA #IMPLIED
 
30
  translatable (yes|no) 'no'
 
31
  context (yes|no) 'no'
 
32
  comments CDATA #IMPLIED
 
33
  agent CDATA #IMPLIED &gt;
 
34
 
 
35
&lt;!ELEMENT atkproperty (#PCDATA | accessibility)* &gt;
 
36
&lt;!ATTLIST atkproperty
 
37
  name CDATA #REQUIRED
 
38
  type CDATA #IMPLIED
 
39
  translatable (yes|no) 'no'
 
40
  context (yes|no) 'no'
 
41
  comments CDATA #IMPLIED &gt;
 
42
 
 
43
&lt;!ELEMENT atkrelation EMPTY &gt;
 
44
&lt;!ATTLIST atkrelation
177
45
  target CDATA #REQUIRED
178
 
  type CDATA #REQUIRED &#62;
 
46
  type CDATA #REQUIRED &gt;
179
47
 
180
 
&#60;!ELEMENT atkaction EMPTY &#62;
181
 
&#60;!ATTLIST atkaction
 
48
&lt;!-- description is assumed to be a translatable string --&gt;
 
49
&lt;!ELEMENT atkaction EMPTY &gt;
 
50
&lt;!ATTLIST atkaction
182
51
  action_name CDATA #REQUIRED
183
 
  description CDATA #IMPLIED &#62;
184
 
 
185
 
&#60;!ELEMENT accessibility (atkrelation | atkaction | atkproperty)* &#62;
186
 
 
187
 
&#60;!ELEMENT signal EMPTY &#62;
188
 
&#60;!ATTLIST signal
 
52
  description CDATA #IMPLIED &gt;
 
53
 
 
54
&lt;!ELEMENT accessibility (atkrelation | atkaction | atkproperty)* &gt;
 
55
 
 
56
&lt;!ELEMENT signal (property*) &gt;
 
57
&lt;!ATTLIST signal
189
58
  name CDATA #REQUIRED
190
59
  handler CDATA #REQUIRED
191
60
  after (yes|no) 'no'
192
61
  object IDREF #IMPLIED
193
 
  last_modification_time CDATA #IMPLIED &#62;
 
62
  last_modification_time CDATA #IMPLIED &gt;
194
63
 
195
 
&#60;!ELEMENT accelerator EMPTY &#62;
196
 
&#60;!ATTLIST accelerator
 
64
&lt;!ELEMENT accelerator EMPTY &gt;
 
65
&lt;!ATTLIST accelerator
197
66
  key CDATA #REQUIRED
198
67
  modifiers CDATA #REQUIRED
199
 
  signal CDATA #REQUIRED &#62;
 
68
  signal CDATA #REQUIRED &gt;
200
69
 
201
 
&#60;!ELEMENT child ((widget|placeholder), packing?) &#62;
202
 
&#60;!-- internal children should not have any properties set on them.
 
70
&lt;!ELEMENT child ((widget|placeholder), packing?) &gt;
 
71
&lt;!-- internal children should not have any properties set on them.
203
72
     (Internal children are things like the scrollbars in a
204
 
     GtkScrolledWindow, or the vbox in a GtkDialog). --&#62;
205
 
&#60;!ATTLIST child
206
 
  internal-child CDATA #IMPLIED &#62;
207
 
 
208
 
&#60;!ELEMENT packing (property+) &#62;
209
 
 
210
 
&#60;!ELEMENT placeholder EMPTY &#62;</PRE
211
 
></TD
212
 
></TR
213
 
></TABLE
214
 
><P
215
 
>The <TT
216
 
CLASS="SGMLTAG"
217
 
>&lt;widget&gt;</TT
218
 
> elements contain
219
 
    <TT
220
 
CLASS="SGMLTAG"
221
 
>&lt;property&gt;</TT
222
 
> elements which define widget
 
73
     GtkScrolledWindow, or the vbox in a GtkDialog). --&gt;
 
74
&lt;!ATTLIST child
 
75
  internal-child CDATA #IMPLIED &gt;
 
76
 
 
77
&lt;!ELEMENT packing (property+) &gt;
 
78
 
 
79
&lt;!ELEMENT placeholder EMPTY &gt;
 
80
</pre><p>The <tt class="sgmltag-element">&lt;widget&gt;</tt> elements contain
 
81
    <tt class="sgmltag-element">&lt;property&gt;</tt> elements which define widget
223
82
    properties.  In general these map to
224
 
    <TT
225
 
CLASS="CLASSNAME"
226
 
>GObject</TT
227
 
> properties.</P
228
 
><P
229
 
>The <TT
230
 
CLASS="SGMLTAG"
231
 
>&lt;signal&gt;</TT
232
 
> and
233
 
    <TT
234
 
CLASS="SGMLTAG"
235
 
>&lt;accelerator&gt;</TT
236
 
> elements are used to define
237
 
    signals and accelerators on the widget.</P
238
 
><P
239
 
>The <TT
240
 
CLASS="SGMLTAG"
241
 
>&lt;widget&gt;</TT
242
 
> element may also
243
 
    contain an <TT
244
 
CLASS="SGMLTAG"
245
 
>&lt;accessibility&gt;</TT
246
 
> element, which
 
83
    <tt class="classname">GObject</tt> properties.</p><p>The <tt class="sgmltag-element">&lt;signal&gt;</tt> and
 
84
    <tt class="sgmltag-element">&lt;accelerator&gt;</tt> elements are used to define
 
85
    signals and accelerators on the widget.</p><p>The <tt class="sgmltag-element">&lt;widget&gt;</tt> element may also
 
86
    contain an <tt class="sgmltag-element">&lt;accessibility&gt;</tt> element, which
247
87
    contains accessibility related properties.  These set various ATK
248
 
    options (such as ATK properties, relations and actions).</P
249
 
><P
250
 
>For each child of the widget, there is an
251
 
    <TT
252
 
CLASS="SGMLTAG"
253
 
>&lt;child&gt;</TT
254
 
> element.  The
255
 
    <TT
256
 
CLASS="PARAMETER"
257
 
><I
258
 
>internal-child</I
259
 
></TT
260
 
> attribute is used to mark
 
88
    options (such as ATK properties, relations and actions).</p><p>For each child of the widget, there is an
 
89
    <tt class="sgmltag-element">&lt;child&gt;</tt> element.  The
 
90
    <i class="parameter"><tt>internal-child</tt></i> attribute is used to mark
261
91
    "internal children of the parent.  These children are widgets that
262
92
    are created when the parent is constructed, such as the
263
 
    <TT
264
 
CLASS="CLASSNAME"
265
 
>GtkVBox</TT
266
 
> and
267
 
    <TT
268
 
CLASS="CLASSNAME"
269
 
>GtkHButtonBox</TT
270
 
> in a
271
 
    <TT
272
 
CLASS="CLASSNAME"
273
 
>GtkDialog</TT
274
 
>.</P
275
 
><P
276
 
>The <TT
277
 
CLASS="SGMLTAG"
278
 
>&lt;child&gt;</TT
279
 
> element contains either
280
 
    a <TT
281
 
CLASS="SGMLTAG"
282
 
>&lt;widget&gt;</TT
283
 
> element representing the child
284
 
    widget, or a <TT
285
 
CLASS="SGMLTAG"
286
 
>&lt;placeholder&gt;</TT
287
 
> element, which
 
93
    <tt class="classname">GtkVBox</tt> and
 
94
    <tt class="classname">GtkHButtonBox</tt> in a
 
95
    <tt class="classname">GtkDialog</tt>.</p><p>The <tt class="sgmltag-element">&lt;child&gt;</tt> element contains either
 
96
    a <tt class="sgmltag-element">&lt;widget&gt;</tt> element representing the child
 
97
    widget, or a <tt class="sgmltag-element">&lt;placeholder&gt;</tt> element, which
288
98
    is ignored when building the interface.  It may also contain a
289
 
    <TT
290
 
CLASS="SGMLTAG"
291
 
>&lt;packing&gt;</TT
292
 
> element, which contains
293
 
    <TT
294
 
CLASS="SGMLTAG"
295
 
>&lt;property&gt;</TT
296
 
> elements defining packing
 
99
    <tt class="sgmltag-element">&lt;packing&gt;</tt> element, which contains
 
100
    <tt class="sgmltag-element">&lt;property&gt;</tt> elements defining packing
297
101
    properties.  These map to GtkContainer child packing
298
 
    properties.</P
299
 
><BR
300
 
CLEAR="all"><DIV
301
 
CLASS="SECT1"
302
 
><H1
303
 
CLASS="SECT1"
304
 
><A
305
 
NAME="PROPERTY-REPRESENTATIONS">Property Representations</H1
306
 
><P
307
 
>Properties are represented as straight content data in the
 
102
    properties.</p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="property-representations"></a>Property Representations</h2></div></div></div><p>Properties are represented as straight content data in the
308
103
      glade file.  All programs working with glade files must
309
 
      represent the various types in the same way.</P
310
 
></DIV
311
 
></DIV
312
 
><DIV
313
 
CLASS="NAVFOOTER"
314
 
><BR
315
 
CLEAR="all"><BR><TABLE
316
 
WIDTH="100%"
317
 
BORDER="0"
318
 
BGCOLOR="#000000"
319
 
CELLPADDING="1"
320
 
CELLSPACING="0"
321
 
><TR
322
 
><TD
323
 
WIDTH="25%"
324
 
BGCOLOR="#C00000"
325
 
ALIGN="left"
326
 
><A
327
 
HREF="libglade-libglade-build.html"
328
 
><FONT
329
 
COLOR="#FFFFFF"
330
 
SIZE="3"
331
 
><B
332
 
>&#60;&#60;&#60; Previous Page</B
333
 
></FONT
334
 
></A
335
 
></TD
336
 
><TD
337
 
WIDTH="25%"
338
 
BGCOLOR="#0000C0"
339
 
ALIGN="center"
340
 
><FONT
341
 
COLOR="#FFFFFF"
342
 
SIZE="3"
343
 
><B
344
 
><A
345
 
HREF="libglade.html"
346
 
><FONT
347
 
COLOR="#FFFFFF"
348
 
SIZE="3"
349
 
><B
350
 
>Home</B
351
 
></FONT
352
 
></A
353
 
></B
354
 
></FONT
355
 
></TD
356
 
><TD
357
 
WIDTH="25%"
358
 
BGCOLOR="#00C000"
359
 
ALIGN="center"
360
 
><FONT
361
 
COLOR="#FFFFFF"
362
 
SIZE="3"
363
 
><B
364
 
>&nbsp;</B
365
 
></FONT
366
 
></TD
367
 
><TD
368
 
WIDTH="25%"
369
 
BGCOLOR="#C00000"
370
 
ALIGN="right"
371
 
><A
372
 
HREF="libglade-dtd-exceptions.html"
373
 
><FONT
374
 
COLOR="#FFFFFF"
375
 
SIZE="3"
376
 
><B
377
 
>Next Page &#62;&#62;&#62;</B
378
 
></FONT
379
 
></A
380
 
></TD
381
 
></TR
382
 
><TR
383
 
><TD
384
 
COLSPAN="2"
385
 
ALIGN="left"
386
 
><FONT
387
 
COLOR="#FFFFFF"
388
 
SIZE="3"
389
 
><B
390
 
>Libglade Build</B
391
 
></FONT
392
 
></TD
393
 
><TD
394
 
COLSPAN="2"
395
 
ALIGN="right"
396
 
><FONT
397
 
COLOR="#FFFFFF"
398
 
SIZE="3"
399
 
><B
400
 
>Exceptions</B
401
 
></FONT
402
 
></TD
403
 
></TR
404
 
></TABLE
405
 
></DIV
406
 
></BODY
407
 
></HTML
408
 
>
 
 
b'\\ No newline at end of file'
 
104
      represent the various types in the same way.</p></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libglade-embedding.html"><b>&lt;&lt;�Embedding Libglade Interfaces</b></a></td><td align="right"><a accesskey="n" href="libglade-dtd-exceptions.html"><b>Exceptions�&gt;&gt;</b></a></td></tr></table></body></html>