File: AnimView.xs

package info (click to toggle)
libgtk2-imageview-perl 0.05-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 224 kB
  • ctags: 36
  • sloc: perl: 457; ansic: 27; makefile: 17
file content (118 lines) | stat: -rw-r--r-- 2,486 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
#include "gtkimageviewperl.h"


MODULE = Gtk2::ImageView::Anim  PACKAGE = Gtk2::ImageView::Anim  PREFIX = gtk_anim_view_

=for object Gtk2::ImageView::Anim Subclass of Gtk2::ImageView capable of playing
GIF animations.
=cut

=for position DESCRIPTION

=head1 DESCRIPTION

Gtk2::ImageView::Anim is a subclass of Gtk2::ImageView that provies facilities
for displaying and controlling an animation.

=cut


=for apidoc
Returns a new Gtk2::ImageView::Anim with the following default values:

=over

=item anim : NULL

=item is_playing : FALSE

=back

=cut
## call as $widget = Gtk2::AnimView->new
GtkWidget_ornull *
gtk_anim_view_new (class)
	C_ARGS:
		/*void*/

=for apidoc
Returns the current animation of the view.
=cut
## call as $anim = $animview->get_anim
GdkPixbufAnimation_ornull *
gtk_anim_view_get_anim (aview)
	GtkAnimView *	aview


=for apidoc
Sets the pixbuf animation to play, or NULL to not play any animation.

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.

The default pixbuf animation is NULL.

=over

=item aview : a Gtk2::ImageView::Anim.

=item anim : A pixbuf animation to play.

=back

=cut
## call as $animview->set_anim($anim)
void
gtk_anim_view_set_anim (aview, anim)
	GtkAnimView *		aview
	GdkPixbufAnimation *	anim


=for apidoc
Sets whether the animation should play or not. If there is no current animation
this method does not have any effect.

=over

=item aview : a Gtk2::ImageView::Anim.

=item playing : TRUE to play the animation, FALSE otherwise

=back

=cut
## call as $animview->set_is_playing($boolean)
void
gtk_anim_view_set_is_playing (aview, playing)
	GtkAnimView *	aview
	gboolean	playing


=for apidoc
Returns TRUE if the animation is playing, FALSE otherwise. If there is no
current animation, this method will always return FALSE.
=cut
## call as $boolean = $animview->get_is_playing
gboolean
gtk_anim_view_get_is_playing (aview)
	GtkAnimView *	aview


=for apidoc
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?

=over

=item aview : a Gtk2::ImageView::Anim.

=back

=cut
## call as $animview->step
void
gtk_anim_view_step (aview)
	GtkAnimView *	aview