Harmony
Scripting Interface Documentation
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

bool isWindowsArch ()
 Query if current platform is Windows. More...
 
bool isLinuxArch ()
 Query if current platform is Linux. More...
 
bool isMacArch ()
 Query if current platform is Mac. More...
 
bool isMacIntelArch ()
 Query if current platform is Mac Intel. More...
 
bool isMacPpcArch ()
 Query if current platform is Mac Power PC. More...
 
String getApplicationPath ()
 Query current application folder. More...
 
String getBinaryPath ()
 Query common binary folder. More...
 
String getResourcesPath ()
 Query common resources folder. More...
 
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 windowsArch
 Current platform is Windows. More...
 
bool linuxArch
 Current platform is Linux. More...
 
bool macArch
 Current platform is Mac. More...
 
bool macIntelArch
 Current platform is Mac Intel. More...
 
bool macPpcArch
 Current platform is Mac Power PC. More...
 
String applicationPath
 Application with GUI folder (different than binFolder on Mac. Same for all other platforms ). More...
 
String binaryPath
 Common binary folder. More...
 
String resourcesPath
 Common resources folder. More...
 
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 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 userName
 

Detailed Description

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

Returns information about the current application running the script and its environment. You can use it in both Script Editor and scriptModule.

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( "OSX PowerPC architecture: " + about.macPpcArch );
print( "OSX Intel architecture: " + about.macIntelArch );
print( "Linux architecture: " + about.linuxArch );
print( "Interactive: " + about.interactiveApp );
// Architecture
print( "StageMain 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 [1/2]

String about::getApplicationPath ( )
slot

Query current application folder.

◆ getApplicationPath [2/2]

String about::getApplicationPath ( )
slot

returns the application. Identical to property "applicationPath".

◆ getBinaryPath [1/2]

String about::getBinaryPath ( )
slot

Query common binary folder.

◆ getBinaryPath [2/2]

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 [1/2]

String about::getResourcesPath ( )
slot

Query common resources folder.

◆ getResourcesPath [2/2]

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 [1/2]

bool about::isLinuxArch ( )
slot

Query if current platform is Linux.

◆ isLinuxArch [2/2]

bool about::isLinuxArch ( )
slot

returns true when running on Linux.

◆ isMacArch [1/2]

bool about::isMacArch ( )
slot

Query if current platform is Mac.

◆ isMacArch [2/2]

bool about::isMacArch ( )
slot

returns true when running on MacOS.

◆ isMacIntelArch [1/2]

bool about::isMacIntelArch ( )
slot

Query if current platform is Mac Intel.

◆ isMacIntelArch [2/2]

bool about::isMacIntelArch ( )
slot

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

◆ isMacPpcArch [1/2]

bool about::isMacPpcArch ( )
slot

Query if current platform is Mac Power PC.

◆ isMacPpcArch [2/2]

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 [1/2]

bool about::isWindowsArch ( )
slot

Query if current platform is Windows.

◆ isWindowsArch [2/2]

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 ).

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

◆ binaryPath

String about::binaryPath
read

Common binary folder.

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

Current platform is Linux.

See isLinuxArch.

◆ macArch

bool about::macArch
read

Current platform is Mac.

See isMasArch.

◆ macIntelArch

bool about::macIntelArch
read

Current platform is Mac Intel.

See isMacIntelArch.

◆ macPpcArch

bool about::macPpcArch
read

Current platform is Mac Power PC.

See isMacIntelArch.

◆ mainApp

bool about::mainApp
read

See isMainApp.

◆ paintMode

bool about::paintMode
read

See isPaintMode.

◆ resourcesPath

String about::resourcesPath
read

Common resources folder.

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

Current platform is Windows.

See isWindorsArch.

◆ xsheetMode

bool about::xsheetMode
read

See isXsheetMode.