KParts
Classes | |
struct | KParts::ScriptableExtension::Exception |
struct | KParts::ScriptableExtension::FunctionRef |
struct | KParts::ScriptableExtension::Null |
struct | KParts::ScriptableExtension::Object |
struct | KParts::ScriptableExtension::Undefined |
Functions | |
KParts::ScriptableExtension::Exception::Exception () | |
KParts::ScriptableExtension::Exception::Exception (const QString &msg) | |
KParts::ScriptableExtension::FunctionRef::FunctionRef () | |
KParts::ScriptableExtension::FunctionRef::FunctionRef (const Object &b, const QString &f) | |
KParts::ScriptableExtension::Object::Object () | |
KParts::ScriptableExtension::Object::Object (ScriptableExtension *o, quint64 id) | |
bool | KParts::ScriptableExtension::FunctionRef::operator== (const FunctionRef &other) const |
bool | KParts::ScriptableExtension::Object::operator== (const Object &other) const |
Object Operations | |
All these methods share the following conventions:
| |
enum | KParts::ScriptableExtension::ScriptLanguage { KParts::ScriptableExtension::ECMAScript , KParts::ScriptableExtension::EnumLimit = 0xFFFF } |
typedef QList< QVariant > | KParts::ScriptableExtension::ArgList |
virtual QVariant | KParts::ScriptableExtension::callAsFunction (ScriptableExtension *callerPrincipal, quint64 objId, const ArgList &args) |
virtual QVariant | KParts::ScriptableExtension::callFunctionReference (ScriptableExtension *callerPrincipal, quint64 objId, const QString &f, const ArgList &args) |
virtual QVariant | KParts::ScriptableExtension::callAsConstructor (ScriptableExtension *callerPrincipal, quint64 objId, const ArgList &args) |
virtual bool | KParts::ScriptableExtension::hasProperty (ScriptableExtension *callerPrincipal, quint64 objId, const QString &propName) |
virtual QVariant | KParts::ScriptableExtension::get (ScriptableExtension *callerPrincipal, quint64 objId, const QString &propName) |
virtual bool | KParts::ScriptableExtension::put (ScriptableExtension *callerPrincipal, quint64 objId, const QString &propName, const QVariant &value) |
virtual bool | KParts::ScriptableExtension::removeProperty (ScriptableExtension *callerPrincipal, quint64 objId, const QString &propName) |
virtual bool | KParts::ScriptableExtension::enumerateProperties (ScriptableExtension *callerPrincipal, quint64 objId, QStringList *result) |
virtual bool | KParts::ScriptableExtension::setException (ScriptableExtension *callerPrincipal, const QString &message) |
virtual QVariant | KParts::ScriptableExtension::evaluateScript (ScriptableExtension *callerPrincipal, quint64 contextObjectId, const QString &code, ScriptLanguage language=ECMAScript) |
virtual bool | KParts::ScriptableExtension::isScriptLanguageSupported (ScriptLanguage lang) const |
virtual void | KParts::ScriptableExtension::acquire (quint64 objid) |
static QVariant | KParts::ScriptableExtension::acquireValue (const QVariant &v) |
virtual void | KParts::ScriptableExtension::release (quint64 objid) |
static QVariant | KParts::ScriptableExtension::releaseValue (const QVariant &v) |
lifetime | |
KParts::ScriptableExtension::ScriptableExtension (QObject *parent) | |
virtual | KParts::ScriptableExtension::~ScriptableExtension () |
static ScriptableExtension * | KParts::ScriptableExtension::childObject (QObject *obj) |
static ScriptableExtension * | KParts::ScriptableExtension::adapterFromLiveConnect (QObject *parentObj, LiveConnectExtension *oldApi) |
Object Hierarchy | |
void | KParts::ScriptableExtension::setHost (ScriptableExtension *host) |
ScriptableExtension * | KParts::ScriptableExtension::host () const |
virtual QVariant | KParts::ScriptableExtension::rootObject () |
QVariant | KParts::ScriptableExtension::enclosingObject () |
Detailed Description
Values are passed to and from scriptable methods or properties as QVariants.
Valid values may be bools, strings, and numbers (doubles), as well as the following custom types:
Typedef Documentation
◆ ArgList
typedef QList<QVariant> KParts::ScriptableExtension::ArgList |
Definition at line 192 of file scriptableextension.h.
Enumeration Type Documentation
◆ ScriptLanguage
Enumerator | |
---|---|
ECMAScript | |
EnumLimit | < also known as JavaScript |
Definition at line 247 of file scriptableextension.h.
Function Documentation
◆ Exception() [1/2]
|
inline |
Definition at line 74 of file scriptableextension.h.
◆ Exception() [2/2]
|
inline |
Definition at line 75 of file scriptableextension.h.
◆ FunctionRef() [1/2]
|
inline |
Definition at line 108 of file scriptableextension.h.
◆ FunctionRef() [2/2]
|
inline |
Definition at line 109 of file scriptableextension.h.
◆ Object() [1/2]
|
inline |
Definition at line 95 of file scriptableextension.h.
◆ Object() [2/2]
|
inline |
Definition at line 96 of file scriptableextension.h.
◆ ScriptableExtension()
|
protected |
Definition at line 34 of file scriptableextension.cpp.
◆ ~ScriptableExtension()
|
virtual |
Definition at line 38 of file scriptableextension.cpp.
◆ acquire()
|
virtual |
increases reference count of object objId
Reimplemented in KParts::ScriptableLiveConnectExtension.
Definition at line 190 of file scriptableextension.cpp.
◆ acquireValue()
|
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 195 of file scriptableextension.cpp.
◆ adapterFromLiveConnect()
|
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 48 of file scriptableextension.cpp.
◆ callAsConstructor()
|
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 109 of file scriptableextension.cpp.
◆ callAsFunction()
|
virtual |
Try to use the object objId
associated with 'this' as a function.
Definition at line 89 of file scriptableextension.cpp.
◆ callFunctionReference()
|
virtual |
Try to use a function reference to field f
of object @objId as a function.
Reimplemented in KParts::ScriptableLiveConnectExtension.
Definition at line 98 of file scriptableextension.cpp.
◆ childObject()
|
static |
Queries obj
for a child object which inherits from this ScriptableExtension class.
Convenience method.
Definition at line 43 of file scriptableextension.cpp.
◆ enclosingObject()
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 69 of file scriptableextension.cpp.
◆ enumerateProperties()
|
virtual |
Tries to enumerate all fields of object objId
associated with this to result
.
Returns true on success
Definition at line 155 of file scriptableextension.cpp.
◆ evaluateScript()
|
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 172 of file scriptableextension.cpp.
◆ get()
|
virtual |
Tries to get field propName
from object objId
associated with 'this'.
Reimplemented in KParts::ScriptableLiveConnectExtension.
Definition at line 127 of file scriptableextension.cpp.
◆ hasProperty()
|
virtual |
Returns true if the object objId
associated with 'this' has the property propName
.
Reimplemented in KParts::ScriptableLiveConnectExtension.
Definition at line 118 of file scriptableextension.cpp.
◆ host()
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 59 of file scriptableextension.cpp.
◆ isScriptLanguageSupported()
|
virtual |
returns true if this extension can execute scripts in the given language
Definition at line 184 of file scriptableextension.cpp.
◆ operator==() [1/2]
|
inline |
Definition at line 110 of file scriptableextension.h.
◆ operator==() [2/2]
|
inline |
Definition at line 97 of file scriptableextension.h.
◆ put()
|
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 136 of file scriptableextension.cpp.
◆ release()
|
virtual |
decreases reference count of object objId
Reimplemented in KParts::ScriptableLiveConnectExtension.
Definition at line 207 of file scriptableextension.cpp.
◆ releaseValue()
|
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 212 of file scriptableextension.cpp.
◆ removeProperty()
|
virtual |
Tries to remove the field d propName
from object objId
associated with 'this'.
Returns true on success
Definition at line 146 of file scriptableextension.cpp.
◆ 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 64 of file scriptableextension.cpp.
◆ setException()
|
virtual |
Tries to raise an exception with given message in this extension's scripting context.
Returns true on success
Definition at line 164 of file scriptableextension.cpp.
◆ setHost()
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 54 of file scriptableextension.cpp.
Variable Documentation
◆ base
Object KParts::ScriptableExtension::FunctionRef::base |
Definition at line 105 of file scriptableextension.h.
◆ field
QString KParts::ScriptableExtension::FunctionRef::field |
Definition at line 106 of file scriptableextension.h.
◆ message
QString KParts::ScriptableExtension::Exception::message |
Error message returned from the callee.
This should be assumed to be low-level (in particular, it might not be translated) and should only be displayed in low-level debugging tools and the like.
Definition at line 72 of file scriptableextension.h.
◆ objId
quint64 KParts::ScriptableExtension::Object::objId |
Definition at line 93 of file scriptableextension.h.
◆ owner
ScriptableExtension* KParts::ScriptableExtension::Object::owner |
Definition at line 92 of file scriptableextension.h.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.