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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/***************************************************************************
* mainmodule.h
* This file is part of the KDE project
* copyright (C)2004-2005 by Sebastian Sauer (mail@dipe.org)
*
* This program 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 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
* Library General Public License for more details.
* You should have received a copy of the GNU Library General Public License
* along with this program; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
***************************************************************************/
#ifndef KROSS_API_MAINMODULE_H
#define KROSS_API_MAINMODULE_H
#include "../api/object.h"
#include "../api/variant.h"
#include "../api/module.h"
#include "../api/event.h"
#include "../api/eventsignal.h"
#include "../api/eventslot.h"
#include "../api/qtobject.h"
#include "../api/eventaction.h"
#include <qstring.h>
#include <qvariant.h>
#include <qobject.h>
#include <ksharedptr.h>
#include <kaction.h>
namespace Kross { namespace Api {
// Forward declarations.
class MainModulePrivate;
/**
* This class implements \a Module for the global
* \a Manager singleton and local \a ScriptContainer
* instances.
*
* The MainModule class provides base functionality
* for a root node in a tree of \a Kross::Api::Object
* instances.
*/
class MainModule : public Module
{
public:
/// Shared pointer to implement reference-counting.
typedef KSharedPtr<MainModule> Ptr;
/**
* Constructor.
*
* \param name the name of the \a Module . While the
* global manager module has the name "Kross"
* the \a ScriptContainer instances are accessible
* by there \a ScriptContainer::getName() name.
*/
explicit MainModule(const QString& name);
/**
* Destructor.
*/
virtual ~MainModule();
/// \see Kross::Api::Object::getClassName()
virtual const QString getClassName() const;
/**
* \return true if the script throwed an exception
* else false.
*/
bool hadException();
/**
* \return the \a Exception this module throwed.
*/
Exception::Ptr getException();
/**
* Set the \a Exception this module throwed.
*
* \param exception The \a Exception this module throws or
* NULL if you like to clear exception and to let
* \a hadException() return false.
*/
void setException(Exception::Ptr exception);
#if 0
/**
* Returns if the defined child is avaible.
*
* \return true if child exists else false.
*/
bool hasChild(const QString& name) const;
#endif
/**
* Add a Qt signal to the \a Module by creating
* an \a EventSignal for it.
*
* \param name the name the \a EventSignal is
* reachable as
* \param sender the QObject instance which
* is the sender of the \p signal
* \param signal the Qt signal macro the \p sender
* emits to call the \a EventSignal
* \return the newly added \a EventSignal instance
* which is now a child of this \a MainModule
*/
EventSignal::Ptr addSignal(const QString& name, QObject* sender, QCString signal);
/**
* Add a Qt slot to the \a Module by creating
* an \a EventSlot for it.
*
* \param name the name the \a EventSlot is
* reachable as
* \param receiver the QObject instance which
* is the receiver of the \p signal
* \param slot the Qt slot macro of the \p receiver
* to invoke if the \a EventSlot got called.
* \return the newly added \a EventSlot instance
* which is now a child of this \a MainModule
*/
EventSlot::Ptr addSlot(const QString& name, QObject* receiver, QCString slot);
/**
* Add a \a QObject to the eventcollection. All
* signals and slots the QObject has will be
* added to a new \a EventCollection instance
* which is child of this \a EventCollection
* instance.
*
* \param object the QObject instance that should
* be added to this \a MainModule
* \param name the name under which this QObject instance
* should be registered as
* \return the newly added \a QtObject instance
* which is now a child of this \a MainModule
*/
QtObject::Ptr addQObject(QObject* object, const QString& name = QString::null);
/**
* Add a \a KAction to the eventcollection. The
* KAction will be wrapped by a \a EventAction
* and will be added to this collection.
*
* \param name name to identify the \a action by
* \param action the KAction instance that should
* be added to this \a MainModule
* \return the newly added \a EventAction instance
* which is now a child of this \a MainModule
*
* \todo check \a name dox.
*/
EventAction::Ptr addKAction(KAction* action, const QString& name = QString::null);
//typedef QValueList<Callable::Ptr> EventList;
//EventList getEvents();
//const QString& serializeToXML();
//void unserializeFromXML(const QString& xml);
private:
/// Private d-pointer class.
MainModulePrivate* d;
};
}}
#endif
|
