1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>Introduction</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="prev" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="next" href="pygtk-reference-format.html" title="Reference Page Format"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Introduction</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="pygtk-reference-format.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="pygtk-introduction"></a>Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="pygtk-introduction.html#id2526228">Major Changes since Version 1.9</a></span></dt><dt><span class="sect1"><a href="pygtk-reference-format.html">Reference Page Format</a></span></dt></dl></div><p>This document describes most of the <code class="literal">PyGTK</code> version
2.0 through 2.10 classes and their methods and associated
functions. Deprecated classes, functions and methods have been
specifically left out of this reference though classes that have become
deprecated since PyGTK 2.0 have been left in but annotated with a
deprecation warning. This document attempts to document as much of the
<code class="literal">PyGTK</code> <code class="literal">API</code> as possible but there are
undoubtedly errors and omissions. If you discover any of these please file
a bug report at <a class="ulink" href="http://bugzilla.gnome.org" target="_top">bugzilla.gnome.org</a> for the
<code class="literal">pygtk</code> project. Specific areas that have not been
documented include:</p><div class="itemizedlist"><ul type="disc"><li>The Cairo classes</li></ul></div><p>This reference describes the API for <code class="literal">PyGTK</code> as of
version 2.9.0+ and assumes that the additional API changes for version
2.10 may not be significant. There will undoubtedly be changes that are
not reflected in this reference. The differences in the API between
version 2.0 and previous versions are denoted in this reference with a
Note that describes the availability of the object, constructor, method or
function. Any of these that do not have a notation can be assumed to be
available in all versions of PyGTK from 2.0 and up. In the case of
properties and signals the availability is dependent on the version of the
underlying GTK+, GDK or Pango libraries. These will be annotated
appropriately in a similar fashion. The source code must be consulted if
this reference and your version of <code class="literal">PyGTK</code> seem to
differ. You are encouraged to use the latest version of
<code class="literal">PyGTK</code> that is available. See the <a class="ulink" href="http://www.pygtk.org" target="_top"><code class="literal">PyGTK</code> homepage</a> for
more information and more resources on how to use PyGTK as well as help in
its development.</p><p> The Reference contains a chapter for each <code class="literal">PyGTK</code>
module (that corresponds to the underlying <code class="literal">GTK+</code>
library) containing the class descriptions. The second chapter illustrates
the <code class="literal">PyGTK</code> class hierarchy covering the gobject, gtk,
gtk.gdk and pango modules.</p><p>The class descriptions are arranged alphabetically within the
chapters. Currently there are five module chapters:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">The <code class="literal">atk</code> module</span></p></td><td>The classes that are included in the
<code class="literal">atk</code> module of <code class="literal">PyGTK</code> and are
accessed similar to: atk.Object. These classes are the base object
classes that provide accessibility support for the
<code class="literal">gtk</code> module classes.</td></tr><tr><td><p><span class="term">The <code class="literal">gtk</code> module</span></p></td><td>The classes that are included in the
<code class="literal">gtk</code> module of <code class="literal">PyGTK</code> and are
accessed similar to: gtk.Widget. These classes are the "higher" level
widget classes that provide most of the user interface widgets used
for application development.</td></tr><tr><td><p><span class="term">The <code class="literal">gtk.gdk</code> module</span></p></td><td>The classes that are included in the
<code class="literal">gtk.gdk</code> module of <code class="literal">PyGTK</code>. These
classes are "lower" level classes that provide more fundamental
capabilities that the <code class="literal">gtk</code> module widgets are built
upon. These classes provide an abstract interface to the underlying
window system (either X Window System or Microsoft Windows).</td></tr><tr><td><p><span class="term">The <code class="literal">gtk.glade</code> module</span></p></td><td>The classes that are included in the
<code class="literal">gtk.glade</code> module of <code class="literal">PyGTK</code>. These
classes provide access to the libglade functions that allow the
dynamic loading of user interfaces from XML descriptions.</td></tr><tr><td><p><span class="term">The <code class="literal">pango</code> module</span></p></td><td>The classes that are included in the
<code class="literal">pango</code> module of <code class="literal">PyGTK</code>. These
classes provide access to the Pango text layout and rendering
engines. PyGTK supports a subset of the full Pango capability:
mainly the high level layout capabilities exposed by the
pango.Layout objects. The low level rendering capabilities have not
been exposed mostly because there isn't a full GObject interface to
the underlying Pango data structures. It's also likely that the
rendering capabilities require more performance that Python can
provide.</td></tr></tbody></table><p>The <code class="literal">gobject</code> module is documented in the <PYGTKDOCLINK HREF="pygobject-reference">PyGObject Reference Manual</PYGTKDOCLINK>.</p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2526228"></a>Major Changes since Version 1.9</h2></div></div></div><p>The major changes in this document since version 1.9
include:</p><div class="itemizedlist"><ul type="disc"><li><p>descriptions of new GTK+ 2.2 and 2.4 classes:</p><div class="itemizedlist"><ul type="circle"><li><PYGTKDOCLINK HREF="class-gobjectgboxed"><code class="classname">gobject.GBoxed</code></PYGTKDOCLINK></li><li><PYGTKDOCLINK HREF="class-gobjectgpointer"><code class="classname">gobject.GPointer</code></PYGTKDOCLINK></li><li><PYGTKDOCLINK HREF="class-gobjectginterface"><code class="classname">gobject.GInterface</code></PYGTKDOCLINK></li><li><PYGTKDOCLINK HREF="class-gobjectmaincontext"><code class="classname">gobject.MainContext</code></PYGTKDOCLINK></li><li><PYGTKDOCLINK HREF="class-gobjectmainloop"><code class="classname">gobject.MainLoop</code></PYGTKDOCLINK></li><li><a class="link" href="class-gtkaction.html" title="gtk.Action"><code class="classname">gtk.Action</code></a></li><li><a class="link" href="class-gtkactiongroup.html" title="gtk.ActionGroup"><code class="classname">gtk.ActionGroup</code></a></li><li><a class="link" href="class-gtkborder.html" title="gtk.Border"><code class="classname">gtk.Border</code></a></li><li><a class="link" href="class-gtkclipboard.html" title="gtk.Clipboard"><code class="classname">gtk.Clipboard</code></a></li><li><a class="link" href="class-gtkcolorbutton.html" title="gtk.ColorButton"><code class="classname">gtk.ColorButton</code></a></li><li><a class="link" href="class-gtkcombobox.html" title="gtk.ComboBox"><code class="classname">gtk.ComboBox</code></a></li><li><a class="link" href="class-gtkcomboboxentry.html" title="gtk.ComboBoxEntry"><code class="classname">gtk.ComboBoxEntry</code></a></li><li><a class="link" href="class-gtkentrycompletion.html" title="gtk.EntryCompletion"><code class="classname">gtk.EntryCompletion</code></a></li><li><a class="link" href="class-gtkexpander.html" title="gtk.Expander"><code class="classname">gtk.Expander</code></a></li><li><a class="link" href="class-gtkfilechooser.html" title="gtk.FileChooser"><code class="classname">gtk.FileChooser</code></a></li><li><a class="link" href="class-gtkfilechooserdialog.html" title="gtk.FileChooserDialog"><code class="classname">gtk.FileChooserDialog</code></a></li><li><a class="link" href="class-gtkfilechooserwidget.html" title="gtk.FileChooserWidget"><code class="classname">gtk.FileChooserWidget</code></a></li><li><a class="link" href="class-gtkfilefilter.html" title="gtk.FileFilter"><code class="classname">gtk.FileFilter</code></a></li><li><a class="link" href="class-gtkfontbutton.html" title="gtk.FontButton"><code class="classname">gtk.FontButton</code></a></li><li><a class="link" href="class-gtkiconinfo.html" title="gtk.IconInfo"><code class="classname">gtk.IconInfo</code></a></li><li><a class="link" href="class-gtkicontheme.html" title="gtk.IconTheme"><code class="classname">gtk.IconTheme</code></a></li><li><a class="link" href="class-gtkradioaction.html" title="gtk.RadioAction"><code class="classname">gtk.RadioAction</code></a></li><li><a class="link" href="class-gtkradiotoolbutton.html" title="gtk.RadioToolButton"><code class="classname">gtk.RadioToolButton</code></a></li><li><a class="link" href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><code class="classname">gtk.SeparatorToolItem</code></a></li><li><a class="link" href="class-gtktoggleaction.html" title="gtk.ToggleAction"><code class="classname">gtk.ToggleAction</code></a></li><li><a class="link" href="class-gtktoggletoolbutton.html" title="gtk.ToggleToolButton"><code class="classname">gtk.ToggleToolButton</code></a></li><li><a class="link" href="class-gtktoolbutton.html" title="gtk.ToolButton"><code class="classname">gtk.ToolButton</code></a></li><li><a class="link" href="class-gtktoolitem.html" title="gtk.ToolItem"><code class="classname">gtk.ToolItem</code></a></li><li><a class="link" href="class-gtktreemodelfilter.html" title="gtk.TreeModelFilter"><code class="classname">gtk.TreeModelFilter</code></a></li><li><a class="link" href="class-gtktreerowreference.html" title="gtk.TreeRowReference"><code class="classname">gtk.TreeRowReference</code></a></li><li><a class="link" href="class-gtkuimanager.html" title="gtk.UIManager"><code class="classname">gtk.UIManager</code></a></li><li><a class="link" href="class-gdkatom.html" title="gtk.gdk.Atom"><code class="classname">gtk.gdk.Atom</code></a></li><li><a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a></li><li><a class="link" href="class-gdkdisplaymanager.html" title="gtk.gdk.DisplayManager"><code class="classname">gtk.gdk.DisplayManager</code></a></li><li><a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a></li><li><a class="link" href="class-pangofontsetsimple.html" title="pango.FontsetSimple"><code class="classname">pango.FontsetSimple</code></a></li></ul></div></li><li><p>Descriptions of new GTK+ 2.6 classes:</p><div class="itemizedlist"><ul type="circle"><li><a class="link" href="class-gtkaboutdialog.html" title="gtk.AboutDialog"><code class="classname">gtk.AboutDialog</code></a></li><li><a class="link" href="class-gtkcellrenderercombo.html" title="gtk.CellRendererCombo"><code class="classname">gtk.CellRendererCombo</code></a></li><li><a class="link" href="class-gtkcellrendererprogress.html" title="gtk.CellRendererProgress"><code class="classname">gtk.CellRendererProgress</code></a></li><li><a class="link" href="class-gtkcellview.html" title="gtk.CellView"><code class="classname">gtk.CellView</code></a></li><li><a class="link" href="class-gtkfilechooserbutton.html" title="gtk.FileChooserButton"><code class="classname">gtk.FileChooserButton</code></a></li><li><a class="link" href="class-gtkiconview.html" title="gtk.IconView"><code class="classname">gtk.IconView</code></a></li><li><a class="link" href="class-gtkmenutoolbutton.html" title="gtk.MenuToolButton"><code class="classname">gtk.MenuToolButton</code></a></li></ul></div></li><li><p>a reference page in each module chapter containing
descriptions of or links to all of the functions defined in a module.</p></li><li><p>a reference page in each module chapter containing
descriptions of all of the constants defined in a module.</p></li><li><p>additional methods, functions, properties and signals added
for GTK+ 2.2, GTK+ 2.4, GTK+ 2.6, PyGTK 2.2, PyGTK 2.4, PyGTK 2.6,
PyGTK 2.8 and PyGTK 2.10.</p></li><li><p>Descriptions of new GTK+ 2.10 classes:</p><div class="itemizedlist"><ul type="circle"><li><a class="link" href="class-gtkassistant.html" title="gtk.Assistant"><code class="classname">gtk.Assistant</code></a></li><li><a class="link" href="class-gtkcellrendereraccel.html" title="gtk.CellRendererAccel"><code class="classname">gtk.CellRendererAccel</code></a></li><li><a class="link" href="class-gtkcellrendererspin.html" title="gtk.CellRendererSpin"><code class="classname">gtk.CellRendererSpin</code></a></li><li><a class="link" href="class-gtklinkbutton.html" title="gtk.LinkButton"><code class="classname">gtk.LinkButton</code></a></li><li><a class="link" href="class-gtkpagesetup.html" title="gtk.PageSetup"><code class="classname">gtk.PageSetup</code></a></li><li><a class="link" href="class-gtkpapersize.html" title="gtk.PaperSize"><code class="classname">gtk.PaperSize</code></a></li><li><a class="link" href="class-gtkprintcontext.html" title="gtk.PrintContext"><code class="classname">gtk.PrintContext</code></a></li><li><a class="link" href="class-gtkprintoperation.html" title="gtk.PrintOperation"><code class="classname">gtk.PrintOperation</code></a></li><li><a class="link" href="class-gtkprintoperationpreview.html" title="gtk.PrintOperationPreview"><code class="classname">gtk.PrintOperationPreview</code></a></li><li><a class="link" href="class-gtkprintsettings.html" title="gtk.PrintSettings"><code class="classname">gtk.PrintSettings</code></a></li><li><a class="link" href="class-gtkrecentchooserdialog.html" title="gtk.RecentChooserDialog"><code class="classname">gtk.RecentChooserDialog</code></a></li><li><a class="link" href="class-gtkrecentchoosermenu.html" title="gtk.RecentChooserMenu"><code class="classname">gtk.RecentChooserMenu</code></a></li><li><a class="link" href="class-gtkrecentchooserwidget.html" title="gtk.RecentChooserWidget"><code class="classname">gtk.RecentChooserWidget</code></a></li><li><a class="link" href="class-gtkrecentchooser.html" title="gtk.RecentChooser"><code class="classname">gtk.RecentChooser</code></a></li><li><a class="link" href="class-gtkrecentfilter.html" title="gtk.RecentFilter"><code class="classname">gtk.RecentFilter</code></a></li><li><a class="link" href="class-gtkrecentinfo.html" title="gtk.RecentInfo"><code class="classname">gtk.RecentInfo</code></a></li><li><a class="link" href="class-gtkrecentmanager.html" title="gtk.RecentManager"><code class="classname">gtk.RecentManager</code></a></li><li><a class="link" href="class-gtkstatusicon.html" title="gtk.StatusIcon"><code class="classname">gtk.StatusIcon</code></a></li></ul></div></li><li><p>new in PyGTK 2.10, the <a class="link" href="unixprint-class-reference.html" title="The gtkunixprint Class Reference">Unix print module
gtkunixprint</a>.</p></li><li><p>documentation on the <a class="link" href="atk-class-reference.html" title="The atk Class Reference">Accessibilty Tool Kit
atk</a>.</p></li></ul></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="pygtk-reference-format.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">PyGTK 2.0 Reference Manual </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Reference Page Format</td></tr></table></div></body></html>
|
