about Class Reference

The about JavaScript global object. Provide information about the main application and the platform on which the script is running. More...

Public Slots

String getFlavorString ()
 returns a string that represents the flavor of the application, e.g. Harmony, More...
 
String getVersionInfoStr ()
 returns the version info string. More...
 
String productName ()
 returns a string that is the name of application. More...
 
bool isFullVersion ()
 returns true whenever this application is a Commercial/Full variant. More...
 
bool isDemoVersion ()
 returns true whenever this application is a Demo variant. More...
 
bool isEducVersion ()
 returns true whenever this application is an Educational variant. More...
 
bool isHarmony ()
 true when connected to a database or when compiled with Harmony. More...
 
bool isStageEssentials ()
 only true when running as Stage Essentials. More...
 
bool isStageAdvanced ()
 only true when running as Stage Advanced More...
 
bool isStage ()
 only true when running as Stage. More...
 
bool isStoryboard ()
 only true when running as Storyboard. More...
 
bool isWindowsArch ()
 returns true when running on Windows. More...
 
bool isLinuxArch ()
 returns true when running on Linux. More...
 
bool isMacArch ()
 returns true when running on MacOS. More...
 
bool isMacIntelArch ()
 returns true when running on an Apple OS X operating system and on a Mac Intel. More...
 
bool isMacPpcArch ()
 returns true when running on an Apple OS X operating system and on a Mac PowerPC. More...
 
bool isInteractiveApp ()
 returns true whenever this application is interactive. All application capable of running scripts are interactive. More...
 
bool isScanApp ()
 true when this application is Scan. More...
 
bool isMainApp ()
 returns true when this application is Stage, or Storyboard, and not a peripheral application. More...
 
bool isControlCenterApp ()
 returns true whenever this application running application is ControlCenter More...
 
bool isPaintMode ()
 returns true when this application is in Paint mode. More...
 
bool isXsheetMode ()
 returns true when this application is in Xsheet mode. More...
 
String getApplicationPath ()
 returns the application. Identical to property "applicationPath". More...
 
String getBinaryPath ()
 returns the folder where the binaries can be found. More...
 
String getResourcesPath ()
 returns the folder where the resources can be found. More...
 
String getUserName ()
 Return the user name. More...
 

Properties

bool fullVersion
 See isFullVersion. More...
 
bool demoVersion
 See isDemoVersion. More...
 
bool educVersion
 See isEducVersion. More...
 
bool harmony
 See isHarmony. More...
 
bool essentials
 See isStageEssentials. More...
 
bool advanced
 See isStageAdvanced. More...
 
bool state
 See isStage. More...
 
bool storyboard
 See isStoryboard. More...
 
bool windowsArch
 See isWindorsArch. More...
 
bool linuxArch
 See isLinuxArch. More...
 
bool macArch
 See isMasArch. More...
 
bool macIntelArch
 See isMacIntelArch. More...
 
bool macPpcArch
 See isMacIntelArch. More...
 
bool mainApp
 See isMainApp. More...
 
bool interactiveApp
 See isInteractiveApp. More...
 
bool scanApp
 See isScanApp. More...
 
bool controlCenterApp
 See isControlCenterApp. More...
 
bool paintMode
 See isPaintMode. More...
 
bool xsheetMode
 See isXsheetMode. More...
 
String applicationPath
 application with GUI folder (different than binFolder on Mac. Same for all other platforms ) More...
 
String binaryPath
 See getBinaryPath. More...
 
String userName
 
String resourcesPath
 See getResourcesPath. More...
 

Detailed Description

The about JavaScript global object. Provide information about the main application and the platform on which the script is running.

The about class allows to query platform and application specific constants.

function printAbout()
{
// Application: normal, demo or educational
print("");
print( "full (commercial) version: " + about.fullVersion );
print( "demo version: " + about.demoVersion );
print( "educational version: " + about.educVersion );
print( "harmony product : " + about.harmony );
print( "" );
print( "stage: " + about.stage );
// Software /product
print( "Windows architecture: " + about.windowsArch );
print( "OSX architecture: " + about.macArch );
print( "Linux architecture: " + about.linuxArch );
print( "Interactive: " + about.interactiveApp );
// Architecture
print( "Harmony mode: " + about.mainApp );
print( "Paint mode: " + about.paintMode );
print( "XSheet mode: " + about.xsheetMode );
// type of application
print( "Scan application: " + about.scanApp );
print( "ControlCenter application: " + about.controlCenterApp);
print( "application path: " + about.applicationPath );
}

Member Function Documentation

◆ getApplicationPath

String about::getApplicationPath ( )
slot

returns the application. Identical to property "applicationPath".

◆ getBinaryPath

String about::getBinaryPath ( )
slot

returns the folder where the binaries can be found.

◆ getFlavorString

String about::getFlavorString ( )
slot

returns a string that represents the flavor of the application, e.g. Harmony,

◆ getResourcesPath

String about::getResourcesPath ( )
slot

returns the folder where the resources can be found.

◆ getUserName

String about::getUserName ( )
slot

Return the user name.

◆ getVersionInfoStr

String about::getVersionInfoStr ( )
slot

returns the version info string.

◆ isControlCenterApp

bool about::isControlCenterApp ( )
slot

returns true whenever this application running application is ControlCenter

◆ isDemoVersion

bool about::isDemoVersion ( )
slot

returns true whenever this application is a Demo variant.

◆ isEducVersion

bool about::isEducVersion ( )
slot

returns true whenever this application is an Educational variant.

◆ isFullVersion

bool about::isFullVersion ( )
slot

returns true whenever this application is a Commercial/Full variant.

◆ isHarmony

bool about::isHarmony ( )
slot

true when connected to a database or when compiled with Harmony.

◆ isInteractiveApp

bool about::isInteractiveApp ( )
slot

returns true whenever this application is interactive. All application capable of running scripts are interactive.

◆ isLinuxArch

bool about::isLinuxArch ( )
slot

returns true when running on Linux.

◆ isMacArch

bool about::isMacArch ( )
slot

returns true when running on MacOS.

◆ isMacIntelArch

bool about::isMacIntelArch ( )
slot

returns true when running on an Apple OS X operating system and on a Mac Intel.

◆ isMacPpcArch

bool about::isMacPpcArch ( )
slot

returns true when running on an Apple OS X operating system and on a Mac PowerPC.

◆ isMainApp

bool about::isMainApp ( )
slot

returns true when this application is Stage, or Storyboard, and not a peripheral application.

◆ isPaintMode

bool about::isPaintMode ( )
slot

returns true when this application is in Paint mode.

◆ isScanApp

bool about::isScanApp ( )
slot

true when this application is Scan.

◆ isStage

bool about::isStage ( )
slot

only true when running as Stage.

◆ isStageAdvanced

bool about::isStageAdvanced ( )
slot

only true when running as Stage Advanced

◆ isStageEssentials

bool about::isStageEssentials ( )
slot

only true when running as Stage Essentials.

◆ isStoryboard

bool about::isStoryboard ( )
slot

only true when running as Storyboard.

◆ isWindowsArch

bool about::isWindowsArch ( )
slot

returns true when running on Windows.

◆ isXsheetMode

bool about::isXsheetMode ( )
slot

returns true when this application is in Xsheet mode.

◆ productName

String about::productName ( )
slot

returns a string that is the name of application.

Property Documentation

◆ advanced

bool about::advanced
read

See isStageAdvanced.

◆ applicationPath

String about::applicationPath
read

application with GUI folder (different than binFolder on Mac. Same for all other platforms )

◆ binaryPath

String about::binaryPath
read

See getBinaryPath.

◆ controlCenterApp

bool about::controlCenterApp
read

See isControlCenterApp.

◆ demoVersion

bool about::demoVersion
read

See isDemoVersion.

◆ educVersion

bool about::educVersion
read

See isEducVersion.

◆ essentials

bool about::essentials
read

See isStageEssentials.

◆ fullVersion

bool about::fullVersion
read

See isFullVersion.

◆ harmony

bool about::harmony
read

See isHarmony.

◆ interactiveApp

bool about::interactiveApp
read

See isInteractiveApp.

◆ linuxArch

bool about::linuxArch
read

See isLinuxArch.

◆ macArch

bool about::macArch
read

See isMasArch.

◆ macIntelArch

bool about::macIntelArch
read

See isMacIntelArch.

◆ macPpcArch

bool about::macPpcArch
read

See isMacIntelArch.

◆ mainApp

bool about::mainApp
read

See isMainApp.

◆ paintMode

bool about::paintMode
read

See isPaintMode.

◆ resourcesPath

String about::resourcesPath
read

See getResourcesPath.

◆ scanApp

bool about::scanApp
read

See isScanApp.

◆ state

bool about::state
read

See isStage.

◆ storyboard

bool about::storyboard
read

See isStoryboard.

◆ userName

String about::userName
read

◆ windowsArch

bool about::windowsArch
read

See isWindorsArch.

◆ xsheetMode

bool about::xsheetMode
read

See isXsheetMode.