Pileus Git - ~andy/gtk/blob - 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/devel/gtk3/">http://developer.gnome.org/devel/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/devel/gtk/">http://developer.gnome.org/devel/gtk/</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/gtksymboliccolor.xml" />
  65     <xi:include href="xml/gtkgradient.xml" />
  66     <xi:include href="xml/gtkicontheme.xml" />
  67     <xi:include href="xml/gtkiconfactory.xml" />
  68     <xi:include href="xml/gtknumerableicon.xml" />
  69     <xi:include href="xml/gtkrc.xml" />
  70     <xi:include href="xml/gtkstyle.xml" />
  71   </part>
  72
  73   <part id="gtkobjects">
  74     <title>GTK+ Widgets and Objects</title>
  75
  76     <chapter>
  77       <title>Object Hierarchy</title>
  78       <xi:include href="xml/tree_index.sgml" />
  79     </chapter>
  80
  81     <chapter>
  82       <title>Widget Gallery</title>
  83       <xi:include href="visual_index.xml" />
  84     </chapter>
  85
  86     <chapter id="WindowWidgets">
  87       <title>Windows</title>
  88       <xi:include href="xml/gtkdialog.xml" />
  89       <xi:include href="xml/gtkinvisible.xml" />
  90       <xi:include href="xml/gtkmessagedialog.xml" />
  91       <xi:include href="xml/gtkwindow.xml" />
  92       <xi:include href="xml/gtkwindowgroup.xml" />
  93       <xi:include href="xml/gtkaboutdialog.xml" />
  94       <xi:include href="xml/gtkassistant.xml" />
  95       <xi:include href="xml/gtkoffscreenwindow.xml" />
  96     </chapter>
  97
  98     <chapter id="DisplayWidgets">
  99       <title>Display Widgets</title>
 100       <xi:include href="xml/gtkaccellabel.xml" />
 101       <xi:include href="xml/gtkimage.xml" />
 102       <xi:include href="xml/gtklabel.xml" />
 103       <xi:include href="xml/gtkprogressbar.xml" />
 104       <xi:include href="xml/gtkstatusbar.xml" />
 105       <xi:include href="xml/gtkinfobar.xml" />
 106       <xi:include href="xml/gtkstatusicon.xml" />
 107       <xi:include href="xml/gtkspinner.xml" />
 108     </chapter>
 109
 110     <chapter id="ButtonWidgets">
 111       <title>Buttons and Toggles</title>
 112       <xi:include href="xml/gtkbutton.xml" />
 113       <xi:include href="xml/gtkcheckbutton.xml" />
 114       <xi:include href="xml/gtkradiobutton.xml" />
 115       <xi:include href="xml/gtktogglebutton.xml" />
 116       <xi:include href="xml/gtklinkbutton.xml" />
 117       <xi:include href="xml/gtkscalebutton.xml" />
 118       <xi:include href="xml/gtkvolumebutton.xml" />
 119       <xi:include href="xml/gtkswitch.xml" />
 120       <xi:include href="xml/gtklockbutton.xml" />
 121     </chapter>
 122
 123     <chapter id="NumericEntry">
 124       <title>Numeric/Text Data Entry</title>
 125       <xi:include href="xml/gtkentry.xml" />
 126       <xi:include href="xml/gtkentrybuffer.xml" />
 127       <xi:include href="xml/gtkentrycompletion.xml" />
 128       <xi:include href="xml/gtkscale.xml" />
 129       <xi:include href="xml/gtkhscale.xml" />
 130       <xi:include href="xml/gtkvscale.xml" />
 131       <xi:include href="xml/gtkspinbutton.xml" />
 132       <xi:include href="xml/gtkeditable.xml" />
 133     </chapter>
 134
 135     <chapter id="TextWidgetObjects">
 136       <title>Multiline Text Editor</title>
 137       <xi:include href="xml/text_widget.sgml" />
 138       <xi:include href="xml/gtktextiter.xml" />
 139       <xi:include href="xml/gtktextmark.xml" />
 140       <xi:include href="xml/gtktextbuffer.xml" />
 141       <xi:include href="xml/gtktexttag.xml" />
 142       <xi:include href="xml/gtktexttagtable.xml" />
 143       <xi:include href="xml/gtktextview.xml" />
 144     </chapter>
 145
 146     <chapter id="TreeWidgetObjects">
 147       <title>Tree, List and Icon Grid Widgets</title>
 148       <xi:include href="xml/tree_widget.sgml" />
 149       <xi:include href="xml/gtktreemodel.xml" />
 150       <xi:include href="xml/gtktreeselection.xml" />
 151       <xi:include href="xml/gtktreeviewcolumn.xml" />
 152       <xi:include href="xml/gtktreeview.xml" />
 153       <xi:include href="xml/gtktreednd.xml" />
 154       <xi:include href="xml/gtkcellview.xml" />
 155       <xi:include href="xml/gtkiconview.xml" />
 156       <xi:include href="xml/gtktreesortable.xml" />
 157       <xi:include href="xml/gtktreemodelsort.xml" />
 158       <xi:include href="xml/gtktreemodelfilter.xml" />
 159       <xi:include href="xml/gtkcelllayout.xml" />
 160       <xi:include href="xml/gtkcellarea.xml" />
 161       <xi:include href="xml/gtkcellareabox.xml" />
 162       <xi:include href="xml/gtkcellareacontext.xml" />
 163       <xi:include href="xml/gtkcellrenderer.xml" />
 164       <xi:include href="xml/gtkcelleditable.xml" />
 165       <xi:include href="xml/gtkcellrendereraccel.xml" />
 166       <xi:include href="xml/gtkcellrenderercombo.xml" />
 167       <xi:include href="xml/gtkcellrendererpixbuf.xml" />
 168       <xi:include href="xml/gtkcellrendererprogress.xml" />
 169       <xi:include href="xml/gtkcellrendererspin.xml" />
 170       <xi:include href="xml/gtkcellrenderertext.xml" />
 171       <xi:include href="xml/gtkcellrenderertoggle.xml" />
 172       <xi:include href="xml/gtkcellrendererspinner.xml" />
 173       <xi:include href="xml/gtkliststore.xml" />
 174       <xi:include href="xml/gtktreestore.xml" />
 175     </chapter>
 176
 177     <chapter id="MenusAndCombos">
 178       <title>Menus, Combo Box, Toolbar</title>
 179       <xi:include href="xml/gtkcombobox.xml" />
 180       <xi:include href="xml/gtkcomboboxtext.xml" />
 181       <xi:include href="xml/gtkmenu.xml" />
 182       <xi:include href="xml/gtkmenubar.xml" />
 183       <xi:include href="xml/gtkmenuitem.xml" />
 184       <xi:include href="xml/gtkimagemenuitem.xml" />
 185       <xi:include href="xml/gtkradiomenuitem.xml" />
 186       <xi:include href="xml/gtkcheckmenuitem.xml" />
 187       <xi:include href="xml/gtkseparatormenuitem.xml" />
 188       <xi:include href="xml/gtktearoffmenuitem.xml" />
 189       <xi:include href="xml/gtktoolshell.xml" />
 190       <xi:include href="xml/gtktoolbar.xml" />
 191       <xi:include href="xml/gtktoolitem.xml" />
 192       <xi:include href="xml/gtktoolpalette.xml" />
 193       <xi:include href="xml/gtktoolitemgroup.xml" />
 194       <xi:include href="xml/gtkseparatortoolitem.xml" />
 195       <xi:include href="xml/gtktoolbutton.xml" />
 196       <xi:include href="xml/gtkmenutoolbutton.xml" />
 197       <xi:include href="xml/gtktoggletoolbutton.xml" />
 198       <xi:include href="xml/gtkradiotoolbutton.xml" />
 199     </chapter>
 200
 201     <chapter id="Actions">
 202       <title>Action-based menus and toolbars</title>
 203       <xi:include href="xml/gtkuimanager.xml" />
 204       <xi:include href="xml/gtkactiongroup.xml" />
 205       <xi:include href="xml/gtkaction.xml" />
 206       <xi:include href="xml/gtktoggleaction.xml" />
 207       <xi:include href="xml/gtkradioaction.xml" />
 208       <xi:include href="xml/gtkrecentaction.xml" />
 209       <xi:include href="xml/gtkactivatable.xml" />
 210     </chapter>
 211
 212     <chapter id="SelectorWidgets">
 213       <title>Selectors (Color/File/Font)</title>
 214       <xi:include href="xml/gtkcolorchooser.xml" />
 215       <xi:include href="xml/gtkcolorbutton.xml" />
 216       <xi:include href="xml/gtkcolorchooserwidget.xml" />
 217       <xi:include href="xml/gtkcolorchooserdialog.xml" />
 218       <xi:include href="xml/gtkcolorsel.xml" />
 219       <xi:include href="xml/gtkcolorseldlg.xml" />
 220       <xi:include href="xml/gtkhsv.xml" />
 221       <xi:include href="xml/gtkfilechooser.xml" />
 222       <xi:include href="xml/gtkfilechooserbutton.xml" />
 223       <xi:include href="xml/gtkfilechooserdialog.xml" />
 224       <xi:include href="xml/gtkfilechooserwidget.xml" />
 225       <xi:include href="xml/gtkfilefilter.xml" />
 226       <xi:include href="xml/gtkfontchooser.xml" />
 227       <xi:include href="xml/gtkfontbutton.xml" />
 228       <xi:include href="xml/gtkfontchooserwidget.xml" />
 229       <xi:include href="xml/gtkfontchooserdialog.xml" />
 230       <xi:include href="xml/gtkfontsel.xml" />
 231       <xi:include href="xml/gtkfontseldlg.xml" />
 232     </chapter>
 233
 234     <chapter id="LayoutContainers">
 235       <title>Layout Containers</title>
 236       <xi:include href="xml/gtkgrid.xml" />
 237       <xi:include href="xml/gtkalignment.xml" />
 238       <xi:include href="xml/gtkaspectframe.xml" />
 239       <xi:include href="xml/gtkbox.xml" />
 240       <xi:include href="xml/gtkhbox.xml" />
 241       <xi:include href="xml/gtkvbox.xml" />
 242       <xi:include href="xml/gtkbbox.xml" />
 243       <xi:include href="xml/gtkhbbox.xml" />
 244       <xi:include href="xml/gtkvbbox.xml" />
 245       <xi:include href="xml/gtkfixed.xml" />
 246       <xi:include href="xml/gtkpaned.xml" />
 247       <xi:include href="xml/gtkhpaned.xml" />
 248       <xi:include href="xml/gtkvpaned.xml" />
 249       <xi:include href="xml/gtklayout.xml" />
 250       <xi:include href="xml/gtknotebook.xml" />
 251       <xi:include href="xml/gtktable.xml" />
 252       <xi:include href="xml/gtkexpander.xml" />
 253       <xi:include href="xml/gtkoverlay.xml" />
 254       <xi:include href="xml/gtkorientable.xml" />
 255     </chapter>
 256
 257     <chapter id="Ornaments">
 258       <title>Ornaments</title>
 259       <xi:include href="xml/gtkframe.xml" />
 260       <xi:include href="xml/gtkseparator.xml" />
 261       <xi:include href="xml/gtkhseparator.xml" />
 262       <xi:include href="xml/gtkvseparator.xml" />
 263     </chapter>
 264
 265     <chapter id="ScrollingWidgets">
 266       <title>Scrolling</title>
 267       <xi:include href="xml/gtkscrollbar.xml" />
 268       <xi:include href="xml/gtkhscrollbar.xml" />
 269       <xi:include href="xml/gtkvscrollbar.xml" />
 270       <xi:include href="xml/gtkscrolledwindow.xml" />
 271       <xi:include href="xml/gtkscrollable.xml" />
 272     </chapter>
 273
 274     <chapter id="Printing">
 275       <title>Printing</title>
 276       <xi:include href="xml/gtkprintoperation.xml" />
 277       <xi:include href="xml/gtkprintcontext.xml" />
 278       <xi:include href="xml/gtkprintsettings.xml" />
 279       <xi:include href="xml/gtkpagesetup.xml" />
 280       <xi:include href="xml/gtkpapersize.xml" />
 281       <xi:include href="xml/gtkprinter.xml" />
 282       <xi:include href="xml/gtkprintjob.xml" />
 283       <xi:include href="xml/gtkprintunixdialog.xml" />
 284       <xi:include href="xml/gtkpagesetupunixdialog.xml" />
 285     </chapter>
 286
 287     <chapter id="MiscObjects">
 288       <title>Miscellaneous</title>
 289       <xi:include href="xml/gtkadjustment.xml" />
 290       <xi:include href="xml/gtkarrow.xml" />
 291       <xi:include href="xml/gtkcalendar.xml" />
 292       <xi:include href="xml/gtkdrawingarea.xml" />
 293       <xi:include href="xml/gtkeventbox.xml" />
 294       <xi:include href="xml/gtkhandlebox.xml" />
 295       <xi:include href="xml/gtkimcontextsimple.xml" />
 296       <xi:include href="xml/gtkimmulticontext.xml" />
 297       <xi:include href="xml/gtksizegroup.xml" />
 298       <xi:include href="xml/gtktooltip.xml" />
 299       <xi:include href="xml/gtkviewport.xml" />
 300       <xi:include href="xml/gtkaccessible.xml" />
 301     </chapter>
 302
 303     <chapter id="AbstractObjects">
 304       <title>Abstract Base Classes</title>
 305       <xi:include href="xml/gtkwidget.xml" />
 306       <xi:include href="xml/gtkcontainer.xml" />
 307       <xi:include href="xml/gtkbin.xml" />
 308       <xi:include href="xml/gtkmenushell.xml" />
 309       <xi:include href="xml/gtkmisc.xml" />
 310       <xi:include href="xml/gtkrange.xml" />
 311       <xi:include href="xml/gtkimcontext.xml" />
 312     </chapter>
 313
 314     <chapter id="PlugSocket">
 315       <title>Cross-process Embedding</title>
 316       <xi:include href="xml/gtkplug.xml" />
 317       <xi:include href="xml/gtksocket.xml" />
 318     </chapter>
 319
 320     <chapter id="RecentDocuments">
 321       <title>Recently Used Documents</title>
 322       <xi:include href="xml/gtkrecentmanager.xml" />
 323       <xi:include href="xml/gtkrecentchooser.xml" />
 324       <xi:include href="xml/gtkrecentchooserdialog.xml" />
 325       <xi:include href="xml/gtkrecentchoosermenu.xml" />
 326       <xi:include href="xml/gtkrecentchooserwidget.xml" />
 327       <xi:include href="xml/gtkrecentfilter.xml" />
 328     </chapter>
 329
 330     <chapter id="ApplicationChoosing">
 331       <title>Choosing from installed applications</title>
 332       <xi:include href="xml/gtkappchooser.xml" />
 333       <xi:include href="xml/gtkappchooserbutton.xml" />
 334       <xi:include href="xml/gtkappchooserdialog.xml" />
 335       <xi:include href="xml/gtkappchooserwidget.xml" />
 336     </chapter>
 337
 338     <chapter id="Builder">
 339       <title>Interface builder</title>
 340       <xi:include href="xml/gtkbuildable.xml" />
 341       <xi:include href="xml/gtkbuilder.xml" />
 342     </chapter>
 343
 344     <chapter id="Application">
 345       <title>Application support</title>
 346       <xi:include href="xml/gtkapplication.xml" />
 347       <xi:include href="xml/gtkapplicationwindow.xml" />
 348       <xi:include href="xml/gtkactionable.xml" />
 349     </chapter>
 350   </part>
 351
 352   <part id="migrating">
 353     <title>Migrating from Previous Versions of GTK+</title>
 354
 355     <partintro>
 356       <para>
 357         This part describes what you need to change in programs use
 358         older versions of GTK+ so that they can use the new features.
 359         It also mentions how to convert applications using widgets
 360         found in the libgnomeui library to use their counterparts
 361         in GTK+.
 362       </para>
 363     </partintro>
 364
 365     <xi:include href="xml/migrating-2to3.xml" />
 366     <xi:include href="xml/migrating-GtkStyleContext.xml" />
 367     <xi:include href="xml/migrating-unique-GtkApplication.xml" />
 368     <xi:include href="xml/migrating-smclient-GtkApplication.xml" />
 369     <xi:include href="xml/migrating-GtkGrid.xml" />
 370     <xi:include href="xml/migrating-checklist.sgml" />
 371   </part>
 372
 373   <part>
 374     <title>GTK+ Tools</title>
 375     <xi:include href="gtk-query-immodules-3.0.xml" />
 376     <xi:include href="gtk-update-icon-cache.xml" />
 377   </part>
 378
 379   <xi:include href="glossary.xml" />
 380
 381   <index id="api-index-full">
 382     <title>Index of all symbols</title>
 383     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
 384   </index>
 385   <index id="api-index-deprecated" role="deprecated">
 386     <title>Index of deprecated symbols</title>
 387     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
 388   </index>
 389   <index id="api-index-3-0" role="3.0">
 390     <title>Index of new symbols in 3.0</title>
 391     <xi:include href="xml/api-index-3.0.xml"><xi:fallback /></xi:include>
 392   </index>
 393   <index id="api-index-3-2" role="3.2">
 394     <title>Index of new symbols in 3.2</title>
 395     <xi:include href="xml/api-index-3.2.xml"><xi:fallback /></xi:include>
 396   </index>
 397   <index id="api-index-3-4" role="3.4">
 398     <title>Index of new symbols in 3.4</title>
 399     <xi:include href="xml/api-index-3.4.xml"><xi:fallback /></xi:include>
 400   </index>
 401
 402   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 403
 404 </book>