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