Storyboard Pro
Scripting Interface Documentation
PropertiesManager Class Reference

This interface is used to access the properties of the storyboard project. More...

Public Slots

Property Getters and Setters
int getDuration ()
 returns the duration of the project in frames More...
 
bool setTitle (String &title)
 sets the project title More...
 
String getTitle ()
 gets the project title More...
 
bool setSubTitle (String &title)
 sets the project sub title More...
 
String getSubTitle ()
 gets the project sub title More...
 
bool setEpisodeTitle (String &title)
 sets the edisode title More...
 
String getEpisodeTitle ()
 gets the episode title More...
 
bool setCopyright (String &text)
 sets the project copyright text More...
 
String getCopyright ()
 gets the copyright string More...
 
bool setStartTime (unsigned int nbFrames)
 sets the project start time More...
 
unsigned int getStartTime ()
 returns the project start time More...
 
bool setFilmWidth (double width)
 sets the project film width More...
 
double getFilmWidth ()
 returns the project film width More...
 

Detailed Description

This interface is used to access the properties of the storyboard project.

The following examples are provided:

var props = new PropertiesManager;
props.setTitle("An Amazing Architectural Journey");
props.setSubTitle("Memoires of R. J. MacDonald");
props.setEpisodeTitle("The First Cruise Ship Arrives");

Member Function Documentation

◆ getCopyright

String PropertiesManager::getCopyright ( )
slot

gets the copyright string

◆ getDuration

int PropertiesManager::getDuration ( )
slot

returns the duration of the project in frames

◆ getEpisodeTitle

String PropertiesManager::getEpisodeTitle ( )
slot

gets the episode title

◆ getFilmWidth

double PropertiesManager::getFilmWidth ( )
slot

returns the project film width

◆ getStartTime

unsigned int PropertiesManager::getStartTime ( )
slot

returns the project start time

◆ getSubTitle

String PropertiesManager::getSubTitle ( )
slot

gets the project sub title

◆ getTitle

String PropertiesManager::getTitle ( )
slot

gets the project title

◆ setCopyright

bool PropertiesManager::setCopyright ( String &  text)
slot

sets the project copyright text

Parameters
texttext of copyright

◆ setEpisodeTitle

bool PropertiesManager::setEpisodeTitle ( String &  title)
slot

sets the edisode title

Parameters
titlenew episode title

◆ setFilmWidth

bool PropertiesManager::setFilmWidth ( double  width)
slot

sets the project film width

Parameters
widthwidth in inches

◆ setStartTime

bool PropertiesManager::setStartTime ( unsigned int  nbFrames)
slot

sets the project start time

Parameters
nbFramesnew start time

◆ setSubTitle

bool PropertiesManager::setSubTitle ( String &  title)
slot

sets the project sub title

Parameters
titlenew title

◆ setTitle

bool PropertiesManager::setTitle ( String &  title)
slot

sets the project title

Parameters
titlenew title