Gtk2::ImageView::Tool.3pm

Langue: en

Version: 2010-05-02 (fedora - 01/12/10)

Section: 3 (Bibliothèques de fonctions)

NAME

Gtk2::ImageView::Tool

HIERARCHY

   Glib::Interface
   +----Gtk2::ImageView::Tool
 
 

DESCRIPTION

Gtk2::ImageView::Tool is an interface that defines how Gtk2::ImageView interacts with objects that acts as tools. Gtk2::ImageView delegates many of its most important tasks (such as drawing) to its tool which carries out all the hard work. The Gtk2::ImageView package comes with two tools; Gtk2::ImageView::Tool::Dragger and Gtk2::ImageView::Tool::Selector, but by implementing your own tool it is possible to extend Gtk2::ImageView to do stuff its author didn't imagine.

Gtk2::ImageView uses Gtk2::ImageView::Tool::Dragger by default, as that tool is he most generally useful one. However, it is trivial to make it use another tool.

  my $view = Gtk2::ImageView->new;
  my $tool = Gtk2::ImageView::Tool::Selector ($view);
  $view->set_tool ($tool);
 
 

Using the above code makes the view use the selector tool instead of the default dragger tool.

METHODS

boolean = $tool->button_press ($ev)

*
$ev (Gtk2::Gdk::Event)

boolean = $tool->button_release ($ev)

*
$ev (Gtk2::Gdk::Event)

cursor = $tool->cursor_at_point ($x, $y)

*
$x (integer)
*
$y (integer)

Ask the tool what cursor it wants displayed.
tool : the tool
x : the mouse pointers X-coordinate
y : the mouse pointers Y-coordinate

Returns

The appropriate cursor.

boolean = $tool->motion_notify ($ev)

*
$ev (Gtk2::Gdk::Event)

$tool->paint_image ($opts, $drawable)

*
$opts (Gtk2::Gdk::Pixbuf::Draw::Opts)
*
$drawable (Gtk2::Gdk::Drawable)

Called whenever the image view decides that any part of the image it shows needs to be redrawn.
tool : the tool
opts : the Gtk2::Gdk::Pixbuf::DrawOpts to use in this draw
drawable : a Gtk2::Gdk::Drawable to draw on

$tool->pixbuf_changed ($reset_fit, $rect)

*
$reset_fit (boolean)
*
$rect (Gtk2::Gdk::Rectangle)

Indicate to the tool that either a part of, or the whole pixbuf that the image view shows has changed. This method is called by the view whenever its pixbuf or its tool changes. That is, when any of the following methods are used:
Gtk2::ImageView::set_pixbuf()
Gtk2::ImageView::set_tool()
Gtk2::ImageView::damage_pixels()

If the reset_fit parameter is TRUE, it means that a new pixbuf has been loaded into the view.
tool : the tool
reset_fit : whether the view is resetting its fit mode or not
rect : rectangle containing the changed area or NULL

SEE ALSO

Gtk2::ImageView, Glib::Interface Copyright (C) 2007 by Jeffrey Ratcliffe.

This software is licensed under the GPL-3; see Gtk2::ImageView for a full notice.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:
Around line 80:
You forgot a '=back' before '=head3'
Around line 89:
=back without =over