==============
PyGtkImageView
==============

Copyright © 2007 Björn Lindqvist <bjourne@gmail.com>

This is the README file for PyGtkImageView.

PyGtkImageView is the Python language binding for the GTK widget
GtkImageView.

Compilation
===========

Compilation requires that gtkimageview and pygtk are installed. And
then:

    $ ./configure --prefix=/some/prefix
    $ make
    $ make install

Note that you should have gtkimageview-1.5.0 installed. Older versions
may also work, but there is no guarantee.

Example
=======

    import gtkimageview
    import gtk
    from gtk import gdk
    
    view = gtkimageview.ImageView()
    view.set_pixbuf(gdk.pixbuf_new_from_file("yourimage.png"))
    win = gtk.Window()
    win.add(view)
    win.show_all()
    gtk.main()

More example code exists in the ./tests/demo??.py files.

Tests
=====
Unit tests exist in the directory ./tests. To run them you must have
nosetests installed. Run the tests by typing:

    nosetests -w tests

in the root directory. The package must first be installed for this to
work.

Documentation
=============
Documentation can be found in the ./docs directory. HTML and PDF
documentation is generated by the bash script makedocs.sh. For it to
work, you need to have:

* epydoc 3.0 beta (install from source)
* latex (the packages tetex-bin and tetex-extra on Ubuntu)
* docutils

Then just run the script from the ./docs dir:

    ./makedocs.sh

The source for the documentation is found in the
./docs/gtkimageview.py file.

Download & Links
================
Check it out from Subversion:

    svn co http://publicsvn.bjourne.webfactional.com/pygtkimageview

Or download the latest release tarball:

    http://trac.bjourne.webfactional.com/attachment/wiki/WikiStart/pygtkimageview-1.1.0.tar.gz?format=raw

Project website: http://trac.bjourne.webfactional.com

Announcement
============
This is the announcement to post to python-announce-list@python.org
and pygtk@daa.com.au.

Subject: [ANN] PyGtkImageView 1.1.0 -- Image viewer widget for PyGTK

I'm pleased to finally announce PyGtkImageView 1.1.0!

Description
-----------
GtkImageView is a simple image viewer widget for GTK+. Similar to the
image viewer panes in gThumb or Eye of Gnome. It makes writing image
viewing and editing applications easy. Among its features are:

* Mouse and keyboard zooming.
* Scrolling and dragging.
* Adjustable interpolation.
* Fullscreen mode.
* GIF animation support.
* Ability to make selections.
* Extensible using a tool system.

PyGtkImageView is the Python bindings for GtkImageView.

PyGtkImageView Download
-----------------------
Subversion: svn co http://publicsvn.bjourne.webfactional.com/pygtkimageview
Tarball:    http://trac.bjourne.webfactional.com/attachment/wiki/WikiStart/pygtkimageview-1.1.0.tar.gz
API doc:    http://trac.bjourne.webfactional.com/chrome/common/pygtkimageview-docs/
PDF:        http://trac.bjourne.webfactional.com/attachment/wiki/WikiStart/pygtkimageview-1.1.0-api.pdf

Project website: http://trac.bjourne.webfactional.com

Examples
--------
Here is the canonical example for using the widget::

   import gtk
   import gtk.gdk
   import gtkimageview

   view = gtkimageview.ImageView()
   scroll = gtkimageview.ImageScrollWin(view)

   # Where "box" is a gtk.Box already part of your layout.
   box.pack_start(scroll)
   pixbuf = gtk.gdk.pixbuf_new_from_file("someimage.png")
   view.set_pixbuf(pixbuf)