summaryrefslogtreecommitdiffstats
path: root/interfaces/kscript/scriptclientinterface.h
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commitce4a32fe52ef09d8f5ff1dd22c001110902b60a2 (patch)
tree5ac38a06f3dde268dc7927dc155896926aaf7012 /interfaces/kscript/scriptclientinterface.h
downloadtdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.tar.gz
tdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'interfaces/kscript/scriptclientinterface.h')
-rw-r--r--interfaces/kscript/scriptclientinterface.h124
1 files changed, 124 insertions, 0 deletions
diff --git a/interfaces/kscript/scriptclientinterface.h b/interfaces/kscript/scriptclientinterface.h
new file mode 100644
index 000000000..adeaa6424
--- /dev/null
+++ b/interfaces/kscript/scriptclientinterface.h
@@ -0,0 +1,124 @@
+/* This file is part of the KDE project
+ Copyright (C) 2001 Ian Reinhart Geiser (geiseri@kde.org)
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Library General Public
+ License as published by the Free Software Foundation; either
+ version 2 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Library General Public License for more details.
+
+ You should have received a copy of the GNU Library General Public License
+ along with this library; see the file COPYING.LIB. If not, write to
+ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
+*/
+#ifndef __scriptclientinterface_h__
+#define __scriptclientinterface_h__
+#include <qvariant.h>
+
+class QString;
+
+//namespace KScriptInterface
+//{
+ /**
+ * 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.
+ * @code
+ * class MyScript : public QObject, public KScriptClientInterface {
+ * Q_OBJECT
+ * public:
+ *
+ * MyScript(QObject *parent)
+ * {
+ * // Create your @ref KScriptInterface here.
+ * m_interface = KParts::ComponentFactory::createInstanceFromQuery<KScriptInterface>(
+ * "KScriptRunner/KScriptRunner", "([X-KDE-Script-Runner] == 'bash/shell')", this );
+ * }
+ *
+ * virtual ~KScriptAction()
+ * {
+ * delete m_interface;
+ * }
+ *
+ * signals:
+ * void error ( const QString &msg );
+ * void warning ( const QString &msg );
+ * void output ( const QString &msg );
+ * void progress ( int percent );
+ * void done ( KScriptClientInterface::Result result, const QVariant &returned );
+ *
+ * public slots:
+ * void activate(const QVariant &args)
+ * {
+ * m_interface->run(parent(), args);
+ * }
+ *
+ * private:
+ *
+ * KScriptInterface *m_interface;
+ * };
+ * @endcode
+ * Things to note about this example are that it only handles a single script type and instance. You may wish to
+ * extend this.
+ **/
+
+ class KScriptClientInterface
+ {
+ public:
+ enum Result { ResultSuccess, ResultFailure, ResultContinue, ResultBreak };
+ /**
+ * 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.
+ */
+ virtual void error( const QString &msg ) =0;
+ /**
+ * 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.
+ */
+ virtual void warning( const QString &msg ) =0;
+ /**
+ * 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.
+ */
+ virtual void output( const QString &msg ) =0;
+ /**
+ * 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.
+ */
+ virtual void progress( int percent ) =0;
+ /**
+ * 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.
+ */
+ virtual void done( KScriptClientInterface::Result result, const QVariant &returned ) =0;
+ /**
+ * Returned when the script has finished running.
+ * For script clients its best to implement this as a signal so feedback
+ * can be sent to the main application.
+ **/
+ //virtual bool isRunning() =0;
+ };
+//};
+
+#endif