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
|
/***************************************************************************
* Copyright (C) 2004 by ian geiser *
* geiseri@sourcextreme.com *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
* This program 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 General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
#ifndef KScriptAction_H
#define KScriptAction_H
#include <scriptclientinterface.h>
#include <qobject.h>
#include <qptrlist.h>
class KAction;
class KActionCollection;
class KScriptInterface;
class KScriptActionManager;
class QTimer;
/**
* Connects a KAction to a script runner.
*
* @author ian geiser geiseri@sourcextreme.com
*/
class KScriptAction : public QObject, public KScriptClientInterface {
Q_OBJECT
public:
KScriptAction( const QString &scriptDesktopFile, QObject *interface, KActionCollection *ac );
virtual ~KScriptAction();
/**
* KAction for the current script
*/
KAction *action();
/**
* Returns the validity of the current script.
*/
bool isValid() const;
signals:
// Reimplemented from KScript
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 );
signals:
void scriptError ( const QString &msg );
void scriptWarning ( const QString &msg );
void scriptOutput ( const QString &msg );
void scriptProgress ( int percent );
void scriptDone ( KScriptClientInterface::Result result, const QVariant &returned );
private slots:
void activate();
void cleanup();
void scriptFinished();
private:
KAction *m_action;
QString m_scriptName;
QString m_scriptType;
QString m_scriptFile;
QString m_scriptMethod;
KScriptInterface *m_interface;
bool m_isValid;
QTimer *m_timeout;
uint m_refs;
};
/**
* Provides an actionlist of scripts that are currently available.
* Scripts are not actually loaded until they are actually executed.
* @author ian geiser <geiseri@sourcextreme.com>
*/
class KScriptActionManager : public QObject {
Q_OBJECT
public:
/**
* Create a script manager that is attached to an action collection.
*/
KScriptActionManager( QObject *parent, KActionCollection *ac );
~KScriptActionManager();
/**
* Return all currently loaded scripts in a direcotry and attaches them
* to a QObject interface. If the dirs are empty the current applications
* scripts directory is used. The dirs are actual directories to search
* in the $KDEPATH/data/ direcories. So if you add "coolapp/data" then
* the manager will search in $KDEPATH/data/coolapp/data for all desktop
* files that are scripts.
*/
QPtrList<KAction> scripts( QObject *interface, const QStringList &dirs = QStringList() ) const;
signals:
/**
* Returns an error message from a script.
*/
void scriptError ( const QString &msg );
/**
* Returns a warning message from a script.
*/
void scriptWarning ( const QString &msg );
/**
* Returns a standard out message from a script.
*/
void scriptOutput ( const QString &msg );
/**
* Returns the percentage complete of an operation in the script.
*/
void scriptProgress ( int percent );
/**
* Notifies that the script has finished.
*/
void scriptDone( KScriptClientInterface::Result result, const QVariant &returned );
private:
mutable QPtrList<KScriptAction> m_actions;
KActionCollection *m_ac;
};
#endif
|
