about Class Reference

returns information about the current application running the script and its environment. More...

#include <aboutinterface.h>

Inheritance diagram for about:

Collaboration diagram for about:

Public Slots
bool	isWindowsArch () const
	Query if current platform is Windows.
bool	isLinuxArch () const
	Query if current platform is Linux.
bool	isMacArch () const
	Query if current platform is Mac.
bool	isMacIntelArch () const
	Query if current platform is Mac Intel.
bool	isMacPpcArch () const
	Query if current platform is Mac Power PC.
QString	getApplicationPath () const
	Query current application folder.
QString	getBinaryPath () const
	Query common binary folder.
QString	getResourcesPath () const
	Query common resources folder.
QString	getFlavorString () const
	returns a string that represents the flavour of the application, e.g. Harmony, Digital, Opus.
QString	getVersionInfoStr () const
	returns the version info string.
QString	productName () const
	returns a string that is the name of application.
bool	isFullVersion () const
	returns true whenever this application is a Commercial/Full variant.
bool	isDemoVersion () const
	returns true whenever this application is a Demo variant.
bool	isEducVersion () const
	returns true whenever this application is an Educational variant.
bool	isDigitalPro () const
	always false
bool	isDigital () const
	always false
bool	isHarmony () const
	true when connected to a database or when compiled with Harmony.
bool	isOpus () const
	always false - opus no longer exists
bool	isAnimate () const
	only true when running as Animate.
bool	isAnimatePro () const
	only true when running as AnimatePro
bool	isStage () const
	only true when running as Stage.
bool	isWindowsArch () const
	returns true when running on Windows.
bool	isLinuxArch () const
	returns true when running on linux.
bool	isMacArch () const
	returns true when running on MacOS.
bool	isMacIntelArch () const
	returns true when running on an Apple OS X operating system and on a Mac Intel.
bool	isMacPpcArch () const
	returns true when running on an Apple OS X operating system and on a Mac PowerPC.
bool	isInteractiveApp () const
	returns true whenever this application is interactive. All application capable of running scripts are interactive.
bool	isScanApp () const
	true when this application is Scan.
bool	isMainApp () const
	returns true when this application is Stage, Digital Pro or Storyboard, and not a peripheral application.
bool	isControlCenterApp () const
	returns true whenever this application running application is ControlCenter
bool	isPaintMode () const
	returns true when this application is in Paint mode.
bool	isXsheetMode () const
	returns true when this application is in Xsheet mode.
QString	getApplicationPath () const
	returns the application. Identical to property "applicationPath".
QString	getBinaryPath () const
	returns the folder where the binaries can be found.
QString	getResourcesPath () const
	returns the folder where the resources can be found.

Properties
bool	windowsArch
	Current platform is Windows.
bool	linuxArch
	Current platform is Linux.
bool	macArch
	Current platform is Mac.
bool	macIntelArch
	Current platform is Mac Intel.
bool	macPpcArch
	Current platform is Mac Power PC.
QString	applicationPath
	Application with GUI folder (different than binFolder on Mac. Same for all other platforms ).
QString	binaryPath
	Common binary folder.
QString	resourcesPath
	Common resources folder.
bool	fullVersion
bool	demoVersion
bool	educVersion
bool	digitalPro
bool	digital
bool	harmony
bool	opus
bool	solo
bool	animate
bool	animatePro
bool	state
bool	mainApp
bool	interactiveApp
bool	scanApp
bool	controlCenterApp
bool	paintMode
bool	xsheetMode

Detailed Description

returns information about the current application running the script and its environment.

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

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("");print( "animate pro product : " + about.animatePro );
  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( "Stage/Digital Main 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

QString about::getApplicationPath ( ) const

slot

Query current application folder.

QString about::getApplicationPath ( ) const

slot

returns the application. Identical to property "applicationPath".

QString about::getBinaryPath ( ) const

slot

Query common binary folder.

QString about::getBinaryPath ( ) const

slot

returns the folder where the binaries can be found.

QString about::getFlavorString ( ) const

slot

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

QString about::getResourcesPath ( ) const

slot

Query common resources folder.

QString about::getResourcesPath ( ) const

slot

returns the folder where the resources can be found.

QString about::getVersionInfoStr ( ) const

slot

returns the version info string.

bool about::isAnimate ( ) const

slot

only true when running as Animate.

bool about::isAnimatePro ( ) const

slot

only true when running as AnimatePro

bool about::isControlCenterApp ( ) const

slot

returns true whenever this application running application is ControlCenter

bool about::isDemoVersion ( ) const

slot

returns true whenever this application is a Demo variant.

bool about::isDigital ( ) const

slot

always false

bool about::isDigitalPro ( ) const

slot

always false

bool about::isEducVersion ( ) const

slot

returns true whenever this application is an Educational variant.

bool about::isFullVersion ( ) const

slot

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

bool about::isHarmony ( ) const

slot

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

bool about::isInteractiveApp ( ) const

slot

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

bool about::isLinuxArch ( ) const

slot

Query if current platform is Linux.

bool about::isLinuxArch ( ) const

slot

returns true when running on linux.

bool about::isMacArch ( ) const

slot

Query if current platform is Mac.

bool about::isMacArch ( ) const

slot

returns true when running on MacOS.

bool about::isMacIntelArch ( ) const

slot

Query if current platform is Mac Intel.

bool about::isMacIntelArch ( ) const

slot

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

bool about::isMacPpcArch ( ) const

slot

Query if current platform is Mac Power PC.

bool about::isMacPpcArch ( ) const

slot

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

bool about::isMainApp ( ) const

slot

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

bool about::isOpus ( ) const

slot

always false - opus no longer exists

bool about::isPaintMode ( ) const

slot

returns true when this application is in Paint mode.

bool about::isScanApp ( ) const

slot

true when this application is Scan.

bool about::isStage ( ) const

slot

only true when running as Stage.

bool about::isWindowsArch ( ) const

slot

Query if current platform is Windows.

bool about::isWindowsArch ( ) const

slot

returns true when running on Windows.

bool about::isXsheetMode ( ) const

slot

returns true when this application is in Xsheet mode.

QString about::productName ( ) const

slot

returns a string that is the name of application.

Property Documentation

bool about::animate

read

bool about::animatePro

read

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

QString about::binaryPath

read

Common binary folder.

bool about::controlCenterApp

read

bool about::demoVersion

read

bool about::digital

read

bool about::digitalPro

read

bool about::educVersion

read

bool about::fullVersion

read

bool about::harmony

read

bool about::interactiveApp

read

bool about::linuxArch

read

Current platform is Linux.

bool about::macArch

read

Current platform is Mac.

bool about::macIntelArch

read

Current platform is Mac Intel.

bool about::macPpcArch

read

Current platform is Mac Power PC.

bool about::mainApp

read

bool about::opus

read

bool about::paintMode

read

QString about::resourcesPath

read

Common resources folder.

bool about::scanApp

read

bool about::solo

read

bool about::state

read

bool about::windowsArch

read

Current platform is Windows.

bool about::xsheetMode

read

---

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

• dox_files/aboutI.h
• dox_files/aboutinterface.h