An extension class that permits KParts to be scripted (such as when embedded inside a KHTMLPart) and to access the host's scriptable objects as well. More...

#include <scriptableextension.h>

Inheritance diagram for KParts::ScriptableExtension:

[legend]

List of all members.

Classes
struct	Exception
	Returned from operations to denote a failure. More...
struct	FunctionRef
	Function references are a pair of an object and a field in it. More...
struct	Null
	Corresponds to 'null' in JavaScript. More...
struct	Object
	Objects are abstracted away as a pair of the ScriptableExtension the performs operations on it, and an implementation-specific Id, which gets passed to the extension's methods. More...
struct	Undefined
	Corresponds to 'undefined' in JavaScript. More...
lifetime
	ScriptableExtension (QObject *parent)
virtual	~ScriptableExtension ()
static ScriptableExtension *	childObject (QObject *obj)
static ScriptableExtension *	adapterFromLiveConnect (QObject parentObj, LiveConnectExtension oldApi)
Object Hierarchy
void	setHost (ScriptableExtension *host)
ScriptableExtension *	host () const
virtual QVariant	rootObject ()
QVariant	enclosingObject ()
Object Operations
All these methods share the following conventions: Values are passed and returned encoded as defined in Script Value Types All methods may return an exception if unsupported All callers must provide an accurate callerPrincipal argument describing which ScriptableExtension (and hence which KPart) they're acting as. This is used to implement security checks. This is not the same as the owner of an object. For example, if a plugin is calling an operation on a KHTMLPart object, then the 'this' parameter would be the object owner, a ScriptableExtension provided by the KHTMLPart, while the callerPrincipal would be the ScriptableExtension of the plugin. The extension is expected to do appropriate cross-site scripting checks on this argument if it is acting as a host.
enum	ScriptLanguage { ECMAScript, EnumLimit = 0xFFFF }
typedef QList< QVariant >	ArgList
virtual QVariant	callAsFunction (ScriptableExtension *callerPrincipal, quint64 objId, const ArgList &args)
virtual QVariant	callFunctionReference (ScriptableExtension *callerPrincipal, quint64 objId, const QString &f, const ArgList &args)
virtual QVariant	callAsConstructor (ScriptableExtension *callerPrincipal, quint64 objId, const ArgList &args)
virtual bool	hasProperty (ScriptableExtension *callerPrincipal, quint64 objId, const QString &propName)
virtual QVariant	get (ScriptableExtension *callerPrincipal, quint64 objId, const QString &propName)
virtual bool	put (ScriptableExtension *callerPrincipal, quint64 objId, const QString &propName, const QVariant &value)
virtual bool	removeProperty (ScriptableExtension *callerPrincipal, quint64 objId, const QString &propName)
virtual bool	enumerateProperties (ScriptableExtension callerPrincipal, quint64 objId, QStringList result)
virtual bool	setException (ScriptableExtension *callerPrincipal, const QString &message)
virtual QVariant	evaluateScript (ScriptableExtension *callerPrincipal, quint64 contextObjectId, const QString &code, ScriptLanguage language=ECMAScript)
virtual bool	isScriptLanguageSupported (ScriptLanguage lang) const
virtual void	acquire (quint64 objid)
virtual void	release (quint64 objid)
static QVariant	acquireValue (const QVariant &v)
static QVariant	releaseValue (const QVariant &v)

Detailed Description

An extension class that permits KParts to be scripted (such as when embedded inside a KHTMLPart) and to access the host's scriptable objects as well.

See Script Value Types for how values are passed to/from various methods here.

Since:: 4.5

Definition at line 44 of file scriptableextension.h.

Member Typedef Documentation

typedef QList<QVariant> KParts::ScriptableExtension::ArgList

Definition at line 192 of file scriptableextension.h.

Member Enumeration Documentation

enum KParts::ScriptableExtension::ScriptLanguage

Enumerator:

ECMAScript
EnumLimit	< also known as JavaScript

Definition at line 247 of file scriptableextension.h.

Constructor & Destructor Documentation

KParts::ScriptableExtension::ScriptableExtension ( QObject * parent ) [protected]

Definition at line 36 of file scriptableextension.cpp.

KParts::ScriptableExtension::~ScriptableExtension ( ) [virtual]

Definition at line 40 of file scriptableextension.cpp.

Member Function Documentation

void KParts::ScriptableExtension::acquire ( quint64 objid ) [virtual]

increases reference count of object objId

Reimplemented in KParts::ScriptableLiveConnectExtension.

Definition at line 192 of file scriptableextension.cpp.

QVariant KParts::ScriptableExtension::acquireValue ( const QVariant & v ) [static]

Helper that calls acquire on any object or function reference base stored in v.

Returns:: a copy of the passed in value

Definition at line 197 of file scriptableextension.cpp.

ScriptableExtension * KParts::ScriptableExtension::adapterFromLiveConnect	(	QObject *	parentObj,
		LiveConnectExtension *	oldApi
	)		`[static]`

This returns a bridge object that permits KParts implementing the older LiveConnectExtension to be used via the ScriptableExtension API.

The bridge's parent will be the parentObj.

Definition at line 50 of file scriptableextension.cpp.

QVariant KParts::ScriptableExtension::callAsConstructor	(	ScriptableExtension *	callerPrincipal,
		quint64	objId,
		const ArgList &	args
	)		`[virtual]`

Try to use the object objId associated with 'this' as a constructor (corresponding to ECMAScript's new foo(bar, baz, glarch) expression).

Definition at line 111 of file scriptableextension.cpp.

QVariant KParts::ScriptableExtension::callAsFunction	(	ScriptableExtension *	callerPrincipal,
		quint64	objId,
		const ArgList &	args
	)		`[virtual]`

Try to use the object objId associated with 'this' as a function.

Definition at line 91 of file scriptableextension.cpp.

QVariant KParts::ScriptableExtension::callFunctionReference	(	ScriptableExtension *	callerPrincipal,
		quint64	objId,
		const QString &	f,
		const ArgList &	args
	)		`[virtual]`

Try to use a function reference to field f of object as a function.

Reimplemented in KParts::ScriptableLiveConnectExtension.

Definition at line 100 of file scriptableextension.cpp.

ScriptableExtension * KParts::ScriptableExtension::childObject ( QObject * obj ) [static]

Queries obj for a child object which inherits from this ScriptableExtension class.

Convenience method.

Definition at line 45 of file scriptableextension.cpp.

QVariant KParts::ScriptableExtension::enclosingObject ( )

Returns an object that represents the host()'s view of us.

For example, if the host is an HTML part, it would return a DOM node of an <object> handled by this part. May be undefined or null

Implemented in terms of objectForKid

Definition at line 71 of file scriptableextension.cpp.

bool KParts::ScriptableExtension::enumerateProperties	(	ScriptableExtension *	callerPrincipal,
		quint64	objId,
		QStringList *	result
	)		`[virtual]`

Tries to enumerate all fields of object objId associated with this to result.

Returns true on success

Definition at line 157 of file scriptableextension.cpp.

QVariant KParts::ScriptableExtension::evaluateScript	(	ScriptableExtension *	callerPrincipal,
		quint64	contextObjectId,
		const QString &	code,
		ScriptLanguage	language = `ECMAScript`
	)		`[virtual]`

Tries to evaluate a script code with the given object as its context.

The parameter language specifies the language to execute it as. Use isScriptLanguageSupported to check for support.

Definition at line 174 of file scriptableextension.cpp.

QVariant KParts::ScriptableExtension::get	(	ScriptableExtension *	callerPrincipal,
		quint64	objId,
		const QString &	propName
	)		`[virtual]`

Tries to get field propName from object objId associated with 'this'.

Reimplemented in KParts::ScriptableLiveConnectExtension.

Definition at line 129 of file scriptableextension.cpp.

bool KParts::ScriptableExtension::hasProperty	(	ScriptableExtension *	callerPrincipal,
		quint64	objId,
		const QString &	propName
	)		`[virtual]`

Returns true if the object objId associated with 'this' has the property propName.

Reimplemented in KParts::ScriptableLiveConnectExtension.

Definition at line 120 of file scriptableextension.cpp.

ScriptableExtension * KParts::ScriptableExtension::host ( ) const

Returns any registered parent scripting context.

May be 0 if setHost was not called (or not call yet).

Definition at line 61 of file scriptableextension.cpp.

bool KParts::ScriptableExtension::isScriptLanguageSupported ( ScriptLanguage lang ) const [virtual]

returns true if this extension can execute scripts in the given language

Definition at line 186 of file scriptableextension.cpp.

bool KParts::ScriptableExtension::put	(	ScriptableExtension *	callerPrincipal,
		quint64	objId,
		const QString &	propName,
		const QVariant &	value
	)		`[virtual]`

Tries to set the field propName from object objId associated with 'this' to value.

Returns true on success

Reimplemented in KParts::ScriptableLiveConnectExtension.

Definition at line 138 of file scriptableextension.cpp.

void KParts::ScriptableExtension::release ( quint64 objid ) [virtual]

decreases reference count of object objId

Reimplemented in KParts::ScriptableLiveConnectExtension.

Definition at line 209 of file scriptableextension.cpp.

QVariant KParts::ScriptableExtension::releaseValue ( const QVariant & v ) [static]

Helper that calls release on any object or function reference base stored in v.

Returns:: a copy of the passed in value

Definition at line 214 of file scriptableextension.cpp.

bool KParts::ScriptableExtension::removeProperty	(	ScriptableExtension *	callerPrincipal,
		quint64	objId,
		const QString &	propName
	)		`[virtual]`

Tries to remove the field d propName from object objId associated with 'this'.

Returns true on success

Definition at line 148 of file scriptableextension.cpp.

QVariant KParts::ScriptableExtension::rootObject ( ) [virtual]

Return the root scriptable object of this KPart.

For example for an HTML part, it would represent a Window object. May be undefined or null

Reimplemented in KParts::ScriptableLiveConnectExtension.

Definition at line 66 of file scriptableextension.cpp.

bool KParts::ScriptableExtension::setException	(	ScriptableExtension *	callerPrincipal,
		const QString &	message
	)		`[virtual]`

Tries to raise an exception with given message in this extension's scripting context.

Returns true on success

Definition at line 166 of file scriptableextension.cpp.

void KParts::ScriptableExtension::setHost ( ScriptableExtension * host )

Reports the hosting ScriptableExtension to a child.

It's the responsibility of a parent part to call this method on all of its kids' ScriptableExtensions as soon as possible.

Definition at line 56 of file scriptableextension.cpp.

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

KParts

KParts::ScriptableExtension Class Reference

Classes

lifetime

Object Hierarchy

Object Operations

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

KParts

kdelibs