]> Pileus Git - ~andy/gtk/blobdiff - docs/reference/gtk/gtk-docs.sgml
Make GtkMenuShell abstract
[~andy/gtk] / docs / reference / gtk / gtk-docs.sgml
index eeb4a30a420a49859f038c9d9de8f0d0a7d9fcfe..b530992f097a4e93a9895a55bcea5477b90d5500 100644 (file)
@@ -1,6 +1,7 @@
 <?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 GtkAboutDialog SYSTEM "xml/gtkaboutdialog.xml">
 <!ENTITY GtkAccelLabel SYSTEM "xml/gtkaccellabel.xml">
 <!ENTITY GtkAction SYSTEM "xml/gtkaction.xml">
 <!ENTITY GtkActionGroup SYSTEM "xml/gtkactiongroup.xml">
@@ -8,10 +9,13 @@
 <!ENTITY GtkAlignment SYSTEM "xml/gtkalignment.xml">
 <!ENTITY GtkArrow SYSTEM "xml/gtkarrow.xml">
 <!ENTITY GtkAspectFrame SYSTEM "xml/gtkaspectframe.xml">
+<!ENTITY GtkAssistant SYSTEM "xml/gtkassistant.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 GtkBuildable SYSTEM "xml/gtkbuildable.xml">
+<!ENTITY GtkBuilder SYSTEM "xml/gtkbuilder.xml">
 <!ENTITY GtkCalendar SYSTEM "xml/gtkcalendar.xml">
 <!ENTITY GtkCheckButton SYSTEM "xml/gtkcheckbutton.xml">
 <!ENTITY GtkCheckMenuItem SYSTEM "xml/gtkcheckmenuitem.xml">
@@ -34,6 +38,7 @@
 <!ENTITY GtkEventBox SYSTEM "xml/gtkeventbox.xml">
 <!ENTITY GtkExpander SYSTEM "xml/gtkexpander.xml">
 <!ENTITY GtkFileChooser SYSTEM "xml/gtkfilechooser.xml">
+<!ENTITY GtkFileChooserButton SYSTEM "xml/gtkfilechooserbutton.xml">
 <!ENTITY GtkFileChooserDialog SYSTEM "xml/gtkfilechooserdialog.xml">
 <!ENTITY GtkFileChooserWidget SYSTEM "xml/gtkfilechooserwidget.xml">
 <!ENTITY GtkFileFilter SYSTEM "xml/gtkfilefilter.xml">
 <!ENTITY GtkItemFactory SYSTEM "xml/gtkitemfactory.xml">
 <!ENTITY GtkLabel SYSTEM "xml/gtklabel.xml">
 <!ENTITY GtkLayout SYSTEM "xml/gtklayout.xml">
+<!ENTITY GtkLinkButton SYSTEM "xml/gtklinkbutton.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 GtkMenuToolButton SYSTEM "xml/gtkmenutoolbutton.xml">
 <!ENTITY GtkMessageDialog SYSTEM "xml/gtkmessagedialog.xml">
 <!ENTITY GtkMisc SYSTEM "xml/gtkmisc.xml">
 <!ENTITY GtkNotebook SYSTEM "xml/gtknotebook.xml">
 <!ENTITY GtkPixmap SYSTEM "xml/gtkpixmap.xml">
 <!ENTITY GtkPlug SYSTEM "xml/gtkplug.xml">
 <!ENTITY GtkPreview SYSTEM "xml/gtkpreview.xml">
+<!ENTITY GtkPrintOperation SYSTEM "xml/gtkprintoperation.xml">
+<!ENTITY GtkPrintContext SYSTEM "xml/gtkprintcontext.xml">
+<!ENTITY GtkPrintSettings SYSTEM "xml/gtkprintsettings.xml">
+<!ENTITY GtkPageSetup SYSTEM "xml/gtkpagesetup.xml">
+<!ENTITY GtkPaperSize SYSTEM "xml/gtkpapersize.xml">
+<!ENTITY GtkPrinter SYSTEM "xml/gtkprinter.xml">
+<!ENTITY GtkPrintJob SYSTEM "xml/gtkprintjob.xml">
+<!ENTITY GtkPrintUnixDialog SYSTEM "xml/gtkprintunixdialog.xml">
+<!ENTITY GtkPageSetupUnixDialog SYSTEM "xml/gtkpagesetupunixdialog.xml">
 <!ENTITY GtkProgress SYSTEM "xml/gtkprogress.xml">
 <!ENTITY GtkProgressBar SYSTEM "xml/gtkprogressbar.xml">
 <!ENTITY GtkRadioAction SYSTEM "xml/gtkradioaction.xml">
 <!ENTITY GtkRadioMenuItem SYSTEM "xml/gtkradiomenuitem.xml">
 <!ENTITY GtkRadioToolButton SYSTEM "xml/gtkradiotoolbutton.xml">
 <!ENTITY GtkRange SYSTEM "xml/gtkrange.xml">
+<!ENTITY GtkRecentChooser SYSTEM "xml/gtkrecentchooser.xml">
+<!ENTITY GtkRecentChooserDialog SYSTEM "xml/gtkrecentchooserdialog.xml">
+<!ENTITY GtkRecentChooserMenu SYSTEM "xml/gtkrecentchoosermenu.xml">
+<!ENTITY GtkRecentChooserWidget SYSTEM "xml/gtkrecentchooserwidget.xml">
+<!ENTITY GtkRecentFilter SYSTEM "xml/gtkrecentfilter.xml">
+<!ENTITY GtkRecentManager SYSTEM "xml/gtkrecentmanager.xml">
+<!ENTITY GtkRecentAction SYSTEM "xml/gtkrecentaction.xml">
 <!ENTITY GtkRuler SYSTEM "xml/gtkruler.xml">
 <!ENTITY GtkScale SYSTEM "xml/gtkscale.xml">
+<!ENTITY GtkScaleButton SYSTEM "xml/gtkscalebutton.xml">
 <!ENTITY GtkScrollbar SYSTEM "xml/gtkscrollbar.xml">
 <!ENTITY GtkScrolledWindow SYSTEM "xml/gtkscrolledwindow.xml">
 <!ENTITY GtkSeparator SYSTEM "xml/gtkseparator.xml">
 <!ENTITY GtkSocket SYSTEM "xml/gtksocket.xml">
 <!ENTITY GtkSpinButton SYSTEM "xml/gtkspinbutton.xml">
 <!ENTITY GtkStatusbar SYSTEM "xml/gtkstatusbar.xml">
+<!ENTITY GtkStatusIcon SYSTEM "xml/gtkstatusicon.xml">
 <!ENTITY GtkTable SYSTEM "xml/gtktable.xml">
 <!ENTITY GtkTearoffMenuItem SYSTEM "xml/gtktearoffmenuitem.xml">
 <!ENTITY GtkText SYSTEM "xml/gtktext.xml">
 <!ENTITY GtkToolButton SYSTEM "xml/gtktoolbutton.xml">
 <!ENTITY GtkToolItem SYSTEM "xml/gtktoolitem.xml">
 <!ENTITY GtkTooltips SYSTEM "xml/gtktooltips.xml">
+<!ENTITY GtkTooltip SYSTEM "xml/gtktooltip.xml">
 <!ENTITY GtkTree SYSTEM "xml/gtktree.xml">
 <!ENTITY GtkTreeItem SYSTEM "xml/gtktreeitem.xml">
 <!ENTITY GtkTreeModel SYSTEM "xml/gtktreemodel.xml">
 <!ENTITY GtkTreeViewColumn SYSTEM "xml/gtktreeviewcolumn.xml">
 <!ENTITY GtkTreeView SYSTEM "xml/gtktreeview.xml">
 <!ENTITY GtkUIManager SYSTEM "xml/gtkuimanager.xml">
+<!ENTITY GtkCellEditable SYSTEM "xml/gtkcelleditable.xml">
 <!ENTITY GtkCellLayout SYSTEM "xml/gtkcelllayout.xml">
 <!ENTITY GtkCellRenderer SYSTEM "xml/gtkcellrenderer.xml">
-<!ENTITY GtkCellEditable SYSTEM "xml/gtkcelleditable.xml">
+<!ENTITY GtkCellRendererAccel SYSTEM "xml/gtkcellrendereraccel.xml">
+<!ENTITY GtkCellRendererCombo SYSTEM "xml/gtkcellrenderercombo.xml">
 <!ENTITY GtkCellRendererPixbuf SYSTEM "xml/gtkcellrendererpixbuf.xml">
 <!ENTITY GtkCellRendererProgress SYSTEM "xml/gtkcellrendererprogress.xml">
+<!ENTITY GtkCellRendererSpin SYSTEM "xml/gtkcellrendererspin.xml">
 <!ENTITY GtkCellRendererText SYSTEM "xml/gtkcellrenderertext.xml">
 <!ENTITY GtkCellRendererToggle SYSTEM "xml/gtkcellrenderertoggle.xml">
+<!ENTITY GtkCellView SYSTEM "xml/gtkcellview.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 GtkVolumeButton SYSTEM "xml/gtkvolumebutton.xml">
 <!ENTITY GtkVPaned SYSTEM "xml/gtkvpaned.xml">
 <!ENTITY GtkVRuler SYSTEM "xml/gtkvruler.xml">
 <!ENTITY GtkVScale SYSTEM "xml/gtkvscale.xml">
 <!ENTITY gtk-Settings SYSTEM "xml/gtksettings.xml">
 
 <!ENTITY index-Object-Tree SYSTEM "xml/tree_index.sgml">
+<!ENTITY visual-index SYSTEM "visual_index.xml">
 
 <!ENTITY index-Objects-Grouped SYSTEM "objects_grouped.sgml">
-<!ENTITY gtk-TextWidget SYSTEM "text_widget.sgml">
-<!ENTITY gtk-TreeWidget SYSTEM "tree_widget.sgml">
+<!ENTITY gtk-TextWidget SYSTEM "xml/text_widget.sgml">
+<!ENTITY gtk-TreeWidget SYSTEM "xml/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-OSX SYSTEM "osx.sgml">
+<!ENTITY gtk-DirectFB SYSTEM "directfb.sgml">
+<!ENTITY gtk-Questions SYSTEM "xml/question_index.sgml">
 <!ENTITY gtk-Changes-1-2 SYSTEM "changes-1.2.sgml">
 <!ENTITY gtk-Changes-2-0 SYSTEM "changes-2.0.sgml">
-<!ENTITY gtk-migrating-checklist SYSTEM "migrating-checklist.sgml">
-<!ENTITY gtk-migrating-GtkFileChooser SYSTEM "migrating-GtkFileChooser.sgml">
-<!ENTITY gtk-migrating-GtkAction SYSTEM "migrating-GtkAction.sgml">
-<!ENTITY gtk-migrating-GtkComboBox SYSTEM "migrating-GtkComboBox.sgml">
+<!ENTITY gtk-migrating-checklist SYSTEM "xml/migrating-checklist.sgml">
+<!ENTITY gtk-migrating-Cairo SYSTEM "xml/migrating-Cairo.sgml">
+<!ENTITY gtk-migrating-GtkFileChooser SYSTEM "xml/migrating-GtkFileChooser.sgml">
+<!ENTITY gtk-migrating-GtkAction SYSTEM "xml/migrating-GtkAction.sgml">
+<!ENTITY gtk-migrating-GtkComboBox SYSTEM "xml/migrating-GtkComboBox.sgml">
+<!ENTITY gtk-migrating-GtkIconView SYSTEM "xml/migrating-GtkIconView.sgml">
+<!ENTITY gtk-migrating-GtkAboutDialog SYSTEM "xml/migrating-GtkAboutDialog.sgml">
+<!ENTITY gtk-migrating-GtkColorButton SYSTEM "xml/migrating-GtkColorButton.sgml">
+<!ENTITY gtk-migrating-GtkAssistant SYSTEM "xml/migrating-GtkAssistant.sgml">
+<!ENTITY gtk-migrating-GtkRecentChooser SYSTEM "xml/migrating-GtkRecentChooser.sgml">
+<!ENTITY gtk-migrating-GtkLinkButton SYSTEM "xml/migrating-GtkLinkButton.sgml">
 <!ENTITY version SYSTEM "version.xml">
 <!ENTITY gtk-query-immodules SYSTEM "gtk-query-immodules-2.0.xml">
+<!ENTITY gtk-update-icon-cache SYSTEM "gtk-update-icon-cache.xml">
+<!ENTITY gtk-glossary SYSTEM "xml/glossary.xml">
 ]>
 <book id="index">
   <bookinfo>
@@ -223,38 +265,31 @@ string utilities, file utilities, a main loop abstraction, and so on.
 <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
+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 <link linkend="GdkPixbuf">GdkPixbuf</link>
+This is a small library which allows you to create #GdkPixbuf
 ("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.
+Use a #GdkPixbuf in combination with #GtkImage to display images.
 </para></listitem>
 </varlistentry>
 
@@ -270,11 +305,8 @@ on X11, Windows, and the Linux framebuffer device.
 <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>.
-
+that is, GUI components such as #GtkButton or #GtkTextView.
 </para></listitem>
 </varlistentry>
 </variablelist>
@@ -283,9 +315,10 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
     &gtk-Building;
     &gtk-Compiling;
     &gtk-Running;
-    &gtk-Windows;
-    &gtk-Framebuffer;
     &gtk-X11;
+    &gtk-Windows;
+    &gtk-OSX;
+    &gtk-DirectFB;
     &gtk-Resources;
     &gtk-Questions;
   </part>
@@ -321,6 +354,11 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
     &index-Object-Tree;
     </chapter>
 
+    <chapter>
+      <title>Widget Gallery</title>
+    &visual-index;
+    </chapter>
+
     <chapter id="WindowWidgets">
       <title>Windows</title>
         &GtkDialog;
@@ -328,6 +366,8 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
         &GtkMessageDialog;
         &GtkWindow;
         &GtkWindowGroup;
+        &GtkAboutDialog;
+        &GtkAssistant;
     </chapter>
 
     <chapter id="DisplayWidgets">
@@ -337,6 +377,7 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
         &GtkLabel;
         &GtkProgressBar;
         &GtkStatusbar;
+        &GtkStatusIcon;
     </chapter>
 
     <chapter id="ButtonWidgets">
@@ -345,6 +386,9 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
         &GtkCheckButton;
         &GtkRadioButton;
         &GtkToggleButton;
+        &GtkLinkButton;
+        &GtkScaleButton;
+       &GtkVolumeButton;
     </chapter>
 
     <chapter id="NumericEntry">
@@ -369,13 +413,14 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
     </chapter>
 
     <chapter id="TreeWidgetObjects">
-      <title>Tree and List Widget</title>
+      <title>Tree, List and Icon Grid Widgets</title>
         &gtk-TreeWidget;
         &GtkTreeModel;
         &GtkTreeSelection;
         &GtkTreeViewColumn;
         &GtkTreeView;
         &GtkTreeDND;
+        &GtkCellView;
         &GtkIconView;
        &GtkTreeSortable;
         &GtkTreeModelSort;
@@ -383,8 +428,11 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
         &GtkCellLayout;
         &GtkCellRenderer;
         &GtkCellEditable;
+        &GtkCellRendererAccel;
+        &GtkCellRendererCombo;
         &GtkCellRendererPixbuf;
         &GtkCellRendererProgress;
+        &GtkCellRendererSpin;
         &GtkCellRendererText;
         &GtkCellRendererToggle;
         &GtkListStore;
@@ -398,7 +446,6 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
         &GtkMenu;
         &GtkMenuBar;
         &GtkMenuItem;
-        &GtkMenuShell;
        &GtkImageMenuItem;
         &GtkRadioMenuItem;
         &GtkCheckMenuItem;      
@@ -408,6 +455,7 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
         &GtkToolItem;
         &GtkSeparatorToolItem;
         &GtkToolButton;
+       &GtkMenuToolButton;
         &GtkToggleToolButton;
         &GtkRadioToolButton;
     </chapter>
@@ -419,6 +467,7 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
         &GtkAction;
         &GtkToggleAction;
         &GtkRadioAction;
+        &GtkRecentAction;
     </chapter>
 
     <chapter id="SelectorWidgets">
@@ -428,6 +477,7 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
         &GtkColorSelectionDialog;
         &GtkFileSelection;
        &GtkFileChooser;
+       &GtkFileChooserButton;
        &GtkFileChooserDialog;
        &GtkFileChooserWidget;
        &GtkFileFilter;
@@ -468,6 +518,19 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
         &GtkScrolledWindow;
     </chapter>
 
+    <chapter id="Printing">
+      <title>Printing</title>
+      &GtkPrintOperation;
+      &GtkPrintContext;
+      &GtkPrintSettings;
+      &GtkPageSetup;
+      &GtkPaperSize;
+      &GtkPrinter;
+      &GtkPrintJob; 
+      &GtkPrintUnixDialog;
+      &GtkPageSetupUnixDialog;
+    </chapter>
+
     <chapter id="MiscObjects">
       <title>Miscellaneous</title>
         &GtkAdjustment;
@@ -479,6 +542,7 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
         &GtkIMContextSimple;
         &GtkIMMulticontext;
         &GtkSizeGroup;
+        &GtkTooltip;
         &GtkTooltips;
         &GtkViewport;
         &GtkAccessible;
@@ -491,6 +555,7 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
         &GtkButtonBox;
         &GtkContainer;
         &GtkItem;
+        &GtkMenuShell;
         &GtkMisc;
         &GtkObject;
         &GtkPaned;
@@ -517,6 +582,22 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
         &GtkVRuler;
     </chapter>
 
+    <chapter id="RecentDocuments">
+      <title>Recently Used Documents</title>
+      &GtkRecentManager;
+      &GtkRecentChooser;
+      &GtkRecentChooserDialog;
+      &GtkRecentChooserMenu;
+      &GtkRecentChooserWidget;
+      &GtkRecentFilter;
+    </chapter>
+
+    <chapter id="Builder">
+      <title>Interface builder</title>
+      &GtkBuildable;
+      &GtkBuilder;
+    </chapter>
+
     <chapter id="DeprecatedObjects">
       <title>Deprecated</title>
         &GtkCList;      
@@ -544,6 +625,9 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
       <para>
        This part describes what you need to change in programs use
        older versions of GTK+ so that they can use the new features.
+        It also mentions how to convert applications using widgets
+        found in the libgnomeui library to use their counterparts
+        in GTK+.
       </para>
     </partintro>
 
@@ -553,14 +637,23 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
     &gtk-migrating-GtkFileChooser;
     &gtk-migrating-GtkAction;
     &gtk-migrating-GtkComboBox;
+    &gtk-migrating-GtkIconView;
+    &gtk-migrating-GtkAboutDialog;
+    &gtk-migrating-GtkColorButton;
+    &gtk-migrating-GtkAssistant;
+    &gtk-migrating-GtkRecentChooser;
+    &gtk-migrating-GtkLinkButton;
   </part>
 
   <part>
     <title>GTK+ Tools</title>
 
      &gtk-query-immodules;
+     &gtk-update-icon-cache;
   </part>
 
+  &gtk-glossary;
+
   <index>
     <title>Index</title>
   </index>
@@ -576,7 +669,14 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
   <index role="2.6">
     <title>Index of new symbols in 2.6</title>
   </index>  
+  <index role="2.8">
+    <title>Index of new symbols in 2.8</title>
+  </index>  
+  <index role="2.10">
+    <title>Index of new symbols in 2.10</title>
+  </index>  
+  <index role="2.12">
+    <title>Index of new symbols in 2.12</title>
+  </index>  
 
 </book>
-
-