Storyboard.Storyboard Class Reference
Detailed Description
A storyboard is an ordered collection of slides.
#include
<class_storyboard_1_1_storyboard.h>
Public Member Functions |
|
| __init__ () | |
| __contains__ () | |
| Given a slide identifier, return True if the
corresponding slide exists in this storyboard, and False otherwise.
|
|
| __delitem__ () | |
| Given a slide identifier, delete the
corresponding slide from this storyboard. |
|
| __getitem__ () | |
| Given a slide identifier, return the
corresponding slide. |
|
| __iter__ () | |
| Iterate in-order through the slides in this
storyboard. |
|
| __len__ () | |
| Return the number of slides in this
storyboard. |
|
| __str__ () | |
| getSlideIdsByStageId () | |
| clear () | |
| Clear all slides from this storyboard.
|
|
| create () | |
| Create a slide, give it a default identifier
and name, and append it to this storyboard. |
|
| duplicate () | |
| Given a slide identifier, duplicate the
corresponding slide, giving the duplicate a unique identifier and
name, and then insert the duplicate in this storyboard after the
original. |
|
| index () | |
| Given a slide identifier, return the 0-based
index of the corresponding slide in this storyboard. |
|
| insert () | |
| Given a 0-based index, insert the slide at
that position in this storyboard. |
|
| setPosition () | |
| Set position of a slide. |
|
| setCurrentSlide () | |
| getCurrentSlide () | |
| getFirstSlide () | |
| Return the identifier of the first slide in
the stage. |
|
| getLastSlide () | |
| Return the identifier of the last slide in
the stage. |
|
| getNextSlide () | |
| Get the identifier of the slide after the
current slide. |
|
| getPreviousSlide () | |
| Get the slide before the current slide.
|
|
| setPlayer () | |
| getPlayer () | |
| getPlayingSlideId () | |
| isPlaying () | |
| isPaused () | |
| isLoop () | |
Member Function Documentation
| Storyboard.Storyboard.__init__ | ( | ) |
| Storyboard.Storyboard.__contains__ | ( | ) |
Given a slide identifier, return True if the corresponding slide exists in this storyboard, and False otherwise.
| Storyboard.Storyboard.__delitem__ | ( | ) |
Given a slide identifier, delete the corresponding slide from this storyboard.
Do nothing if no such slide is found.
| Storyboard.Storyboard.__getitem__ | ( | ) |
Given a slide identifier, return the corresponding slide.
Raise KeyError if no such slide is found.
or
Given an integer, return the identifier or the slide at the specified 0-based index. Raise IndexError if there's no corresponding slide.
| Storyboard.Storyboard.__iter__ | ( | ) |
Iterate in-order through the slides in this storyboard.
| Storyboard.Storyboard.__len__ | ( | ) |
Return the number of slides in this storyboard.
| Storyboard.Storyboard.__str__ | ( | ) |
| Storyboard.Storyboard.getSlideIdsByStageId | ( | ) |
| Storyboard.Storyboard.clear | ( | ) |
Clear all slides from this storyboard.
| Storyboard.Storyboard.create | ( | ) |
Create a slide, give it a default identifier and name, and append it to this storyboard.
Optionally, a slide identifier and a slide name can be provided for the new slide, and the index where the slide will be inserted can also be specified.
| Storyboard.Storyboard.duplicate | ( | ) |
Given a slide identifier, duplicate the corresponding slide, giving the duplicate a unique identifier and name, and then insert the duplicate in this storyboard after the original.
| Storyboard.Storyboard.index | ( | ) |
Given a slide identifier, return the 0-based index of the corresponding slide in this storyboard.
| Storyboard.Storyboard.insert | ( | ) |
Given a 0-based index, insert the slide at that position in this storyboard.
A negative index is accepted: -1 places the slide at the end of the list, any other negative index places the slide at the start of the list. An index greater than the number of slides in this storyboard is accepted: the slide is placed at the end of the list. Return the index of the slide.
The makeCurrent argument indicates if the new slide should become the current slide.
| Storyboard.Storyboard.setPosition | ( | ) |
Set position of a slide.
The newPosition argument is 0-based. The slide's old position is returned. -1 is returned if the argument slide does not exist.
| Storyboard.Storyboard.setCurrentSlide | ( | ) |
| Storyboard.Storyboard.getCurrentSlide | ( | ) |
| Storyboard.Storyboard.getFirstSlide | ( | ) |
Return the identifier of the first slide in the stage.
None is returned if there are no slides.
| Storyboard.Storyboard.getLastSlide | ( | ) |
Return the identifier of the last slide in the stage.
None is returned if there are no slides.
| Storyboard.Storyboard.getNextSlide | ( | ) |
Get the identifier of the slide after the current slide.
None is returned if there are no slides.
If there is only one slide then the current slide (ie. the only slide) is returned.
If the current slide is the last slide then the first slide is returned.
| Storyboard.Storyboard.getPreviousSlide | ( | ) |
Get the slide before the current slide.
None is returned if there are no slides.
If there is only one slide then the current slide (ie. the only slide) is returned.
If the current slide is the first slide then the last slide is returned.
| Storyboard.Storyboard.setPlayer | ( | ) |
| Storyboard.Storyboard.getPlayer | ( | ) |
| Storyboard.Storyboard.getPlayingSlideId | ( | ) |
| Storyboard.Storyboard.isPlaying | ( | ) |
| Storyboard.Storyboard.isPaused | ( | ) |
| Storyboard.Storyboard.isLoop | ( | ) |
