gtk-docs.sgml 13.1 KB
Newer Older
Owen Taylor's avatar
Owen Taylor committed
1
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
2
<!entity hash "#">
Owen Taylor's avatar
Owen Taylor committed
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
<!entity GtkAccelLabel SYSTEM "sgml/gtkaccellabel.sgml">
<!entity GtkAdjustment SYSTEM "sgml/gtkadjustment.sgml">
<!entity GtkAlignment SYSTEM "sgml/gtkalignment.sgml">
<!entity GtkArrow SYSTEM "sgml/gtkarrow.sgml">
<!entity GtkAspectFrame SYSTEM "sgml/gtkaspectframe.sgml">
<!entity GtkButtonBox SYSTEM "sgml/gtkbbox.sgml">
<!entity GtkBin SYSTEM "sgml/gtkbin.sgml">
<!entity GtkBox SYSTEM "sgml/gtkbox.sgml">
<!entity GtkButton SYSTEM "sgml/gtkbutton.sgml">
<!entity GtkCalendar SYSTEM "sgml/gtkcalendar.sgml">
<!entity GtkCheckButton SYSTEM "sgml/gtkcheckbutton.sgml">
<!entity GtkCheckMenuItem SYSTEM "sgml/gtkcheckmenuitem.sgml">
<!entity GtkCList SYSTEM "sgml/gtkclist.sgml">
<!entity GtkColorSelection SYSTEM "sgml/gtkcolorsel.sgml">
<!entity GtkColorSelectionDialog SYSTEM "sgml/gtkcolorseldlg.sgml">
<!entity GtkCombo SYSTEM "sgml/gtkcombo.sgml">
<!entity GtkContainer SYSTEM "sgml/gtkcontainer.sgml">
<!entity GtkCTree SYSTEM "sgml/gtkctree.sgml">
<!entity GtkCurve SYSTEM "sgml/gtkcurve.sgml">
<!entity GtkData SYSTEM "sgml/gtkdata.sgml">
<!entity GtkDialog SYSTEM "sgml/gtkdialog.sgml">
<!entity GtkDrawingArea SYSTEM "sgml/gtkdrawingarea.sgml">
<!entity GtkEditable SYSTEM "sgml/gtkeditable.sgml">
<!entity GtkEntry SYSTEM "sgml/gtkentry.sgml">
<!entity GtkEventBox SYSTEM "sgml/gtkeventbox.sgml">
<!entity GtkFileSelection SYSTEM "sgml/gtkfilesel.sgml">
<!entity GtkFixed SYSTEM "sgml/gtkfixed.sgml">
<!entity GtkFontSelection SYSTEM "sgml/gtkfontsel.sgml">
<!entity GtkFontSelectionDialog SYSTEM "sgml/gtkfontseldlg.sgml">
<!entity GtkFrame SYSTEM "sgml/gtkframe.sgml">
<!entity GtkGammaCurve SYSTEM "sgml/gtkgamma.sgml">
<!entity GtkHandleBox SYSTEM "sgml/gtkhandlebox.sgml">
<!entity GtkHButtonBox SYSTEM "sgml/gtkhbbox.sgml">
<!entity GtkHBox SYSTEM "sgml/gtkhbox.sgml">
<!entity GtkHPaned SYSTEM "sgml/gtkhpaned.sgml">
<!entity GtkHRuler SYSTEM "sgml/gtkhruler.sgml">
<!entity GtkHScale SYSTEM "sgml/gtkhscale.sgml">
<!entity GtkHScrollbar SYSTEM "sgml/gtkhscrollbar.sgml">
<!entity GtkHSeparator SYSTEM "sgml/gtkhseparator.sgml">
<!entity GtkImage SYSTEM "sgml/gtkimage.sgml">
43
44
<!entity GtkIMContext SYSTEM "sgml/gtkimcontext.sgml">
<!entity GtkIMMulticontext SYSTEM "sgml/gtkimmulticontext.sgml">
Owen Taylor's avatar
Owen Taylor committed
45
46
47
48
49
50
51
52
53
54
55
56
<!entity GtkInputDialog SYSTEM "sgml/gtkinputdialog.sgml">
<!entity GtkInvisible SYSTEM "sgml/gtkinvisible.sgml">
<!entity GtkItem SYSTEM "sgml/gtkitem.sgml">
<!entity GtkItemFactory SYSTEM "sgml/gtkitemfactory.sgml">
<!entity GtkLabel SYSTEM "sgml/gtklabel.sgml">
<!entity GtkLayout SYSTEM "sgml/gtklayout.sgml">
<!entity GtkList SYSTEM "sgml/gtklist.sgml">
<!entity GtkListItem SYSTEM "sgml/gtklistitem.sgml">
<!entity GtkMenu SYSTEM "sgml/gtkmenu.sgml">
<!entity GtkMenuBar SYSTEM "sgml/gtkmenubar.sgml">
<!entity GtkMenuItem SYSTEM "sgml/gtkmenuitem.sgml">
<!entity GtkMenuShell SYSTEM "sgml/gtkmenushell.sgml">
Jonathan Blandford's avatar
Jonathan Blandford committed
57
<!entity gtk-GtkMessageDialog SYSTEM "sgml/gtkmessagedialog.sgml">
Owen Taylor's avatar
Owen Taylor committed
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
<!entity GtkMisc SYSTEM "sgml/gtkmisc.sgml">
<!entity GtkNotebook SYSTEM "sgml/gtknotebook.sgml">
<!entity GtkObject SYSTEM "sgml/gtkobject.sgml">
<!entity GtkOptionMenu SYSTEM "sgml/gtkoptionmenu.sgml">
<!entity GtkPacker SYSTEM "sgml/gtkpacker.sgml">
<!entity GtkPaned SYSTEM "sgml/gtkpaned.sgml">
<!entity GtkPixmap SYSTEM "sgml/gtkpixmap.sgml">
<!entity GtkPlug SYSTEM "sgml/gtkplug.sgml">
<!entity GtkPreview SYSTEM "sgml/gtkpreview.sgml">
<!entity GtkProgress SYSTEM "sgml/gtkprogress.sgml">
<!entity GtkProgressBar SYSTEM "sgml/gtkprogressbar.sgml">
<!entity GtkRadioButton SYSTEM "sgml/gtkradiobutton.sgml">
<!entity GtkRadioMenuItem SYSTEM "sgml/gtkradiomenuitem.sgml">
<!entity GtkRange SYSTEM "sgml/gtkrange.sgml">
<!entity GtkRuler SYSTEM "sgml/gtkruler.sgml">
<!entity GtkScale SYSTEM "sgml/gtkscale.sgml">
<!entity GtkScrollbar SYSTEM "sgml/gtkscrollbar.sgml">
<!entity GtkScrolledWindow SYSTEM "sgml/gtkscrolledwindow.sgml">
<!entity GtkSeparator SYSTEM "sgml/gtkseparator.sgml">
<!entity GtkSocket SYSTEM "sgml/gtksocket.sgml">
<!entity GtkSpinButton SYSTEM "sgml/gtkspinbutton.sgml">
<!entity GtkStatusbar SYSTEM "sgml/gtkstatusbar.sgml">
<!entity GtkTable SYSTEM "sgml/gtktable.sgml">
<!entity GtkTearoffMenuItem SYSTEM "sgml/gtktearoffmenuitem.sgml">
<!entity GtkText SYSTEM "sgml/gtktext.sgml">
83
84
85
86
87
88
<!entity GtkTextBuffer SYSTEM "sgml/gtktextbuffer.sgml">
<!entity gtk-GtkTextIter SYSTEM "sgml/gtktextiter.sgml">
<!entity gtk-GtkTextMark SYSTEM "sgml/gtktextmark.sgml">
<!entity GtkTextTag SYSTEM "sgml/gtktexttag.sgml">
<!entity GtkTextTagTable SYSTEM "sgml/gtktexttagtable.sgml">
<!entity GtkTextView SYSTEM "sgml/gtktextview.sgml">
Owen Taylor's avatar
Owen Taylor committed
89
90
91
92
93
94
<!entity GtkTipsQuery SYSTEM "sgml/gtktipsquery.sgml">
<!entity GtkToggleButton SYSTEM "sgml/gtktogglebutton.sgml">
<!entity GtkToolbar SYSTEM "sgml/gtktoolbar.sgml">
<!entity GtkTooltips SYSTEM "sgml/gtktooltips.sgml">
<!entity GtkTree SYSTEM "sgml/gtktree.sgml">
<!entity GtkTreeItem SYSTEM "sgml/gtktreeitem.sgml">
Jonathan Blandford's avatar
Jonathan Blandford committed
95
96
97
98
99
100
101
102
103
104
105
106
<!entity gtk-gtktreemodel SYSTEM "sgml/gtktreemodel.sgml">
<!entity gtk-GtkTreeSelection SYSTEM "sgml/gtktreeselection.sgml">
<!entity gtk-GtkTreeStore SYSTEM "sgml/gtktreestore.sgml">
<!entity gtk-GtkTreeViewColumn SYSTEM "sgml/gtktreeviewcolumn.sgml">
<!entity gtk-GtkTreeView SYSTEM "sgml/gtktreeview.sgml">
<!entity gtk-GtkModelSimple SYSTEM "sgml/gtkmodelsimple.sgml">
<!entity gtk-GtkCellRenderer SYSTEM "sgml/gtkcellrenderer.sgml">
<!entity gtk-GtkCellRendererPixbuf SYSTEM "sgml/gtkcellrendererpixbuf.sgml">
<!entity gtk-GtkCellRendererText SYSTEM "sgml/gtkcellrenderertext.sgml">
<!entity gtk-GtkCellRendererTextPixbuf SYSTEM "sgml/gtkcellrenderertextpixbuf.sgml">
<!entity gtk-GtkCellRendererToggle SYSTEM "sgml/gtkcellrenderertoggle.sgml">
<!entity gtk-GtkListStore SYSTEM "sgml/gtkliststore.sgml">
Owen Taylor's avatar
Owen Taylor committed
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
<!entity GtkVButtonBox SYSTEM "sgml/gtkvbbox.sgml">
<!entity GtkVBox SYSTEM "sgml/gtkvbox.sgml">
<!entity GtkViewport SYSTEM "sgml/gtkviewport.sgml">
<!entity GtkVPaned SYSTEM "sgml/gtkvpaned.sgml">
<!entity GtkVRuler SYSTEM "sgml/gtkvruler.sgml">
<!entity GtkVScale SYSTEM "sgml/gtkvscale.sgml">
<!entity GtkVScrollbar SYSTEM "sgml/gtkvscrollbar.sgml">
<!entity GtkVSeparator SYSTEM "sgml/gtkvseparator.sgml">
<!entity GtkWidget SYSTEM "sgml/gtkwidget.sgml">
<!entity GtkWindow SYSTEM "sgml/gtkwindow.sgml">
<!entity gtk-General SYSTEM "sgml/gtkmain.sgml">
<!entity gtk-Feature-Test-Macros SYSTEM "sgml/gtkfeatures.sgml">
<!entity gtk-Graphics-Contexts SYSTEM "sgml/gtkgc.sgml">
<!entity gtk-Styles SYSTEM "sgml/gtkstyle.sgml">
<!entity gtk-Themes SYSTEM "sgml/gtkthemes.sgml">
<!entity gtk-Resource-Files SYSTEM "sgml/gtkrc.sgml">
<!entity gtk-Keyboard-Accelerators SYSTEM "sgml/gtkaccelgroup.sgml">
<!entity gtk-Selections SYSTEM "sgml/gtkselection.sgml">
Jonathan Blandford's avatar
Jonathan Blandford committed
125
<!entity gtk-Clipboards SYSTEM "sgml/gtkclipboard.sgml">
Owen Taylor's avatar
Owen Taylor committed
126
127
128
129
130
131
132
133
134
135
<!entity gtk-Drag-and-Drop SYSTEM "sgml/gtkdnd.sgml">
<!entity gtk-Signals SYSTEM "sgml/gtksignal.sgml">
<!entity gtk-Object-Properties SYSTEM "sgml/gtkarg.sgml">
<!entity gtk-Types SYSTEM "sgml/gtktypeutils.sgml">
<!entity gtk-Bindings SYSTEM "sgml/gtkbindings.sgml">
<!entity gtk-Standard-Enumerations SYSTEM "sgml/gtkenums.sgml">

<!entity index-Object-Tree SYSTEM "sgml/tree_index.sgml">

<!entity index-Objects-Grouped SYSTEM "objects_grouped.sgml">
Havoc Pennington's avatar
Havoc Pennington committed
136
<!entity gtk-TextWidget SYSTEM "text_widget.sgml">
Jonathan Blandford's avatar
Jonathan Blandford committed
137
<!entity gtk-TreeWidget SYSTEM "tree_widget.sgml">
Owen Taylor's avatar
Owen Taylor committed
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
]>
<book id="index">
  <bookinfo>
    <title>GTK+ Reference Manual</title>
  </bookinfo>

  <chapter id="gtk">
    <title>GTK+ </title>
    <para>
GTK+ is a multi-platform open source GUI Toolkit. Everything about
GTK+ from the object-oriented design to the Free Software LGPL
licensing allows you to code your project with the most freedom
possible. You can develop open software, free software, or even
commercial non-free software without having to spend a dime for
licenses or royalties.
    </para>
    <para>
GTK+ is a set of libraries to create graphical user interfaces. It
works on many Unix-like platforms, and a Windows version is in
development. GTK+ is released under the GNU Library General Public
License (GNU LGPL), which allows for flexible licensing of client
applications. GTK+ has a C-based object-oriented architecture that
allows for maximum flexibility.  Bindings for other languages have
been written, including C++, Objective-C, Guile/Scheme, Perl, Python,
TOM, Ada95, Free Pascal, and Eiffel.
    </para>
    <para>
GTK+ consists of the following component libraries:
<variablelist>

<varlistentry>
<term>GLib</term>
<listitem><para>
Provides many useful data types, macros, type conversions,
string utilities and a lexical scanner. Includes Win32 support.
</para></listitem>
</varlistentry>

<varlistentry>
<term>GDK</term>
<listitem><para>
A wrapper for low-level windowing functions.
</para></listitem>
</varlistentry>

<varlistentry>
<term>GTK+</term>
<listitem><para>
An advanced widget set.
</para></listitem>
</varlistentry>
</variablelist>
    </para>
Havoc Pennington's avatar
Havoc Pennington committed
191

Owen Taylor's avatar
Owen Taylor committed
192
193
194
195
196
197
198
199
200
201
202
203
204
205
    &gtk-General;
    &gtk-Feature-Test-Macros;
    &gtk-Graphics-Contexts;
    &gtk-Styles;
    &gtk-Themes;
    &gtk-Resource-Files;
    &gtk-Keyboard-Accelerators;
    &gtk-Selections;
    &gtk-Drag-and-Drop;
    &gtk-Signals;
    &gtk-Object-Properties;
    &gtk-Types;
    &gtk-Bindings;
    &gtk-Standard-Enumerations;
Havoc Pennington's avatar
Havoc Pennington committed
206

Owen Taylor's avatar
Owen Taylor committed
207
208
  </chapter>

Havoc Pennington's avatar
Havoc Pennington committed
209
  <chapter  id="gtkobjects" role="no-toc">
Owen Taylor's avatar
Owen Taylor committed
210
211
212
213
214
215
    <title>GTK+ Widgets and Objects</title>

    <sect1>
      <title>Object Hierarchy</title>
    &index-Object-Tree;
    </sect1>
Havoc Pennington's avatar
Havoc Pennington committed
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

    <sect1 id="WindowWidgets">
      <title>Windows</title>
        &GtkDialog;
        &GtkInvisible;
        &GtkPlug;
        &GtkWindow;
    </sect1>

    <sect1 id="DisplayWidgets">
      <title>Display Widgets</title>
        &GtkAccelLabel;
        &GtkImage;
        &GtkLabel;
        &GtkProgressBar;
        &GtkStatusbar;
    </sect1>

    <sect1 id="ButtonWidgets">
      <title>Buttons and Toggles</title>
        &GtkButton;
        &GtkCheckButton;
        &GtkRadioButton;
        &GtkToggleButton;
    </sect1>

    <sect1 id="NumericEntry">
      <title>Numeric/Text Data Entry</title>
        &GtkEntry;
        &GtkHScale;      
        &GtkSpinButton;
        &GtkVScale;
    </sect1>

    <sect1 id="TextWidgetObjects">
      <title>Multiline Text Editor</title>
        &gtk-TextWidget;
        &gtk-GtkTextIter;
        &gtk-GtkTextMark;
        &GtkText;
        &GtkTextBuffer;
        &GtkTextTag;
        &GtkTextTagTable;
        &GtkTextView;
    </sect1>

Jonathan Blandford's avatar
Jonathan Blandford committed
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
    <sect1 id="TreeWidgetObjects">
      <title>Tree and List Widget</title>
        &gtk-TreeWidget;
        &gtk-gtktreemodel;
        &gtk-GtkTreeSelection;
        &gtk-GtkTreeStore;
        &gtk-GtkTreeViewColumn;
        &gtk-GtkTreeView;
        &gtk-GtkModelSimple;
        &gtk-GtkCellRenderer;
        &gtk-GtkCellRendererPixbuf;
        &gtk-GtkCellRendererText;
        &gtk-GtkCellRendererTextPixbuf;
        &gtk-GtkCellRendererToggle;
        &gtk-GtkListStore;
    </sect1>
Havoc Pennington's avatar
Havoc Pennington committed
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
    <sect1 id="MenusAndCombos">
      <title>Menus, Combo Box, Toolbar</title>
        &GtkCheckMenuItem;      
        &GtkCombo;
        &GtkItemFactory;
        &GtkMenu;
        &GtkMenuBar;
        &GtkMenuItem;
        &GtkMenuShell;
        &GtkOptionMenu;
        &GtkRadioMenuItem;
        &GtkTearoffMenuItem;
        &GtkToolbar;
    </sect1>

    <sect1 id="SelectorWidgets">
      <title>Selectors (File/Font/Color/Input Devices)</title>
        &GtkColorSelection;
        &GtkColorSelectionDialog;
        &GtkFileSelection;
        &GtkFontSelection;
        &GtkFontSelectionDialog;
        &GtkInputDialog;
    </sect1>
    
    <sect1 id="LayoutContainers">
      <title>Layout Containers</title>
        &GtkAlignment;
        &GtkAspectFrame;
        &GtkHBox;
        &GtkHButtonBox;
        &GtkFixed;
        &GtkHPaned;
        &GtkLayout;
        &GtkNotebook;
        &GtkTable;
        &GtkVButtonBox;
        &GtkVBox;
        &GtkVPaned;
    </sect1>

    <sect1 id="Ornaments">
      <title>Ornaments</title>
        &GtkFrame;
        &GtkHSeparator;
        &GtkVSeparator;
    </sect1>

    <sect1 id="ScrollingWidgets">
      <title>Scrolling</title>
        &GtkHScrollbar;
        &GtkScrolledWindow;
        &GtkVScrollbar;
    </sect1>

    <sect1 id="MiscObjects">
      <title>Miscellaneous</title>
        &GtkAdjustment;
        &GtkArrow;
        &GtkCalendar;
        &GtkDrawingArea;
        &GtkEventBox;
        &GtkHandleBox;
        &GtkIMContext;
        &GtkIMMulticontext;
        &GtkTooltips;
        &GtkViewport;
    </sect1>

    <sect1 id="AbstractObjects">
      <title>Abstract Base Classes</title>
        &GtkBin;
        &GtkBox;
        &GtkContainer;
        &GtkEditable;
        &GtkButtonBox;
        &GtkMisc;
        &GtkObject;
        &GtkPaned;
        &GtkRange;
        &GtkScale;
        &GtkScrollbar;
        &GtkSeparator;
        &GtkWidget;
    </sect1>    

    <sect1 id="PlugSocket">
      <title>Cross-process Embedding</title>
        &GtkSocket;
    </sect1>

    <sect1 id="DeprecatedObjects">
      <title>Deprecated</title>
        &GtkCList;      
        &GtkCTree;
        &GtkCurve;
        &GtkData;
        &GtkGammaCurve;
        &GtkHRuler;
        &GtkItem;
        &GtkList;
        &GtkListItem;
        &GtkPacker;
        &GtkPixmap;
        &GtkPreview;
        &GtkProgress;
        &GtkRuler;
        &GtkTipsQuery;
        &GtkTree;
        &GtkTreeItem;
        &GtkVRuler;
    </sect1>

Owen Taylor's avatar
Owen Taylor committed
391
  </chapter>
Havoc Pennington's avatar
Havoc Pennington committed
392

Owen Taylor's avatar
Owen Taylor committed
393
</book>