root/plgtkimageview/Zoom.xs

Revision 460, 2.2 kB (checked in by jeffrey, 1 year ago)

+ Zoom.xs

Line 
1 #include "gtkimageviewperl.h"
2
3
4 MODULE = Gtk2::ImageView::Zoom  PACKAGE = Gtk2::ImageView::Zoom  PREFIX = gtk_zooms_
5
6
7 =for object Gtk2::ImageView::Zoom Functions for dealing with zoom factors
8 =cut
9
10 =for position DESCRIPTION
11
12 =head1 DESCRIPTION
13
14 GtkImageView uses a discrete amount of zoom factors for determining which zoom to set. Using these functions, it is possible to retrieve information and manipulate a zoom factor.
15
16 =cut
17
18
19 =for apidoc
20
21 Returns the zoom factor that is one step larger than the supplied zoom factor.
22
23 =over
24
25 =item zoom : A zoom factor.
26
27 =back
28
29 =head3 Returns
30
31 =over
32
33 =item a zoom factor that is one step larger than the supplied one
34
35 =back
36
37 =cut
38 ## call as $zoom = Gtk2::ImageView::Zoom->get_zoom_in($zoom)
39 ## gdouble gtk_zooms_get_zoom_in(gdouble zoom);
40 gdouble
41 gtk_zooms_get_zoom_in (class, zoom)
42         gdouble zoom
43         C_ARGS:
44                 zoom
45
46
47 =for apidoc
48
49 Returns the zoom factor that is one step smaller than the supplied zoom factor.
50
51 =over
52
53 =item zoom : A zoom factor.
54
55 =back
56
57 =head3 Returns
58
59 =over
60
61 =item a zoom factor that is one step smaller than the supplied one.
62
63 =back
64
65 =cut
66 ## call as $zoom = Gtk2::ImageView::Zoom->get_zoom_out($zoom)
67 ## gdouble gtk_zooms_get_zoom_out(gdouble zoom);
68 gdouble
69 gtk_zooms_get_zoom_out (class, zoom)
70         gdouble zoom
71         C_ARGS:
72                 zoom
73
74
75 =for apidoc
76
77 Returns the minimum allowed zoom factor.
78
79 =head3 Returns
80
81 =over
82
83 =item The minimal zoom factor.
84
85 =back
86
87 =cut
88 ## call as $zoom = Gtk2::ImageView::Zoom->get_min_zoom
89 ## gdouble gtk_zooms_get_min_zoom(void);
90 gdouble
91 gtk_zooms_get_min_zoom (class)
92         C_ARGS:
93                 /*void*/
94
95
96 =for apidoc
97
98 Returns the maximum allowed zoom factor.
99
100 =head3 Returns
101
102 =over
103
104 =item The maximal zoom factor.
105
106 =back
107
108 =cut
109 ## call as $zoom = Gtk2::ImageView::Zoom->get_max_zoom
110 ## gdouble gtk_zooms_get_max_zoom(void);
111 gdouble
112 gtk_zooms_get_max_zoom (class)
113         C_ARGS:
114                 /*void*/
115
116
117 =for apidoc
118
119 Returns the zoom factor clamped to the minumum and maximum allowed value.
120
121 =over
122
123 =item zoom : A zoom factor.
124
125 =back
126
127 =head3 Returns
128
129 =over
130
131 =item The zoom factor clamped to the interval [min, max].
132
133 =back
134
135 =cut
136 ## call as $zoom = Gtk2::ImageView::Zoom->clamp_zoom($zoom)
137 ## gdouble gtk_zooms_clamp_zoom(gdouble zoom;
138 gdouble
139 gtk_zooms_clamp_zoom (class, zoom)
140         gdouble zoom
141         C_ARGS:
142                 zoom
143
Note: See TracBrowser for help on using the browser.