KParts::LiveConnectExtension Class Reference

#include <browserextension.h>

Inheritance diagram for KParts::LiveConnectExtension:

List of all members.

Public Types
typedef QList< QPair< Type, QString > >	ArgList
enum	Type {   TypeVoid = 0, TypeBool, TypeFunction, TypeNumber,   TypeObject, TypeString }
Signals
void	partEvent (const unsigned long objid, const QString &event, const KParts::LiveConnectExtension::ArgList &args)
Public Member Functions
	LiveConnectExtension (KParts::ReadOnlyPart *parent)
virtual	~LiveConnectExtension ()
virtual bool	call (const unsigned long objid, const QString &func, const QStringList &args, Type &type, unsigned long &retobjid, QString &value)
virtual bool	get (const unsigned long objid, const QString &field, Type &type, unsigned long &retobjid, QString &value)
virtual bool	put (const unsigned long objid, const QString &field, const QString &value)
virtual void	unregister (const unsigned long objid)
Static Public Member Functions
static LiveConnectExtension *	childObject (QObject *obj)

---

Detailed Description

An extension class for LiveConnect, i.e.

a call from JavaScript from a HTML page which embeds this part. A part can have an object hierarchy by using objid as a reference to an object.

Definition at line 765 of file browserextension.h.

---

Member Typedef Documentation

typedef QList<QPair<Type, QString> > KParts::LiveConnectExtension::ArgList

Definition at line 772 of file browserextension.h.

---

Member Enumeration Documentation

enum KParts::LiveConnectExtension::Type

Enumerator:

TypeVoid
TypeBool
TypeFunction
TypeNumber
TypeObject
TypeString

Definition at line 769 of file browserextension.h.

---

Constructor & Destructor Documentation

LiveConnectExtension::LiveConnectExtension

(

KParts::ReadOnlyPart *

parent

)

Definition at line 798 of file browserextension.cpp.

LiveConnectExtension::~LiveConnectExtension

(

)

[virtual]

Definition at line 801 of file browserextension.cpp.

---

Member Function Documentation

bool LiveConnectExtension::call	(	const unsigned long	objid,
		const QString &	func,
		const QStringList &	args,
		Type &	type,
		unsigned long &	retobjid,
		QString &	value
	)		[virtual]

calls a function of objid, return true on success

Definition at line 811 of file browserextension.cpp.

LiveConnectExtension * LiveConnectExtension::childObject

(

QObject *

obj

)

[static]

Definition at line 817 of file browserextension.cpp.

bool LiveConnectExtension::get	(	const unsigned long	objid,
		const QString &	field,
		Type &	type,
		unsigned long &	retobjid,
		QString &	value
	)		[virtual]

get a field value from objid, return true on success

Definition at line 803 of file browserextension.cpp.

void KParts::LiveConnectExtension::partEvent	(	const unsigned long	objid,
		const QString &	event,
		const KParts::LiveConnectExtension::ArgList &	args
	)		[signal]

notify a event from the part of object objid

bool LiveConnectExtension::put	(	const unsigned long	objid,
		const QString &	field,
		const QString &	value
	)		[virtual]

put a field value in objid, return true on success

Definition at line 807 of file browserextension.cpp.

void LiveConnectExtension::unregister

(

const unsigned long

objid

)

[virtual]

notifies the part that there is no reference anymore to objid

Definition at line 815 of file browserextension.cpp.

---

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

• browserextension.h
• browserextension.cpp