Pileus Git - ~andy/gtk/blob - docs/reference/gtk/gtk-docs.sgml

   1 <!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
   2 <!entity hash "#">
   3 <!entity GtkAccelLabel SYSTEM "sgml/gtkaccellabel.sgml">
   4 <!entity GtkAdjustment SYSTEM "sgml/gtkadjustment.sgml">
   5 <!entity GtkAlignment SYSTEM "sgml/gtkalignment.sgml">
   6 <!entity GtkArrow SYSTEM "sgml/gtkarrow.sgml">
   7 <!entity GtkAspectFrame SYSTEM "sgml/gtkaspectframe.sgml">
   8 <!entity GtkButtonBox SYSTEM "sgml/gtkbbox.sgml">
   9 <!entity GtkBin SYSTEM "sgml/gtkbin.sgml">
  10 <!entity GtkBox SYSTEM "sgml/gtkbox.sgml">
  11 <!entity GtkButton SYSTEM "sgml/gtkbutton.sgml">
  12 <!entity GtkCalendar SYSTEM "sgml/gtkcalendar.sgml">
  13 <!entity GtkCheckButton SYSTEM "sgml/gtkcheckbutton.sgml">
  14 <!entity GtkCheckMenuItem SYSTEM "sgml/gtkcheckmenuitem.sgml">
  15 <!entity GtkCList SYSTEM "sgml/gtkclist.sgml">
  16 <!entity GtkColorSelection SYSTEM "sgml/gtkcolorsel.sgml">
  17 <!entity GtkColorSelectionDialog SYSTEM "sgml/gtkcolorseldlg.sgml">
  18 <!entity GtkCombo SYSTEM "sgml/gtkcombo.sgml">
  19 <!entity GtkContainer SYSTEM "sgml/gtkcontainer.sgml">
  20 <!entity GtkCTree SYSTEM "sgml/gtkctree.sgml">
  21 <!entity GtkCurve SYSTEM "sgml/gtkcurve.sgml">
  22 <!entity GtkDialog SYSTEM "sgml/gtkdialog.sgml">
  23 <!entity GtkDrawingArea SYSTEM "sgml/gtkdrawingarea.sgml">
  24 <!entity gtk-GtkEditable SYSTEM "sgml/gtkeditable.sgml">
  25 <!entity GtkOldEditable SYSTEM "sgml/gtkoldeditable.sgml">
  26 <!entity GtkEntry SYSTEM "sgml/gtkentry.sgml">
  27 <!entity GtkEventBox SYSTEM "sgml/gtkeventbox.sgml">
  28 <!entity GtkFileSelection SYSTEM "sgml/gtkfilesel.sgml">
  29 <!entity GtkFixed SYSTEM "sgml/gtkfixed.sgml">
  30 <!entity GtkFontSelection SYSTEM "sgml/gtkfontsel.sgml">
  31 <!entity GtkFontSelectionDialog SYSTEM "sgml/gtkfontseldlg.sgml">
  32 <!entity GtkFrame SYSTEM "sgml/gtkframe.sgml">
  33 <!entity GtkGammaCurve SYSTEM "sgml/gtkgamma.sgml">
  34 <!entity GtkHandleBox SYSTEM "sgml/gtkhandlebox.sgml">
  35 <!entity GtkHButtonBox SYSTEM "sgml/gtkhbbox.sgml">
  36 <!entity GtkHBox SYSTEM "sgml/gtkhbox.sgml">
  37 <!entity GtkHPaned SYSTEM "sgml/gtkhpaned.sgml">
  38 <!entity GtkHRuler SYSTEM "sgml/gtkhruler.sgml">
  39 <!entity GtkHScale SYSTEM "sgml/gtkhscale.sgml">
  40 <!entity GtkHScrollbar SYSTEM "sgml/gtkhscrollbar.sgml">
  41 <!entity GtkHSeparator SYSTEM "sgml/gtkhseparator.sgml">
  42 <!entity GtkImage SYSTEM "sgml/gtkimage.sgml">
  43 <!entity GtkIMContext SYSTEM "sgml/gtkimcontext.sgml">
  44 <!entity GtkIMContextSimple SYSTEM "sgml/gtkimcontextsimple.sgml">
  45 <!entity GtkIMMulticontext SYSTEM "sgml/gtkimmulticontext.sgml">
  46 <!entity GtkInputDialog SYSTEM "sgml/gtkinputdialog.sgml">
  47 <!entity GtkInvisible SYSTEM "sgml/gtkinvisible.sgml">
  48 <!entity GtkItem SYSTEM "sgml/gtkitem.sgml">
  49 <!entity GtkItemFactory SYSTEM "sgml/gtkitemfactory.sgml">
  50 <!entity GtkLabel SYSTEM "sgml/gtklabel.sgml">
  51 <!entity GtkLayout SYSTEM "sgml/gtklayout.sgml">
  52 <!entity GtkList SYSTEM "sgml/gtklist.sgml">
  53 <!entity GtkListItem SYSTEM "sgml/gtklistitem.sgml">
  54 <!entity GtkMenu SYSTEM "sgml/gtkmenu.sgml">
  55 <!entity GtkMenuBar SYSTEM "sgml/gtkmenubar.sgml">
  56 <!entity GtkMenuItem SYSTEM "sgml/gtkmenuitem.sgml">
  57 <!entity GtkMenuShell SYSTEM "sgml/gtkmenushell.sgml">
  58 <!entity GtkMessageDialog SYSTEM "sgml/gtkmessagedialog.sgml">
  59 <!entity GtkMisc SYSTEM "sgml/gtkmisc.sgml">
  60 <!entity GtkNotebook SYSTEM "sgml/gtknotebook.sgml">
  61 <!entity GtkObject SYSTEM "sgml/gtkobject.sgml">
  62 <!entity GtkOptionMenu SYSTEM "sgml/gtkoptionmenu.sgml">
  63 <!entity GtkPaned SYSTEM "sgml/gtkpaned.sgml">
  64 <!entity GtkPixmap SYSTEM "sgml/gtkpixmap.sgml">
  65 <!entity GtkPlug SYSTEM "sgml/gtkplug.sgml">
  66 <!entity GtkPreview SYSTEM "sgml/gtkpreview.sgml">
  67 <!entity GtkProgress SYSTEM "sgml/gtkprogress.sgml">
  68 <!entity GtkProgressBar SYSTEM "sgml/gtkprogressbar.sgml">
  69 <!entity GtkRadioButton SYSTEM "sgml/gtkradiobutton.sgml">
  70 <!entity GtkRadioMenuItem SYSTEM "sgml/gtkradiomenuitem.sgml">
  71 <!entity GtkRange SYSTEM "sgml/gtkrange.sgml">
  72 <!entity GtkRuler SYSTEM "sgml/gtkruler.sgml">
  73 <!entity GtkScale SYSTEM "sgml/gtkscale.sgml">
  74 <!entity GtkScrollbar SYSTEM "sgml/gtkscrollbar.sgml">
  75 <!entity GtkScrolledWindow SYSTEM "sgml/gtkscrolledwindow.sgml">
  76 <!entity GtkSeparator SYSTEM "sgml/gtkseparator.sgml">
  77 <!entity GtkSizeGroup SYSTEM "sgml/gtksizegroup.sgml">
  78 <!entity GtkSocket SYSTEM "sgml/gtksocket.sgml">
  79 <!entity GtkSpinButton SYSTEM "sgml/gtkspinbutton.sgml">
  80 <!entity GtkStatusbar SYSTEM "sgml/gtkstatusbar.sgml">
  81 <!entity GtkTable SYSTEM "sgml/gtktable.sgml">
  82 <!entity GtkTearoffMenuItem SYSTEM "sgml/gtktearoffmenuitem.sgml">
  83 <!entity GtkText SYSTEM "sgml/gtktext.sgml">
  84 <!entity GtkTextBuffer SYSTEM "sgml/gtktextbuffer.sgml">
  85 <!entity gtk-GtkTextIter SYSTEM "sgml/gtktextiter.sgml">
  86 <!entity gtk-GtkTextMark SYSTEM "sgml/gtktextmark.sgml">
  87 <!entity GtkTextTag SYSTEM "sgml/gtktexttag.sgml">
  88 <!entity GtkTextTagTable SYSTEM "sgml/gtktexttagtable.sgml">
  89 <!entity GtkTextView SYSTEM "sgml/gtktextview.sgml">
  90 <!entity GtkTipsQuery SYSTEM "sgml/gtktipsquery.sgml">
  91 <!entity GtkToggleButton SYSTEM "sgml/gtktogglebutton.sgml">
  92 <!entity GtkToolbar SYSTEM "sgml/gtktoolbar.sgml">
  93 <!entity GtkTooltips SYSTEM "sgml/gtktooltips.sgml">
  94 <!entity GtkTree SYSTEM "sgml/gtktree.sgml">
  95 <!entity GtkTreeItem SYSTEM "sgml/gtktreeitem.sgml">
  96 <!entity gtk-GtkTreeModel SYSTEM "sgml/gtktreemodel.sgml">
  97 <!entity gtk-GtkTreeModelSort SYSTEM "sgml/gtktreemodelsort.sgml">
  98 <!entity gtk-GtkTreeSelection SYSTEM "sgml/gtktreeselection.sgml">
  99 <!entity gtk-GtkTreeStore SYSTEM "sgml/gtktreestore.sgml">
 100 <!entity gtk-GtkTreeViewColumn SYSTEM "sgml/gtktreeviewcolumn.sgml">
 101 <!entity gtk-GtkTreeView SYSTEM "sgml/gtktreeview.sgml">
 102 <!entity gtk-GtkCellRenderer SYSTEM "sgml/gtkcellrenderer.sgml">
 103 <!entity gtk-GtkCellRendererPixbuf SYSTEM "sgml/gtkcellrendererpixbuf.sgml">
 104 <!entity gtk-GtkCellRendererText SYSTEM "sgml/gtkcellrenderertext.sgml">
 105 <!entity gtk-GtkCellRendererTextPixbuf SYSTEM "sgml/gtkcellrenderertextpixbuf.sgml">
 106 <!entity gtk-GtkCellRendererToggle SYSTEM "sgml/gtkcellrenderertoggle.sgml">
 107 <!entity gtk-GtkListStore SYSTEM "sgml/gtkliststore.sgml">
 108 <!entity GtkVButtonBox SYSTEM "sgml/gtkvbbox.sgml">
 109 <!entity GtkVBox SYSTEM "sgml/gtkvbox.sgml">
 110 <!entity GtkViewport SYSTEM "sgml/gtkviewport.sgml">
 111 <!entity GtkVPaned SYSTEM "sgml/gtkvpaned.sgml">
 112 <!entity GtkVRuler SYSTEM "sgml/gtkvruler.sgml">
 113 <!entity GtkVScale SYSTEM "sgml/gtkvscale.sgml">
 114 <!entity GtkVScrollbar SYSTEM "sgml/gtkvscrollbar.sgml">
 115 <!entity GtkVSeparator SYSTEM "sgml/gtkvseparator.sgml">
 116 <!entity GtkWidget SYSTEM "sgml/gtkwidget.sgml">
 117 <!entity GtkWindow SYSTEM "sgml/gtkwindow.sgml">
 118 <!entity gtk-General SYSTEM "sgml/gtkmain.sgml">
 119 <!entity gtk-Feature-Test-Macros SYSTEM "sgml/gtkfeatures.sgml">
 120 <!entity gtk-Graphics-Contexts SYSTEM "sgml/gtkgc.sgml">
 121 <!entity gtk-Styles SYSTEM "sgml/gtkstyle.sgml">
 122 <!entity gtk-Themes SYSTEM "sgml/gtkthemes.sgml">
 123 <!entity gtk-Resource-Files SYSTEM "sgml/gtkrc.sgml">
 124 <!entity gtk-Keyboard-Accelerators SYSTEM "sgml/gtkaccelgroup.sgml">
 125 <!entity gtk-Selections SYSTEM "sgml/gtkselection.sgml">
 126 <!entity gtk-Clipboards SYSTEM "sgml/gtkclipboard.sgml">
 127 <!entity gtk-Drag-and-Drop SYSTEM "sgml/gtkdnd.sgml">
 128 <!entity gtk-Signals SYSTEM "sgml/gtksignal.sgml">
 129 <!entity gtk-Types SYSTEM "sgml/gtktypeutils.sgml">
 130 <!entity gtk-Bindings SYSTEM "sgml/gtkbindings.sgml">
 131 <!entity gtk-Standard-Enumerations SYSTEM "sgml/gtkenums.sgml">
 132 <!entity gtk-Stock-Items SYSTEM "sgml/gtkstock.sgml">
 133 <!entity gtk-Themeable-Stock-Images SYSTEM "sgml/gtkiconfactory.sgml">
 134
 135 <!entity index-Object-Tree SYSTEM "sgml/tree_index.sgml">
 136
 137 <!entity index-Objects-Grouped SYSTEM "objects_grouped.sgml">
 138 <!entity gtk-TextWidget SYSTEM "text_widget.sgml">
 139 <!entity gtk-TreeWidget SYSTEM "tree_widget.sgml">
 140 <!entity gtk-Compiling SYSTEM "compiling.sgml">
 141 <!entity gtk-Windows SYSTEM "windows.sgml">
 142 <!entity gtk-Framebuffer SYSTEM "framebuffer.sgml">
 143 ]>
 144 <book id="index">
 145   <bookinfo>
 146     <title>GTK+ Reference Manual</title>
 147   </bookinfo>
 148
 149   <chapter id="gtk">
 150     <title>GTK+ </title>
 151     <para>
 152 GTK+ is a multi-platform open source GUI Toolkit. Everything about
 153 GTK+ from the object-oriented design to the Free Software LGPL
 154 licensing allows you to code your project with the most freedom
 155 possible. You can develop open software, free software, or even
 156 commercial non-free software without having to spend a dime for
 157 licenses or royalties.
 158     </para>
 159     <para>
 160 GTK+ is a set of libraries to create graphical user interfaces. It
 161 works on many Unix-like platforms, Windows, and on framebuffer
 162 devices. GTK+ is released under the GNU Library General Public License
 163 (GNU LGPL), which allows for flexible licensing of client
 164 applications. GTK+ has a C-based object-oriented architecture that
 165 allows for maximum flexibility.  Bindings for other languages have
 166 been written, including C++, Objective-C, Guile/Scheme, Perl, Python,
 167 TOM, Ada95, Free Pascal, and Eiffel.
 168     </para>
 169     <para>
 170 GTK+ consists of the following component libraries:
 171 <variablelist>
 172
 173 <varlistentry>
 174 <term>GLib</term>
 175 <listitem><para>
 176 Provides many useful data types, macros, type conversions,
 177 string utilities and a lexical scanner. Includes Win32 support.
 178 </para></listitem>
 179 </varlistentry>
 180
 181 <varlistentry>
 182 <term>GDK</term>
 183 <listitem><para>
 184 A wrapper for low-level windowing functions.
 185 </para></listitem>
 186 </varlistentry>
 187
 188 <varlistentry>
 189 <term>GTK+</term>
 190 <listitem><para>
 191 An advanced widget set.
 192 </para></listitem>
 193 </varlistentry>
 194 </variablelist>
 195     </para>
 196
 197     &gtk-Compiling;
 198     &gtk-Windows;
 199     &gtk-Framebuffer;
 200     &gtk-General;
 201     &gtk-Feature-Test-Macros;
 202     &gtk-Graphics-Contexts;
 203     &gtk-Styles;
 204 <!--    &gtk-Themes; -->
 205     &gtk-Resource-Files;
 206     &gtk-Keyboard-Accelerators;
 207     &gtk-Selections;
 208     &gtk-Clipboards;
 209     &gtk-Drag-and-Drop;
 210     &gtk-Signals;
 211     &gtk-Stock-Items;
 212     &gtk-Themeable-Stock-Images;
 213     &gtk-Types;
 214     &gtk-Bindings;
 215     &gtk-Standard-Enumerations;
 216
 217   </chapter>
 218
 219   <chapter  id="gtkobjects" role="no-toc">
 220     <title>GTK+ Widgets and Objects</title>
 221
 222     <sect1>
 223       <title>Object Hierarchy</title>
 224     &index-Object-Tree;
 225     </sect1>
 226
 227     <sect1 id="WindowWidgets">
 228       <title>Windows</title>
 229         &GtkDialog;
 230         &GtkInvisible;
 231         &GtkMessageDialog;
 232         &GtkPlug;
 233         &GtkWindow;
 234     </sect1>
 235
 236     <sect1 id="DisplayWidgets">
 237       <title>Display Widgets</title>
 238         &GtkAccelLabel;
 239         &GtkImage;
 240         &GtkLabel;
 241         &GtkProgressBar;
 242         &GtkStatusbar;
 243     </sect1>
 244
 245     <sect1 id="ButtonWidgets">
 246       <title>Buttons and Toggles</title>
 247         &GtkButton;
 248         &GtkCheckButton;
 249         &GtkRadioButton;
 250         &GtkToggleButton;
 251     </sect1>
 252
 253     <sect1 id="NumericEntry">
 254       <title>Numeric/Text Data Entry</title>
 255         &GtkEntry;
 256         &GtkHScale;
 257         &GtkSpinButton;
 258         &GtkVScale;
 259     </sect1>
 260
 261     <sect1 id="TextWidgetObjects">
 262       <title>Multiline Text Editor</title>
 263         &gtk-TextWidget;
 264         &gtk-GtkTextIter;
 265         &gtk-GtkTextMark;
 266         &GtkTextBuffer;
 267         &GtkTextTag;
 268         &GtkTextTagTable;
 269         &GtkTextView;
 270     </sect1>
 271
 272     <sect1 id="TreeWidgetObjects">
 273       <title>Tree and List Widget</title>
 274         &gtk-TreeWidget;
 275         &gtk-GtkTreeModel;
 276         &gtk-GtkTreeSelection;
 277         &gtk-GtkTreeStore;
 278         &gtk-GtkTreeViewColumn;
 279         &gtk-GtkTreeView;
 280         &gtk-GtkTreeModelSort;
 281         &gtk-GtkCellRenderer;
 282         &gtk-GtkCellRendererPixbuf;
 283         &gtk-GtkCellRendererText;
 284         &gtk-GtkCellRendererTextPixbuf;
 285         &gtk-GtkCellRendererToggle;
 286         &gtk-GtkListStore;
 287     </sect1>
 288     <sect1 id="MenusAndCombos">
 289       <title>Menus, Combo Box, Toolbar</title>
 290         &GtkCheckMenuItem;
 291         &GtkCombo;
 292         &GtkItemFactory;
 293         &GtkMenu;
 294         &GtkMenuBar;
 295         &GtkMenuItem;
 296         &GtkMenuShell;
 297         &GtkOptionMenu;
 298         &GtkRadioMenuItem;
 299         &GtkTearoffMenuItem;
 300         &GtkToolbar;
 301     </sect1>
 302
 303     <sect1 id="SelectorWidgets">
 304       <title>Selectors (File/Font/Color/Input Devices)</title>
 305         &GtkColorSelection;
 306         &GtkColorSelectionDialog;
 307         &GtkFileSelection;
 308         &GtkFontSelection;
 309         &GtkFontSelectionDialog;
 310         &GtkInputDialog;
 311     </sect1>
 312
 313     <sect1 id="LayoutContainers">
 314       <title>Layout Containers</title>
 315         &GtkAlignment;
 316         &GtkAspectFrame;
 317         &GtkHBox;
 318         &GtkHButtonBox;
 319         &GtkFixed;
 320         &GtkHPaned;
 321         &GtkLayout;
 322         &GtkNotebook;
 323         &GtkTable;
 324         &GtkVButtonBox;
 325         &GtkVBox;
 326         &GtkVPaned;
 327     </sect1>
 328
 329     <sect1 id="Ornaments">
 330       <title>Ornaments</title>
 331         &GtkFrame;
 332         &GtkHSeparator;
 333         &GtkVSeparator;
 334     </sect1>
 335
 336     <sect1 id="ScrollingWidgets">
 337       <title>Scrolling</title>
 338         &GtkHScrollbar;
 339         &GtkScrolledWindow;
 340         &GtkVScrollbar;
 341     </sect1>
 342
 343     <sect1 id="MiscObjects">
 344       <title>Miscellaneous</title>
 345         &GtkAdjustment;
 346         &GtkArrow;
 347         &GtkCalendar;
 348         &GtkDrawingArea;
 349         &GtkEventBox;
 350         &GtkHandleBox;
 351         &GtkIMContext;
 352         &GtkIMMulticontext;
 353         &GtkSizeGroup;
 354         &GtkTooltips;
 355         &GtkViewport;
 356     </sect1>
 357
 358     <sect1 id="AbstractObjects">
 359       <title>Abstract Base Classes</title>
 360         &GtkBin;
 361         &GtkBox;
 362         &GtkButtonBox;
 363         &GtkContainer;
 364         &gtk-GtkEditable;
 365         &GtkOldEditable;
 366         &GtkItem;
 367         &GtkMisc;
 368         &GtkObject;
 369         &GtkPaned;
 370         &GtkRange;
 371         &GtkScale;
 372         &GtkScrollbar;
 373         &GtkSeparator;
 374         &GtkWidget;
 375     </sect1>
 376
 377     <sect1 id="PlugSocket">
 378       <title>Cross-process Embedding</title>
 379         &GtkSocket;
 380     </sect1>
 381
 382     <sect1 id="SpecialObjects">
 383       <title>Special-purpose features</title>
 384         &GtkCurve;
 385         &GtkGammaCurve;
 386         &GtkHRuler;
 387         &GtkRuler;
 388         &GtkVRuler;
 389     </sect1>
 390
 391     <sect1 id="DeprecatedObjects">
 392       <title>Deprecated</title>
 393         &GtkCList;
 394         &GtkCTree;
 395         &GtkList;
 396         &GtkListItem;
 397         &GtkPixmap;
 398         &GtkProgress;
 399         &GtkPreview;
 400         &GtkText;
 401         &GtkTipsQuery;
 402         &GtkTree;
 403         &GtkTreeItem;
 404     </sect1>
 405
 406   </chapter>
 407
 408 </book>