• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • interfaces
 

interfaces

Public Types | Public Member Functions
KScriptClientInterface Class Reference

#include <scriptclientinterface.h>

Inheritance diagram for KScriptClientInterface:
KScriptManager

List of all members.

Public Types

enum  Result { ResultSuccess, ResultFailure, ResultContinue, ResultBreak }

Public Member Functions

virtual void error (const TQString &msg)=0
virtual void warning (const TQString &msg)=0
virtual void output (const TQString &msg)=0
virtual void progress (int percent)=0
virtual void done (KScriptClientInterface::Result result, const TQVariant &returned)=0

Detailed Description

This class is used for allowing feedback to the main system.

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

To implement KScript in your application you would use this class to interface with the scripting engine. There are currently a few implementations of script managers around but developers can implement their own custom interfaces with this class.

    class MyScript : public TQObject, public KScriptClientInterface {
    Q_OBJECT
    public:

    MyScript(TQObject *parent)
    {
        // Create your @ref KScriptInterface here.
        m_interface = KParts::ComponentFactory::createInstanceFromQuery<KScriptInterface>( 
            "KScriptRunner/KScriptRunner", "([X-TDE-Script-Runner] == 'bash/shell')", this );
    }

    virtual ~KScriptAction()
    {
        delete m_interface;
    }

    signals:
    void error ( const TQString &msg );
    void warning ( const TQString &msg );
    void output ( const TQString &msg );
    void progress ( int percent );
    void done ( KScriptClientInterface::Result result, const TQVariant &returned );

    public slots:
    void activate(const TQVariant &args)
    {
        m_interface->run(parent(), args);
    }

    private:

    KScriptInterface *m_interface;
    };

Things to note about this example are that it only handles a single script type and instance. You may wish to extend this.

Definition at line 73 of file scriptclientinterface.h.


Member Function Documentation

virtual void KScriptClientInterface::done ( KScriptClientInterface::Result  result,
const TQVariant &  returned 
) [pure virtual]

This function will allow feedback on completion of the script.

It turns the result as a KScriptInteface::Result, and a return value as a QVariant For script clients its best to implement this as a signal so feedback can be sent to the main application.

Implemented in KScriptManager.

virtual void KScriptClientInterface::error ( const TQString &  msg) [pure virtual]

This function will allow the main application of any errors that have occurred during processing of the script.

For script clients its best to implement this as a signal so feedback can be sent to the main application.

Implemented in KScriptManager.

virtual void KScriptClientInterface::output ( const TQString &  msg) [pure virtual]

This function will allow the main application of any normal output that has occurred during the processing of the script.

For script clients its best to implement this as a signal so feedback can be sent to the main application.

Implemented in KScriptManager.

virtual void KScriptClientInterface::progress ( int  percent) [pure virtual]

This function will allow feedback to any progress bars in the main application as to how far along the script is.

This is very useful when a script is processing files or doing some long operation that is of a known duration.] For script clients its best to implement this as a signal so feedback can be sent to the main application.

Implemented in KScriptManager.

virtual void KScriptClientInterface::warning ( const TQString &  msg) [pure virtual]

This function will allow the main application of any warnings that have occurred during the processing of the script.

For script clients its best to implement this as a signal so feedback can be sent to the main application.

Implemented in KScriptManager.


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

interfaces

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

interfaces

Skip menu "interfaces"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for interfaces by doxygen 1.7.6.1
This website is maintained by Timothy Pearson.