]> Pileus Git - ~andy/gtk/blob - docs/reference/gtk/gtk-docs.sgml
c82e8f731c5375726f20c6a7f05a6271b583fd0b
[~andy/gtk] / docs / reference / gtk / gtk-docs.sgml
1 <?xml version="1.0"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3                "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
4 <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
5 <!ENTITY version SYSTEM "version.xml">
6 <!ENTITY pi "&#960;">
7 <!ENTITY solidus "&#8260;">
8 ]>
9 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
10   <bookinfo>
11     <title>GTK+ 3 Reference Manual</title>
12     <releaseinfo>
13       This document is for the GTK+ 3 library, version &version;.
14       The latest versions can be found online at
15       <ulink role="online-location" url="http://developer.gnome.org/gtk3/">http://developer.gnome.org/gtk3/</ulink>.
16       If you are looking for the older GTK+ 2 series of libraries,
17       see <ulink role="online-location" url="http://developer.gnome.org/gtk2/">http://developer.gnome.org/gtk2/</ulink>.
18     </releaseinfo>
19   </bookinfo>
20
21   <part id="gtk">
22     <title>GTK+ Overview</title>
23     <xi:include href="overview.xml"/>
24     <xi:include href="xml/getting_started.xml"/>
25     <xi:include href="building.sgml" />
26     <xi:include href="xml/compiling.sgml" />
27     <xi:include href="running.sgml" />
28     <xi:include href="x11.sgml" />
29     <xi:include href="windows.sgml" />
30     <xi:include href="osx.sgml" />
31     <xi:include href="broadway.xml" />
32     <xi:include href="wayland.xml" />
33     <xi:include href="resources.sgml" />
34     <xi:include href="xml/question_index.sgml" />
35     <xi:include href="drawing-model.xml" />
36   </part>
37
38
39   <part  id="gtkbase">
40     <title>GTK+ Core Reference</title>
41     <xi:include href="xml/gtkmain.xml" />
42     <xi:include href="xml/gtkfeatures.xml" />
43     <xi:include href="xml/gtkaccelgroup.xml" />
44     <xi:include href="xml/gtkaccelmap.xml" />
45     <xi:include href="xml/gtkclipboard.xml" />
46     <xi:include href="xml/gtkdnd.xml" />
47     <xi:include href="xml/gtkstock.xml" />
48     <xi:include href="xml/gtksettings.xml" />
49     <xi:include href="xml/gtkbindings.xml" />
50     <xi:include href="xml/gtkenums.xml" />
51     <xi:include href="xml/gtkselection.xml" />
52     <xi:include href="xml/gtktesting.xml" />
53     <xi:include href="xml/filesystem.xml" />
54   </part>
55
56   <part id="theming">
57     <title>Theming in GTK+</title>
58     <xi:include href="xml/gtkstylecontext.xml" />
59     <xi:include href="xml/gtkcssprovider.xml" />
60     <xi:include href="xml/gtkstyleprovider.xml" />
61     <xi:include href="xml/gtkstyleproperties.xml" />
62     <xi:include href="xml/gtkthemingengine.xml" />
63     <xi:include href="xml/gtkwidgetpath.xml" />
64     <xi:include href="xml/gtkicontheme.xml" />
65     <xi:include href="xml/gtkiconfactory.xml" />
66     <xi:include href="xml/gtknumerableicon.xml" />
67   </part>
68
69   <part id="gtkobjects">
70     <title>GTK+ Widgets and Objects</title>
71
72     <chapter>
73       <title>Object Hierarchy</title>
74       <xi:include href="xml/tree_index.sgml" />
75     </chapter>
76
77     <chapter>
78       <title>Widget Gallery</title>
79       <xi:include href="visual_index.xml" />
80     </chapter>
81
82     <chapter id="WindowWidgets">
83       <title>Windows</title>
84       <xi:include href="xml/gtkdialog.xml" />
85       <xi:include href="xml/gtkinvisible.xml" />
86       <xi:include href="xml/gtkmessagedialog.xml" />
87       <xi:include href="xml/gtkwindow.xml" />
88       <xi:include href="xml/gtkwindowgroup.xml" />
89       <xi:include href="xml/gtkaboutdialog.xml" />
90       <xi:include href="xml/gtkassistant.xml" />
91       <xi:include href="xml/gtkoffscreenwindow.xml" />
92       <xi:include href="xml/gtkbubblewindow.xml" />
93     </chapter>
94
95     <chapter id="DisplayWidgets">
96       <title>Display Widgets</title>
97       <xi:include href="xml/gtkaccellabel.xml" />
98       <xi:include href="xml/gtkimage.xml" />
99       <xi:include href="xml/gtklabel.xml" />
100       <xi:include href="xml/gtkprogressbar.xml" />
101       <xi:include href="xml/gtkstatusbar.xml" />
102       <xi:include href="xml/gtklevelbar.xml" />
103       <xi:include href="xml/gtkinfobar.xml" />
104       <xi:include href="xml/gtkstatusicon.xml" />
105       <xi:include href="xml/gtkspinner.xml" />
106     </chapter>
107
108     <chapter id="ButtonWidgets">
109       <title>Buttons and Toggles</title>
110       <xi:include href="xml/gtkbutton.xml" />
111       <xi:include href="xml/gtkcheckbutton.xml" />
112       <xi:include href="xml/gtkradiobutton.xml" />
113       <xi:include href="xml/gtktogglebutton.xml" />
114       <xi:include href="xml/gtklinkbutton.xml" />
115       <xi:include href="xml/gtkscalebutton.xml" />
116       <xi:include href="xml/gtkvolumebutton.xml" />
117       <xi:include href="xml/gtkswitch.xml" />
118       <xi:include href="xml/gtklockbutton.xml" />
119       <xi:include href="xml/gtkmenubutton.xml" />
120     </chapter>
121
122     <chapter id="NumericEntry">
123       <title>Numeric/Text Data Entry</title>
124       <xi:include href="xml/gtkentry.xml" />
125       <xi:include href="xml/gtkentrybuffer.xml" />
126       <xi:include href="xml/gtkentrycompletion.xml" />
127       <xi:include href="xml/gtkscale.xml" />
128       <xi:include href="xml/gtkspinbutton.xml" />
129       <xi:include href="xml/gtksearchentry.xml" />
130       <xi:include href="xml/gtkeditable.xml" />
131     </chapter>
132
133     <chapter id="TextWidgetObjects">
134       <title>Multiline Text Editor</title>
135       <xi:include href="xml/text_widget.sgml" />
136       <xi:include href="xml/gtktextiter.xml" />
137       <xi:include href="xml/gtktextmark.xml" />
138       <xi:include href="xml/gtktextbuffer.xml" />
139       <xi:include href="xml/gtktexttag.xml" />
140       <xi:include href="xml/gtktexttagtable.xml" />
141       <xi:include href="xml/gtktextview.xml" />
142     </chapter>
143
144     <chapter id="TreeWidgetObjects">
145       <title>Tree, List and Icon Grid Widgets</title>
146       <xi:include href="xml/tree_widget.sgml" />
147       <xi:include href="xml/gtktreemodel.xml" />
148       <xi:include href="xml/gtktreeselection.xml" />
149       <xi:include href="xml/gtktreeviewcolumn.xml" />
150       <xi:include href="xml/gtktreeview.xml" />
151       <xi:include href="xml/gtktreednd.xml" />
152       <xi:include href="xml/gtkcellview.xml" />
153       <xi:include href="xml/gtkiconview.xml" />
154       <xi:include href="xml/gtktreesortable.xml" />
155       <xi:include href="xml/gtktreemodelsort.xml" />
156       <xi:include href="xml/gtktreemodelfilter.xml" />
157       <xi:include href="xml/gtkcelllayout.xml" />
158       <xi:include href="xml/gtkcellarea.xml" />
159       <xi:include href="xml/gtkcellareabox.xml" />
160       <xi:include href="xml/gtkcellareacontext.xml" />
161       <xi:include href="xml/gtkcellrenderer.xml" />
162       <xi:include href="xml/gtkcelleditable.xml" />
163       <xi:include href="xml/gtkcellrendereraccel.xml" />
164       <xi:include href="xml/gtkcellrenderercombo.xml" />
165       <xi:include href="xml/gtkcellrendererpixbuf.xml" />
166       <xi:include href="xml/gtkcellrendererprogress.xml" />
167       <xi:include href="xml/gtkcellrendererspin.xml" />
168       <xi:include href="xml/gtkcellrenderertext.xml" />
169       <xi:include href="xml/gtkcellrenderertoggle.xml" />
170       <xi:include href="xml/gtkcellrendererspinner.xml" />
171       <xi:include href="xml/gtkliststore.xml" />
172       <xi:include href="xml/gtktreestore.xml" />
173     </chapter>
174
175     <chapter id="MenusAndCombos">
176       <title>Menus, Combo Box, Toolbar</title>
177       <xi:include href="xml/gtkcombobox.xml" />
178       <xi:include href="xml/gtkcomboboxtext.xml" />
179       <xi:include href="xml/gtkmenu.xml" />
180       <xi:include href="xml/gtkmenubar.xml" />
181       <xi:include href="xml/gtkmenuitem.xml" />
182       <xi:include href="xml/gtkimagemenuitem.xml" />
183       <xi:include href="xml/gtkradiomenuitem.xml" />
184       <xi:include href="xml/gtkcheckmenuitem.xml" />
185       <xi:include href="xml/gtkseparatormenuitem.xml" />
186       <xi:include href="xml/gtktoolshell.xml" />
187       <xi:include href="xml/gtktoolbar.xml" />
188       <xi:include href="xml/gtktoolitem.xml" />
189       <xi:include href="xml/gtktoolpalette.xml" />
190       <xi:include href="xml/gtktoolitemgroup.xml" />
191       <xi:include href="xml/gtkseparatortoolitem.xml" />
192       <xi:include href="xml/gtktoolbutton.xml" />
193       <xi:include href="xml/gtkmenutoolbutton.xml" />
194       <xi:include href="xml/gtktoggletoolbutton.xml" />
195       <xi:include href="xml/gtkradiotoolbutton.xml" />
196     </chapter>
197
198     <chapter id="Actions">
199       <title>Action-based menus and toolbars</title>
200       <xi:include href="xml/gtkuimanager.xml" />
201       <xi:include href="xml/gtkactiongroup.xml" />
202       <xi:include href="xml/gtkaction.xml" />
203       <xi:include href="xml/gtktoggleaction.xml" />
204       <xi:include href="xml/gtkradioaction.xml" />
205       <xi:include href="xml/gtkrecentaction.xml" />
206       <xi:include href="xml/gtkactivatable.xml" />
207     </chapter>
208
209     <chapter id="SelectorWidgets">
210       <title>Selectors (Color/File/Font)</title>
211       <xi:include href="xml/gtkcolorchooser.xml" />
212       <xi:include href="xml/gtkcolorbutton.xml" />
213       <xi:include href="xml/gtkcolorchooserwidget.xml" />
214       <xi:include href="xml/gtkcolorchooserdialog.xml" />
215       <xi:include href="xml/gtkfilechooser.xml" />
216       <xi:include href="xml/gtkfilechooserbutton.xml" />
217       <xi:include href="xml/gtkfilechooserdialog.xml" />
218       <xi:include href="xml/gtkfilechooserwidget.xml" />
219       <xi:include href="xml/gtkfilefilter.xml" />
220       <xi:include href="xml/gtkfontchooser.xml" />
221       <xi:include href="xml/gtkfontbutton.xml" />
222       <xi:include href="xml/gtkfontchooserwidget.xml" />
223       <xi:include href="xml/gtkfontchooserdialog.xml" />
224     </chapter>
225     
226     <chapter id="LayoutContainers">
227       <title>Layout Containers</title>
228       <xi:include href="xml/gtkgrid.xml" />
229       <xi:include href="xml/gtkalignment.xml" />
230       <xi:include href="xml/gtkaspectframe.xml" />
231       <xi:include href="xml/gtkbox.xml" />
232       <xi:include href="xml/gtkbbox.xml" />
233       <xi:include href="xml/gtkfixed.xml" />
234       <xi:include href="xml/gtkpaned.xml" />
235       <xi:include href="xml/gtklayout.xml" />
236       <xi:include href="xml/gtknotebook.xml" />
237       <xi:include href="xml/gtkexpander.xml" />
238       <xi:include href="xml/gtkoverlay.xml" />
239       <xi:include href="xml/gtkorientable.xml" />
240     </chapter>
241
242     <chapter id="Ornaments">
243       <title>Ornaments</title>
244       <xi:include href="xml/gtkframe.xml" />
245       <xi:include href="xml/gtkseparator.xml" />
246     </chapter>
247
248     <chapter id="ScrollingWidgets">
249       <title>Scrolling</title>
250       <xi:include href="xml/gtkscrollbar.xml" />
251       <xi:include href="xml/gtkscrolledwindow.xml" />
252       <xi:include href="xml/gtkscrollable.xml" />
253     </chapter>
254
255     <chapter id="Printing">
256       <title>Printing</title>
257       <xi:include href="xml/gtkprintoperation.xml" />
258       <xi:include href="xml/gtkprintcontext.xml" />
259       <xi:include href="xml/gtkprintsettings.xml" />
260       <xi:include href="xml/gtkpagesetup.xml" />
261       <xi:include href="xml/gtkpapersize.xml" />
262       <xi:include href="xml/gtkprinter.xml" />
263       <xi:include href="xml/gtkprintjob.xml" />
264       <xi:include href="xml/gtkprintunixdialog.xml" />
265       <xi:include href="xml/gtkpagesetupunixdialog.xml" />
266     </chapter>
267
268     <chapter id="MiscObjects">
269       <title>Miscellaneous</title>
270       <xi:include href="xml/gtkadjustment.xml" />
271       <xi:include href="xml/gtkarrow.xml" />
272       <xi:include href="xml/gtkcalendar.xml" />
273       <xi:include href="xml/gtkdrawingarea.xml" />
274       <xi:include href="xml/gtkeventbox.xml" />
275       <xi:include href="xml/gtkhandlebox.xml" />
276       <xi:include href="xml/gtkimcontextsimple.xml" />
277       <xi:include href="xml/gtkimmulticontext.xml" />
278       <xi:include href="xml/gtksizegroup.xml" />
279       <xi:include href="xml/gtktooltip.xml" />
280       <xi:include href="xml/gtkviewport.xml" />
281       <xi:include href="xml/gtkaccessible.xml" />
282     </chapter>
283
284     <chapter id="AbstractObjects">
285       <title>Abstract Base Classes</title>
286       <xi:include href="xml/gtkwidget.xml" />
287       <xi:include href="xml/gtkcontainer.xml" />
288       <xi:include href="xml/gtkbin.xml" />
289       <xi:include href="xml/gtkmenushell.xml" />
290       <xi:include href="xml/gtkmisc.xml" />
291       <xi:include href="xml/gtkrange.xml" />
292       <xi:include href="xml/gtkimcontext.xml" />
293     </chapter>
294
295     <chapter id="PlugSocket">
296       <title>Cross-process Embedding</title>
297       <xi:include href="xml/gtkplug.xml" />
298       <xi:include href="xml/gtksocket.xml" />
299     </chapter>
300
301     <chapter id="RecentDocuments">
302       <title>Recently Used Documents</title>
303       <xi:include href="xml/gtkrecentmanager.xml" />
304       <xi:include href="xml/gtkrecentchooser.xml" />
305       <xi:include href="xml/gtkrecentchooserdialog.xml" />
306       <xi:include href="xml/gtkrecentchoosermenu.xml" />
307       <xi:include href="xml/gtkrecentchooserwidget.xml" />
308       <xi:include href="xml/gtkrecentfilter.xml" />
309     </chapter>
310
311     <chapter id="ApplicationChoosing">
312       <title>Choosing from installed applications</title>
313       <xi:include href="xml/gtkappchooser.xml" />
314       <xi:include href="xml/gtkappchooserbutton.xml" />
315       <xi:include href="xml/gtkappchooserdialog.xml" />
316       <xi:include href="xml/gtkappchooserwidget.xml" />
317     </chapter>
318
319     <chapter id="Builder">
320       <title>Interface builder</title>
321       <xi:include href="xml/gtkbuildable.xml" />
322       <xi:include href="xml/gtkbuilder.xml" />
323     </chapter>
324
325     <chapter id="Application">
326       <title>Application support</title>
327       <xi:include href="xml/gtkapplication.xml" />
328       <xi:include href="xml/gtkapplicationwindow.xml" />
329       <xi:include href="xml/gtkactionable.xml" />
330     </chapter>
331
332     <chapter id="DeprecatedObjects">
333       <title>Deprecated</title>
334       <xi:include href="xml/gtksymboliccolor.xml" />
335       <xi:include href="xml/gtkgradient.xml" />
336       <xi:include href="xml/gtkrc.xml" />
337       <xi:include href="xml/gtkstyle.xml" />
338       <xi:include href="xml/gtkhscale.xml" />
339       <xi:include href="xml/gtkvscale.xml" />
340       <xi:include href="xml/gtktearoffmenuitem.xml" />
341       <xi:include href="xml/gtkcolorsel.xml" />
342       <xi:include href="xml/gtkcolorseldlg.xml" />
343       <xi:include href="xml/gtkhsv.xml" />
344       <xi:include href="xml/gtkfontsel.xml" />
345       <xi:include href="xml/gtkfontseldlg.xml" />
346       <xi:include href="xml/gtkhbox.xml" />
347       <xi:include href="xml/gtkvbox.xml" />
348       <xi:include href="xml/gtkhbbox.xml" />
349       <xi:include href="xml/gtkvbbox.xml" />
350       <xi:include href="xml/gtkhpaned.xml" />
351       <xi:include href="xml/gtkvpaned.xml" />
352       <xi:include href="xml/gtktable.xml" />
353       <xi:include href="xml/gtkhseparator.xml" />
354       <xi:include href="xml/gtkvseparator.xml" />
355       <xi:include href="xml/gtkhscrollbar.xml" />
356       <xi:include href="xml/gtkvscrollbar.xml" />
357     </chapter>
358
359   </part>
360
361   <part id="migrating">
362     <title>Migrating from Previous Versions of GTK+</title>
363
364     <partintro>
365       <para>
366         This part describes what you need to change in programs use
367         older versions of GTK+ so that they can use the new features.
368         It also mentions how to convert applications using widgets
369         found in the libgnomeui library to use their counterparts
370         in GTK+.
371       </para>
372     </partintro>
373
374     <xi:include href="xml/migrating-2to3.xml" />
375     <xi:include href="xml/migrating-GtkStyleContext.xml" />
376     <xi:include href="xml/migrating-unique-GtkApplication.xml" />
377     <xi:include href="xml/migrating-smclient-GtkApplication.xml" />
378     <xi:include href="xml/migrating-GtkGrid.xml" />
379     <xi:include href="xml/migrating-checklist.sgml" />
380   </part>
381
382   <part>
383     <title>GTK+ Tools</title>
384     <xi:include href="gtk-query-immodules-3.0.xml" />
385     <xi:include href="gtk-update-icon-cache.xml" />
386     <xi:include href="gtk-launch.xml" />
387     <xi:include href="broadwayd.xml" />
388   </part>
389
390   <xi:include href="glossary.xml" />
391
392   <index id="api-index-full">
393     <title>Index of all symbols</title>
394     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
395   </index>
396   <index id="api-index-deprecated" role="deprecated">
397     <title>Index of deprecated symbols</title>
398     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
399   </index>
400   <index id="api-index-3-0" role="3.0">
401     <title>Index of new symbols in 3.0</title>
402     <xi:include href="xml/api-index-3.0.xml"><xi:fallback /></xi:include>
403   </index>
404   <index id="api-index-3-2" role="3.2">
405     <title>Index of new symbols in 3.2</title>
406     <xi:include href="xml/api-index-3.2.xml"><xi:fallback /></xi:include>
407   </index>
408   <index id="api-index-3-4" role="3.4">
409     <title>Index of new symbols in 3.4</title>
410     <xi:include href="xml/api-index-3.4.xml"><xi:fallback /></xi:include>
411   </index>
412   <index id="api-index-3-6" role="3.6">
413     <title>Index of new symbols in 3.6</title>
414     <xi:include href="xml/api-index-3.6.xml"><xi:fallback /></xi:include>
415   </index>
416   <index id="api-index-3-8" role="3.8">
417     <title>Index of new symbols in 3.8</title>
418     <xi:include href="xml/api-index-3.8.xml"><xi:fallback /></xi:include>
419   </index>
420
421   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
422
423 </book>