1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
/* 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 __scriptmanager_h__
#define __scriptmanager_h__
#include <qvariant.h>
#include <scriptclientinterface.h>
#include <scriptinterface.h>
#include <qdict.h>
#include <qobject.h>
#include <kdelibs_export.h>
class ScriptInfo;
//namespace KScriptInterface
//{
/**
* This class is the base for all script engines.
* @author Ian Reinhart Geiser <geiseri@kde.org>
*
**/
class KDE_EXPORT KScriptManager : public QObject, public KScriptClientInterface
{
Q_OBJECT
friend class KScriptInterface;
public:
/**
* Create a new instance of the script engine.
*/
KScriptManager(QObject *parent, const char *name);
/**
* Destroy the current script engine.
*/
virtual ~KScriptManager();
/**
* Add a new script instance to the script engine.
* This should be the full name and path to the desktop
* file.
*/
bool addScript( const QString &scriptDesktopFile);
/**
* Remove a script instance from the script engine.
* @returns the success of the operation.
*/
bool removeScript( const QString &scriptName );
/**
* Access the names of script instances from the script engine.
* @returns a QStringList of the current scripts.
*/
QStringList scripts();
/**
* Clear all script intstances in memory
*/
void clear();
/**
* This function will allow the main application of any errors
* that have occurred during processing of the script.
*/
void error( const QString &msg ) {emit scriptError(msg);}
/**
* This function will allow the main application of any warnings
* that have occurred during the processing of the script.
*/
void warning( const QString &msg ) {emit scriptWarning(msg);}
/**
* This function will allow the main application of any normal
* output that has occurred during the processing of the script.
*/
void output( const QString &msg ) {emit scriptOutput(msg);}
/**
* 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.
*/
void progress( int percent ) {emit scriptProgress(percent);}
/**
* 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
*/
void done( KScriptClientInterface::Result result, const QVariant &returned ) {emit scriptDone(result, returned);}
public slots:
/**
* Run the selected script
*/
void runScript( const QString &scriptName, QObject *context = 0, const QVariant &arg = 0 );
signals:
/**
* Send out a signal of the error message from the current running
* script.
*/
void scriptError( const QString &msg );
/**
* Send out a signal of the warning message from the current running
* script.
*/
void scriptWarning( const QString &msg );
/**
* Send out a signal of the output message from the current running
* script.
*/
void scriptOutput( const QString &msg );
/**
* Send out a signal of the progress of the current running
* script.
*/
void scriptProgress( int percent);
/**
* Send out a signal of the exit status of the script
*
*/
void scriptDone( KScriptClientInterface::Result result, const QVariant &returned);
protected:
QDict<ScriptInfo> m_scripts;
QDict<KScriptInterface> m_scriptCache;
//QStringList m_scriptNames;
QString m_currentScript;
};
//};
#endif
|
