• Skip to content
  • Skip to link menu
KDE 3.5 API Reference
  • KDE API Reference
  • @topname@
  • Sitemap
  • Contact Us
 

interfaces

KScriptInterface Class Reference

#include <scriptinterface.h>

Inheritance diagram for KScriptInterface:

QObject

List of all members.


Detailed Description

This class is the base for all script engines.

Author:
Ian Reinhart Geiser <geiseri@kde.org>

Definition at line 47 of file scriptinterface.h.


Public Member Functions

virtual QString script () const =0
virtual void setScript (const QString &scriptFile)=0
virtual void setScript (const QString &scriptLibFile, const QString &method)=0
virtual void run (QObject *context=0, const QVariant &arg=0)=0
virtual void kill ()=0

Public Attributes

KScriptClientInterface * ScriptClientInterface

Member Function Documentation

virtual QString KScriptInterface::script (  )  const [pure virtual]

Return the current script code data.

Returns:
QString containing the currenly runable code

virtual void KScriptInterface::setScript ( const QString &  scriptFile  )  [pure virtual]

Sets the path to the script library that we are going to embed.

virtual void KScriptInterface::setScript ( const QString &  scriptLibFile,
const QString &  method 
) [pure virtual]

Sets the path to the script library that we are going to embed.

The second argument is the function from the script library that we wish to call.

virtual void KScriptInterface::run ( QObject *  context = 0,
const QVariant &  arg = 0 
) [pure virtual]

Run the actual script code This can both take a context object that will be shared between the main application and a variant that will contain the arguments.

virtual void KScriptInterface::kill (  )  [pure virtual]

Abort the scripts run.


Member Data Documentation

KScriptClientInterface* KScriptInterface::ScriptClientInterface

This is the method for sending feedback to applications.

example of how this works:

        ScriptClientInterface->error( message_to_send_back_to_the_main_application );
Will send the error message back to the main application.

Definition at line 85 of file scriptinterface.h.


The documentation for this class was generated from the following file:
  • scriptinterface.h

interfaces

Skip menu "interfaces"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

@topname@

Skip menu "@topname@"
  •     kdnssd-avahi
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for @topname@ by doxygen 1.5.5
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal