Changeset 456 for plgtkimageview/ImageNav.xs

Timestamp:

12/27/07 23:50:17 (5 years ago)

Author:

jeffrey

Message:

+ remaining docs

Files:

• plgtkimageview/ImageNav.xs (modified) (2 diffs)

plgtkimageview/ImageNav.xs

@@ -4 +4 @@
-MODULE = Gtk2::ImageView::Nav  PACKAGE = Gtk2::ImageView::Nav  PREFIX = gtk_image_nav_
-
+=for object Gtk2::ImageView::Nav Navigation window showing a thumbnailed overview of a Gtk2::ImageView.
-
+=head1 DESCRIPTION
+
+Gtk2::ImageView::Nav is a popup window that shows a downscaled preview of the pixbuf that Gtk2::ImageView is showing. The user can drag around a rectangle which indicates the current view of the image.
+
+This class is used by Gtk2::ImageView::ScrollWin itself. It is probably not very useful for clients of this library.
+
+Gtk2::ImageView::Nav has the same keybindings that Gtk2::ImageView has. All keypresses that it receives are passed along to the view. 
+
+=cut
+
+
+=for apidoc
+
+Creates a new Gtk2::ImageView::Nav for showing thumbnails of the view. The pixbuf is by default NULL.
+
+=over
+
+=item view : a Gtk2::ImageView.
+
+=back
+
+=head3 Returns
+
+=over
+
+=item a new Gtk2::ImageView::Nav showing the view.
+
+=back
+
+=cut
-GtkWidget *
-gtk_image_nav_new (view)
-                GtkImageView *  view
-
+
+=for apidoc
+
+Returns the downscaled pixbuf of the views pixbuf that this Gtk2::ImageView::Nav shows, or NULL if that pixbuf has not been created yet.
+
+The pixbuf is by default NULL.
+
+=over
+
+=item nav : a Gtk2::ImageView::Nav.
+
+=back
+
+=head3 Returns
+
+=over
+
+=item the pixbuf in the navigation area this image navigator shows, or NULL if none exist.
+
+=back
+
+=cut
-GdkPixbuf *
-gtk_image_nav_get_pixbuf (nav)
@@ -21 +74 @@
-                GtkImageNav *   nav
-
+
+=for apidoc
+
+Show the Gtk2::ImageView::Nav centered around the point (center_x, center_y) and grab mouse and keyboard events. The grab continues until a button release event is received which causes the widget to hide.
+
+=over
+
+=item nav : a Gtk2::ImageView::Nav.
+
+=item center_x : x coordinate of center position
+
+=item center_y : y coordinate of center position
+
+=back
+
+=head3 Returns
+
+=over
+
+=item the pixbuf in the navigation area this image navigator shows, or NULL if none exist.
+
+=back
+
+=cut
-void
-gtk_image_nav_show_and_grab (nav, center_x, center_y)