root/plgtkimageview/ImageNav.xs

Revision 456, 2.1 kB (checked in by jeffrey, 1 year ago)

+ remaining docs

Line 
1 #include "gtkimageviewperl.h"
2
3
4 MODULE = Gtk2::ImageView::Nav  PACKAGE = Gtk2::ImageView::Nav  PREFIX = gtk_image_nav_
5
6 =for object Gtk2::ImageView::Nav Navigation window showing a thumbnailed overview of a Gtk2::ImageView.
7
8 =head1 DESCRIPTION
9
10 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.
11
12 This class is used by Gtk2::ImageView::ScrollWin itself. It is probably not very useful for clients of this library.
13
14 Gtk2::ImageView::Nav has the same keybindings that Gtk2::ImageView has. All keypresses that it receives are passed along to the view.
15
16 =cut
17
18
19 =for apidoc
20
21 Creates a new Gtk2::ImageView::Nav for showing thumbnails of the view. The pixbuf is by default NULL.
22
23 =over
24
25 =item view : a Gtk2::ImageView.
26
27 =back
28
29 =head3 Returns
30
31 =over
32
33 =item a new Gtk2::ImageView::Nav showing the view.
34
35 =back
36
37 =cut
38 GtkWidget *
39 gtk_image_nav_new (view)
40                 GtkImageView *  view
41
42
43 =for apidoc
44
45 Returns the downscaled pixbuf of the views pixbuf that this Gtk2::ImageView::Nav shows, or NULL if that pixbuf has not been created yet.
46
47 The pixbuf is by default NULL.
48
49 =over
50
51 =item nav : a Gtk2::ImageView::Nav.
52
53 =back
54
55 =head3 Returns
56
57 =over
58
59 =item the pixbuf in the navigation area this image navigator shows, or NULL if none exist.
60
61 =back
62
63 =cut
64 GdkPixbuf *
65 gtk_image_nav_get_pixbuf (nav)
66                 GtkImageNav *   nav
67
68 void
69 gtk_image_nav_grab (nav)
70                 GtkImageNav *   nav
71
72 void
73 gtk_image_nav_release (nav)
74                 GtkImageNav *   nav
75
76
77 =for apidoc
78
79 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.
80
81 =over
82
83 =item nav : a Gtk2::ImageView::Nav.
84
85 =item center_x : x coordinate of center position
86
87 =item center_y : y coordinate of center position
88
89 =back
90
91 =head3 Returns
92
93 =over
94
95 =item the pixbuf in the navigation area this image navigator shows, or NULL if none exist.
96
97 =back
98
99 =cut
100 void
101 gtk_image_nav_show_and_grab (nav, center_x, center_y)
102                 GtkImageNav *   nav
103                 int             center_x
104                 int             center_y
Note: See TracBrowser for help on using the browser.