Class e.p.p.s.t.Slideshow(gobject.GObject):

Part of elisa.plugins.poblesec.slideshow.transition_slideshow View In Hierarchy

Known subclasses: elisa.plugins.poblesec.slideshow.transition_slideshow.TransitionSlideshow

A L{Slideshow} is responsible for displaying a set of pictures sequentially
in automated fashion.
It is interruptible at any time and may also be controlled manually while it
is playing.

Emit the signals:
 - current-picture-changed: when the current picture displayed/in focus is
                            changed; at that point the actual picture file
                            starts being loaded
     params: L{elisa.plugins.base.models.image.ImageModel} of the picture
             C{int} index of the picture in the playlist

 - current-picture-loaded: when the current picture is finally loaded
     params: L{pgm.timing.implicit.AnimatedObject} wrapping the image
             drawable containing the loaded picture

 - status-changed: when L{status} changes
     params: one of [Slideshow.STOPPED, Slideshow.PLAYING]

 - end-reached: when the slideshow was playing and it displayed all the
                pictures available

@cvar name:   user displayable name of the slideshow
@type name:   C{str}
@ivar status: whether the slideshow was started or not
@type status: one of [Slideshow.STOPPED, Slideshow.PLAYING]

Line #	Kind	Name	Docs
89	Method	__init__
99	Method	clean	Cleanup the slideshow as to prepare it for destruction.
105	Method	set_playlist	Set the list of pictures to display during the slideshow and display one
118	Method	set_interval	Set the time during which a picture should be displayed/in focus for the
128	Method	start	Start the automated slideshow.
138	Method	stop	Stop the slideshow.
144	Method	next	Display the next picture in the playlist.
150	Method	previous	Display the previous picture in the playlist.
156	Method	_get_status	Undocumented
159	Method	_set_status	Undocumented

def __init__(self, playground):

overridden in elisa.plugins.poblesec.slideshow.transition_slideshow.TransitionSlideshow

Parameters playground node of the scene where the pictures will be displayed (type: elisa.plugins.pigment.graph.group.Group )

def clean(self):

overridden in elisa.plugins.poblesec.slideshow.transition_slideshow.TransitionSlideshow

Cleanup the slideshow as to prepare it for destruction.

def set_playlist(self, playlist, index=0):

overridden in elisa.plugins.poblesec.slideshow.transition_slideshow.TransitionSlideshow

Set the list of pictures to display during the slideshow and display one of them immediately, by default the first one.

Parameters	playlist	list of pictures to display during the slideshow (type: `list` of `elisa.plugins.base.models.image.ImageModel` )
	index	index in the playlist of the picture to display immediately (type: `int` )

def set_interval(self, interval):

overridden in elisa.plugins.poblesec.slideshow.transition_slideshow.TransitionSlideshow

Set the time during which a picture should be displayed/in focus for the user.

Parameters interval time in seconds (type: float )

def start(self, index=None):

overridden in elisa.plugins.poblesec.slideshow.transition_slideshow.TransitionSlideshow

Start the automated slideshow.

Parameters index index in the playlist of the picture to start the slideshow with (type: int )

def stop(self):

overridden in elisa.plugins.poblesec.slideshow.transition_slideshow.TransitionSlideshow

Stop the slideshow.

def next(self):