Gtk2::ImageView::Anim.3pm

Langue: en

Version: 2010-05-02 (fedora - 01/12/10)

Section: 3 (Bibliothèques de fonctions)

NAME

Gtk2::ImageView::Anim - Subclass of Gtk2::ImageView capable of playing GIF animations.

HIERARCHY

   Glib::Object
   +----Glib::InitiallyUnowned
        +----Gtk2::Object
             +----Gtk2::Widget
                  +----Gtk2::ImageView
                       +----Gtk2::ImageView::Anim
 
 

INTERFACES

   Glib::Object::_Unregistered::AtkImplementorIface
   Gtk2::Buildable
 
 

DESCRIPTION

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

METHODS

widget or undef = Gtk2::ImageView::Anim->new

Creates a new Gtk2::ImageView::Anim with default values. The default values are:
anim : NULL
is_playing : FALSE

Returns

a new Gtk2::ImageView::Anim.

pixbufanimation or undef = $aview->get_anim

Returns the current animation of the view.
aview : a Gtk2::ImageView::Anim.

Returns

the current animation.

$aview->set_anim ($anim)

*
$anim (Gtk2::Gdk::PixbufAnimation)

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.
aview : a Gtk2::ImageView::Anim.
anim : A pixbuf animation to play.

boolean = $aview->get_is_playing

Returns whether the animation is playing or not. If there is no current animation, this method will always return FALSE.
aview : a Gtk2::ImageView::Anim.

Returns

TRUE if an animation is playing, FALSE otherwise.

$aview->set_is_playing ($playing)

*
$playing (boolean)

Sets whether the animation should play or not. If there is no current animation this method does not have any effect.
aview : a Gtk2::ImageView::Anim.
playing : TRUE to play the animation, FALSE otherwise

$aview->step

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?
aview : a Gtk2::ImageView::Anim.

SIGNALS

toggle-running (Gtk2::ImageView::Anim)
step (Gtk2::ImageView::Anim)

SEE ALSO

Gtk2::ImageView, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::ImageView Copyright (C) 2007 by Jeffrey Ratcliffe.

This software is licensed under the GPL-3; see Gtk2::ImageView for a full notice.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:
Around line 47:
You forgot a '=back' before '=head3'
Around line 56:
=back without =over
Around line 71:
You forgot a '=back' before '=head3'
Around line 80:
=back without =over
Around line 123:
You forgot a '=back' before '=head3'
Around line 132:
=back without =over