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

#include <captionManager.h>

Inheritance diagram for CaptionManager:

Collaboration diagram for CaptionManager:

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

bool CaptionManager::addPanelCaption ( String & name )

slot

adds a panel caption

Parameters

name	title of Caption

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

slot

adds a panel sketch

Parameters

name	title of Caption
panelId	uniqueId of panel

bool CaptionManager::addProjectCaption ( String & name )

slot

adds a project caption

Parameters

name	title of Caption

bool CaptionManager::deletePanelCaption ( String & name )

slot

deletes a panel caption

Parameters

name	title of Caption

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

slot

deletes a panel sketch

Parameters

name	title of Caption
panelId	uniqueId of panel

bool CaptionManager::deleteProjectCaption ( String & name )

slot

deletes a project caption

Parameters

name	title of Caption

String CaptionManager::nameOfPanelCaption ( int index )

slot

returns name of the panel caption at index

Parameters

index ith caption in list

String CaptionManager::nameOfProjectCaption ( int index )

slot

returns name of the panel caption at index

Parameters

index ith position in list

int CaptionManager::numberOfPanelCaptions ( )

slot

returns number of panel captions

int CaptionManager::numberOfProjectCaptions ( )

slot

returns number of project captions

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

slot

renames a panel caption

Parameters

name	existing title of Caption
newName	new title of Caption

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

slot

renames a panel sketch

Parameters

name	title of Caption
panelId	uniqueId of panel
newName	new title of Caption

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

slot

renames a project caption

Parameters

name	title of Caption
newName	new title of Caption

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

slot

sets text on a panel caption

Parameters

name	title of Caption
panelId	uniqueId of panel
text	new text

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

slot

sets new text in a project caption

Parameters

name	title of Caption
text	new text

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

slot

returns text of the panel caption

Parameters

name	title of Caption
panelId	uniqueId of panel

String CaptionManager::textOfProjectCaption ( String & name )

slot

returns text of the project caption

Parameters

name	title of Caption

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

dox_files/captionManager.h

Public Slots

Detailed Description

Member Function Documentation