• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

libplasma

Plasma::ScriptEngine

Plasma::ScriptEngine Class Reference

#include <scriptengine.h>

Inheritance diagram for Plasma::ScriptEngine:

Inheritance graph
[legend]

List of all members.


Detailed Description

The base class for scripting interfaces to be used in loading plasmoids of a given language.

All ScriptEngines should export as consistent an interface as possible so that the learning curve is limited. In particular, the following API should be made available in the script environment:

TODO: define the actual scripting APIas ... PlasmaApplet - the applet of this plasmoid LoadUserInterface(String uiFile) - loads and returns a given UI file LoadImage - loads an image resource out of the plasmoid's package PlasmaSvg - creates and returns an Svg file

Definition at line 61 of file scriptengine.h.


Public Member Functions

virtual bool init ()
 ~ScriptEngine ()

Protected Member Functions

virtual QString mainScript () const
virtual const Package * package () const
 ScriptEngine (QObject *parent=0)

Constructor & Destructor Documentation

Plasma::ScriptEngine::~ScriptEngine (  ) 

Definition at line 44 of file scriptengine.cpp.

Plasma::ScriptEngine::ScriptEngine ( QObject *  parent = 0  )  [explicit, protected]

Definition at line 38 of file scriptengine.cpp.


Member Function Documentation

bool Plasma::ScriptEngine::init (  )  [virtual]

Called when it is safe to initialize the internal state of the engine.

Definition at line 49 of file scriptengine.cpp.

QString Plasma::ScriptEngine::mainScript (  )  const [protected, virtual]

Returns:
absolute path to the main script file for this plasmoid

Reimplemented in Plasma::AppletScript, and Plasma::RunnerScript.

Definition at line 59 of file scriptengine.cpp.

const Package * Plasma::ScriptEngine::package (  )  const [protected, virtual]

Returns:
the Package associated with this plasmoid which can be used to request resources, such as images and interface files.

Reimplemented in Plasma::AppletScript, and Plasma::RunnerScript.

Definition at line 54 of file scriptengine.cpp.


The documentation for this class was generated from the following files:
  • scriptengine.h
  • scriptengine.cpp

libplasma

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

API Reference

Skip menu "API Reference"
  • KWin
  •   KWin Libraries
  • Libraries
  •   libkworkspace
  •   libplasma
  •   libsolidcontrol
  •   libtaskmanager
  • Plasma
  •   Animators
  •   Applets
  •   Engines
  • Solid Modules
Generated for API Reference by doxygen 1.5.4
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