This is the API reference for PyGtkImageView which is a set of Python
bindings for the GTK+ widget GtkImageView.
PyGtkImageView contains a simple but full-featured image viewer widget
similar to the image viewer panes in gThumb or Eye of GNOME. The main class in
the module is ImageView.
Documentation
This API documentation can be found in the ./docs directory. HTML
and PDF documentation is generated by the bash script makedocs.sh.
To build the documentation, you need to have the following tools
installed:
- epydoc 3.0 beta (install from
source)
- latex (the packages tetex-bin, tetex-extra and texlive-lang-french
in Ubuntu).
- docutils
Then just run the script:
$ ./makedocs.sh
The source for the documentation is found in the
./docs/gtkimageview.py file.
Keep in mind that this documentation is not built from the library
source. This is because while epydoc does support generating
documentation from extension modules, the result is generally very
poor (GTK+ and PyGTK is partially to blame for that).
Epydoc has no support for extracting documentation for signals, which
is why signals are here documented as methods prefixed with sig_*. For
example, the description for the signal "pixbuf-changed" is found in
the method description ImageView.sig_pixbuf_changed.
The examples should make it clear how these signals are supposed to be
used.
For that reason, epydoc cannot automatically discern which GTK+
classes GtkImageView's classes subclass. Instead, see the class
descriptions for inheritance information.
Release history
Major changes between version of PyGtkImageView. For a complete
history, also see the Release history document in GtkImageView.
Major changes in 1.0.0
None! First release. :)
Author:
Björn Lindqvist
Requires:
Python 2.2+, GtkImageView, PyGTK
Version:
1.2.0
License:
LGPL
Copyright:
© 2007-2009 Björn Lindqvist
To Do:
-
Make the epydoc generated HTML documentation a little nicer.
-
Fix the PDF generation so that images can be used both in the
HTML and in the PDF documentation.
-
Windows installer.
|
PixbufDrawOpts
Container class which holds options for how the pixbuf should be
drawn.
|
|
PixbufDrawCache
Cache that ensures fast redraws by storing the last draw
operation.
|
|
IImageTool
IImageTool is an interface that defines how ImageView interacts
with objects that acts as tools.
|
|
ImageToolDragger
ImageToolDragger is the default image tool for ImageView.
|
|
ImageToolSelector
ImageToolSelector is a tool for selecting areas of an image.
|
|
ImageNav
ImageNav is a popup window that shows a downscaled preview of the
pixbuf that ImageView is showing.
|
|
ImageScrollWin
Provides a widget similar in appearance to
gtk.ScrollableWindow that is more suitable for displaying
ImageView's.
|
|
ImageView
ImageView is a full-featured general purpose image viewer widget
for GTK.
|
|
AnimView
AnimView subclasses ImageView.
|