Storyboard Pro
Scripting Interface Documentation
CaptionManager Class Reference

This interface is used to access caption properties. Note that the text in captions is in html format. More...

Public Slots

Panel
int numberOfPanelCaptions ()
 returns number of panel captions More...
 
String nameOfPanelCaption (int index)
 returns name of the panel caption at index More...
 
String textOfPanelCaption (String &name, String &panelId)
 returns text of the panel caption More...
 
bool addPanelCaption (String &name)
 adds a panel caption More...
 
bool addPanelSketch (String &name, String &panelId)
 adds a panel sketch More...
 
bool deletePanelCaption (String &name)
 deletes a panel caption More...
 
bool deletePanelSketch (String &name, String &panelId)
 deletes a panel sketch More...
 
bool renamePanelCaption (String &name, String &newName)
 renames a panel caption More...
 
bool renamePanelSketch (String &name, String &panelId, String &newName)
 renames a panel sketch More...
 
bool setPanelCaptionText (String &name, String &panelId, String &text)
 sets text on a panel caption More...
 
Project
int numberOfProjectCaptions ()
 returns number of project captions More...
 
String nameOfProjectCaption (int index)
 returns name of the panel caption at index More...
 
bool addProjectCaption (String &name)
 adds a project caption More...
 
String textOfProjectCaption (String &name)
 returns text of the project caption More...
 
bool deleteProjectCaption (String &name)
 deletes a project caption More...
 
bool renameProjectCaption (String &name, String &newName)
 renames a project caption More...
 
bool setProjectCaptionText (String &name, String &text)
 sets new text in a project caption More...
 

Detailed Description

This interface is used to access caption properties. Note that the text in captions is in html format.

The following examples are provided:

var cm = new CaptionManager();
var sb = new StoryboardManager();
// Retrieve the first panel in the project.
var panelId = sb.panelInProject(0);
var str = "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0//EN\" \"http://www.w3.org/TR/REC-html40/strict.dtd\">
<html><head><meta name=\"qrichtext\" content=\"1\" /><style type=\"text/css\">
p, li { white-space: pre-wrap; }
</style></head><body style=\" font-family:'Sans Serif'; font-size:9pt; font-weight:400; font-style:normal;\">
<p style=\" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;\">New Text</p></body></html>";
// Add a caption named Private Notes, and assign the string to the caption in the first panel
if ( cm.addPanelCaption("Private Notes") )
cm.setPanelCaptionText( "Private Notes", panelId, str );

Member Function Documentation

◆ addPanelCaption

bool CaptionManager::addPanelCaption ( String &  name)
slot

adds a panel caption

Parameters
nametitle of Caption

◆ addPanelSketch

bool CaptionManager::addPanelSketch ( String &  name,
String &  panelId 
)
slot

adds a panel sketch

Parameters
nametitle of Caption
panelIduniqueId of panel

◆ addProjectCaption

bool CaptionManager::addProjectCaption ( String &  name)
slot

adds a project caption

Parameters
nametitle of Caption

◆ deletePanelCaption

bool CaptionManager::deletePanelCaption ( String &  name)
slot

deletes a panel caption

Parameters
nametitle of Caption

◆ deletePanelSketch

bool CaptionManager::deletePanelSketch ( String &  name,
String &  panelId 
)
slot

deletes a panel sketch

Parameters
nametitle of Caption
panelIduniqueId of panel

◆ deleteProjectCaption

bool CaptionManager::deleteProjectCaption ( String &  name)
slot

deletes a project caption

Parameters
nametitle of Caption

◆ nameOfPanelCaption

String CaptionManager::nameOfPanelCaption ( int  index)
slot

returns name of the panel caption at index

Parameters
indexith caption in list

◆ nameOfProjectCaption

String CaptionManager::nameOfProjectCaption ( int  index)
slot

returns name of the panel caption at index

Parameters
indexith position in list

◆ numberOfPanelCaptions

int CaptionManager::numberOfPanelCaptions ( )
slot

returns number of panel captions

◆ numberOfProjectCaptions

int CaptionManager::numberOfProjectCaptions ( )
slot

returns number of project captions

◆ renamePanelCaption

bool CaptionManager::renamePanelCaption ( String &  name,
String &  newName 
)
slot

renames a panel caption

Parameters
nameexisting title of Caption
newNamenew title of Caption

◆ renamePanelSketch

bool CaptionManager::renamePanelSketch ( String &  name,
String &  panelId,
String &  newName 
)
slot

renames a panel sketch

Parameters
nametitle of Caption
panelIduniqueId of panel
newNamenew title of Caption

◆ renameProjectCaption

bool CaptionManager::renameProjectCaption ( String &  name,
String &  newName 
)
slot

renames a project caption

Parameters
nametitle of Caption
newNamenew title of Caption

◆ setPanelCaptionText

bool CaptionManager::setPanelCaptionText ( String &  name,
String &  panelId,
String &  text 
)
slot

sets text on a panel caption

Parameters
nametitle of Caption
panelIduniqueId of panel
textnew text

◆ setProjectCaptionText

bool CaptionManager::setProjectCaptionText ( String &  name,
String &  text 
)
slot

sets new text in a project caption

Parameters
nametitle of Caption
textnew text

◆ textOfPanelCaption

String CaptionManager::textOfPanelCaption ( String &  name,
String &  panelId 
)
slot

returns text of the panel caption

Parameters
nametitle of Caption
panelIduniqueId of panel

◆ textOfProjectCaption

String CaptionManager::textOfProjectCaption ( String &  name)
slot

returns text of the project caption

Parameters
nametitle of Caption