Detailed Description

An object that represents the root javascript object and its global context, as well as information about its original script's source.

The root Javascript object is the initial Javascript object that is loaded from a string or file source. This evaluated root is often the global object and provides the context for other objects in ts context.

The Javascript root object provides utilities for reloading the file or script as needed, and maintains a cached copy of the script at the time it is run.
It is best to avoid re-evaluating the scripts constantly – this will help avoid unnecessary processing and allows for a more persistent scripting environment.

Loading a Javascript Root Object
The following is more of a proof of concept for the interoperability between Javascript and Python – the whole UI can be generated directly in Python/PySide instead.

from ToonBoom import harmony
sess = harmony.session()
js = sess.javascript
js_string = """
  function setupUI( pythonFunc )
  {
    var mainWidget = new QWidget();
    var button = new QPushButton( mainWidget );
    var layout = new QHBoxLayout();
    mainWidget.setLayout(layout);
    layout.addWidget(button, 1, 0);
    button.text = "Hello World"
    button.pressed.connect( pythonFunc.call );
    mainWidget.show();
    return mainWidget;
  }
"""
def myCallbackFunction():
  print( "Hello Python World" )
js_obj = js.load_string( js_string )
#Initialize the JS UI with a Python callback function.
js_obj["setupUI"].call( myCallbackFunction )
#Clicking the button will result in the Python Function to be called.

Public Member Functions
	JavascriptRootObject (const QString &javascript, const QString &filePath=QString())
	Construct the object based on its javascript and/or the absolute file path to that javascript. More...

void	reload (bool fromDisk=false)
	Reevaluates the javascript object from the original string, or from the original file's path. More...

virtual bool	contains (const QVariant &propName) const override
	Checks the if the object contains a given property at key or at value if the object is an array. More...

virtual void	remove (const QVariant &propValue) const
	Removes a property from the object at key or at value if the object is an array. For removing at index on arrays, use pop() method instead.

virtual QVariant	pop (int propIdx) const
	Pops a property from the array object at index. More...

virtual void	insert (int propIdx, const QVariant &propValue) const
	Inserts a property in the middle of arrays.

virtual void	clear () const
	Clears the object of any property.

virtual void	append (const QVariant &propValue) const
	Appends a property to the end of an array.

QVariant	call (const QVariant &arguments=QVariant(), const QVariant &selfValue=QVariant())
	Calls the javascript function with the provided arguments and an object representing the object bound to the self at the function's execution. More...

Public Attributes
QString	path
	Provides the path to the loaded javascript content, if provided from a path.

QString	script
	Get and set the script's string. More...

bool	loaded
	Identifies if the script has been successfully loaded into the script interface.

QString	type
	Identifies the type of this object as root.

QString	source
	The source of the javascript object – the file path if loaded from a file, otherwise from memory.

Constructor & Destructor Documentation

◆ JavascriptRootObject()

OMC::JavascriptRootObject::JavascriptRootObject	(	const QString &	javascript,
		const QString &	filePath = `QString()`
	)

Construct the object based on its javascript and/or the absolute file path to that javascript.

Parameters

javascript	The full javascript as a string that will be evaluated.
filePath	The absolute file path to the javascript that will be evaluated.

Member Function Documentation

◆ call()

QVariant OMC::JavascriptObject::call	(	const QVariant &	arguments = `QVariant()`,
		const QVariant &	selfValue = `QVariant()`
	)

inherited

Calls the javascript function with the provided arguments and an object representing the object bound to the self at the function's execution.

Parameters

arguments	- A list of arguments provided to the function being called. If the function is defined with named-arguments, the arguments will use those names.
selfValue	- An object that is bound to the function when called. This object is available with the 'this' object in the context of the function.

Calling a function with 'this' object bound

from ToonBoom import harmony
sess = harmony.session()
js = sess.javascript
js_string = """
  function functionWithThisBound()
  {
    if( this.contextExists )
    {
      return true;
    }
    return false;
  }
"""
js_obj = js.load_string( js_string )
results = js_obj["functionWithThisBound"].call( [] )
print( "%s : Expecting False -- no context provided."%(results) )
results = js_obj["functionWithThisBound"].call( [], { "contextExists":True } )
print( "%s : Expecting True -- context provided."%(results) )

Returns: Returns the javascript function return value.

◆ contains()

virtual bool OMC::JavascriptObject::contains ( const QVariant & propName ) const

overridevirtualinherited

Checks the if the object contains a given property at key or at value if the object is an array.

Introspecting a JS Object

from ToonBoom import harmony
sess = harmony.session()
js = sess.javascript
js_string = """
  var objectExists = "Exists";
"""
js_obj = js.load_string( js_string )
if js_obj.contains( "objectExists" ):
  print( "Exists as expected." )
if not js_obj.contains( "objectDoesntExist" ):
  print( "Doesn't exist, as expected." )

Returns: True if contains the property.

◆ pop()

virtual QVariant OMC::JavascriptObject::pop ( int propIdx ) const

virtualinherited

Pops a property from the array object at index.

Returns: The popped value.

◆ reload()

void OMC::JavascriptRootObject::reload ( bool fromDisk = false )

Reevaluates the javascript object from the original string, or from the original file's path.

If optional fromDisk is true, the javascript object is loaded from its original path and not from its cached string.

Parameters

fromDisk - In the event that the object was loaded from a file, setting fromDisk to true will reload it from that same file. Otherwise, reloads it from a local cache.

Member Data Documentation

◆ script

QString OMC::JavascriptRootObject::script

readwrite

Get and set the script's string.

This string is used for the evaluation of the script. If this value is changed, the script needs to be reevaluated.

Changing a root objects script and reevaluating

from ToonBoom import harmony
sess = harmony.session()
js = sess.javascript
js_string_001 = """
  function hello()
  {
    MessageLog.trace( "Hello" );
  }
"""
js_string_002 = """
  function world()
  {
    MessageLog.trace( "World" );
  }
"""
js_obj = js.load_string( js_string_001 )
js_obj["hello"].call( [] )  #MessageLog -- "Hello"
js_obj.script = js_string_002
js_obj.reload() #Reload the script, now that it is changed.
js_obj["world"].call( [] )  #MessageLog -- "World"

Inheritance diagram for OMC::JavascriptRootObject:

[legend]

Collaboration diagram for OMC::JavascriptRootObject:

[legend]

Detailed Description

Public Member Functions

Public Attributes

Constructor & Destructor Documentation

◆ JavascriptRootObject()

Member Function Documentation

◆ call()

◆ contains()

◆ pop()

◆ reload()

Member Data Documentation

◆ script