Storyboard
List of all members
SelectionManager Class Reference

This interface is used to access the GUI storyboard selection. In batch mode, this interface is a no-op. More...

#include <selectionManager.h>

Inheritance diagram for SelectionManager:
Inheritance graph
[legend]
Collaboration diagram for SelectionManager:
Collaboration graph
[legend]

Public Slots

Getters
StringList getSequenceSelection ()
 returns list of selected sequences
 
StringList getSceneSelection ()
 returns list of selected scenes
 
StringList getPanelSelection ()
 returns list of selected panels
 
Setters
bool clearSelection ()
 Clear selection.
 
bool selectAll ()
 Select All.
 
bool setPanelSelection (StringList &l)
 set Selected Panels
 
bool setSceneSelection (StringList &l)
 set Selected Scenes
 
bool setSequenceSelection (StringList &l)
 set Selected Sequences
 
bool setCurrentPanel (String &panelId)
 sets the current panel and moves the playhead
 

Detailed Description

This interface is used to access the GUI storyboard selection. In batch mode, this interface is a no-op.

The following examples are provided:

var selection = new SelectionManager();
var storybd = new StoryboardManager();
var selIds = new Array(0);
selIds = selection.getSequenceSelection();
for ( var i = 0; i < selIds.length; ++ i )
System.println( " seq " + selIds[i] + " : " + storybd.nameOfSequence( selIds[i] ) )
selIds = selection.getSceneSelection();
for ( var i = 0; i < selIds.length; ++ i )
System.println( " scene " + selIds[i] + " : " + storybd.nameOfScene( selIds[i] ) );
selIds = selection.getPanelSelection();
for ( var i = 0; i < selIds.length; ++ i )
System.println( " panel " + selIds[i] + " : " + storybd.nameOfPanel( selIds[i] ) );

Member Function Documentation

bool SelectionManager::clearSelection ( )
slot

Clear selection.

StringList SelectionManager::getPanelSelection ( )
slot

returns list of selected panels

StringList SelectionManager::getSceneSelection ( )
slot

returns list of selected scenes

StringList SelectionManager::getSequenceSelection ( )
slot

returns list of selected sequences

bool SelectionManager::selectAll ( )
slot

Select All.

bool SelectionManager::setCurrentPanel ( String &  panelId)
slot

sets the current panel and moves the playhead

Parameters
panelId- Unique id of Panel
bool SelectionManager::setPanelSelection ( StringList &  l)
slot

set Selected Panels

Parameters
l- Array of panel Ids.
bool SelectionManager::setSceneSelection ( StringList &  l)
slot

set Selected Scenes

Parameters
l- Array of scene Ids.
bool SelectionManager::setSequenceSelection ( StringList &  l)
slot

set Selected Sequences

Parameters
l- Array of sequence Ids.

The documentation for this class was generated from the following file: