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 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)

Additional Inherited Members
Properties inherited from QObject
	objectName
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () 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< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (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
QList< T >	findChildren (const QString &name, 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 QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () 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
T	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)
T	qobject_cast (const QObject *object)
T	qobject_cast (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)
QThread *	thread () 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 *context, Functor functor, 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)
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction 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
QObject *	sender () 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.

---

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

• scriptableextension.h
• scriptableextension.cpp