OMC::About Class Reference

Detailed Description

Get the active about details from the instance of the application.

Provided from the Application (OMH::Harmony::about)

The About class provides general information about the current application session. This includes environment information, and general application information,

from ToonBoom import harmony #Import the Harmony Module
sess = harmony.session() #Get access to the Harmony session, this class.
about = sess.about #Get about object.
print( about.path_application ) #Expectation: Prints the path to the Harmony application's path.

Public Attributes

QString flavor_string
 Returns a string that represents the flavor of the application. e.g. Harmony.
 
QString flavor_string_translated
 Returns the version info string.
 
int version_major
 Returns the major version number.
 
int version_minor
 Returns the minor version number.
 
int version_patch
 Returns the patch version number.
 
int build_number
 Returns the build number.
 
QString product_name
 String that is the name of application.
 
bool version_full
 True whenever this application is a Commercial / Full variant.
 
bool version_educational
 True whenever this application is an Educational variant.
 
bool harmony
 True when connected to a database or when compiled with Harmony Premium.
 
bool harmony_premium
 True whenever the application running is a Preimium variant.
 
bool harmony_essentials
 True whenever the application running is an Essentials variant.
 
bool harmony_advanced
 True whenever the application running is an Advanced variant.
 
bool storyboard
 True whenever the application running is Stage.
 
bool arch_windows
 True when running on Windows.
 
bool arch_linux
 True when running on Linux.
 
bool arch_mac
 True when running on mac.
 
bool arch_mac_intel
 True when running on an Apple OS X operating system on Mac Intel.
 
bool arch_mac_ppc
 True when running on an Apple OS X operating system on Mac PowerPC.
 
bool arch_mac_m1
 True when running on an Apple OS X operating system on Mac M1.
 
bool interactive
 True whenever this application is running in an interactive mode with a GUI.
 
bool app_stage
 True whenever the application running is Stage.
 
bool app_scan
 True whenever the application running is Scan.
 
bool app_main
 True when the application is Harmony or Storyboard, and not a peripheral application.
 
bool mode_paint
 True when the application is in Paint mode.
 
bool mode_xsheet
 True when the application is in Xsheet mode.
 
bool mode_database
 True when the application is in Database mode.
 
QString path_application
 String that is the path of the application.
 
QString path_binary
 String that is the folder where the binaries can be found.
 
QString user_name
 The user name.
 
bool version_demo
 True whenever this application is a Demo variant.
 
bool mode_python
 True whenever the application is running from the external Python module interface.
 
bool mode_batch
 True whenever the application is running from the external batch-mode from the commandline.
 
Inheritance diagram for OMC::About:
Collaboration diagram for OMC::About: