module kparts

class KParts.URLArgs

KParts.URLArgs is fully implemented except as noted:

QMap<QString,QString>&  metaData ()

variable d

NOT implemented

class KParts.WindowArgs

KParts.WindowArgs is fully implemented except as noted:

variable d

NOT implemented

class KParts.OpenURLEvent

KParts.OpenURLEvent is fully implemented except as noted:

class KParts.BrowserExtension

KParts.BrowserExtension is fully implemented except as noted:

actionSlotMap ()

TAKES nothing and RETURNS result (a Python dict of QCString:QCString). actionSlotMap is a static member function.

C++:  static KParts::BrowserExtension::ActionSlotMap  actionSlotMap ()

void  createNewWindow (const KURL& url, const KParts::URLArgs& args, const KParts::WindowArgs& windowArgs, KParts::ReadOnlyPart*& part)

NOT implemented

class KParts.BrowserHostExtension

KParts.BrowserHostExtension is fully implemented except as noted:

frames ()

TAKES nothing and RETURNS result (a Python list of KParts.ReadOnlyPart).

C++:  virtual const QPtrList<KParts::ReadOnlyPart>  frames 
          () const

class KParts.LiveConnectExtension [KDE 3.1.0 - ]

KParts.LiveConnectExtension is fully implemented except as noted:

typedef QValueList<QPair<Type,QString>> ArgList

virtual bool  get (const ulong objid, const QString& field, KParts::LiveConnectExtension::Type& type, ulong& retobjid, QString& value)

virtual bool  call (const ulong objid, const QString& func, const QStringList& args, KParts::LiveConnectExtension::Type& type, ulong& retobjid, QString& value)

virtual void  partEvent (const ulong objid, const QString& event, const KParts::LiveConnectExtension::ArgList& args)

NOT implemented

class KParts.BrowserInterface

KParts.BrowserInterface is fully implemented except as noted:

class KParts.BrowserRun

KParts.BrowserRun is fully implemented except as noted:

askSave (url, offer, mimeType, suggestedFilename)

TAKES url (KURL), offer (KService), mimeType (QString), suggestedFilename (QString - default = QString.null) and RETURNS result (KParts.BrowserRun.AskSaveResult). askSave is a static member function.

C++:  static KParts::BrowserRun::AskSaveResult  askSave 
          (const KURL& url, KService::Ptr offer, const QString& mimeType, const QString& suggestedFilename = QString::null)

KParts::BrowserRun::NonEmbeddableResult  handleNonEmbeddable (const QString& mimeType)

NOT implemented

class KParts.DockMainWindow

KParts.DockMainWindow is fully implemented except as noted:

class KParts.Event

KParts.Event is fully implemented except as noted:

class KParts.GUIActivateEvent

KParts.GUIActivateEvent is fully implemented except as noted:

class KParts.PartActivateEvent

KParts.PartActivateEvent is fully implemented except as noted:

class KParts.PartSelectEvent

KParts.PartSelectEvent is fully implemented except as noted:

class KParts.Factory

KParts.Factory is fully implemented except as noted:

class KParts.HistoryProvider

KParts.HistoryProvider is fully implemented except as noted:

class KParts.MainWindow

KParts.MainWindow is fully implemented except as noted:

class KParts.PartBase

KParts.PartBase is fully implemented except as noted:

void  setPluginLoadingMode (KParts::PartBase::PluginLoadingMode loadingMode)

NOT implemented

class KParts.Part

KParts.Part is fully implemented except as noted:

class KParts.ReadOnlyPart

KParts.ReadOnlyPart is fully implemented except as noted:

This class is abstract ; all pure virtual methods must be overloaded before using

Even though this is an abstract class, you can use createReadOnlyPart (see below) without creating a concrete instance of this class.

openFile ()

TAKES nothing and RETURNS result (int). Pure virtual - must be overloaded in subclass.

C++:  virtual bool  openFile ()  = 0

class KParts.ReadWritePart

KParts.ReadWritePart is fully implemented except as noted:

This class is abstract ; all pure virtual methods must be overloaded before using

Even though this is an abstract class, you can use createReadWritePart (see below) without creating a concrete instance of this class.

saveFile ()

TAKES nothing and RETURNS result (int). Pure virtual - must be overloaded in subclass.

C++:  virtual bool  saveFile ()  = 0

class KParts.PartManager

KParts.PartManager is fully implemented except as noted:

class KParts.Plugin

KParts.Plugin is fully implemented except as noted:

class KParts.Plugin.PluginInfo

KParts.Plugin.PluginInfo is fully implemented except as noted:

Global Functions

testQMapQCStringInt (dict)

C++:  QMap<QCString,int>  testQMapQCStringInt 
          (QMap<QCString,int> a0)

TAKES dict (a Python dict of QCString:int) and RETURNS result (a Python dict of QCString:int).

createReadOnlyPart (a0, a1, a2, a3, a4)

C++:  KParts::ReadOnlyPart*  createReadOnlyPart 
          (const QString& a0, QObject* a1 = 0, const QString& a2 = QString::null, const char* a3 = "KParts::ReadOnlyPart", const QStringList& a4 = QStringList())

TAKES a0 (QString), a1 (QObject - default = 0), a2 (QString - default = QString.null), a3 (char - default = "KParts.ReadOnlyPart"), a4 (QStringList - default = QStringList()) and RETURNS result (KParts.ReadOnlyPart).

This is a PyKDE-only function that handles the machinery necessary to create a KParts::ReadOnlyPart. It executes the following C++ code:

 KParts::ReadOnlyPart *createReadOnlyPart (const QString& lib, QObject *parent,
                                           const QString& name, const char *className,
                                           const QStringList &args)
{
    KLibFactory *factory = KLibLoader::self ()->factory ((const char *)lib);

    if (factory)
            return static_cast<KParts::ReadOnlyPart*> (factory->create (parent,
                                               (const char *)name, className, args));
        else
                return NULL;

Notice that it takes care of creating the KLibFactory for you, and returns the part cast to type KParts::ReadOnlyPart. The actual part has a different class (derived from KParts::ReadOnlyPart), and calls to openURL or openFile will use the part's overloaded methods. Currently it isn't possible to call KParts::ReadOnlyPart::openURL if it has been overloaded.

Usage: KParts.createReadOnlyPart (lib, parent, name, className, args)

createReadWritePart (a0, a1, a2, a3, a4)

C++:  KParts::ReadWritePart*  createReadWritePart 
          (const QString& a0, QObject* a1 = 0, const QString& a2 = QString::null, const char* a3 = "KParts::ReadWritePart", const QStringList& a4 = QStringList())

TAKES a0 (QString), a1 (QObject - default = 0), a2 (QString - default = QString.null), a3 (char - default = "KParts.ReadWritePart"), a4 (QStringList - default = QStringList()) and RETURNS result (KParts.ReadWritePart).

This is a PyKDE-only function that handles the machinery necessary to create a KParts::ReadWritePart. It executes the following C++ code:

 KParts::ReadWritePart *createReadWritePart (const QString& lib, QObject *parent,
                                           const QString& name, const char *className,
                                           const QStringList &args)
 {
     KLibFactory *factory = KLibLoader::self ()->factory ((const char *)lib);

     if (factory)
             return static_cast<KParts::ReadWritePart*> (factory->create (parent,
                                                (const char *)name, className, args));
         else
                 return NULL;

Notice that it takes care of creating the KLibFactory for you, and returns the part cast to type KParts::ReadWritePart. The actual part has a different class (derived from KParts::ReadWritePart), and calls to openURL or openFile will use the part's overloaded methods. Currently it isn't possible to call KParts::ReadWritePart::openURL if it has been overloaded.

Usage: KParts.createReadWritePart (lib, parent, name, className, args)