• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KParts

  • KParts
  • LiveConnectExtension
Public Types | Signals | Public Member Functions | Static Public Member Functions | List of all members
KParts::LiveConnectExtension Class Reference

#include <browserextension.h>

Inheritance diagram for KParts::LiveConnectExtension:
QObject

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

◆ ArgList

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

Definition at line 772 of file browserextension.h.

Member Enumeration Documentation

◆ Type

enum KParts::LiveConnectExtension::Type
Enumerator
TypeVoid 
TypeBool 
TypeFunction 
TypeNumber 
TypeObject 
TypeString 

Definition at line 769 of file browserextension.h.

Constructor & Destructor Documentation

◆ LiveConnectExtension()

LiveConnectExtension::LiveConnectExtension ( KParts::ReadOnlyPart *  parent)

Definition at line 798 of file browserextension.cpp.

◆ ~LiveConnectExtension()

LiveConnectExtension::~LiveConnectExtension ( )
virtual

Definition at line 801 of file browserextension.cpp.

Member Function Documentation

◆ call()

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.

◆ childObject()

LiveConnectExtension * LiveConnectExtension::childObject ( QObject *  obj)
static

Definition at line 817 of file browserextension.cpp.

◆ get()

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.

◆ partEvent

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

◆ put()

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.

◆ unregister()

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
This file is part of the KDE documentation.
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.

KParts

Skip menu "KParts"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal