gtk2/docs/reference/gtk/gtk-docs.sgml
2003-07-01 19:46:22 +00:00

503 lines
16 KiB
XML

<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY GtkAccelLabel SYSTEM "xml/gtkaccellabel.xml">
<!ENTITY GtkAdjustment SYSTEM "xml/gtkadjustment.xml">
<!ENTITY GtkAlignment SYSTEM "xml/gtkalignment.xml">
<!ENTITY GtkArrow SYSTEM "xml/gtkarrow.xml">
<!ENTITY GtkAspectFrame SYSTEM "xml/gtkaspectframe.xml">
<!ENTITY GtkButtonBox SYSTEM "xml/gtkbbox.xml">
<!ENTITY GtkBin SYSTEM "xml/gtkbin.xml">
<!ENTITY GtkBox SYSTEM "xml/gtkbox.xml">
<!ENTITY GtkButton SYSTEM "xml/gtkbutton.xml">
<!ENTITY GtkCalendar SYSTEM "xml/gtkcalendar.xml">
<!ENTITY GtkCheckButton SYSTEM "xml/gtkcheckbutton.xml">
<!ENTITY GtkCheckMenuItem SYSTEM "xml/gtkcheckmenuitem.xml">
<!ENTITY GtkCList SYSTEM "xml/gtkclist.xml">
<!ENTITY GtkColorButton SYSTEM "xml/gtkcolorbutton.xml">
<!ENTITY GtkColorSelection SYSTEM "xml/gtkcolorsel.xml">
<!ENTITY GtkColorSelectionDialog SYSTEM "xml/gtkcolorseldlg.xml">
<!ENTITY GtkCombo SYSTEM "xml/gtkcombo.xml">
<!ENTITY GtkContainer SYSTEM "xml/gtkcontainer.xml">
<!ENTITY GtkCTree SYSTEM "xml/gtkctree.xml">
<!ENTITY GtkCurve SYSTEM "xml/gtkcurve.xml">
<!ENTITY GtkDialog SYSTEM "xml/gtkdialog.xml">
<!ENTITY GtkDrawingArea SYSTEM "xml/gtkdrawingarea.xml">
<!ENTITY GtkEditable SYSTEM "xml/gtkeditable.xml">
<!ENTITY GtkOldEditable SYSTEM "xml/gtkoldeditable.xml">
<!ENTITY GtkEntry SYSTEM "xml/gtkentry.xml">
<!ENTITY GtkEventBox SYSTEM "xml/gtkeventbox.xml">
<!ENTITY GtkExpander SYSTEM "xml/gtkexpander.xml">
<!ENTITY GtkFileSelection SYSTEM "xml/gtkfilesel.xml">
<!ENTITY GtkFixed SYSTEM "xml/gtkfixed.xml">
<!ENTITY GtkFontButton SYSTEM "xml/gtkfontbutton.xml">
<!ENTITY GtkFontSelection SYSTEM "xml/gtkfontsel.xml">
<!ENTITY GtkFontSelectionDialog SYSTEM "xml/gtkfontseldlg.xml">
<!ENTITY GtkFrame SYSTEM "xml/gtkframe.xml">
<!ENTITY GtkGammaCurve SYSTEM "xml/gtkgamma.xml">
<!ENTITY GtkHandleBox SYSTEM "xml/gtkhandlebox.xml">
<!ENTITY GtkHButtonBox SYSTEM "xml/gtkhbbox.xml">
<!ENTITY GtkHBox SYSTEM "xml/gtkhbox.xml">
<!ENTITY GtkHPaned SYSTEM "xml/gtkhpaned.xml">
<!ENTITY GtkHRuler SYSTEM "xml/gtkhruler.xml">
<!ENTITY GtkHScale SYSTEM "xml/gtkhscale.xml">
<!ENTITY GtkHScrollbar SYSTEM "xml/gtkhscrollbar.xml">
<!ENTITY GtkHSeparator SYSTEM "xml/gtkhseparator.xml">
<!ENTITY GtkImage SYSTEM "xml/gtkimage.xml">
<!ENTITY GtkImageMenuItem SYSTEM "xml/gtkimagemenuitem.xml">
<!ENTITY GtkIMContext SYSTEM "xml/gtkimcontext.xml">
<!ENTITY GtkIMContextSimple SYSTEM "xml/gtkimcontextsimple.xml">
<!ENTITY GtkIMMulticontext SYSTEM "xml/gtkimmulticontext.xml">
<!ENTITY GtkInputDialog SYSTEM "xml/gtkinputdialog.xml">
<!ENTITY GtkInvisible SYSTEM "xml/gtkinvisible.xml">
<!ENTITY GtkItem SYSTEM "xml/gtkitem.xml">
<!ENTITY GtkItemFactory SYSTEM "xml/gtkitemfactory.xml">
<!ENTITY GtkLabel SYSTEM "xml/gtklabel.xml">
<!ENTITY GtkLayout SYSTEM "xml/gtklayout.xml">
<!ENTITY GtkList SYSTEM "xml/gtklist.xml">
<!ENTITY GtkListItem SYSTEM "xml/gtklistitem.xml">
<!ENTITY GtkMenu SYSTEM "xml/gtkmenu.xml">
<!ENTITY GtkMenuBar SYSTEM "xml/gtkmenubar.xml">
<!ENTITY GtkMenuItem SYSTEM "xml/gtkmenuitem.xml">
<!ENTITY GtkMenuShell SYSTEM "xml/gtkmenushell.xml">
<!ENTITY GtkMessageDialog SYSTEM "xml/gtkmessagedialog.xml">
<!ENTITY GtkMisc SYSTEM "xml/gtkmisc.xml">
<!ENTITY GtkNotebook SYSTEM "xml/gtknotebook.xml">
<!ENTITY GtkObject SYSTEM "xml/gtkobject.xml">
<!ENTITY GtkOptionMenu SYSTEM "xml/gtkoptionmenu.xml">
<!ENTITY GtkPaned SYSTEM "xml/gtkpaned.xml">
<!ENTITY GtkPixmap SYSTEM "xml/gtkpixmap.xml">
<!ENTITY GtkPlug SYSTEM "xml/gtkplug.xml">
<!ENTITY GtkPreview SYSTEM "xml/gtkpreview.xml">
<!ENTITY GtkProgress SYSTEM "xml/gtkprogress.xml">
<!ENTITY GtkProgressBar SYSTEM "xml/gtkprogressbar.xml">
<!ENTITY GtkRadioButton SYSTEM "xml/gtkradiobutton.xml">
<!ENTITY GtkRadioMenuItem SYSTEM "xml/gtkradiomenuitem.xml">
<!ENTITY GtkRange SYSTEM "xml/gtkrange.xml">
<!ENTITY GtkRuler SYSTEM "xml/gtkruler.xml">
<!ENTITY GtkScale SYSTEM "xml/gtkscale.xml">
<!ENTITY GtkScrollbar SYSTEM "xml/gtkscrollbar.xml">
<!ENTITY GtkScrolledWindow SYSTEM "xml/gtkscrolledwindow.xml">
<!ENTITY GtkSeparator SYSTEM "xml/gtkseparator.xml">
<!ENTITY GtkSeparatorMenuItem SYSTEM "xml/gtkseparatormenuitem.xml">
<!ENTITY GtkSizeGroup SYSTEM "xml/gtksizegroup.xml">
<!ENTITY GtkSocket SYSTEM "xml/gtksocket.xml">
<!ENTITY GtkSpinButton SYSTEM "xml/gtkspinbutton.xml">
<!ENTITY GtkStatusbar SYSTEM "xml/gtkstatusbar.xml">
<!ENTITY GtkTable SYSTEM "xml/gtktable.xml">
<!ENTITY GtkTearoffMenuItem SYSTEM "xml/gtktearoffmenuitem.xml">
<!ENTITY GtkText SYSTEM "xml/gtktext.xml">
<!ENTITY GtkTextBuffer SYSTEM "xml/gtktextbuffer.xml">
<!ENTITY GtkTextIter SYSTEM "xml/gtktextiter.xml">
<!ENTITY GtkTextMark SYSTEM "xml/gtktextmark.xml">
<!ENTITY GtkTextTag SYSTEM "xml/gtktexttag.xml">
<!ENTITY GtkTextTagTable SYSTEM "xml/gtktexttagtable.xml">
<!ENTITY GtkTextView SYSTEM "xml/gtktextview.xml">
<!ENTITY GtkTipsQuery SYSTEM "xml/gtktipsquery.xml">
<!ENTITY GtkToggleButton SYSTEM "xml/gtktogglebutton.xml">
<!ENTITY GtkToolbar SYSTEM "xml/gtktoolbar.xml">
<!ENTITY GtkTooltips SYSTEM "xml/gtktooltips.xml">
<!ENTITY GtkTree SYSTEM "xml/gtktree.xml">
<!ENTITY GtkTreeItem SYSTEM "xml/gtktreeitem.xml">
<!ENTITY GtkTreeModel SYSTEM "xml/gtktreemodel.xml">
<!ENTITY GtkTreeSortable SYSTEM "xml/gtktreesortable.xml">
<!ENTITY GtkTreeModelSort SYSTEM "xml/gtktreemodelsort.xml">
<!ENTITY GtkTreeSelection SYSTEM "xml/gtktreeselection.xml">
<!ENTITY GtkTreeStore SYSTEM "xml/gtktreestore.xml">
<!ENTITY GtkTreeViewColumn SYSTEM "xml/gtktreeviewcolumn.xml">
<!ENTITY GtkTreeView SYSTEM "xml/gtktreeview.xml">
<!ENTITY GtkCellRenderer SYSTEM "xml/gtkcellrenderer.xml">
<!ENTITY GtkCellEditable SYSTEM "xml/gtkcelleditable.xml">
<!ENTITY GtkCellRendererPixbuf SYSTEM "xml/gtkcellrendererpixbuf.xml">
<!ENTITY GtkCellRendererText SYSTEM "xml/gtkcellrenderertext.xml">
<!ENTITY GtkCellRendererToggle SYSTEM "xml/gtkcellrenderertoggle.xml">
<!ENTITY GtkListStore SYSTEM "xml/gtkliststore.xml">
<!ENTITY GtkTreeDND SYSTEM "xml/gtktreednd.xml">
<!ENTITY GtkVButtonBox SYSTEM "xml/gtkvbbox.xml">
<!ENTITY GtkVBox SYSTEM "xml/gtkvbox.xml">
<!ENTITY GtkViewport SYSTEM "xml/gtkviewport.xml">
<!ENTITY GtkVPaned SYSTEM "xml/gtkvpaned.xml">
<!ENTITY GtkVRuler SYSTEM "xml/gtkvruler.xml">
<!ENTITY GtkVScale SYSTEM "xml/gtkvscale.xml">
<!ENTITY GtkVScrollbar SYSTEM "xml/gtkvscrollbar.xml">
<!ENTITY GtkVSeparator SYSTEM "xml/gtkvseparator.xml">
<!ENTITY GtkWidget SYSTEM "xml/gtkwidget.xml">
<!ENTITY GtkWindow SYSTEM "xml/gtkwindow.xml">
<!ENTITY GtkWindowGroup SYSTEM "xml/gtkwindowgroup.xml">
<!ENTITY GtkAccessible SYSTEM "xml/gtkaccessible.xml">
<!ENTITY gtk-General SYSTEM "xml/gtkmain.xml">
<!ENTITY gtk-Feature-Test-Macros SYSTEM "xml/gtkfeatures.xml">
<!ENTITY gtk-Graphics-Contexts SYSTEM "xml/gtkgc.xml">
<!ENTITY gtk-Styles SYSTEM "xml/gtkstyle.xml">
<!ENTITY gtk-Themes SYSTEM "xml/gtkthemes.xml">
<!ENTITY gtk-Resource-Files SYSTEM "xml/gtkrc.xml">
<!ENTITY GtkAccelGroup SYSTEM "xml/gtkaccelgroup.xml">
<!ENTITY gtk-accel-map SYSTEM "xml/gtkaccelmap.xml">
<!ENTITY gtk-Selections SYSTEM "xml/gtkselection.xml">
<!ENTITY gtk-Clipboards SYSTEM "xml/gtkclipboard.xml">
<!ENTITY gtk-Drag-and-Drop SYSTEM "xml/gtkdnd.xml">
<!ENTITY gtk-Signals SYSTEM "xml/gtksignal.xml">
<!ENTITY gtk-Types SYSTEM "xml/gtktypeutils.xml">
<!ENTITY gtk-Bindings SYSTEM "xml/gtkbindings.xml">
<!ENTITY gtk-Standard-Enumerations SYSTEM "xml/gtkenums.xml">
<!ENTITY gtk-Stock-Items SYSTEM "xml/gtkstock.xml">
<!ENTITY gtk-Themeable-Stock-Images SYSTEM "xml/gtkiconfactory.xml">
<!ENTITY gtk-Settings SYSTEM "xml/gtksettings.xml">
<!ENTITY index-Object-Tree SYSTEM "xml/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">
<!ENTITY version SYSTEM "version.xml">
<!ENTITY gtk-query-immodules SYSTEM "gtk-query-immodules-2.0.xml">
]>
<book id="index">
<bookinfo>
<title>GTK+ Reference Manual</title>
<releaseinfo>for GTK+ &version;</releaseinfo>
</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 <link linkend="PangoLayout">PangoLayout</link> object, representing
a paragraph of text.
Pango provides the engine for <link linkend="GtkTextView">GtkTextView</link>,
<link linkend="GtkLabel">GtkLabel</link>,
<link linkend="GtkEntry">GtkEntry</link>, 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 <link linkend="GdkPixbuf">GdkPixbuf</link>
("pixel buffer") objects from image data or image files.
Use a <link linkend="GdkPixbuf">GdkPixbuf</link> in combination with <link linkend="GtkImage">GtkImage</link> 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 <link linkend="GtkButton">GtkButton</link> or
<link linkend="GtkTextView">GtkTextView</link>.
</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;
&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;
&GtkEditable;
</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>
&GtkColorButton;
&GtkColorSelection;
&GtkColorSelectionDialog;
&GtkFileSelection;
&GtkFontButton;
&GtkFontSelection;
&GtkFontSelectionDialog;
&GtkInputDialog;
</chapter>
<chapter id="LayoutContainers">
<title>Layout Containers</title>
&GtkAlignment;
&GtkAspectFrame;
&GtkHBox;
&GtkVBox;
&GtkHButtonBox;
&GtkVButtonBox;
&GtkFixed;
&GtkHPaned;
&GtkVPaned;
&GtkLayout;
&GtkNotebook;
&GtkTable;
&GtkExpander;
</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;
&GtkIMContextSimple;
&GtkIMMulticontext;
&GtkSizeGroup;
&GtkTooltips;
&GtkViewport;
&GtkAccessible;
</chapter>
<chapter id="AbstractObjects">
<title>Abstract Base Classes</title>
&GtkBin;
&GtkBox;
&GtkButtonBox;
&GtkContainer;
&GtkItem;
&GtkMisc;
&GtkObject;
&GtkPaned;
&GtkRange;
&GtkScale;
&GtkScrollbar;
&GtkSeparator;
&GtkWidget;
&GtkIMContext;
</chapter>
<chapter id="PlugSocket">
<title>Cross-process Embedding</title>
&GtkPlug;
&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>
<part>
<title>GTK+ Tools</title>
&gtk-query-immodules;
</part>
<index/>
</book>