root/plgtkimageview/AnimView.xs

Revision 531, 2.7 kB (checked in by jeffrey, 9 months ago)

fixed some documentation issues

Line 
1 #include "gtkimageviewperl.h"
2
3
4 MODULE = Gtk2::ImageView::Anim  PACKAGE = Gtk2::ImageView::Anim  PREFIX = gtk_anim_view_
5
6 =for object Gtk2::ImageView::Anim Subclass of Gtk2::ImageView capable of playing GIF animations.
7 =cut
8
9 =for position DESCRIPTION
10
11 =head1 DESCRIPTION
12
13 Gtk2::ImageView::Anim is a subclass of Gtk2::ImageView that provies facilities for displaying and controlling an animation.
14
15 =cut
16
17
18 =for apidoc
19
20 Creates a new Gtk2::ImageView::Anim with default values. The default values are:
21
22 =over
23
24 =item anim : NULL
25
26 =item is_playing : FALSE
27
28 =back
29
30 =head3 Returns
31
32 =over
33
34 =item a new Gtk2::ImageView::Anim.
35
36 =back
37
38 =cut
39 ## call as $widget = Gtk2::AnimView->new
40 GtkWidget_ornull *
41 gtk_anim_view_new (class)
42         C_ARGS:
43                 /*void*/
44
45 =for apidoc
46
47 Returns the current animation of the view.
48
49 =over
50
51 =item aview : a Gtk2::ImageView::Anim.
52
53 =back
54
55 =head3 Returns
56
57 =over
58
59 =item the current animation.
60
61 =back
62
63 =cut
64 ## call as $anim = $animview->get_anim
65 GdkPixbufAnimation_ornull *
66 gtk_anim_view_get_anim (aview)
67         GtkAnimView *   aview
68
69
70 =for apidoc
71
72 Sets the pixbuf animation to play, or NULL to not play any animation.
73
74 The effect of this method is analoguous to Gtk2::ImageView::set_pixbuf(). Fit mode is reset to GTK_FIT_SIZE_IF_LARGER so that the whole area of the animation fits in the view. Three signals are emitted, first the Gtk2::ImageView will emit zoom-changed and then pixbuf-changed, second, Gtk2::ImageView::Anim itself will emit anim-changed.
75
76 The default pixbuf animation is NULL.
77
78 =over
79
80 =item aview : a Gtk2::ImageView::Anim.
81
82 =item anim : A pixbuf animation to play.
83
84 =back
85
86 =cut
87 ## call as $animview->set_anim($anim)
88 void
89 gtk_anim_view_set_anim (aview, anim)
90         GtkAnimView *           aview
91         GdkPixbufAnimation *    anim
92
93
94 =for apidoc
95
96 Sets whether the animation should play or not. If there is no current animation this method does not have any effect.
97
98 =over
99
100 =item aview : a Gtk2::ImageView::Anim.
101
102 =item playing : TRUE to play the animation, FALSE otherwise
103
104 =back
105
106 =cut
107 ## call as $animview->set_is_playing($boolean)
108 void
109 gtk_anim_view_set_is_playing (aview, playing)
110         GtkAnimView *   aview
111         gboolean        playing
112
113
114 =for apidoc
115
116 Returns whether the animation is playing or not. If there is no current animation, this method will always return FALSE.
117
118 =over
119
120 =item aview : a Gtk2::ImageView::Anim.
121
122 =back
123
124 =head3 Returns
125
126 =over
127
128 =item TRUE if an animation is playing, FALSE otherwise.
129
130 =back
131
132 =cut
133 ## call as $boolean = $animview->get_is_playing
134 gboolean
135 gtk_anim_view_get_is_playing (aview)
136         GtkAnimView *   aview
137
138
139 =for apidoc
140
141 Steps the animation one frame forward. If the animation is playing it will be stopped. Will it wrap around if the animation is at its last frame?
142
143 =over
144
145 =item aview : a Gtk2::ImageView::Anim.
146
147 =back
148
149 =cut
150 ## call as $animview->step
151 void
152 gtk_anim_view_step (aview)
153         GtkAnimView *   aview
Note: See TracBrowser for help on using the browser.