The about JavaScript global object. Provides 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...

int	getMajorVersion ()
	Returns the major version number. More...

int	getMinorVersion ()
	Returns the minor version number. More...

int	getPatchVersion ()
	Returns the patch version number. More...

int	getBuildNumber ()
	Returns the build number. 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 ()
	Returns true when connected to a database or when compiled with Harmony. More...

bool	isStageEssentials ()
	Returns true whenever the application running is an Essentials variant. More...

bool	isStageAdvanced ()
	Returns true whenever the application running is an Advanced variant. More...

bool	isStage ()
	Returns true whenever the application running is Stage. More...

bool	isStoryboard ()
	Returns true when running 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 or when on Mac Intel. More...

bool	isMacPpcArch ()
	Returns true when running on an Apple OS X operating system or when on Mac PowerPC. More...

bool	isInteractiveApp ()
	Returns true whenever this application is interactive. All application capable of running scripts are interactive. More...

bool	isScanApp ()
	Returns true when the application running is Scan. More...

bool	isMainApp ()
	Returns true when the application is Harmony or Storyboard, and not a peripheral application. More...

bool	isControlCenterApp ()
	Returns true whenever the application running application is ControlCenter. More...

bool	isPaintMode ()
	Returns true when the application is in Paint mode. More...

bool	isXsheetMode ()
	Returns true when the application is in Xsheet mode. More...

bool	isDatabaseMode ()
	Returns true when the application is in Database 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 ()
	Returns 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	stage
	See isStage(). More...

bool	storyboard
	See isStoryboard(). More...

bool	windowsArch
	See isWindowsArch(). More...

bool	linuxArch
	See isLinuxArch(). More...

bool	macArch
	See isMacArch(). 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
	See getUserName(). More...

String	resourcesPath
	See getResourcesPath(). More...

bool	databaseMode
	See isDatabaseMode(). More...

int	majorVersion
	See getMajorVersion. More...

int	minorVersion
	See getMinorVersion. More...

int	patchVersion
	See getPatchVersion. More...

int	buildNumber
	See getBuildNumber. More...

Detailed Description

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

The about class allows querying of platform and application specific constants.

function printAbout()
{
  // Application: full, demo or educational
  MessageLog.trace( "Full (commercial) version: " + about.fullVersion );
  MessageLog.trace( "Demo version: " + about.demoVersion );
  MessageLog.trace( "Educational version: " + about.educVersion );
  MessageLog.trace( "Harmony product : " + about.harmony );
  
  // Software/Product
  MessageLog.trace( "Windows architecture: " + about.windowsArch );
  MessageLog.trace( "OSX architecture: " + about.macArch );
  MessageLog.trace( "OSX PowerPC architecture: " + about.macPpcArch );
  MessageLog.trace( "OSC Intel architecture: " + about.macIntelArch );
  MessageLog.trace( "Linux architecture: " + about.linuxArch );
  MessageLog.trace( "Interactive: " + about.interactiveApp );
  // Architecture
  MessageLog.trace( "Harmony mode: " + about.mainApp );
  MessageLog.trace( "Paint mode: " + about.paintMode );
  MessageLog.trace( "XSheet mode: " + about.xsheetMode );
  // Type of Application
  MessageLog.trace( "Scan application: " + about.scanApp );
  MessageLog.trace( "ControlCenter application: " + about.controlCenterApp);
  MessageLog.trace( "Application path: " + about.applicationPath );
}

Member Function Documentation

◆ getApplicationPath

String about::getApplicationPath ( )

slot

Returns the application. Identical to property "applicationPath".

Returns: Returns the application.

◆ getBinaryPath

String about::getBinaryPath ( )

slot

Returns the folder where the binaries can be found.

Returns: Returns the folder where the binaries can be found.

◆ getBuildNumber

int about::getBuildNumber ( )

slot

Returns the build number.

Returns: The build version number.

◆ getFlavorString

String about::getFlavorString ( )

slot

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

Returns: Returns a string that represents the flavor of the application.

◆ getMajorVersion

int about::getMajorVersion ( )

slot

Returns the major version number.

Returns: The major version number.

◆ getMinorVersion

int about::getMinorVersion ( )

slot

Returns the minor version number.

Returns: The minor version number.

◆ getPatchVersion

int about::getPatchVersion ( )

slot

Returns the patch version number.

Returns: The patch version number.

◆ getResourcesPath

String about::getResourcesPath ( )

slot

Returns the folder where the resources can be found.

Returns: Returns the folder where the resources can be found.

◆ getUserName

String about::getUserName ( )

slot

Returns the user name.

Returns: Returns the user name.

◆ getVersionInfoStr

String about::getVersionInfoStr ( )

slot

Returns the version info string.

Returns: Returns the version info string.

◆ isControlCenterApp

bool about::isControlCenterApp ( )

slot

Returns true whenever the application running application is ControlCenter.

Returns: Returns true whenever the application is ControlCenter.

◆ isDatabaseMode

bool about::isDatabaseMode ( )

slot

Returns true when the application is in Database mode.

Returns: Returns true when the appplication is in Database mode.

◆ isDemoVersion

bool about::isDemoVersion ( )

slot

Returns true whenever this application is a Demo variant.

Returns: Returns true whenever this application is a Demo variant.

◆ isEducVersion

bool about::isEducVersion ( )

slot

Returns true whenever this application is an Educational variant.

Returns: Returns true whenever this application is an Educational variant.

◆ isFullVersion

bool about::isFullVersion ( )

slot

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

Returns: Returns true whenever this application is a Commercial/Full variant.

◆ isHarmony

bool about::isHarmony ( )

slot

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

Returns: Returns 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.

Returns: Returns true whenever this application is interactive.

◆ isLinuxArch

bool about::isLinuxArch ( )

slot

Returns true when running on Linux.

Returns: Returns true when running on Linux.

◆ isMacArch

bool about::isMacArch ( )

slot

Returns true when running on MacOS.

Returns: Returns true when running on MacOS.

◆ isMacIntelArch

bool about::isMacIntelArch ( )

slot

Returns true when running on an Apple OS X operating system or when on Mac Intel.

Returns: Returns true when running on an Apple OS X operating system or when on Mac Intel.

◆ isMacPpcArch

bool about::isMacPpcArch ( )

slot

Returns true when running on an Apple OS X operating system or when on Mac PowerPC.

Returns: Returns true when running on an Apple OS X operating system or when on Mac PowerPC.

◆ isMainApp

bool about::isMainApp ( )

slot

Returns true when the application is Harmony or Storyboard, and not a peripheral application.

Returns: Returns true when the application is Harmony or Storyboard.

◆ isPaintMode

bool about::isPaintMode ( )

slot

Returns true when the application is in Paint mode.

Returns: Returns true when the application is in Paint mode.

◆ isScanApp

bool about::isScanApp ( )

slot

Returns true when the application running is Scan.

Returns: Returns true when the application running is Scan.

◆ isStage

bool about::isStage ( )

slot

Returns true whenever the application running is Stage.

◆ isStageAdvanced

bool about::isStageAdvanced ( )

slot

Returns true whenever the application running is an Advanced variant.

◆ isStageEssentials

bool about::isStageEssentials ( )

slot

Returns true whenever the application running is an Essentials variant.

◆ isStoryboard

bool about::isStoryboard ( )

slot

Returns true when running Storyboard.

Returns: Returns true when running Storyboard.

◆ isWindowsArch

bool about::isWindowsArch ( )

slot

Returns true when running on Windows.

Returns: Returns true when running on Windows.

◆ isXsheetMode

bool about::isXsheetMode ( )

slot

Returns true when the application is in Xsheet mode.

Returns: Returns true when the 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().

◆ buildNumber

int about::buildNumber

read

See getBuildNumber.

◆ controlCenterApp

bool about::controlCenterApp

read

See isControlCenterApp().

◆ databaseMode

bool about::databaseMode

read

See isDatabaseMode().

◆ 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 isMacArch().

◆ macIntelArch

bool about::macIntelArch

read

See isMacIntelArch().

◆ macPpcArch

bool about::macPpcArch

read

See isMacIntelArch().

◆ mainApp

bool about::mainApp

read

See isMainApp().

◆ majorVersion

int about::majorVersion

read

See getMajorVersion.

◆ minorVersion

int about::minorVersion

read

See getMinorVersion.

◆ paintMode

bool about::paintMode

read

See isPaintMode().

◆ patchVersion

int about::patchVersion

read

See getPatchVersion.

◆ resourcesPath

String about::resourcesPath

read

See getResourcesPath().

◆ scanApp

bool about::scanApp

read

See isScanApp().

◆ stage

bool about::stage

read

See isStage().

◆ storyboard

bool about::storyboard

read

See isStoryboard().

◆ userName

String about::userName

read

See getUserName().

◆ windowsArch

bool about::windowsArch

read

See isWindowsArch().

◆ xsheetMode

bool about::xsheetMode

read

See isXsheetMode().

Public Slots

Properties

Detailed Description

Member Function Documentation

◆ getApplicationPath

◆ getBinaryPath

◆ getBuildNumber

◆ getFlavorString

◆ getMajorVersion

◆ getMinorVersion

◆ getPatchVersion

◆ getResourcesPath

◆ getUserName

◆ getVersionInfoStr

◆ isControlCenterApp

◆ isDatabaseMode

◆ isDemoVersion

◆ isEducVersion

◆ isFullVersion

◆ isHarmony

◆ isInteractiveApp

◆ isLinuxArch

◆ isMacArch

◆ isMacIntelArch

◆ isMacPpcArch

◆ isMainApp

◆ isPaintMode

◆ isScanApp

◆ isStage

◆ isStageAdvanced

◆ isStageEssentials

◆ isStoryboard

◆ isWindowsArch

◆ isXsheetMode

◆ productName

Property Documentation

◆ advanced

◆ applicationPath

◆ binaryPath

◆ buildNumber

◆ controlCenterApp

◆ databaseMode

◆ demoVersion

◆ educVersion

◆ essentials

◆ fullVersion

◆ harmony

◆ interactiveApp

◆ linuxArch

◆ macArch

◆ macIntelArch

◆ macPpcArch

◆ mainApp

◆ majorVersion

◆ minorVersion

◆ paintMode

◆ patchVersion

◆ resourcesPath

◆ scanApp

◆ stage

◆ storyboard

◆ userName

◆ windowsArch

◆ xsheetMode