KParts::ScriptableExtension

Search for usage in LXR

KParts::ScriptableExtension Class Reference

#include <KParts/ScriptableExtension>

Inheritance diagram for KParts::ScriptableExtension:

Classes

struct  Exception
 
struct  FunctionRef
 
struct  Null
 
struct  Object
 
struct  Undefined
 

lifetime

 ScriptableExtension (QObject *parent)
 
 ~ScriptableExtension () override
 
static ScriptableExtensionchildObject (QObject *obj)
 
static ScriptableExtensionadapterFromLiveConnect (QObject *parentObj, LiveConnectExtension *oldApi)
 

Object Hierarchy

void setHost (ScriptableExtension *host)
 
ScriptableExtensionhost () 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< QVariantArgList
 
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)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

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 35 of file scriptableextension.h.

Member Enumeration Documentation

Enumerator
EnumLimit 

< also known as JavaScript

Definition at line 261 of file scriptableextension.h.

Member Function Documentation

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

increases reference count of object objId

Definition at line 160 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 165 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 31 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 89 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 72 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.

Definition at line 80 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 26 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 51 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 130 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 145 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'.

Definition at line 105 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.

Definition at line 97 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 41 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 154 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

Definition at line 113 of file scriptableextension.cpp.

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

decreases reference count of object objId

Definition at line 177 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 182 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 122 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

Definition at line 46 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 138 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 36 of file scriptableextension.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Sat Dec 4 2021 22:57:09 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.