Pileus Git - ~andy/gtk/blob - 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-Resources SYSTEM "resources.sgml">
 153 <!entity gtk-Windows SYSTEM "windows.sgml">
 154 <!entity gtk-Framebuffer SYSTEM "framebuffer.sgml">
 155 <!entity gtk-Questions SYSTEM "question_index.sgml">
 156 <!entity gtk-Changes-1-2 SYSTEM "changes-1.2.sgml">
 157 <!entity gtk-Changes-2-0 SYSTEM "changes-2.0.sgml">
 158
 159 ]>
 160 <book id="index">
 161   <bookinfo>
 162     <title>GTK+ Reference Manual</title>
 163   </bookinfo>
 164
 165   <chapter id="gtk">
 166     <title>GTK+ Overview</title>
 167     <para>
 168 GTK+ is a library for creating graphical user interfaces. It
 169 works on many UNIX-like platforms, Windows, and on framebuffer
 170 devices. GTK+ is released under the GNU Library General Public License
 171 (GNU LGPL), which allows for flexible licensing of client
 172 applications. GTK+ has a C-based object-oriented architecture that
 173 allows for maximum flexibility.  Bindings for other languages have
 174 been written, including C++, Objective-C, Guile/Scheme, Perl, Python,
 175 TOM, Ada95, Free Pascal, and Eiffel.
 176     </para>
 177     <para>
 178 GTK+ depends on the following libraries:
 179 <variablelist>
 180
 181 <varlistentry>
 182 <term>GLib</term>
 183 <listitem><para>
 184 A general-purpose utility library, not specific to graphical user interfaces.
 185 GLib provides many useful data types, macros, type conversions,
 186 string utilities, file utilities, a main loop abstraction, and so on.
 187 </para></listitem>
 188 </varlistentry>
 189
 190 <varlistentry>
 191 <term>Pango</term>
 192 <listitem><para>
 193
 194 Pango is a library for internationalized text handling. It centers
 195 around the #PangoLayout object, representing a paragraph of text.
 196 Pango provides the engine for #GtkTextView, #GtkLabel, #GtkEntry, and
 197 other widgets that display text.
 198
 199 </para></listitem>
 200 </varlistentry>
 201
 202 <varlistentry>
 203 <term>ATK</term>
 204 <listitem><para>
 205
 206 ATK is the Accessibility Toolkit. It provides a set of generic
 207 interfaces allowing accessibility technologies to interact with a
 208 graphical user interface. For example, a screen reader uses ATK to
 209 discover the text in an interface and read it to blind users.  GTK+
 210 widgets have built-in support for accessibility using the ATK
 211 framework.
 212
 213 </para></listitem>
 214 </varlistentry>
 215
 216 <varlistentry>
 217 <term>GdkPixbuf</term>
 218 <listitem><para>
 219 This is a small library which allows you to create #GdkPixbuf
 220 ("pixel buffer") objects from image data or image files.
 221 Use a #GdkPixbuf in combination with #GtkImage to display images.
 222 </para></listitem>
 223 </varlistentry>
 224
 225 <varlistentry>
 226 <term>GDK</term>
 227 <listitem><para>
 228 GDK is the abstraction layer that allows GTK+ to support multiple
 229 windowing systems. GDK provides drawing and window system facilities
 230 on X11, Windows, and the Linux framebuffer device.
 231 </para></listitem>
 232 </varlistentry>
 233
 234 <varlistentry>
 235 <term>GTK+</term>
 236 <listitem><para>
 237
 238 The GTK+ library itself contains <firstterm>widgets</firstterm>,
 239 that is, GUI components such as #GtkButton or #GtkTextView.
 240
 241 </para></listitem>
 242 </varlistentry>
 243 </variablelist>
 244     </para>
 245
 246     &gtk-Building;
 247     &gtk-Compiling;
 248     &gtk-Windows;
 249     &gtk-Framebuffer;
 250     &gtk-Changes-1-2;
 251     &gtk-Changes-2-0;
 252     &gtk-Resources;
 253     &gtk-Questions;
 254
 255   </chapter>
 256
 257
 258   <chapter  id="gtkbase" role="no-toc">
 259     <title>GTK+ Core Reference</title>
 260
 261     &gtk-General;
 262     &GtkAccelGroup;
 263     &gtk-accel-map;
 264     &gtk-Clipboards;
 265     &gtk-Drag-and-Drop;
 266     &gtk-Stock-Items;
 267     &gtk-Themeable-Stock-Images;
 268     &gtk-Resource-Files;
 269     &gtk-Settings;
 270     &gtk-Bindings;
 271     &gtk-Standard-Enumerations;
 272     &gtk-Graphics-Contexts;
 273     &gtk-Styles;
 274     &gtk-Selections;
 275     &gtk-Feature-Test-Macros;
 276     &gtk-Signals;
 277     &gtk-Types;
 278 <!--    &gtk-Themes; -->
 279
 280   </chapter>
 281
 282   <chapter  id="gtkobjects" role="no-toc">
 283     <title>GTK+ Widgets and Objects</title>
 284
 285     <sect1>
 286       <title>Object Hierarchy</title>
 287     &index-Object-Tree;
 288     </sect1>
 289
 290     <sect1 id="WindowWidgets">
 291       <title>Windows</title>
 292         &GtkDialog;
 293         &GtkInvisible;
 294         &GtkMessageDialog;
 295         &GtkPlug;
 296         &GtkWindow;
 297         &GtkWindowGroup;
 298     </sect1>
 299
 300     <sect1 id="DisplayWidgets">
 301       <title>Display Widgets</title>
 302         &GtkAccelLabel;
 303         &GtkImage;
 304         &GtkLabel;
 305         &GtkProgressBar;
 306         &GtkStatusbar;
 307     </sect1>
 308
 309     <sect1 id="ButtonWidgets">
 310       <title>Buttons and Toggles</title>
 311         &GtkButton;
 312         &GtkCheckButton;
 313         &GtkRadioButton;
 314         &GtkToggleButton;
 315     </sect1>
 316
 317     <sect1 id="NumericEntry">
 318       <title>Numeric/Text Data Entry</title>
 319         &GtkEntry;
 320         &GtkHScale;
 321         &GtkSpinButton;
 322         &GtkVScale;
 323     </sect1>
 324
 325     <sect1 id="TextWidgetObjects">
 326       <title>Multiline Text Editor</title>
 327         &gtk-TextWidget;
 328         &GtkTextIter;
 329         &GtkTextMark;
 330         &GtkTextBuffer;
 331         &GtkTextTag;
 332         &GtkTextTagTable;
 333         &GtkTextView;
 334     </sect1>
 335
 336     <sect1 id="TreeWidgetObjects">
 337       <title>Tree and List Widget</title>
 338         &gtk-TreeWidget;
 339         &GtkTreeModel;
 340         &GtkTreeSelection;
 341         &GtkTreeViewColumn;
 342         &GtkTreeView;
 343         &GtkTreeDND;
 344         &GtkTreeSortable;
 345         &GtkTreeModelSort;
 346         &GtkCellRenderer;
 347         &GtkCellEditable;
 348         &GtkCellRendererPixbuf;
 349         &GtkCellRendererText;
 350         &GtkCellRendererToggle;
 351         &GtkListStore;
 352         &GtkTreeStore;
 353     </sect1>
 354     <sect1 id="MenusAndCombos">
 355       <title>Menus, Combo Box, Toolbar</title>
 356         &GtkCombo;
 357         &GtkItemFactory;
 358         &GtkMenu;
 359         &GtkMenuBar;
 360         &GtkMenuItem;
 361         &GtkMenuShell;
 362         &GtkOptionMenu;
 363         &GtkImageMenuItem;
 364         &GtkRadioMenuItem;
 365         &GtkCheckMenuItem;
 366         &GtkSeparatorMenuItem;
 367         &GtkTearoffMenuItem;
 368         &GtkToolbar;
 369     </sect1>
 370
 371     <sect1 id="SelectorWidgets">
 372       <title>Selectors (File/Font/Color/Input Devices)</title>
 373         &GtkColorSelection;
 374         &GtkColorSelectionDialog;
 375         &GtkFileSelection;
 376         &GtkFontSelection;
 377         &GtkFontSelectionDialog;
 378         &GtkInputDialog;
 379     </sect1>
 380
 381     <sect1 id="LayoutContainers">
 382       <title>Layout Containers</title>
 383         &GtkAlignment;
 384         &GtkAspectFrame;
 385         &GtkHBox;
 386         &GtkHButtonBox;
 387         &GtkFixed;
 388         &GtkHPaned;
 389         &GtkLayout;
 390         &GtkNotebook;
 391         &GtkTable;
 392         &GtkVButtonBox;
 393         &GtkVBox;
 394         &GtkVPaned;
 395     </sect1>
 396
 397     <sect1 id="Ornaments">
 398       <title>Ornaments</title>
 399         &GtkFrame;
 400         &GtkHSeparator;
 401         &GtkVSeparator;
 402     </sect1>
 403
 404     <sect1 id="ScrollingWidgets">
 405       <title>Scrolling</title>
 406         &GtkHScrollbar;
 407         &GtkScrolledWindow;
 408         &GtkVScrollbar;
 409     </sect1>
 410
 411     <sect1 id="MiscObjects">
 412       <title>Miscellaneous</title>
 413         &GtkAdjustment;
 414         &GtkArrow;
 415         &GtkCalendar;
 416         &GtkDrawingArea;
 417         &GtkEventBox;
 418         &GtkHandleBox;
 419         &GtkIMContext;
 420         &GtkIMContextSimple;
 421         &GtkIMMulticontext;
 422         &GtkSizeGroup;
 423         &GtkTooltips;
 424         &GtkViewport;
 425     </sect1>
 426
 427     <sect1 id="AbstractObjects">
 428       <title>Abstract Base Classes</title>
 429         &GtkBin;
 430         &GtkBox;
 431         &GtkButtonBox;
 432         &GtkContainer;
 433         &GtkEditable;
 434         &GtkOldEditable;
 435         &GtkItem;
 436         &GtkMisc;
 437         &GtkObject;
 438         &GtkPaned;
 439         &GtkRange;
 440         &GtkScale;
 441         &GtkScrollbar;
 442         &GtkSeparator;
 443         &GtkWidget;
 444     </sect1>
 445
 446     <sect1 id="PlugSocket">
 447       <title>Cross-process Embedding</title>
 448         &GtkSocket;
 449     </sect1>
 450
 451     <sect1 id="SpecialObjects">
 452       <title>Special-purpose features</title>
 453         &GtkCurve;
 454         &GtkGammaCurve;
 455         &GtkHRuler;
 456         &GtkRuler;
 457         &GtkVRuler;
 458     </sect1>
 459
 460     <sect1 id="DeprecatedObjects">
 461       <title>Deprecated</title>
 462         &GtkCList;
 463         &GtkCTree;
 464         &GtkList;
 465         &GtkListItem;
 466         &GtkPixmap;
 467         &GtkProgress;
 468         &GtkPreview;
 469         &GtkText;
 470         &GtkTipsQuery;
 471         &GtkTree;
 472         &GtkTreeItem;
 473     </sect1>
 474
 475   </chapter>
 476
 477 </book>