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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Introduction</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="previous" 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></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="pygtk-introduction.html#id2862721">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><dt><span class="sect1"><a href="pygtk-reference-copyright.html">Copyright and License Notice</a></span></dt></dl></div><p>This document describes most of the <tt class="literal">PyGTK</tt>
version 2.0 through 2.6 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. I have
attempted to document as much of the <tt class="literal">PyGTK</tt>
<tt class="literal">API</tt> as I can but there are undoubtedly errors and
omissions. If you discover any of these please send me email at
<tt class="email"><<a href="mailto:finlay@moeraki.com"><a href="mailto:finlay@moeraki.com" target="_top">finlay@moeraki.com</a></a>></tt> or file a
bug report at <a href="http://bugzilla.gnome.org" target="_top">bugzilla.gnome.org</a>
for the <tt class="literal">pygtk</tt> project. Specific areas that have not been
documented include:</p><div class="itemizedlist"><ul type="disc"><li>The ATK classes</li></ul></div><p>This reference describes the API for <tt class="literal">PyGTK</tt> as of
version 2.5.0+ and assumes that the additional API changes for version 2.6
may 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 <tt class="literal">PyGTK</tt> seem to differ. You are encouraged to
use the latest version of <tt class="literal">PyGTK</tt> that is available. See
the <a href="http://www.pygtk.org" target="_top"><tt class="literal">PyGTK</tt>
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
<tt class="literal">PyGTK</tt> module (that corresponds to the underlying
<tt class="literal">GTK+</tt> library) containing the class descriptions. The
second chapter illustrates the <tt class="literal">PyGTK</tt> 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><span class="term">The<tt class="literal">gobject</tt>module</span></td><td>The classes that are included in the
<tt class="literal">gobject</tt> module of <tt class="literal">PyGTK</tt> and are
accessed similar to: gobject.GObject. These classes are the base object
classes that the <tt class="literal">gtk</tt> and <tt class="literal">gtk.gdk</tt>
module classes are built on.</td></tr><tr><td><span class="term">The<tt class="literal">gtk</tt>module</span></td><td>The classes that are included in the
<tt class="literal">gtk</tt> module of <tt class="literal">PyGTK</tt> 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><span class="term">The<tt class="literal">gtk.gdk</tt>module</span></td><td>The classes that are included in the
<tt class="literal">gtk.gdk</tt> module of <tt class="literal">PyGTK</tt>. These classes
are "lower" level classes that provide more fundamental capabilities that
the <tt class="literal">gtk</tt> 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><span class="term">The<tt class="literal">gtk.glade</tt>module</span></td><td>The classes that are included in the
<tt class="literal">gtk.glade</tt> module of <tt class="literal">PyGTK</tt>. These
classes provide access to the libglade functions that allow the
dynamic loading of user interfaces from XML descriptions.</td></tr><tr><td><span class="term">The<tt class="literal">pango</tt>module</span></td><td>The classes that are included in the
<tt class="literal">pango</tt> module of <tt class="literal">PyGTK</tt>. 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 <tt class="literal">atk</tt> module classes will be added in a later
version of this Reference.</p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2862721"></a>Major Changes since Version 1.9</h2></div></div><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><a href="class-gobjectgboxed.html" title="gobject.GBoxed"><tt class="classname">gobject.GBoxed</tt></a></li><li><a href="class-gobjectgpointer.html" title="gobject.GPointer"><tt class="classname">gobject.GPointer</tt></a></li><li><a href="class-gobjectginterface.html" title="gobject.GInterface"><tt class="classname">gobject.GInterface</tt></a></li><li><a href="class-gobjectmaincontext.html" title="gobject.MainContext"><tt class="classname">gobject.MainContext</tt></a></li><li><a href="class-gobjectmainloop.html" title="gobject.MainLoop"><tt class="classname">gobject.MainLoop</tt></a></li><li><a href="class-gtkaction.html" title="gtk.Action"><tt class="classname">gtk.Action</tt></a></li><li><a href="class-gtkactiongroup.html" title="gtk.ActionGroup"><tt class="classname">gtk.ActionGroup</tt></a></li><li><a href="class-gtkborder.html" title="gtk.Border"><tt class="classname">gtk.Border</tt></a></li><li><a href="class-gtkclipboard.html" title="gtk.Clipboard"><tt class="classname">gtk.Clipboard</tt></a></li><li><a href="class-gtkcolorbutton.html" title="gtk.ColorButton"><tt class="classname">gtk.ColorButton</tt></a></li><li><a href="class-gtkcombobox.html" title="gtk.ComboBox"><tt class="classname">gtk.ComboBox</tt></a></li><li><a href="class-gtkcomboboxentry.html" title="gtk.ComboBoxEntry"><tt class="classname">gtk.ComboBoxEntry</tt></a></li><li><a href="class-gtkentrycompletion.html" title="gtk.EntryCompletion"><tt class="classname">gtk.EntryCompletion</tt></a></li><li><a href="class-gtkexpander.html" title="gtk.Expander"><tt class="classname">gtk.Expander</tt></a></li><li><a href="class-gtkfilechooser.html" title="gtk.FileChooser"><tt class="classname">gtk.FileChooser</tt></a></li><li><a href="class-gtkfilechooserdialog.html" title="gtk.FileChooserDialog"><tt class="classname">gtk.FileChooserDialog</tt></a></li><li><a href="class-gtkfilechooserwidget.html" title="gtk.FileChooserWidget"><tt class="classname">gtk.FileChooserWidget</tt></a></li><li><a href="class-gtkfilefilter.html" title="gtk.FileFilter"><tt class="classname">gtk.FileFilter</tt></a></li><li><a href="class-gtkfontbutton.html" title="gtk.FontButton"><tt class="classname">gtk.FontButton</tt></a></li><li><a href="class-gtkiconinfo.html" title="gtk.IconInfo"><tt class="classname">gtk.IconInfo</tt></a></li><li><a href="class-gtkicontheme.html" title="gtk.IconTheme"><tt class="classname">gtk.IconTheme</tt></a></li><li><a href="class-gtkradioaction.html" title="gtk.RadioAction"><tt class="classname">gtk.RadioAction</tt></a></li><li><a href="class-gtkradiotoolbutton.html" title="gtk.RadioToolButton"><tt class="classname">gtk.RadioToolButton</tt></a></li><li><a href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><tt class="classname">gtk.SeparatorToolItem</tt></a></li><li><a href="class-gtktoggleaction.html" title="gtk.ToggleAction"><tt class="classname">gtk.ToggleAction</tt></a></li><li><a href="class-gtktoggletoolbutton.html" title="gtk.ToggleToolButton"><tt class="classname">gtk.ToggleToolButton</tt></a></li><li><a href="class-gtktoolbutton.html" title="gtk.ToolButton"><tt class="classname">gtk.ToolButton</tt></a></li><li><a href="class-gtktoolitem.html" title="gtk.ToolItem"><tt class="classname">gtk.ToolItem</tt></a></li><li><a href="class-gtktreemodelfilter.html" title="gtk.TreeModelFilter"><tt class="classname">gtk.TreeModelFilter</tt></a></li><li><a href="class-gtktreerowreference.html" title="gtk.TreeRowReference"><tt class="classname">gtk.TreeRowReference</tt></a></li><li><a href="class-gtkuimanager.html" title="gtk.UIManager"><tt class="classname">gtk.UIManager</tt></a></li><li><a href="class-gdkatom.html" title="gtk.gdk.Atom"><tt class="classname">gtk.gdk.Atom</tt></a></li><li><a href="class-gdkdisplay.html" title="gtk.gdk.Display"><tt class="classname">gtk.gdk.Display</tt></a></li><li><a href="class-gdkdisplaymanager.html" title="gtk.gdk.DisplayManager"><tt class="classname">gtk.gdk.DisplayManager</tt></a></li><li><a href="class-gdkscreen.html" title="gtk.gdk.Screen"><tt class="classname">gtk.gdk.Screen</tt></a></li><li><a href="class-pangofontsetsimple.html" title="pango.FontsetSimple"><tt class="classname">pango.FontsetSimple</tt></a></li></ul></div></li><li><p>Descriptions of new GTK+ 2.6 classes:</p><div class="itemizedlist"><ul type="circle"><li><a href="class-gtkaboutdialog.html" title="gtk.AboutDialog"><tt class="classname">gtk.AboutDialog</tt></a></li><li><a href="class-gtkcellrenderercombo.html" title="gtk.CellRendererCombo"><tt class="classname">gtk.CellRendererCombo</tt></a></li><li><a href="class-gtkcellrendererprogress.html" title="gtk.CellRendererProgress"><tt class="classname">gtk.CellRendererProgress</tt></a></li><li><a href="class-gtkcellview.html" title="gtk.CellView"><tt class="classname">gtk.CellView</tt></a></li><li><a href="class-gtkfilechooserbutton.html" title="gtk.FileChooserButton"><tt class="classname">gtk.FileChooserButton</tt></a></li><li><a href="class-gtkiconview.html" title="gtk.IconView"><tt class="classname">gtk.IconView</tt></a></li><li><a href="class-gtkmenutoolbutton.html" title="gtk.MenuToolButton"><tt class="classname">gtk.MenuToolButton</tt></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 and PyGTK 2.6.</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"><a accesskey="u" href="index.html">Up</a></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>
|
