StoryboardUi.StoryboardUi Class Reference
#include
<class_storyboard_ui_1_1_storyboard_ui.h>
Public Member Functions |
|
| __init__ () | |
| getLayout () | |
| setDirty () | |
| Call to indicate refresh required. |
|
| isDirty () | |
| Return True if refresh is required. |
|
| setDirtyScrollItem () | |
| Set the scroll item. |
|
| getDirtyScrollItem () | |
| Return the scroll item. |
|
| inAuthoringMode () | |
| setViewportId () | |
| setSlidePlaying () | |
| setSlidePlayState () | |
| getSlidePlaying () | |
| setShotPlaying () | |
| getShotPlaying () | |
| updateVisibility () | |
| doCreate () | |
| doCleanup () | |
| doLayout () | |
| doItemLayout () | |
| Apply the item layout information to the
corresponding item controls. |
|
| updateActiveIndicator () | |
| Update visibility and position of active
slide indicator. |
|
| updateShotPlayingIndicator () | |
| Update visibility and position of shot
playing indicator. |
|
| updateCreateButton () | |
| Update visibility of create button. |
|
| updateLoopButton () | |
| updateScrollButtons () | |
| Update visibility of scroll buttons.
|
|
| updateScrollBar () | |
| Update range and value of scroll bar.
|
|
| updateSlideControl () | |
| Update the value of a slide control to match
the selected state of a slide item. |
|
| clearSlideSelection () | |
| Clear the slide selection. |
|
| selectSlide () | |
| Select a slide. |
|
| getSlideSelection () | |
| Return a sequence containing all the
selected slides. |
|
| getEmptySlideThumbnail () | |
| getDefaultSlideThumbnail () | |
| getAlternativeThumbnail () | |
| Find the alternative in the document and
figure out which thumbnail to display. |
|
| getDefaultAlternativeThumbnail () | |
| getDefaultBehaviorThumbnail () | |
| Returns the default thumbnail image for a
behavior, based on its type. |
|
| getActionIndicator () | |
| getSlideThumbnail () | |
| Return the thumbnail to use for this slide.
|
|
| getSlideItemThumbnail () | |
| Return the thumbnail to use for this slide
item. |
|
| getSlideItemIndicators () | |
| Return the indicator to use for this slide
item. |
|
| getHotkeyImage () | |
| Return the hotkey indicator image. |
|
| getSlideUi () | |
| Return the slide UI corresponding to the given slide id.
|
|
| createSlideUi () | |
| createItemUi () | |
| createOpenCloseUi () | |
| deleteSlideUi () | |
| deleteItemUi () | |
| deleteOpenCloseUi () | |
| setSlideOpen () | |
| setOpenCloseItemOpen () | |
| setSlideDraggable () | |
| setSlideItemLabel () | |
| Set the label for a slide item. |
|
| changeDuration () | |
| Rename the slide corresponding to the
argument slide UI.
|
|
| renameSlide () | |
| Rename the slide corresponding to the
argument slide UI.
|
|
| deleteSlide () | |
| Delete the slide corresponding to the
argument slide UI.
|
|
| onClose () | |
| Called when user clicks on "Close" button.
|
|
| onCreate () | |
| Called when user clicks on "Create" button.
|
|
| onCreateEmptySlide () | |
| Called when user chooses "Storyboard Slide"
from create context menu. |
|
| onCreateSlide () | |
| Called when user chooses "Slide from Scene"
from create context menu. |
|
| onSavePresentation () | |
| Called when user chooses "Presentation from
Slides" from create context menu. |
|
| onScrollLeft () | |
| Called when user clicks on scroll left
button. |
|
| onScrollRight () | |
| Called when user clicks on scroll right
button. |
|
| onScroll () | |
| Called when user drags scroll bar. |
|
| onSlide () | |
| Called when user clicks on a slide. |
|
| onSlideContextMenu () | |
| Called when user right clicks on a slide.
|
|
| onSlideDoubleClick () | |
| Called when user double clicks on a slide.
|
|
| onRenameDoubleClick () | |
| Called when user double clicks on a slide.
|
|
| onDurationDoubleClick () | |
| Called when user double clicks on a slide.
|
|
| onSlideDrag () | |
| Called when user drags a slide. |
|
| onSlideDrop () | |
| Called when user drops something on a slide.
|
|
| onSlideItem () | |
| Called when user clicks on a slide item.
|
|
| onSlideItemContextMenu () | |
| Called when user right clicks on a slide
item. |
|
| onSlideItemDrag () | |
| Called when user drags a slide item.
|
|
| onSlideItemDrop () | |
| Called when user drops something on a slide
item. |
|
| onOpenCloseItem () | |
| Called when user clicks on a slide's
open/close item. |
|
| onSlidePlay () | |
| Called when user chooses Play from slide
context menu. |
|
| onSlidePlayAll () | |
| onSlidePlayStop () | |
| onSlidePlayPause () | |
| onSlidePlayResume () | |
| onSlideInsert () | |
| Called when user chooses Insert from slide
context menu. |
|
| onSlideDuplicate () | |
| Called when user chooses Duplicate from
slide context menu. |
|
| onSlideRename () | |
| Called when user chooses Rename from slide
context menu. |
|
| onSlideChangeDuration () | |
| Called when user chooses Rename from slide
context menu. |
|
| onSlideSetImage () | |
| Called when user chooses Set Image from
slide context menu. |
|
| onSlideSetKey () | |
| Called when user chooses Set Key from slide
context menu. |
|
| onSaveMovie () | |
| onProperties () | |
| onAddToTrigger () | |
| Called when user chooses activate by current
triggers from slide context menu. |
|
| onRemoveFromTriggers () | |
| Remove a given slide from all triggers that
it is associated with. |
|
| onSlideDelete () | |
| Called when user chooses Delete from slide
context menu. |
|
| onSlideItemDelete () | |
| Called when user chooses Delete from slide
item context menu. |
|
| onSlideItemActionChange () | |
| onSlideItemProperties () | |
| Called when user chooses Properties from
slide item context menu. |
|
| onBegin () | |
| Called when user clicks on Begin button.
|
|
| onEnd () | |
| Called when user clicks on End button.
|
|
| onPlay () | |
| Called when user clicks on Play button.
|
|
| onStop () | |
| Called when the user clicks on Stop button.
|
|
| onPrevious () | |
| Called when user clicks on Previous button.
|
|
| onNext () | |
| Called when user clicks on Next button.
|
|
| onLoop () | |
| getStoryboard () | |
| Return the Storyboard data. |
|
| setDocument () | |
| setAuthoringMode () | |
| getAllSlideUiItemsByName () | |
| getAllSlideUiItems () | |
| ALTERNATIVE_IMAGE_SET () | |
| ALTERNATIVE_RENAMED () | |
| ALTERNATIVE_CHANGED () | |
| This is sent when the alternative has
changed membership somehow, or if the image was re-set by undo.
|
|
| APPLICATION_CLOSE_SCENE () | |
| APPLICATION_MODE_CHANGED () | |
| BEHAVIOR_CHANGED () | |
| BEHAVIOR_THUMBNAIL_SAVED () | |
| ENVIRONMENT_THUMBNAIL_SAVED () | |
| ENVIRONMENT_RENAMED () | |
| UPDATE_DELAYED () | |
| HOTKEY_ASSIGNED () | |
| DOCUMENT_LOADED () | |
| SHOT_PLAYING_DONE () | |
| SHOT_PLAY_SINGLE () | |
| Listen to SHOT_PLAY_SINGLE instead of
SHOT_STARTED so we can update the playing indicator before the fade
in from black happens. |
|
| SHOT_RENAMED () | |
| SHOT_THUMBNAIL_SAVED () | |
| SHOT_TYPE_CHANGED () | |
| SLIDE_CREATED () | |
| SLIDE_DELETED () | |
| SLIDE_DUPLICATED () | |
| SLIDE_THUMBNAIL_SAVED () | |
| SLIDE_MODEL_ID_CHANGED () | |
| SLIDE_ITEM_ADDED () | |
| SLIDE_ITEM_CHANGED () | |
| SLIDE_ITEM_POSITION_CHANGED () | |
| SLIDE_ITEM_REMOVED () | |
| SLIDE_PLAY_STARTED () | |
| SLIDE_PLAY_ENDED () | |
| SLIDE_PLAY_PAUSED () | |
| SLIDE_PLAY_RESUMED () | |
| SLIDE_POSITION_CHANGED () | |
| SLIDE_DURATION_CHANGED () | |
| SLIDE_RENAMED () | |
| STAGE_ACTIVE_LIST () | |
| STAGE_OPENED () | |
| STORYBOARD_LOOP_CHANGED () | |
| STORYBOARD_UI_SET_MODE () | |
| TRIGGER_ITEM_ADDED () | |
| BEHAVIOR_DELETED () | |
Member Function Documentation
| StoryboardUi.StoryboardUi.__init__ | ( | ) |
Reimplemented from UiSelector.OverlayUiNew.
| StoryboardUi.StoryboardUi.getLayout | ( | ) |
| StoryboardUi.StoryboardUi.setDirty | ( | ) |
Call to indicate refresh required.
| StoryboardUi.StoryboardUi.isDirty | ( | ) |
Return True if refresh is required.
| StoryboardUi.StoryboardUi.setDirtyScrollItem | ( | ) |
Set the scroll item.
| StoryboardUi.StoryboardUi.getDirtyScrollItem | ( | ) |
Return the scroll item.
| StoryboardUi.StoryboardUi.inAuthoringMode | ( | ) |
| StoryboardUi.StoryboardUi.setViewportId | ( | ) |
| StoryboardUi.StoryboardUi.setSlidePlaying | ( | ) |
| StoryboardUi.StoryboardUi.setSlidePlayState | ( | ) |
| StoryboardUi.StoryboardUi.getSlidePlaying | ( | ) |
| StoryboardUi.StoryboardUi.setShotPlaying | ( | ) |
| StoryboardUi.StoryboardUi.getShotPlaying | ( | ) |
| StoryboardUi.StoryboardUi.updateVisibility | ( | ) |
| StoryboardUi.StoryboardUi.doCreate | ( | ) |
| StoryboardUi.StoryboardUi.doCleanup | ( | ) |
Reimplemented from UiSelector.OverlayUiNew.
| StoryboardUi.StoryboardUi.doLayout | ( | ) |
Reimplemented from UiSelector.OverlayUiNew.
| StoryboardUi.StoryboardUi.doItemLayout | ( | ) |
Apply the item layout information to the corresponding item controls.
| StoryboardUi.StoryboardUi.updateActiveIndicator | ( | ) |
Update visibility and position of active slide indicator.
| StoryboardUi.StoryboardUi.updateShotPlayingIndicator | ( | ) |
Update visibility and position of shot playing indicator.
| StoryboardUi.StoryboardUi.updateCreateButton | ( | ) |
Update visibility of create button.
For now, the create button is only visible in authoring mode.
| StoryboardUi.StoryboardUi.updateLoopButton | ( | ) |
| StoryboardUi.StoryboardUi.updateScrollButtons | ( | ) |
Update visibility of scroll buttons.
The buttons should only be visible if the user is able to scroll in the corresponding direction.
| StoryboardUi.StoryboardUi.updateScrollBar | ( | ) |
Update range and value of scroll bar.
| StoryboardUi.StoryboardUi.updateSlideControl | ( | ) |
Update the value of a slide control to match the selected state of a slide item.
| StoryboardUi.StoryboardUi.clearSlideSelection | ( | ) |
Clear the slide selection.
| StoryboardUi.StoryboardUi.selectSlide | ( | ) |
Select a slide.
| StoryboardUi.StoryboardUi.getSlideSelection | ( | ) |
Return a sequence containing all the selected slides.
| StoryboardUi.StoryboardUi.getEmptySlideThumbnail | ( | ) |
| StoryboardUi.StoryboardUi.getDefaultSlideThumbnail | ( | ) |
| StoryboardUi.StoryboardUi.getAlternativeThumbnail | ( | ) |
Find the alternative in the document and figure out which thumbnail to display.
| StoryboardUi.StoryboardUi.getDefaultAlternativeThumbnail | ( | ) |
| StoryboardUi.StoryboardUi.getDefaultBehaviorThumbnail | ( | ) |
Returns the default thumbnail image for a behavior, based on its type.
| StoryboardUi.StoryboardUi.getActionIndicator | ( | ) |
| StoryboardUi.StoryboardUi.getSlideThumbnail | ( | ) |
Return the thumbnail to use for this slide.
| StoryboardUi.StoryboardUi.getSlideItemThumbnail | ( | ) |
Return the thumbnail to use for this slide item.
| StoryboardUi.StoryboardUi.getSlideItemIndicators | ( | ) |
Return the indicator to use for this slide item.
| StoryboardUi.StoryboardUi.getHotkeyImage | ( | ) |
Return the hotkey indicator image.
| StoryboardUi.StoryboardUi.getSlideUi | ( | ) |
Return the slide UI corresponding to the given slide id.
| StoryboardUi.StoryboardUi.createSlideUi | ( | ) |
| StoryboardUi.StoryboardUi.createItemUi | ( | ) |
| StoryboardUi.StoryboardUi.createOpenCloseUi | ( | ) |
| StoryboardUi.StoryboardUi.deleteSlideUi | ( | ) |
| StoryboardUi.StoryboardUi.deleteItemUi | ( | ) |
| StoryboardUi.StoryboardUi.deleteOpenCloseUi | ( | ) |
| StoryboardUi.StoryboardUi.setSlideOpen | ( | ) |
| StoryboardUi.StoryboardUi.setOpenCloseItemOpen | ( | ) |
| StoryboardUi.StoryboardUi.setSlideDraggable | ( | ) |
| StoryboardUi.StoryboardUi.setSlideItemLabel | ( | ) |
Set the label for a slide item.
Updating the corresponding control if necessary.
| StoryboardUi.StoryboardUi.changeDuration | ( | ) |
Rename the slide corresponding to the argument slide UI.
| StoryboardUi.StoryboardUi.renameSlide | ( | ) |
Rename the slide corresponding to the argument slide UI.
| StoryboardUi.StoryboardUi.deleteSlide | ( | ) |
Delete the slide corresponding to the argument slide UI.
| StoryboardUi.StoryboardUi.onClose | ( | ) |
Called when user clicks on "Close" button.
| StoryboardUi.StoryboardUi.onCreate | ( | ) |
Called when user clicks on "Create" button.
| StoryboardUi.StoryboardUi.onCreateEmptySlide | ( | ) |
Called when user chooses "Storyboard Slide" from create context menu.
| StoryboardUi.StoryboardUi.onCreateSlide | ( | ) |
Called when user chooses "Slide from Scene" from create context menu.
| StoryboardUi.StoryboardUi.onSavePresentation | ( | ) |
Called when user chooses "Presentation from Slides" from create context menu.
| StoryboardUi.StoryboardUi.onScrollLeft | ( | ) |
Called when user clicks on scroll left button.
| StoryboardUi.StoryboardUi.onScrollRight | ( | ) |
Called when user clicks on scroll right button.
| StoryboardUi.StoryboardUi.onScroll | ( | ) |
Called when user drags scroll bar.
| StoryboardUi.StoryboardUi.onSlide | ( | ) |
Called when user clicks on a slide.
| StoryboardUi.StoryboardUi.onSlideContextMenu | ( | ) |
Called when user right clicks on a slide.
| StoryboardUi.StoryboardUi.onSlideDoubleClick | ( | ) |
Called when user double clicks on a slide.
| StoryboardUi.StoryboardUi.onRenameDoubleClick | ( | ) |
Called when user double clicks on a slide.
| StoryboardUi.StoryboardUi.onDurationDoubleClick | ( | ) |
Called when user double clicks on a slide.
| StoryboardUi.StoryboardUi.onSlideDrag | ( | ) |
Called when user drags a slide.
| StoryboardUi.StoryboardUi.onSlideDrop | ( | ) |
Called when user drops something on a slide.
| StoryboardUi.StoryboardUi.onSlideItem | ( | ) |
Called when user clicks on a slide item.
| StoryboardUi.StoryboardUi.onSlideItemContextMenu | ( | ) |
Called when user right clicks on a slide item.
| StoryboardUi.StoryboardUi.onSlideItemDrag | ( | ) |
Called when user drags a slide item.
| StoryboardUi.StoryboardUi.onSlideItemDrop | ( | ) |
Called when user drops something on a slide item.
| StoryboardUi.StoryboardUi.onOpenCloseItem | ( | ) |
Called when user clicks on a slide's open/close item.
| StoryboardUi.StoryboardUi.onSlidePlay | ( | ) |
Called when user chooses Play from slide context menu.
| StoryboardUi.StoryboardUi.onSlidePlayAll | ( | ) |
| StoryboardUi.StoryboardUi.onSlidePlayStop | ( | ) |
| StoryboardUi.StoryboardUi.onSlidePlayPause | ( | ) |
| StoryboardUi.StoryboardUi.onSlidePlayResume | ( | ) |
| StoryboardUi.StoryboardUi.onSlideInsert | ( | ) |
Called when user chooses Insert from slide context menu.
| StoryboardUi.StoryboardUi.onSlideDuplicate | ( | ) |
Called when user chooses Duplicate from slide context menu.
| StoryboardUi.StoryboardUi.onSlideRename | ( | ) |
Called when user chooses Rename from slide context menu.
| StoryboardUi.StoryboardUi.onSlideChangeDuration | ( | ) |
Called when user chooses Rename from slide context menu.
| StoryboardUi.StoryboardUi.onSlideSetImage | ( | ) |
Called when user chooses Set Image from slide context menu.
| StoryboardUi.StoryboardUi.onSlideSetKey | ( | ) |
Called when user chooses Set Key from slide context menu.
| StoryboardUi.StoryboardUi.onSaveMovie | ( | ) |
| StoryboardUi.StoryboardUi.onProperties | ( | ) |
| StoryboardUi.StoryboardUi.onAddToTrigger | ( | ) |
Called when user chooses activate by current triggers from slide context menu.
| StoryboardUi.StoryboardUi.onRemoveFromTriggers | ( | ) |
Remove a given slide from all triggers that it is associated with.
| StoryboardUi.StoryboardUi.onSlideDelete | ( | ) |
Called when user chooses Delete from slide context menu.
| StoryboardUi.StoryboardUi.onSlideItemDelete | ( | ) |
Called when user chooses Delete from slide item context menu.
| StoryboardUi.StoryboardUi.onSlideItemActionChange | ( | ) |
| StoryboardUi.StoryboardUi.onSlideItemProperties | ( | ) |
Called when user chooses Properties from slide item context menu.
| StoryboardUi.StoryboardUi.onBegin | ( | ) |
Called when user clicks on Begin button.
| StoryboardUi.StoryboardUi.onEnd | ( | ) |
Called when user clicks on End button.
| StoryboardUi.StoryboardUi.onPlay | ( | ) |
Called when user clicks on Play button.
| StoryboardUi.StoryboardUi.onStop | ( | ) |
Called when the user clicks on Stop button.
| StoryboardUi.StoryboardUi.onPrevious | ( | ) |
Called when user clicks on Previous button.
| StoryboardUi.StoryboardUi.onNext | ( | ) |
Called when user clicks on Next button.
| StoryboardUi.StoryboardUi.onLoop | ( | ) |
| StoryboardUi.StoryboardUi.getStoryboard | ( | ) |
Return the Storyboard data.
| StoryboardUi.StoryboardUi.setDocument | ( | ) |
| StoryboardUi.StoryboardUi.setAuthoringMode | ( | ) |
| StoryboardUi.StoryboardUi.getAllSlideUiItemsByName | ( | ) |
| StoryboardUi.StoryboardUi.getAllSlideUiItems | ( | ) |
| StoryboardUi.StoryboardUi.ALTERNATIVE_IMAGE_SET | ( | ) |
| StoryboardUi.StoryboardUi.ALTERNATIVE_RENAMED | ( | ) |
| StoryboardUi.StoryboardUi.ALTERNATIVE_CHANGED | ( | ) |
This is sent when the alternative has changed membership somehow, or if the image was re-set by undo.
The thumbnail should be updated here.
| StoryboardUi.StoryboardUi.APPLICATION_CLOSE_SCENE | ( | ) |
| StoryboardUi.StoryboardUi.APPLICATION_MODE_CHANGED | ( | ) |
| StoryboardUi.StoryboardUi.BEHAVIOR_CHANGED | ( | ) |
| StoryboardUi.StoryboardUi.BEHAVIOR_THUMBNAIL_SAVED | ( | ) |
| StoryboardUi.StoryboardUi.ENVIRONMENT_THUMBNAIL_SAVED | ( | ) |
| StoryboardUi.StoryboardUi.ENVIRONMENT_RENAMED | ( | ) |
| StoryboardUi.StoryboardUi.UPDATE_DELAYED | ( | ) |
| StoryboardUi.StoryboardUi.HOTKEY_ASSIGNED | ( | ) |
| StoryboardUi.StoryboardUi.DOCUMENT_LOADED | ( | ) |
| StoryboardUi.StoryboardUi.SHOT_PLAYING_DONE | ( | ) |
| StoryboardUi.StoryboardUi.SHOT_PLAY_SINGLE | ( | ) |
Listen to SHOT_PLAY_SINGLE instead of SHOT_STARTED so we can update the playing indicator before the fade in from black happens.
| StoryboardUi.StoryboardUi.SHOT_RENAMED | ( | ) |
| StoryboardUi.StoryboardUi.SHOT_THUMBNAIL_SAVED | ( | ) |
| StoryboardUi.StoryboardUi.SHOT_TYPE_CHANGED | ( | ) |
| StoryboardUi.StoryboardUi.SLIDE_CREATED | ( | ) |
| StoryboardUi.StoryboardUi.SLIDE_DELETED | ( | ) |
| StoryboardUi.StoryboardUi.SLIDE_DUPLICATED | ( | ) |
| StoryboardUi.StoryboardUi.SLIDE_THUMBNAIL_SAVED | ( | ) |
| StoryboardUi.StoryboardUi.SLIDE_MODEL_ID_CHANGED | ( | ) |
| StoryboardUi.StoryboardUi.SLIDE_ITEM_ADDED | ( | ) |
| StoryboardUi.StoryboardUi.SLIDE_ITEM_CHANGED | ( | ) |
| StoryboardUi.StoryboardUi.SLIDE_ITEM_POSITION_CHANGED | ( | ) |
| StoryboardUi.StoryboardUi.SLIDE_ITEM_REMOVED | ( | ) |
| StoryboardUi.StoryboardUi.SLIDE_PLAY_STARTED | ( | ) |
| StoryboardUi.StoryboardUi.SLIDE_PLAY_ENDED | ( | ) |
| StoryboardUi.StoryboardUi.SLIDE_PLAY_PAUSED | ( | ) |
| StoryboardUi.StoryboardUi.SLIDE_PLAY_RESUMED | ( | ) |
| StoryboardUi.StoryboardUi.SLIDE_POSITION_CHANGED | ( | ) |
| StoryboardUi.StoryboardUi.SLIDE_DURATION_CHANGED | ( | ) |
| StoryboardUi.StoryboardUi.SLIDE_RENAMED | ( | ) |
| StoryboardUi.StoryboardUi.STAGE_ACTIVE_LIST | ( | ) |
| StoryboardUi.StoryboardUi.STAGE_OPENED | ( | ) |
| StoryboardUi.StoryboardUi.STORYBOARD_LOOP_CHANGED | ( | ) |
| StoryboardUi.StoryboardUi.STORYBOARD_UI_SET_MODE | ( | ) |
| StoryboardUi.StoryboardUi.TRIGGER_ITEM_ADDED | ( | ) |
| StoryboardUi.StoryboardUi.BEHAVIOR_DELETED | ( | ) |
