Scripting Interface |
Returns information about the current application running the script and its environment. You can use it in both Script Editor and scriptModule. 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 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 |
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.
|
slot |
Query current application folder.
|
slot |
returns the application. Identical to property "applicationPath".
|
slot |
Query common binary folder.
|
slot |
returns the folder where the binaries can be found.
|
slot |
returns a string that represents the flavour of the application, e.g. Harmony,
|
slot |
Query common resources folder.
|
slot |
returns the folder where the resources can be found.
|
slot |
Return the user name.
|
slot |
returns the version info string.
|
slot |
returns true whenever this application running application is ControlCenter
|
slot |
returns true whenever this application is a Demo variant.
|
slot |
returns true whenever this application is an Educational variant.
|
slot |
returns true whenever this application is a Commercial/Full variant.
|
slot |
true when connected to a database or when compiled with Harmony.
|
slot |
returns true whenever this application is interactive. All application capable of running scripts are interactive.
|
slot |
Query if current platform is Linux.
|
slot |
returns true when running on linux.
|
slot |
Query if current platform is Mac.
|
slot |
returns true when running on MacOS.
|
slot |
Query if current platform is Mac Intel.
|
slot |
returns true when running on an Apple OS X operating system and on a Mac Intel.
|
slot |
Query if current platform is Mac Power PC.
|
slot |
returns true when running on an Apple OS X operating system and on a Mac PowerPC.
|
slot |
returns true when this application is Stage, or Storyboard, and not a peripheral application.
|
slot |
returns true when this application is in Paint mode.
|
slot |
true when this application is Scan.
|
slot |
only true when running as Stage.
|
slot |
only true when running as Stage Advanced
|
slot |
only true when running as Stage Essentials.
|
slot |
only true when running as Storyboard.
|
slot |
Query if current platform is Windows.
|
slot |
returns true when running on Windows.
|
slot |
returns true when this application is in Xsheet mode.
|
slot |
returns a string that is the name of application.
|
read |
See isStageAdvanced.
|
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 )
|
read |
Common binary folder.
See getBinaryPath.
|
read |
See isControlCenterApp.
|
read |
See isDemoVersion.
|
read |
See isEducVersion.
|
read |
See isStageEssentials.
|
read |
See isFullVersion.
|
read |
See isHarmony.
|
read |
See isInteractiveApp.
|
read |
Current platform is Linux.
See isLinuxArch.
|
read |
Current platform is Mac.
See isMasArch.
|
read |
Current platform is Mac Intel.
See isMacIntelArch.
|
read |
Current platform is Mac Power PC.
See isMacIntelArch.
|
read |
See isMainApp.
|
read |
See isPaintMode.
|
read |
Common resources folder.
See getResourcesPath.
|
read |
See isScanApp.
|
read |
See isStage.
|
read |
See isStoryboard.
|
read |
|
read |
Current platform is Windows.
See isWindorsArch.
|
read |
See isXsheetMode.