gtk2/docs/reference/gtk/gtk-docs.sgml
Matthias Clasen 85a8b59044 Add some ids which are referenced from the object hierarchy.
* gdk-pixbuf/tmpl/animation.sgml, gdk-pixbuf/tmpl/gdk-pixbuf.sgml,
	gtk/tmpl/gtkrc.sgml, gtk/tmpl/gtktextview.sgml, gtk/tmpl/gtkiconfactory.sgml,
	gtk/tmpl/gtkaccelgroup.sgml: Add some ids which are referenced
	from the object hierarchy.

	* gtk/gtk-docs.sgml: Use parts as top-level division (#61575),
	include gtkaccessible docs.
2002-03-07 23:20:16 +00:00

483 lines
16 KiB
Plaintext

<!doctype book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
<!notation PNG system "PNG">
<!entity % local.notation.class "| PNG">
<!entity hash "#">
<!entity percent "%">
<!entity GtkAccelLabel SYSTEM "sgml/gtkaccellabel.sgml">
<!entity GtkAdjustment SYSTEM "sgml/gtkadjustment.sgml">
<!entity GtkAlignment SYSTEM "sgml/gtkalignment.sgml">
<!entity GtkArrow SYSTEM "sgml/gtkarrow.sgml">
<!entity GtkAspectFrame SYSTEM "sgml/gtkaspectframe.sgml">
<!entity GtkButtonBox SYSTEM "sgml/gtkbbox.sgml">
<!entity GtkBin SYSTEM "sgml/gtkbin.sgml">
<!entity GtkBox SYSTEM "sgml/gtkbox.sgml">
<!entity GtkButton SYSTEM "sgml/gtkbutton.sgml">
<!entity GtkCalendar SYSTEM "sgml/gtkcalendar.sgml">
<!entity GtkCheckButton SYSTEM "sgml/gtkcheckbutton.sgml">
<!entity GtkCheckMenuItem SYSTEM "sgml/gtkcheckmenuitem.sgml">
<!entity GtkCList SYSTEM "sgml/gtkclist.sgml">
<!entity GtkColorSelection SYSTEM "sgml/gtkcolorsel.sgml">
<!entity GtkColorSelectionDialog SYSTEM "sgml/gtkcolorseldlg.sgml">
<!entity GtkCombo SYSTEM "sgml/gtkcombo.sgml">
<!entity GtkContainer SYSTEM "sgml/gtkcontainer.sgml">
<!entity GtkCTree SYSTEM "sgml/gtkctree.sgml">
<!entity GtkCurve SYSTEM "sgml/gtkcurve.sgml">
<!entity GtkDialog SYSTEM "sgml/gtkdialog.sgml">
<!entity GtkDrawingArea SYSTEM "sgml/gtkdrawingarea.sgml">
<!entity GtkEditable SYSTEM "sgml/gtkeditable.sgml">
<!entity GtkOldEditable SYSTEM "sgml/gtkoldeditable.sgml">
<!entity GtkEntry SYSTEM "sgml/gtkentry.sgml">
<!entity GtkEventBox SYSTEM "sgml/gtkeventbox.sgml">
<!entity GtkFileSelection SYSTEM "sgml/gtkfilesel.sgml">
<!entity GtkFixed SYSTEM "sgml/gtkfixed.sgml">
<!entity GtkFontSelection SYSTEM "sgml/gtkfontsel.sgml">
<!entity GtkFontSelectionDialog SYSTEM "sgml/gtkfontseldlg.sgml">
<!entity GtkFrame SYSTEM "sgml/gtkframe.sgml">
<!entity GtkGammaCurve SYSTEM "sgml/gtkgamma.sgml">
<!entity GtkHandleBox SYSTEM "sgml/gtkhandlebox.sgml">
<!entity GtkHButtonBox SYSTEM "sgml/gtkhbbox.sgml">
<!entity GtkHBox SYSTEM "sgml/gtkhbox.sgml">
<!entity GtkHPaned SYSTEM "sgml/gtkhpaned.sgml">
<!entity GtkHRuler SYSTEM "sgml/gtkhruler.sgml">
<!entity GtkHScale SYSTEM "sgml/gtkhscale.sgml">
<!entity GtkHScrollbar SYSTEM "sgml/gtkhscrollbar.sgml">
<!entity GtkHSeparator SYSTEM "sgml/gtkhseparator.sgml">
<!entity GtkImage SYSTEM "sgml/gtkimage.sgml">
<!entity GtkImageMenuItem SYSTEM "sgml/gtkimagemenuitem.sgml">
<!entity GtkIMContext SYSTEM "sgml/gtkimcontext.sgml">
<!entity GtkIMContextSimple SYSTEM "sgml/gtkimcontextsimple.sgml">
<!entity GtkIMMulticontext SYSTEM "sgml/gtkimmulticontext.sgml">
<!entity GtkInputDialog SYSTEM "sgml/gtkinputdialog.sgml">
<!entity GtkInvisible SYSTEM "sgml/gtkinvisible.sgml">
<!entity GtkItem SYSTEM "sgml/gtkitem.sgml">
<!entity GtkItemFactory SYSTEM "sgml/gtkitemfactory.sgml">
<!entity GtkLabel SYSTEM "sgml/gtklabel.sgml">
<!entity GtkLayout SYSTEM "sgml/gtklayout.sgml">
<!entity GtkList SYSTEM "sgml/gtklist.sgml">
<!entity GtkListItem SYSTEM "sgml/gtklistitem.sgml">
<!entity GtkMenu SYSTEM "sgml/gtkmenu.sgml">
<!entity GtkMenuBar SYSTEM "sgml/gtkmenubar.sgml">
<!entity GtkMenuItem SYSTEM "sgml/gtkmenuitem.sgml">
<!entity GtkMenuShell SYSTEM "sgml/gtkmenushell.sgml">
<!entity GtkMessageDialog SYSTEM "sgml/gtkmessagedialog.sgml">
<!entity GtkMisc SYSTEM "sgml/gtkmisc.sgml">
<!entity GtkNotebook SYSTEM "sgml/gtknotebook.sgml">
<!entity GtkObject SYSTEM "sgml/gtkobject.sgml">
<!entity GtkOptionMenu SYSTEM "sgml/gtkoptionmenu.sgml">
<!entity GtkPaned SYSTEM "sgml/gtkpaned.sgml">
<!entity GtkPixmap SYSTEM "sgml/gtkpixmap.sgml">
<!entity GtkPlug SYSTEM "sgml/gtkplug.sgml">
<!entity GtkPreview SYSTEM "sgml/gtkpreview.sgml">
<!entity GtkProgress SYSTEM "sgml/gtkprogress.sgml">
<!entity GtkProgressBar SYSTEM "sgml/gtkprogressbar.sgml">
<!entity GtkRadioButton SYSTEM "sgml/gtkradiobutton.sgml">
<!entity GtkRadioMenuItem SYSTEM "sgml/gtkradiomenuitem.sgml">
<!entity GtkRange SYSTEM "sgml/gtkrange.sgml">
<!entity GtkRuler SYSTEM "sgml/gtkruler.sgml">
<!entity GtkScale SYSTEM "sgml/gtkscale.sgml">
<!entity GtkScrollbar SYSTEM "sgml/gtkscrollbar.sgml">
<!entity GtkScrolledWindow SYSTEM "sgml/gtkscrolledwindow.sgml">
<!entity GtkSeparator SYSTEM "sgml/gtkseparator.sgml">
<!entity GtkSeparatorMenuItem SYSTEM "sgml/gtkseparatormenuitem.sgml">
<!entity GtkSizeGroup SYSTEM "sgml/gtksizegroup.sgml">
<!entity GtkSocket SYSTEM "sgml/gtksocket.sgml">
<!entity GtkSpinButton SYSTEM "sgml/gtkspinbutton.sgml">
<!entity GtkStatusbar SYSTEM "sgml/gtkstatusbar.sgml">
<!entity GtkTable SYSTEM "sgml/gtktable.sgml">
<!entity GtkTearoffMenuItem SYSTEM "sgml/gtktearoffmenuitem.sgml">
<!entity GtkText SYSTEM "sgml/gtktext.sgml">
<!entity GtkTextBuffer SYSTEM "sgml/gtktextbuffer.sgml">
<!entity GtkTextIter SYSTEM "sgml/gtktextiter.sgml">
<!entity GtkTextMark SYSTEM "sgml/gtktextmark.sgml">
<!entity GtkTextTag SYSTEM "sgml/gtktexttag.sgml">
<!entity GtkTextTagTable SYSTEM "sgml/gtktexttagtable.sgml">
<!entity GtkTextView SYSTEM "sgml/gtktextview.sgml">
<!entity GtkTipsQuery SYSTEM "sgml/gtktipsquery.sgml">
<!entity GtkToggleButton SYSTEM "sgml/gtktogglebutton.sgml">
<!entity GtkToolbar SYSTEM "sgml/gtktoolbar.sgml">
<!entity GtkTooltips SYSTEM "sgml/gtktooltips.sgml">
<!entity GtkTree SYSTEM "sgml/gtktree.sgml">
<!entity GtkTreeItem SYSTEM "sgml/gtktreeitem.sgml">
<!entity GtkTreeModel SYSTEM "sgml/gtktreemodel.sgml">
<!entity GtkTreeSortable SYSTEM "sgml/gtktreesortable.sgml">
<!entity GtkTreeModelSort SYSTEM "sgml/gtktreemodelsort.sgml">
<!entity GtkTreeSelection SYSTEM "sgml/gtktreeselection.sgml">
<!entity GtkTreeStore SYSTEM "sgml/gtktreestore.sgml">
<!entity GtkTreeViewColumn SYSTEM "sgml/gtktreeviewcolumn.sgml">
<!entity GtkTreeView SYSTEM "sgml/gtktreeview.sgml">
<!entity GtkCellRenderer SYSTEM "sgml/gtkcellrenderer.sgml">
<!entity GtkCellEditable SYSTEM "sgml/gtkcelleditable.sgml">
<!entity GtkCellRendererPixbuf SYSTEM "sgml/gtkcellrendererpixbuf.sgml">
<!entity GtkCellRendererText SYSTEM "sgml/gtkcellrenderertext.sgml">
<!entity GtkCellRendererToggle SYSTEM "sgml/gtkcellrenderertoggle.sgml">
<!entity GtkListStore SYSTEM "sgml/gtkliststore.sgml">
<!entity GtkTreeDND SYSTEM "sgml/gtktreednd.sgml">
<!entity GtkVButtonBox SYSTEM "sgml/gtkvbbox.sgml">
<!entity GtkVBox SYSTEM "sgml/gtkvbox.sgml">
<!entity GtkViewport SYSTEM "sgml/gtkviewport.sgml">
<!entity GtkVPaned SYSTEM "sgml/gtkvpaned.sgml">
<!entity GtkVRuler SYSTEM "sgml/gtkvruler.sgml">
<!entity GtkVScale SYSTEM "sgml/gtkvscale.sgml">
<!entity GtkVScrollbar SYSTEM "sgml/gtkvscrollbar.sgml">
<!entity GtkVSeparator SYSTEM "sgml/gtkvseparator.sgml">
<!entity GtkWidget SYSTEM "sgml/gtkwidget.sgml">
<!entity GtkWindow SYSTEM "sgml/gtkwindow.sgml">
<!entity GtkWindowGroup SYSTEM "sgml/gtkwindowgroup.sgml">
<!entity GtkAccessible SYSTEM "sgml/gtkaccessible.sgml">
<!entity gtk-General SYSTEM "sgml/gtkmain.sgml">
<!entity gtk-Feature-Test-Macros SYSTEM "sgml/gtkfeatures.sgml">
<!entity gtk-Graphics-Contexts SYSTEM "sgml/gtkgc.sgml">
<!entity gtk-Styles SYSTEM "sgml/gtkstyle.sgml">
<!entity gtk-Themes SYSTEM "sgml/gtkthemes.sgml">
<!entity gtk-Resource-Files SYSTEM "sgml/gtkrc.sgml">
<!entity GtkAccelGroup SYSTEM "sgml/gtkaccelgroup.sgml">
<!entity gtk-accel-map SYSTEM "sgml/gtkaccelmap.sgml">
<!entity gtk-Selections SYSTEM "sgml/gtkselection.sgml">
<!entity gtk-Clipboards SYSTEM "sgml/gtkclipboard.sgml">
<!entity gtk-Drag-and-Drop SYSTEM "sgml/gtkdnd.sgml">
<!entity gtk-Signals SYSTEM "sgml/gtksignal.sgml">
<!entity gtk-Types SYSTEM "sgml/gtktypeutils.sgml">
<!entity gtk-Bindings SYSTEM "sgml/gtkbindings.sgml">
<!entity gtk-Standard-Enumerations SYSTEM "sgml/gtkenums.sgml">
<!entity gtk-Stock-Items SYSTEM "sgml/gtkstock.sgml">
<!entity gtk-Themeable-Stock-Images SYSTEM "sgml/gtkiconfactory.sgml">
<!entity gtk-Settings SYSTEM "sgml/gtksettings.sgml">
<!entity index-Object-Tree SYSTEM "sgml/tree_index.sgml">
<!entity index-Objects-Grouped SYSTEM "objects_grouped.sgml">
<!entity gtk-TextWidget SYSTEM "text_widget.sgml">
<!entity gtk-TreeWidget SYSTEM "tree_widget.sgml">
<!entity gtk-Compiling SYSTEM "compiling.sgml">
<!entity gtk-Building SYSTEM "building.sgml">
<!entity gtk-Running SYSTEM "running.sgml">
<!entity gtk-Resources SYSTEM "resources.sgml">
<!entity gtk-Windows SYSTEM "windows.sgml">
<!entity gtk-Framebuffer SYSTEM "framebuffer.sgml">
<!entity gtk-X11 SYSTEM "x11.sgml">
<!entity gtk-Questions SYSTEM "question_index.sgml">
<!entity gtk-Changes-1-2 SYSTEM "changes-1.2.sgml">
<!entity gtk-Changes-2-0 SYSTEM "changes-2.0.sgml">
]>
<book id="index">
<bookinfo>
<title>GTK+ Reference Manual</title>
</bookinfo>
<part id="gtk">
<title>GTK+ Overview</title>
<partintro>
<para>
GTK+ is a library for creating graphical user interfaces. It
works on many UNIX-like platforms, Windows, and on framebuffer
devices. GTK+ is released under the GNU Library General Public License
(GNU LGPL), which allows for flexible licensing of client
applications. GTK+ has a C-based object-oriented architecture that
allows for maximum flexibility. Bindings for other languages have
been written, including C++, Objective-C, Guile/Scheme, Perl, Python,
TOM, Ada95, Free Pascal, and Eiffel.
</para>
<para>
GTK+ depends on the following libraries:
<variablelist>
<varlistentry>
<term>GLib</term>
<listitem><para>
A general-purpose utility library, not specific to graphical user interfaces.
GLib provides many useful data types, macros, type conversions,
string utilities, file utilities, a main loop abstraction, and so on.
</para></listitem>
</varlistentry>
<varlistentry>
<term>Pango</term>
<listitem><para>
Pango is a library for internationalized text handling. It centers
around the #PangoLayout object, representing a paragraph of text.
Pango provides the engine for #GtkTextView, #GtkLabel, #GtkEntry, and
other widgets that display text.
</para></listitem>
</varlistentry>
<varlistentry>
<term>ATK</term>
<listitem><para>
ATK is the Accessibility Toolkit. It provides a set of generic
interfaces allowing accessibility technologies to interact with a
graphical user interface. For example, a screen reader uses ATK to
discover the text in an interface and read it to blind users. GTK+
widgets have built-in support for accessibility using the ATK
framework.
</para></listitem>
</varlistentry>
<varlistentry>
<term>GdkPixbuf</term>
<listitem><para>
This is a small library which allows you to create #GdkPixbuf
("pixel buffer") objects from image data or image files.
Use a #GdkPixbuf in combination with #GtkImage to display images.
</para></listitem>
</varlistentry>
<varlistentry>
<term>GDK</term>
<listitem><para>
GDK is the abstraction layer that allows GTK+ to support multiple
windowing systems. GDK provides drawing and window system facilities
on X11, Windows, and the Linux framebuffer device.
</para></listitem>
</varlistentry>
<varlistentry>
<term>GTK+</term>
<listitem><para>
The GTK+ library itself contains <firstterm>widgets</firstterm>,
that is, GUI components such as #GtkButton or #GtkTextView.
</para></listitem>
</varlistentry>
</variablelist>
</para>
</partintro>
&gtk-Building;
&gtk-Compiling;
&gtk-Running;
&gtk-Windows;
&gtk-Framebuffer;
&gtk-X11;
&gtk-Changes-1-2;
&gtk-Changes-2-0;
&gtk-Resources;
&gtk-Questions;
</part>
<part id="gtkbase">
<title>GTK+ Core Reference</title>
&gtk-General;
&GtkAccelGroup;
&gtk-accel-map;
&gtk-Clipboards;
&gtk-Drag-and-Drop;
&gtk-Stock-Items;
&gtk-Themeable-Stock-Images;
&gtk-Resource-Files;
&gtk-Settings;
&gtk-Bindings;
&gtk-Standard-Enumerations;
&gtk-Graphics-Contexts;
&gtk-Styles;
&gtk-Selections;
&gtk-Feature-Test-Macros;
&gtk-Signals;
&gtk-Types;
</part>
<part id="gtkobjects">
<title>GTK+ Widgets and Objects</title>
<chapter>
<title>Object Hierarchy</title>
&index-Object-Tree;
</chapter>
<chapter id="WindowWidgets">
<title>Windows</title>
&GtkDialog;
&GtkInvisible;
&GtkMessageDialog;
&GtkPlug;
&GtkWindow;
&GtkWindowGroup;
</chapter>
<chapter id="DisplayWidgets">
<title>Display Widgets</title>
&GtkAccelLabel;
&GtkImage;
&GtkLabel;
&GtkProgressBar;
&GtkStatusbar;
</chapter>
<chapter id="ButtonWidgets">
<title>Buttons and Toggles</title>
&GtkButton;
&GtkCheckButton;
&GtkRadioButton;
&GtkToggleButton;
</chapter>
<chapter id="NumericEntry">
<title>Numeric/Text Data Entry</title>
&GtkEntry;
&GtkHScale;
&GtkVScale;
&GtkSpinButton;
</chapter>
<chapter id="TextWidgetObjects">
<title>Multiline Text Editor</title>
&gtk-TextWidget;
&GtkTextIter;
&GtkTextMark;
&GtkTextBuffer;
&GtkTextTag;
&GtkTextTagTable;
&GtkTextView;
</chapter>
<chapter id="TreeWidgetObjects">
<title>Tree and List Widget</title>
&gtk-TreeWidget;
&GtkTreeModel;
&GtkTreeSelection;
&GtkTreeViewColumn;
&GtkTreeView;
&GtkTreeDND;
&GtkTreeSortable;
&GtkTreeModelSort;
&GtkCellRenderer;
&GtkCellEditable;
&GtkCellRendererPixbuf;
&GtkCellRendererText;
&GtkCellRendererToggle;
&GtkListStore;
&GtkTreeStore;
</chapter>
<chapter id="MenusAndCombos">
<title>Menus, Combo Box, Toolbar</title>
&GtkCombo;
&GtkItemFactory;
&GtkMenu;
&GtkMenuBar;
&GtkMenuItem;
&GtkMenuShell;
&GtkOptionMenu;
&GtkImageMenuItem;
&GtkRadioMenuItem;
&GtkCheckMenuItem;
&GtkSeparatorMenuItem;
&GtkTearoffMenuItem;
&GtkToolbar;
</chapter>
<chapter id="SelectorWidgets">
<title>Selectors (File/Font/Color/Input Devices)</title>
&GtkColorSelection;
&GtkColorSelectionDialog;
&GtkFileSelection;
&GtkFontSelection;
&GtkFontSelectionDialog;
&GtkInputDialog;
</chapter>
<chapter id="LayoutContainers">
<title>Layout Containers</title>
&GtkAlignment;
&GtkAspectFrame;
&GtkHBox;
&GtkVBox;
&GtkHButtonBox;
&GtkVButtonBox;
&GtkFixed;
&GtkHPaned;
&GtkVPaned;
&GtkLayout;
&GtkNotebook;
&GtkTable;
</chapter>
<chapter id="Ornaments">
<title>Ornaments</title>
&GtkFrame;
&GtkHSeparator;
&GtkVSeparator;
</chapter>
<chapter id="ScrollingWidgets">
<title>Scrolling</title>
&GtkHScrollbar;
&GtkVScrollbar;
&GtkScrolledWindow;
</chapter>
<chapter id="MiscObjects">
<title>Miscellaneous</title>
&GtkAdjustment;
&GtkArrow;
&GtkCalendar;
&GtkDrawingArea;
&GtkEventBox;
&GtkHandleBox;
&GtkIMContext;
&GtkIMContextSimple;
&GtkIMMulticontext;
&GtkSizeGroup;
&GtkTooltips;
&GtkViewport;
&GtkAccessible;
</chapter>
<chapter id="AbstractObjects">
<title>Abstract Base Classes</title>
&GtkBin;
&GtkBox;
&GtkButtonBox;
&GtkContainer;
&GtkEditable;
&GtkItem;
&GtkMisc;
&GtkObject;
&GtkPaned;
&GtkRange;
&GtkScale;
&GtkScrollbar;
&GtkSeparator;
&GtkWidget;
</chapter>
<chapter id="PlugSocket">
<title>Cross-process Embedding</title>
&GtkSocket;
</chapter>
<chapter id="SpecialObjects">
<title>Special-purpose features</title>
&GtkCurve;
&GtkGammaCurve;
&GtkRuler;
&GtkHRuler;
&GtkVRuler;
</chapter>
<chapter id="DeprecatedObjects">
<title>Deprecated</title>
&GtkCList;
&GtkCTree;
&GtkList;
&GtkListItem;
&GtkPixmap;
&GtkProgress;
&GtkPreview;
&GtkOldEditable;
&GtkText;
&GtkTipsQuery;
&GtkTree;
&GtkTreeItem;
</chapter>
</part>
</book>