summaryrefslogtreecommitdiffstats
path: root/interfaces/kscript/scriptclientinterface.h
diff options
context:
space:
mode:
authorTimothy Pearson <kb9vqf@pearsoncomputing.net>2013-01-26 13:17:21 -0600
committerTimothy Pearson <kb9vqf@pearsoncomputing.net>2013-01-26 13:17:21 -0600
commitdfe289850f068f19ba4a83ab4e7e22a7e09c13c9 (patch)
treec297348a55df66c571de4525646e0b9762427353 /interfaces/kscript/scriptclientinterface.h
parentb7658a0d5eca24a9d37c6e04f88298ef02389db0 (diff)
downloadtdelibs-dfe289850f068f19ba4a83ab4e7e22a7e09c13c9.tar.gz
tdelibs-dfe289850f068f19ba4a83ab4e7e22a7e09c13c9.zip
Rename a number of libraries and executables to avoid conflicts with KDE4
Diffstat (limited to 'interfaces/kscript/scriptclientinterface.h')
-rw-r--r--interfaces/kscript/scriptclientinterface.h124
1 files changed, 0 insertions, 124 deletions
diff --git a/interfaces/kscript/scriptclientinterface.h b/interfaces/kscript/scriptclientinterface.h
deleted file mode 100644
index 0f07d34b2..000000000
--- a/interfaces/kscript/scriptclientinterface.h
+++ /dev/null
@@ -1,124 +0,0 @@
-/* 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 <tqvariant.h>
-
-class TQString;
-
-//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 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;
- * };
- * @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 TQString &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 TQString &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 TQString &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 TQVariant &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