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

   1 <!doctype book PUBLIC "-//OASIS//DTD DocBook V4.1//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 GtkImageMenuItem SYSTEM "sgml/gtkimagemenuitem.sgml">
  44 <!entity GtkIMContext SYSTEM "sgml/gtkimcontext.sgml">
  45 <!entity GtkIMContextSimple SYSTEM "sgml/gtkimcontextsimple.sgml">
  46 <!entity GtkIMMulticontext SYSTEM "sgml/gtkimmulticontext.sgml">
  47 <!entity GtkInputDialog SYSTEM "sgml/gtkinputdialog.sgml">
  48 <!entity GtkInvisible SYSTEM "sgml/gtkinvisible.sgml">
  49 <!entity GtkItem SYSTEM "sgml/gtkitem.sgml">
  50 <!entity GtkItemFactory SYSTEM "sgml/gtkitemfactory.sgml">
  51 <!entity GtkLabel SYSTEM "sgml/gtklabel.sgml">
  52 <!entity GtkLayout SYSTEM "sgml/gtklayout.sgml">
  53 <!entity GtkList SYSTEM "sgml/gtklist.sgml">
  54 <!entity GtkListItem SYSTEM "sgml/gtklistitem.sgml">
  55 <!entity GtkMenu SYSTEM "sgml/gtkmenu.sgml">
  56 <!entity GtkMenuBar SYSTEM "sgml/gtkmenubar.sgml">
  57 <!entity GtkMenuItem SYSTEM "sgml/gtkmenuitem.sgml">
  58 <!entity GtkMenuShell SYSTEM "sgml/gtkmenushell.sgml">
  59 <!entity GtkMessageDialog SYSTEM "sgml/gtkmessagedialog.sgml">
  60 <!entity GtkMisc SYSTEM "sgml/gtkmisc.sgml">
  61 <!entity GtkNotebook SYSTEM "sgml/gtknotebook.sgml">
  62 <!entity GtkObject SYSTEM "sgml/gtkobject.sgml">
  63 <!entity GtkOptionMenu SYSTEM "sgml/gtkoptionmenu.sgml">
  64 <!entity GtkPaned SYSTEM "sgml/gtkpaned.sgml">
  65 <!entity GtkPixmap SYSTEM "sgml/gtkpixmap.sgml">
  66 <!entity GtkPlug SYSTEM "sgml/gtkplug.sgml">
  67 <!entity GtkPreview SYSTEM "sgml/gtkpreview.sgml">
  68 <!entity GtkProgress SYSTEM "sgml/gtkprogress.sgml">
  69 <!entity GtkProgressBar SYSTEM "sgml/gtkprogressbar.sgml">
  70 <!entity GtkRadioButton SYSTEM "sgml/gtkradiobutton.sgml">
  71 <!entity GtkRadioMenuItem SYSTEM "sgml/gtkradiomenuitem.sgml">
  72 <!entity GtkRange SYSTEM "sgml/gtkrange.sgml">
  73 <!entity GtkRuler SYSTEM "sgml/gtkruler.sgml">
  74 <!entity GtkScale SYSTEM "sgml/gtkscale.sgml">
  75 <!entity GtkScrollbar SYSTEM "sgml/gtkscrollbar.sgml">
  76 <!entity GtkScrolledWindow SYSTEM "sgml/gtkscrolledwindow.sgml">
  77 <!entity GtkSeparator SYSTEM "sgml/gtkseparator.sgml">
  78 <!entity GtkSeparatorMenuItem SYSTEM "sgml/gtkseparatormenuitem.sgml">
  79 <!entity GtkSizeGroup SYSTEM "sgml/gtksizegroup.sgml">
  80 <!entity GtkSocket SYSTEM "sgml/gtksocket.sgml">
  81 <!entity GtkSpinButton SYSTEM "sgml/gtkspinbutton.sgml">
  82 <!entity GtkStatusbar SYSTEM "sgml/gtkstatusbar.sgml">
  83 <!entity GtkTable SYSTEM "sgml/gtktable.sgml">
  84 <!entity GtkTearoffMenuItem SYSTEM "sgml/gtktearoffmenuitem.sgml">
  85 <!entity GtkText SYSTEM "sgml/gtktext.sgml">
  86 <!entity GtkTextBuffer SYSTEM "sgml/gtktextbuffer.sgml">
  87 <!entity gtk-GtkTextIter SYSTEM "sgml/gtktextiter.sgml">
  88 <!entity gtk-GtkTextMark SYSTEM "sgml/gtktextmark.sgml">
  89 <!entity GtkTextTag SYSTEM "sgml/gtktexttag.sgml">
  90 <!entity GtkTextTagTable SYSTEM "sgml/gtktexttagtable.sgml">
  91 <!entity GtkTextView SYSTEM "sgml/gtktextview.sgml">
  92 <!entity GtkTipsQuery SYSTEM "sgml/gtktipsquery.sgml">
  93 <!entity GtkToggleButton SYSTEM "sgml/gtktogglebutton.sgml">
  94 <!entity GtkToolbar SYSTEM "sgml/gtktoolbar.sgml">
  95 <!entity GtkTooltips SYSTEM "sgml/gtktooltips.sgml">
  96 <!entity GtkTree SYSTEM "sgml/gtktree.sgml">
  97 <!entity GtkTreeItem SYSTEM "sgml/gtktreeitem.sgml">
  98 <!entity gtk-GtkTreeModel SYSTEM "sgml/gtktreemodel.sgml">
  99 <!entity gtk-GtkTreeSortable SYSTEM "sgml/gtktreesortable.sgml">
 100 <!entity gtk-GtkTreeModelSort SYSTEM "sgml/gtktreemodelsort.sgml">
 101 <!entity gtk-GtkTreeSelection SYSTEM "sgml/gtktreeselection.sgml">
 102 <!entity gtk-GtkTreeStore SYSTEM "sgml/gtktreestore.sgml">
 103 <!entity gtk-GtkTreeViewColumn SYSTEM "sgml/gtktreeviewcolumn.sgml">
 104 <!entity gtk-GtkTreeView SYSTEM "sgml/gtktreeview.sgml">
 105 <!entity gtk-GtkCellRenderer SYSTEM "sgml/gtkcellrenderer.sgml">
 106 <!entity gtk-GtkCellEditable SYSTEM "sgml/gtkcelleditable.sgml">
 107 <!entity gtk-GtkCellRendererPixbuf SYSTEM "sgml/gtkcellrendererpixbuf.sgml">
 108 <!entity gtk-GtkCellRendererText SYSTEM "sgml/gtkcellrenderertext.sgml">
 109 <!entity gtk-GtkCellRendererToggle SYSTEM "sgml/gtkcellrenderertoggle.sgml">
 110 <!entity gtk-GtkListStore SYSTEM "sgml/gtkliststore.sgml">
 111 <!entity gtk-GtkTreeDND SYSTEM "sgml/gtktreednd.sgml">
 112 <!entity GtkVButtonBox SYSTEM "sgml/gtkvbbox.sgml">
 113 <!entity GtkVBox SYSTEM "sgml/gtkvbox.sgml">
 114 <!entity GtkViewport SYSTEM "sgml/gtkviewport.sgml">
 115 <!entity GtkVPaned SYSTEM "sgml/gtkvpaned.sgml">
 116 <!entity GtkVRuler SYSTEM "sgml/gtkvruler.sgml">
 117 <!entity GtkVScale SYSTEM "sgml/gtkvscale.sgml">
 118 <!entity GtkVScrollbar SYSTEM "sgml/gtkvscrollbar.sgml">
 119 <!entity GtkVSeparator SYSTEM "sgml/gtkvseparator.sgml">
 120 <!entity GtkWidget SYSTEM "sgml/gtkwidget.sgml">
 121 <!entity GtkWindow SYSTEM "sgml/gtkwindow.sgml">
 122 <!entity GtkWindowGroup SYSTEM "sgml/gtkwindowgroup.sgml">
 123 <!entity gtk-General SYSTEM "sgml/gtkmain.sgml">
 124 <!entity gtk-Feature-Test-Macros SYSTEM "sgml/gtkfeatures.sgml">
 125 <!entity gtk-Graphics-Contexts SYSTEM "sgml/gtkgc.sgml">
 126 <!entity gtk-Styles SYSTEM "sgml/gtkstyle.sgml">
 127 <!entity gtk-Themes SYSTEM "sgml/gtkthemes.sgml">
 128 <!entity gtk-Resource-Files SYSTEM "sgml/gtkrc.sgml">
 129 <!entity gtk-Keyboard-Accelerators SYSTEM "sgml/gtkaccelgroup.sgml">
 130 <!entity gtk-Selections SYSTEM "sgml/gtkselection.sgml">
 131 <!entity gtk-Clipboards SYSTEM "sgml/gtkclipboard.sgml">
 132 <!entity gtk-Drag-and-Drop SYSTEM "sgml/gtkdnd.sgml">
 133 <!entity gtk-Signals SYSTEM "sgml/gtksignal.sgml">
 134 <!entity gtk-Types SYSTEM "sgml/gtktypeutils.sgml">
 135 <!entity gtk-Bindings SYSTEM "sgml/gtkbindings.sgml">
 136 <!entity gtk-Standard-Enumerations SYSTEM "sgml/gtkenums.sgml">
 137 <!entity gtk-Stock-Items SYSTEM "sgml/gtkstock.sgml">
 138 <!entity gtk-Themeable-Stock-Images SYSTEM "sgml/gtkiconfactory.sgml">
 139 <!entity gtk-Settings SYSTEM "sgml/gtksettings.sgml">
 140
 141 <!entity index-Object-Tree SYSTEM "sgml/tree_index.sgml">
 142
 143 <!entity index-Objects-Grouped SYSTEM "objects_grouped.sgml">
 144 <!entity gtk-TextWidget SYSTEM "text_widget.sgml">
 145 <!entity gtk-TreeWidget SYSTEM "tree_widget.sgml">
 146 <!entity gtk-Compiling SYSTEM "compiling.sgml">
 147 <!entity gtk-Building SYSTEM "building.sgml">
 148 <!entity gtk-Resources SYSTEM "resources.sgml">
 149 <!entity gtk-Windows SYSTEM "windows.sgml">
 150 <!entity gtk-Framebuffer SYSTEM "framebuffer.sgml">
 151 ]>
 152 <book id="index">
 153   <bookinfo>
 154     <title>GTK+ Reference Manual</title>
 155   </bookinfo>
 156
 157   <chapter id="gtk">
 158     <title>GTK+ Overview</title>
 159     <para>
 160 GTK+ is a library for creating 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+ depends on the following libraries:
 171 <variablelist>
 172
 173 <varlistentry>
 174 <term>GLib</term>
 175 <listitem><para>
 176 A general-purpose utility library, not specific to graphical user interfaces.
 177 GLib provides many useful data types, macros, type conversions,
 178 string utilities, file utilities, a main loop abstraction, and so on.
 179 </para></listitem>
 180 </varlistentry>
 181
 182 <varlistentry>
 183 <term>Pango</term>
 184 <listitem><para>
 185
 186 Pango is a library for internationalized text handling. It centers
 187 around the #PangoLayout object, representing a paragraph of text.
 188 Pango provides the engine for #GtkTextView, #GtkLabel, #GtkEntry, and
 189 other widgets that display text.
 190
 191 </para></listitem>
 192 </varlistentry>
 193
 194 <varlistentry>
 195 <term>ATK</term>
 196 <listitem><para>
 197
 198 ATK is the Accessibility Toolkit. It provides a set of generic
 199 interfaces allowing accessibility technologies to interact with a
 200 graphical user interface. For example, a screen reader uses ATK to
 201 discover the text in an interface and read it to blind users.  GTK+
 202 widgets have built-in support for accessibility using the ATK
 203 framework.
 204
 205 </para></listitem>
 206 </varlistentry>
 207
 208 <varlistentry>
 209 <term>GdkPixbuf</term>
 210 <listitem><para>
 211 This is a small library which allows you to create #GdkPixbuf
 212 ("pixel buffer") objects from image data or image files.
 213 Use a #GdkPixbuf in combination with #GtkImage to display images.
 214 </para></listitem>
 215 </varlistentry>
 216
 217 <varlistentry>
 218 <term>GDK</term>
 219 <listitem><para>
 220 GDK is the abstraction layer that allows GTK+ to support multiple
 221 windowing systems. GDK provides drawing and window system facilities
 222 on X11, Windows, and the Linux framebuffer device.
 223 </para></listitem>
 224 </varlistentry>
 225
 226 <varlistentry>
 227 <term>GTK+</term>
 228 <listitem><para>
 229
 230 The GTK+ library itself contains <firstterm>widgets</firstterm>,
 231 that is, GUI components such as #GtkButton or #GtkTextView.
 232
 233 </para></listitem>
 234 </varlistentry>
 235 </variablelist>
 236     </para>
 237
 238     &gtk-Building;
 239     &gtk-Compiling;
 240     &gtk-Resources;
 241     &gtk-Windows;
 242     &gtk-Framebuffer;
 243
 244   </chapter>
 245
 246
 247   <chapter  id="gtkbase" role="no-toc">
 248     <title>GTK+ Core Reference</title>
 249
 250     &gtk-General;
 251     &gtk-Keyboard-Accelerators;
 252     &gtk-Clipboards;
 253     &gtk-Drag-and-Drop;
 254     &gtk-Stock-Items;
 255     &gtk-Themeable-Stock-Images;
 256     &gtk-Resource-Files;
 257     &gtk-Settings;
 258     &gtk-Bindings;
 259     &gtk-Standard-Enumerations;
 260     &gtk-Graphics-Contexts;
 261     &gtk-Styles;
 262     &gtk-Selections;
 263     &gtk-Feature-Test-Macros;
 264     &gtk-Signals;
 265     &gtk-Types;
 266 <!--    &gtk-Themes; -->
 267
 268   </chapter>
 269
 270   <chapter  id="gtkobjects" role="no-toc">
 271     <title>GTK+ Widgets and Objects</title>
 272
 273     <sect1>
 274       <title>Object Hierarchy</title>
 275     &index-Object-Tree;
 276     </sect1>
 277
 278     <sect1 id="WindowWidgets">
 279       <title>Windows</title>
 280         &GtkDialog;
 281         &GtkInvisible;
 282         &GtkMessageDialog;
 283         &GtkPlug;
 284         &GtkWindow;
 285         &GtkWindowGroup;
 286     </sect1>
 287
 288     <sect1 id="DisplayWidgets">
 289       <title>Display Widgets</title>
 290         &GtkAccelLabel;
 291         &GtkImage;
 292         &GtkLabel;
 293         &GtkProgressBar;
 294         &GtkStatusbar;
 295     </sect1>
 296
 297     <sect1 id="ButtonWidgets">
 298       <title>Buttons and Toggles</title>
 299         &GtkButton;
 300         &GtkCheckButton;
 301         &GtkRadioButton;
 302         &GtkToggleButton;
 303     </sect1>
 304
 305     <sect1 id="NumericEntry">
 306       <title>Numeric/Text Data Entry</title>
 307         &GtkEntry;
 308         &GtkHScale;
 309         &GtkSpinButton;
 310         &GtkVScale;
 311     </sect1>
 312
 313     <sect1 id="TextWidgetObjects">
 314       <title>Multiline Text Editor</title>
 315         &gtk-TextWidget;
 316         &gtk-GtkTextIter;
 317         &gtk-GtkTextMark;
 318         &GtkTextBuffer;
 319         &GtkTextTag;
 320         &GtkTextTagTable;
 321         &GtkTextView;
 322     </sect1>
 323
 324     <sect1 id="TreeWidgetObjects">
 325       <title>Tree and List Widget</title>
 326         &gtk-TreeWidget;
 327         &gtk-GtkTreeModel;
 328         &gtk-GtkTreeSelection;
 329         &gtk-GtkTreeViewColumn;
 330         &gtk-GtkTreeView;
 331         &gtk-GtkTreeDND;
 332         &gtk-GtkTreeSortable;
 333         &gtk-GtkTreeModelSort;
 334         &gtk-GtkCellRenderer;
 335         &gtk-GtkCellEditable;
 336         &gtk-GtkCellRendererPixbuf;
 337         &gtk-GtkCellRendererText;
 338         &gtk-GtkCellRendererToggle;
 339         &gtk-GtkListStore;
 340         &gtk-GtkTreeStore;
 341     </sect1>
 342     <sect1 id="MenusAndCombos">
 343       <title>Menus, Combo Box, Toolbar</title>
 344         &GtkCombo;
 345         &GtkItemFactory;
 346         &GtkMenu;
 347         &GtkMenuBar;
 348         &GtkMenuItem;
 349         &GtkMenuShell;
 350         &GtkOptionMenu;
 351         &GtkImageMenuItem;
 352         &GtkRadioMenuItem;
 353         &GtkCheckMenuItem;
 354         &GtkSeparatorMenuItem;
 355         &GtkTearoffMenuItem;
 356         &GtkToolbar;
 357     </sect1>
 358
 359     <sect1 id="SelectorWidgets">
 360       <title>Selectors (File/Font/Color/Input Devices)</title>
 361         &GtkColorSelection;
 362         &GtkColorSelectionDialog;
 363         &GtkFileSelection;
 364         &GtkFontSelection;
 365         &GtkFontSelectionDialog;
 366         &GtkInputDialog;
 367     </sect1>
 368
 369     <sect1 id="LayoutContainers">
 370       <title>Layout Containers</title>
 371         &GtkAlignment;
 372         &GtkAspectFrame;
 373         &GtkHBox;
 374         &GtkHButtonBox;
 375         &GtkFixed;
 376         &GtkHPaned;
 377         &GtkLayout;
 378         &GtkNotebook;
 379         &GtkTable;
 380         &GtkVButtonBox;
 381         &GtkVBox;
 382         &GtkVPaned;
 383     </sect1>
 384
 385     <sect1 id="Ornaments">
 386       <title>Ornaments</title>
 387         &GtkFrame;
 388         &GtkHSeparator;
 389         &GtkVSeparator;
 390     </sect1>
 391
 392     <sect1 id="ScrollingWidgets">
 393       <title>Scrolling</title>
 394         &GtkHScrollbar;
 395         &GtkScrolledWindow;
 396         &GtkVScrollbar;
 397     </sect1>
 398
 399     <sect1 id="MiscObjects">
 400       <title>Miscellaneous</title>
 401         &GtkAdjustment;
 402         &GtkArrow;
 403         &GtkCalendar;
 404         &GtkDrawingArea;
 405         &GtkEventBox;
 406         &GtkHandleBox;
 407         &GtkIMContext;
 408         &GtkIMContextSimple;
 409         &GtkIMMulticontext;
 410         &GtkSizeGroup;
 411         &GtkTooltips;
 412         &GtkViewport;
 413     </sect1>
 414
 415     <sect1 id="AbstractObjects">
 416       <title>Abstract Base Classes</title>
 417         &GtkBin;
 418         &GtkBox;
 419         &GtkButtonBox;
 420         &GtkContainer;
 421         &gtk-GtkEditable;
 422         &GtkOldEditable;
 423         &GtkItem;
 424         &GtkMisc;
 425         &GtkObject;
 426         &GtkPaned;
 427         &GtkRange;
 428         &GtkScale;
 429         &GtkScrollbar;
 430         &GtkSeparator;
 431         &GtkWidget;
 432     </sect1>
 433
 434     <sect1 id="PlugSocket">
 435       <title>Cross-process Embedding</title>
 436         &GtkSocket;
 437     </sect1>
 438
 439     <sect1 id="SpecialObjects">
 440       <title>Special-purpose features</title>
 441         &GtkCurve;
 442         &GtkGammaCurve;
 443         &GtkHRuler;
 444         &GtkRuler;
 445         &GtkVRuler;
 446     </sect1>
 447
 448     <sect1 id="DeprecatedObjects">
 449       <title>Deprecated</title>
 450         &GtkCList;
 451         &GtkCTree;
 452         &GtkList;
 453         &GtkListItem;
 454         &GtkPixmap;
 455         &GtkProgress;
 456         &GtkPreview;
 457         &GtkText;
 458         &GtkTipsQuery;
 459         &GtkTree;
 460         &GtkTreeItem;
 461     </sect1>
 462
 463   </chapter>
 464
 465 </book>