Script
Public Slots | Properties | List of all members
about Class Reference

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

#include <aboutinterface.h>

Inheritance diagram for about:
Inheritance graph
[legend]
Collaboration diagram for about:
Collaboration graph
[legend]

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 flavour 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

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

You can use it in both Script Editor and scriptModule.

function printAbout()
{
// Application: normal, deom or educationals
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

String about::getApplicationPath ( )
slot

Query current application folder.

String about::getApplicationPath ( )
slot

returns the application. Identical to property "applicationPath".

String about::getBinaryPath ( )
slot

Query common binary folder.

String about::getBinaryPath ( )
slot

returns the folder where the binaries can be found.

String about::getFlavorString ( )
slot

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

String about::getResourcesPath ( )
slot

Query common resources folder.

String about::getResourcesPath ( )
slot

returns the folder where the resources can be found.

String about::getUserName ( )
slot

Return the user name.

String about::getVersionInfoStr ( )
slot

returns the version info string.

bool about::isControlCenterApp ( )
slot

returns true whenever this application running application is ControlCenter

bool about::isDemoVersion ( )
slot

returns true whenever this application is a Demo variant.

bool about::isEducVersion ( )
slot

returns true whenever this application is an Educational variant.

bool about::isFullVersion ( )
slot

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

bool about::isHarmony ( )
slot

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

bool about::isInteractiveApp ( )
slot

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

bool about::isLinuxArch ( )
slot

Query if current platform is Linux.

bool about::isLinuxArch ( )
slot

returns true when running on linux.

bool about::isMacArch ( )
slot

Query if current platform is Mac.

bool about::isMacArch ( )
slot

returns true when running on MacOS.

bool about::isMacIntelArch ( )
slot

Query if current platform is Mac Intel.

bool about::isMacIntelArch ( )
slot

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

bool about::isMacPpcArch ( )
slot

Query if current platform is Mac Power PC.

bool about::isMacPpcArch ( )
slot

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

bool about::isMainApp ( )
slot

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

bool about::isPaintMode ( )
slot

returns true when this application is in Paint mode.

bool about::isScanApp ( )
slot

true when this application is Scan.

bool about::isStage ( )
slot

only true when running as Stage.

bool about::isStageAdvanced ( )
slot

only true when running as Stage Advanced

bool about::isStageEssentials ( )
slot

only true when running as Stage Essentials.

bool about::isStoryboard ( )
slot

only true when running as Storyboard.

bool about::isWindowsArch ( )
slot

Query if current platform is Windows.

bool about::isWindowsArch ( )
slot

returns true when running on Windows.

bool about::isXsheetMode ( )
slot

returns true when this application is in Xsheet mode.

String about::productName ( )
slot

returns a string that is the name of application.

Property Documentation

bool about::advanced
readprivate

See isStageAdvanced.

String about::applicationPath
readprivate

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 )

String about::binaryPath
readprivate

Common binary folder.

See getBinaryPath.

bool about::controlCenterApp
readprivate

See isControlCenterApp.

bool about::demoVersion
readprivate

See isDemoVersion.

bool about::educVersion
readprivate

See isEducVersion.

bool about::essentials
readprivate

See isStageEssentials.

bool about::fullVersion
readprivate

See isFullVersion.

bool about::harmony
readprivate

See isHarmony.

bool about::interactiveApp
readprivate

See isInteractiveApp.

bool about::linuxArch
readprivate

Current platform is Linux.

See isLinuxArch.

bool about::macArch
readprivate

Current platform is Mac.

See isMasArch.

bool about::macIntelArch
readprivate

Current platform is Mac Intel.

See isMacIntelArch.

bool about::macPpcArch
readprivate

Current platform is Mac Power PC.

See isMacIntelArch.

bool about::mainApp
readprivate

See isMainApp.

bool about::paintMode
readprivate

See isPaintMode.

String about::resourcesPath
readprivate

Common resources folder.

See getResourcesPath.

bool about::scanApp
readprivate

See isScanApp.

bool about::state
readprivate

See isStage.

bool about::storyboard
readprivate

See isStoryboard.

String about::userName
readprivate
bool about::windowsArch
readprivate

Current platform is Windows.

See isWindorsArch.

bool about::xsheetMode
readprivate

See isXsheetMode.


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