]> Pileus Git - ~andy/gtk/blob - docs/reference/gtk/gtk-docs.sgml
Add package version info to API docs.
[~andy/gtk] / docs / reference / gtk / gtk-docs.sgml
1 <?xml version="1.0"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4 <!ENTITY GtkAccelLabel SYSTEM "xml/gtkaccellabel.xml">
5 <!ENTITY GtkAdjustment SYSTEM "xml/gtkadjustment.xml">
6 <!ENTITY GtkAlignment SYSTEM "xml/gtkalignment.xml">
7 <!ENTITY GtkArrow SYSTEM "xml/gtkarrow.xml">
8 <!ENTITY GtkAspectFrame SYSTEM "xml/gtkaspectframe.xml">
9 <!ENTITY GtkButtonBox SYSTEM "xml/gtkbbox.xml">
10 <!ENTITY GtkBin SYSTEM "xml/gtkbin.xml">
11 <!ENTITY GtkBox SYSTEM "xml/gtkbox.xml">
12 <!ENTITY GtkButton SYSTEM "xml/gtkbutton.xml">
13 <!ENTITY GtkCalendar SYSTEM "xml/gtkcalendar.xml">
14 <!ENTITY GtkCheckButton SYSTEM "xml/gtkcheckbutton.xml">
15 <!ENTITY GtkCheckMenuItem SYSTEM "xml/gtkcheckmenuitem.xml">
16 <!ENTITY GtkCList SYSTEM "xml/gtkclist.xml">
17 <!ENTITY GtkColorSelection SYSTEM "xml/gtkcolorsel.xml">
18 <!ENTITY GtkColorSelectionDialog SYSTEM "xml/gtkcolorseldlg.xml">
19 <!ENTITY GtkCombo SYSTEM "xml/gtkcombo.xml">
20 <!ENTITY GtkContainer SYSTEM "xml/gtkcontainer.xml">
21 <!ENTITY GtkCTree SYSTEM "xml/gtkctree.xml">
22 <!ENTITY GtkCurve SYSTEM "xml/gtkcurve.xml">
23 <!ENTITY GtkDialog SYSTEM "xml/gtkdialog.xml">
24 <!ENTITY GtkDrawingArea SYSTEM "xml/gtkdrawingarea.xml">
25 <!ENTITY GtkEditable SYSTEM "xml/gtkeditable.xml">
26 <!ENTITY GtkOldEditable SYSTEM "xml/gtkoldeditable.xml">
27 <!ENTITY GtkEntry SYSTEM "xml/gtkentry.xml">
28 <!ENTITY GtkEventBox SYSTEM "xml/gtkeventbox.xml">
29 <!ENTITY GtkFileSelection SYSTEM "xml/gtkfilesel.xml">
30 <!ENTITY GtkFixed SYSTEM "xml/gtkfixed.xml">
31 <!ENTITY GtkFontSelection SYSTEM "xml/gtkfontsel.xml">
32 <!ENTITY GtkFontSelectionDialog SYSTEM "xml/gtkfontseldlg.xml">
33 <!ENTITY GtkFrame SYSTEM "xml/gtkframe.xml">
34 <!ENTITY GtkGammaCurve SYSTEM "xml/gtkgamma.xml">
35 <!ENTITY GtkHandleBox SYSTEM "xml/gtkhandlebox.xml">
36 <!ENTITY GtkHButtonBox SYSTEM "xml/gtkhbbox.xml">
37 <!ENTITY GtkHBox SYSTEM "xml/gtkhbox.xml">
38 <!ENTITY GtkHPaned SYSTEM "xml/gtkhpaned.xml">
39 <!ENTITY GtkHRuler SYSTEM "xml/gtkhruler.xml">
40 <!ENTITY GtkHScale SYSTEM "xml/gtkhscale.xml">
41 <!ENTITY GtkHScrollbar SYSTEM "xml/gtkhscrollbar.xml">
42 <!ENTITY GtkHSeparator SYSTEM "xml/gtkhseparator.xml">
43 <!ENTITY GtkImage SYSTEM "xml/gtkimage.xml">
44 <!ENTITY GtkImageMenuItem SYSTEM "xml/gtkimagemenuitem.xml">
45 <!ENTITY GtkIMContext SYSTEM "xml/gtkimcontext.xml">
46 <!ENTITY GtkIMContextSimple SYSTEM "xml/gtkimcontextsimple.xml">
47 <!ENTITY GtkIMMulticontext SYSTEM "xml/gtkimmulticontext.xml">
48 <!ENTITY GtkInputDialog SYSTEM "xml/gtkinputdialog.xml">
49 <!ENTITY GtkInvisible SYSTEM "xml/gtkinvisible.xml">
50 <!ENTITY GtkItem SYSTEM "xml/gtkitem.xml">
51 <!ENTITY GtkItemFactory SYSTEM "xml/gtkitemfactory.xml">
52 <!ENTITY GtkLabel SYSTEM "xml/gtklabel.xml">
53 <!ENTITY GtkLayout SYSTEM "xml/gtklayout.xml">
54 <!ENTITY GtkList SYSTEM "xml/gtklist.xml">
55 <!ENTITY GtkListItem SYSTEM "xml/gtklistitem.xml">
56 <!ENTITY GtkMenu SYSTEM "xml/gtkmenu.xml">
57 <!ENTITY GtkMenuBar SYSTEM "xml/gtkmenubar.xml">
58 <!ENTITY GtkMenuItem SYSTEM "xml/gtkmenuitem.xml">
59 <!ENTITY GtkMenuShell SYSTEM "xml/gtkmenushell.xml">
60 <!ENTITY GtkMessageDialog SYSTEM "xml/gtkmessagedialog.xml">
61 <!ENTITY GtkMisc SYSTEM "xml/gtkmisc.xml">
62 <!ENTITY GtkNotebook SYSTEM "xml/gtknotebook.xml">
63 <!ENTITY GtkObject SYSTEM "xml/gtkobject.xml">
64 <!ENTITY GtkOptionMenu SYSTEM "xml/gtkoptionmenu.xml">
65 <!ENTITY GtkPaned SYSTEM "xml/gtkpaned.xml">
66 <!ENTITY GtkPixmap SYSTEM "xml/gtkpixmap.xml">
67 <!ENTITY GtkPlug SYSTEM "xml/gtkplug.xml">
68 <!ENTITY GtkPreview SYSTEM "xml/gtkpreview.xml">
69 <!ENTITY GtkProgress SYSTEM "xml/gtkprogress.xml">
70 <!ENTITY GtkProgressBar SYSTEM "xml/gtkprogressbar.xml">
71 <!ENTITY GtkRadioButton SYSTEM "xml/gtkradiobutton.xml">
72 <!ENTITY GtkRadioMenuItem SYSTEM "xml/gtkradiomenuitem.xml">
73 <!ENTITY GtkRange SYSTEM "xml/gtkrange.xml">
74 <!ENTITY GtkRuler SYSTEM "xml/gtkruler.xml">
75 <!ENTITY GtkScale SYSTEM "xml/gtkscale.xml">
76 <!ENTITY GtkScrollbar SYSTEM "xml/gtkscrollbar.xml">
77 <!ENTITY GtkScrolledWindow SYSTEM "xml/gtkscrolledwindow.xml">
78 <!ENTITY GtkSeparator SYSTEM "xml/gtkseparator.xml">
79 <!ENTITY GtkSeparatorMenuItem SYSTEM "xml/gtkseparatormenuitem.xml">
80 <!ENTITY GtkSizeGroup SYSTEM "xml/gtksizegroup.xml">
81 <!ENTITY GtkSocket SYSTEM "xml/gtksocket.xml">
82 <!ENTITY GtkSpinButton SYSTEM "xml/gtkspinbutton.xml">
83 <!ENTITY GtkStatusbar SYSTEM "xml/gtkstatusbar.xml">
84 <!ENTITY GtkTable SYSTEM "xml/gtktable.xml">
85 <!ENTITY GtkTearoffMenuItem SYSTEM "xml/gtktearoffmenuitem.xml">
86 <!ENTITY GtkText SYSTEM "xml/gtktext.xml">
87 <!ENTITY GtkTextBuffer SYSTEM "xml/gtktextbuffer.xml">
88 <!ENTITY GtkTextIter SYSTEM "xml/gtktextiter.xml">
89 <!ENTITY GtkTextMark SYSTEM "xml/gtktextmark.xml">
90 <!ENTITY GtkTextTag SYSTEM "xml/gtktexttag.xml">
91 <!ENTITY GtkTextTagTable SYSTEM "xml/gtktexttagtable.xml">
92 <!ENTITY GtkTextView SYSTEM "xml/gtktextview.xml">
93 <!ENTITY GtkTipsQuery SYSTEM "xml/gtktipsquery.xml">
94 <!ENTITY GtkToggleButton SYSTEM "xml/gtktogglebutton.xml">
95 <!ENTITY GtkToolbar SYSTEM "xml/gtktoolbar.xml">
96 <!ENTITY GtkTooltips SYSTEM "xml/gtktooltips.xml">
97 <!ENTITY GtkTree SYSTEM "xml/gtktree.xml">
98 <!ENTITY GtkTreeItem SYSTEM "xml/gtktreeitem.xml">
99 <!ENTITY GtkTreeModel SYSTEM "xml/gtktreemodel.xml">
100 <!ENTITY GtkTreeSortable SYSTEM "xml/gtktreesortable.xml">
101 <!ENTITY GtkTreeModelSort SYSTEM "xml/gtktreemodelsort.xml">
102 <!ENTITY GtkTreeSelection SYSTEM "xml/gtktreeselection.xml">
103 <!ENTITY GtkTreeStore SYSTEM "xml/gtktreestore.xml">
104 <!ENTITY GtkTreeViewColumn SYSTEM "xml/gtktreeviewcolumn.xml">
105 <!ENTITY GtkTreeView SYSTEM "xml/gtktreeview.xml">
106 <!ENTITY GtkCellRenderer SYSTEM "xml/gtkcellrenderer.xml">
107 <!ENTITY GtkCellEditable SYSTEM "xml/gtkcelleditable.xml">
108 <!ENTITY GtkCellRendererPixbuf SYSTEM "xml/gtkcellrendererpixbuf.xml">
109 <!ENTITY GtkCellRendererText SYSTEM "xml/gtkcellrenderertext.xml">
110 <!ENTITY GtkCellRendererToggle SYSTEM "xml/gtkcellrenderertoggle.xml">
111 <!ENTITY GtkListStore SYSTEM "xml/gtkliststore.xml">
112 <!ENTITY GtkTreeDND SYSTEM "xml/gtktreednd.xml">
113 <!ENTITY GtkVButtonBox SYSTEM "xml/gtkvbbox.xml">
114 <!ENTITY GtkVBox SYSTEM "xml/gtkvbox.xml">
115 <!ENTITY GtkViewport SYSTEM "xml/gtkviewport.xml">
116 <!ENTITY GtkVPaned SYSTEM "xml/gtkvpaned.xml">
117 <!ENTITY GtkVRuler SYSTEM "xml/gtkvruler.xml">
118 <!ENTITY GtkVScale SYSTEM "xml/gtkvscale.xml">
119 <!ENTITY GtkVScrollbar SYSTEM "xml/gtkvscrollbar.xml">
120 <!ENTITY GtkVSeparator SYSTEM "xml/gtkvseparator.xml">
121 <!ENTITY GtkWidget SYSTEM "xml/gtkwidget.xml">
122 <!ENTITY GtkWindow SYSTEM "xml/gtkwindow.xml">
123 <!ENTITY GtkWindowGroup SYSTEM "xml/gtkwindowgroup.xml">
124 <!ENTITY GtkAccessible SYSTEM "xml/gtkaccessible.xml">
125 <!ENTITY gtk-General SYSTEM "xml/gtkmain.xml">
126 <!ENTITY gtk-Feature-Test-Macros SYSTEM "xml/gtkfeatures.xml">
127 <!ENTITY gtk-Graphics-Contexts SYSTEM "xml/gtkgc.xml">
128 <!ENTITY gtk-Styles SYSTEM "xml/gtkstyle.xml">
129 <!ENTITY gtk-Themes SYSTEM "xml/gtkthemes.xml">
130 <!ENTITY gtk-Resource-Files SYSTEM "xml/gtkrc.xml">
131 <!ENTITY GtkAccelGroup SYSTEM "xml/gtkaccelgroup.xml">
132 <!ENTITY gtk-accel-map SYSTEM "xml/gtkaccelmap.xml">
133 <!ENTITY gtk-Selections SYSTEM "xml/gtkselection.xml">
134 <!ENTITY gtk-Clipboards SYSTEM "xml/gtkclipboard.xml">
135 <!ENTITY gtk-Drag-and-Drop SYSTEM "xml/gtkdnd.xml">
136 <!ENTITY gtk-Signals SYSTEM "xml/gtksignal.xml">
137 <!ENTITY gtk-Types SYSTEM "xml/gtktypeutils.xml">
138 <!ENTITY gtk-Bindings SYSTEM "xml/gtkbindings.xml">
139 <!ENTITY gtk-Standard-Enumerations SYSTEM "xml/gtkenums.xml">
140 <!ENTITY gtk-Stock-Items SYSTEM "xml/gtkstock.xml">
141 <!ENTITY gtk-Themeable-Stock-Images SYSTEM "xml/gtkiconfactory.xml">
142 <!ENTITY gtk-Settings SYSTEM "xml/gtksettings.xml">
143
144 <!ENTITY index-Object-Tree SYSTEM "xml/tree_index.sgml">
145
146 <!ENTITY index-Objects-Grouped SYSTEM "objects_grouped.sgml">
147 <!ENTITY gtk-TextWidget SYSTEM "text_widget.sgml">
148 <!ENTITY gtk-TreeWidget SYSTEM "tree_widget.sgml">
149 <!ENTITY gtk-Compiling SYSTEM "compiling.sgml">
150 <!ENTITY gtk-Building SYSTEM "building.sgml">
151 <!ENTITY gtk-Running SYSTEM "running.sgml">
152 <!ENTITY gtk-Resources SYSTEM "resources.sgml">
153 <!ENTITY gtk-Windows SYSTEM "windows.sgml">
154 <!ENTITY gtk-Framebuffer SYSTEM "framebuffer.sgml">
155 <!ENTITY gtk-X11 SYSTEM "x11.sgml">
156 <!ENTITY gtk-Questions SYSTEM "question_index.sgml">
157 <!ENTITY gtk-Changes-1-2 SYSTEM "changes-1.2.sgml">
158 <!ENTITY gtk-Changes-2-0 SYSTEM "changes-2.0.sgml">
159 <!ENTITY version SYSTEM "version.xml">
160 ]>
161 <book id="index">
162   <bookinfo>
163     <title>GTK+ Reference Manual</title>
164     <releaseinfo>for GTK+ &version;</releaseinfo>
165   </bookinfo>
166
167   <part id="gtk">
168     <title>GTK+ Overview</title>
169     <partintro>
170     <para>
171 GTK+ is a library for creating graphical user interfaces. It
172 works on many UNIX-like platforms, Windows, and on framebuffer
173 devices. GTK+ is released under the GNU Library General Public License
174 (GNU LGPL), which allows for flexible licensing of client
175 applications. GTK+ has a C-based object-oriented architecture that
176 allows for maximum flexibility.  Bindings for other languages have
177 been written, including C++, Objective-C, Guile/Scheme, Perl, Python,
178 TOM, Ada95, Free Pascal, and Eiffel.
179     </para>
180     <para>
181 GTK+ depends on the following libraries:
182 <variablelist>
183
184 <varlistentry>
185 <term>GLib</term>
186 <listitem><para>
187 A general-purpose utility library, not specific to graphical user interfaces.
188 GLib provides many useful data types, macros, type conversions,
189 string utilities, file utilities, a main loop abstraction, and so on.
190 </para></listitem>
191 </varlistentry>
192
193 <varlistentry>
194 <term>Pango</term>
195 <listitem><para>
196
197 Pango is a library for internationalized text handling. It centers
198 around the #PangoLayout object, representing a paragraph of text.
199 Pango provides the engine for #GtkTextView, #GtkLabel, #GtkEntry, and
200 other widgets that display text.
201
202 </para></listitem>
203 </varlistentry>
204
205 <varlistentry>
206 <term>ATK</term>
207 <listitem><para>
208
209 ATK is the Accessibility Toolkit. It provides a set of generic
210 interfaces allowing accessibility technologies to interact with a
211 graphical user interface. For example, a screen reader uses ATK to
212 discover the text in an interface and read it to blind users.  GTK+
213 widgets have built-in support for accessibility using the ATK
214 framework.
215
216 </para></listitem>
217 </varlistentry>
218
219 <varlistentry>
220 <term>GdkPixbuf</term>
221 <listitem><para>
222 This is a small library which allows you to create #GdkPixbuf
223 ("pixel buffer") objects from image data or image files. 
224 Use a #GdkPixbuf in combination with #GtkImage to display images.
225 </para></listitem>
226 </varlistentry>
227
228 <varlistentry>
229 <term>GDK</term>
230 <listitem><para>
231 GDK is the abstraction layer that allows GTK+ to support multiple
232 windowing systems. GDK provides drawing and window system facilities
233 on X11, Windows, and the Linux framebuffer device.
234 </para></listitem>
235 </varlistentry>
236
237 <varlistentry>
238 <term>GTK+</term>
239 <listitem><para>
240
241 The GTK+ library itself contains <firstterm>widgets</firstterm>, 
242 that is, GUI components such as #GtkButton or #GtkTextView.
243
244 </para></listitem>
245 </varlistentry>
246 </variablelist>
247     </para>
248 </partintro>
249     &gtk-Building;
250     &gtk-Compiling;
251     &gtk-Running;
252     &gtk-Windows;
253     &gtk-Framebuffer;
254     &gtk-X11;
255     &gtk-Changes-1-2;
256     &gtk-Changes-2-0;
257     &gtk-Resources;
258     &gtk-Questions;
259
260   </part>
261
262
263   <part  id="gtkbase">
264     <title>GTK+ Core Reference</title>
265
266     &gtk-General;
267     &GtkAccelGroup;
268     &gtk-accel-map;
269     &gtk-Clipboards;
270     &gtk-Drag-and-Drop;
271     &gtk-Stock-Items;
272     &gtk-Themeable-Stock-Images;
273     &gtk-Resource-Files;   
274     &gtk-Settings;
275     &gtk-Bindings;
276     &gtk-Standard-Enumerations;
277     &gtk-Graphics-Contexts;
278     &gtk-Styles;
279     &gtk-Selections;
280     &gtk-Feature-Test-Macros;
281     &gtk-Signals;
282     &gtk-Types;
283   </part>
284
285   <part id="gtkobjects">
286     <title>GTK+ Widgets and Objects</title>
287     <chapter>
288       <title>Object Hierarchy</title>
289     &index-Object-Tree;
290     </chapter>
291
292     <chapter id="WindowWidgets">
293       <title>Windows</title>
294         &GtkDialog;
295         &GtkInvisible;
296         &GtkMessageDialog;
297         &GtkPlug;
298         &GtkWindow;
299         &GtkWindowGroup;
300     </chapter>
301
302     <chapter id="DisplayWidgets">
303       <title>Display Widgets</title>
304         &GtkAccelLabel;
305         &GtkImage;
306         &GtkLabel;
307         &GtkProgressBar;
308         &GtkStatusbar;
309     </chapter>
310
311     <chapter id="ButtonWidgets">
312       <title>Buttons and Toggles</title>
313         &GtkButton;
314         &GtkCheckButton;
315         &GtkRadioButton;
316         &GtkToggleButton;
317     </chapter>
318
319     <chapter id="NumericEntry">
320       <title>Numeric/Text Data Entry</title>
321         &GtkEntry;
322         &GtkHScale;      
323         &GtkVScale;
324         &GtkSpinButton;
325     </chapter>
326
327     <chapter id="TextWidgetObjects">
328       <title>Multiline Text Editor</title>
329         &gtk-TextWidget;
330         &GtkTextIter;
331         &GtkTextMark;
332         &GtkTextBuffer;
333         &GtkTextTag;
334         &GtkTextTagTable;
335         &GtkTextView;
336     </chapter>
337
338     <chapter id="TreeWidgetObjects">
339       <title>Tree and List Widget</title>
340         &gtk-TreeWidget;
341         &GtkTreeModel;
342         &GtkTreeSelection;
343         &GtkTreeViewColumn;
344         &GtkTreeView;
345         &GtkTreeDND;
346         &GtkTreeSortable;
347         &GtkTreeModelSort;
348         &GtkCellRenderer;
349         &GtkCellEditable;
350         &GtkCellRendererPixbuf;
351         &GtkCellRendererText;
352         &GtkCellRendererToggle;
353         &GtkListStore;
354         &GtkTreeStore;
355     </chapter>
356     <chapter id="MenusAndCombos">
357       <title>Menus, Combo Box, Toolbar</title>
358         &GtkCombo;
359         &GtkItemFactory;
360         &GtkMenu;
361         &GtkMenuBar;
362         &GtkMenuItem;
363         &GtkMenuShell;
364         &GtkOptionMenu;
365         &GtkImageMenuItem;
366         &GtkRadioMenuItem;
367         &GtkCheckMenuItem;      
368         &GtkSeparatorMenuItem;
369         &GtkTearoffMenuItem;
370         &GtkToolbar;
371     </chapter>
372
373     <chapter id="SelectorWidgets">
374       <title>Selectors (File/Font/Color/Input Devices)</title>
375         &GtkColorSelection;
376         &GtkColorSelectionDialog;
377         &GtkFileSelection;
378         &GtkFontSelection;
379         &GtkFontSelectionDialog;
380         &GtkInputDialog;
381     </chapter>
382     
383     <chapter id="LayoutContainers">
384       <title>Layout Containers</title>
385         &GtkAlignment;
386         &GtkAspectFrame;
387         &GtkHBox;
388         &GtkVBox;
389         &GtkHButtonBox;
390         &GtkVButtonBox;
391         &GtkFixed;
392         &GtkHPaned;
393         &GtkVPaned;
394         &GtkLayout;
395         &GtkNotebook;
396         &GtkTable;
397     </chapter>
398
399     <chapter id="Ornaments">
400       <title>Ornaments</title>
401         &GtkFrame;
402         &GtkHSeparator;
403         &GtkVSeparator;
404     </chapter>
405
406     <chapter id="ScrollingWidgets">
407       <title>Scrolling</title>
408         &GtkHScrollbar;
409         &GtkVScrollbar;
410         &GtkScrolledWindow;
411     </chapter>
412
413     <chapter id="MiscObjects">
414       <title>Miscellaneous</title>
415         &GtkAdjustment;
416         &GtkArrow;
417         &GtkCalendar;
418         &GtkDrawingArea;
419         &GtkEventBox;
420         &GtkHandleBox;
421         &GtkIMContext;
422         &GtkIMContextSimple;
423         &GtkIMMulticontext;
424         &GtkSizeGroup;
425         &GtkTooltips;
426         &GtkViewport;
427         &GtkAccessible;
428     </chapter>
429
430     <chapter id="AbstractObjects">
431       <title>Abstract Base Classes</title>
432         &GtkBin;
433         &GtkBox;
434         &GtkButtonBox;
435         &GtkContainer;
436         &GtkEditable;
437         &GtkItem;
438         &GtkMisc;
439         &GtkObject;
440         &GtkPaned;
441         &GtkRange;
442         &GtkScale;
443         &GtkScrollbar;
444         &GtkSeparator;
445         &GtkWidget;
446     </chapter>    
447
448     <chapter id="PlugSocket">
449       <title>Cross-process Embedding</title>
450         &GtkSocket;
451     </chapter>
452
453     <chapter id="SpecialObjects">
454       <title>Special-purpose features</title>
455         &GtkCurve;
456         &GtkGammaCurve;
457         &GtkRuler;
458         &GtkHRuler;
459         &GtkVRuler;
460     </chapter>
461
462     <chapter id="DeprecatedObjects">
463       <title>Deprecated</title>
464         &GtkCList;      
465         &GtkCTree;
466         &GtkList;
467         &GtkListItem;
468         &GtkPixmap;
469         &GtkProgress;
470         &GtkPreview;
471         &GtkOldEditable;
472         &GtkText;
473         &GtkTipsQuery;
474         &GtkTree;
475         &GtkTreeItem;
476     </chapter>
477
478   </part>
479
480 </book>