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
|
/***************************************************************************
* callable.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_CALLABLE_H
#define KROSS_API_CALLABLE_H
#include "object.h"
#include "list.h"
//#include "exception.h"
#include <tqstring.h>
#include <tqvaluelist.h>
#include <ksharedptr.h>
namespace Kross { namespace Api {
/**
* Base class for callable objects. Classes like
* \a Event or \a Class are inherited from this class
* and implement the \a Object::call() method to handle
* the call.
*/
class Callable : public Object
{
public:
/**
* Shared pointer to implement reference-counting.
*/
typedef TDESharedPtr<Callable> Ptr;
/**
* Constructor.
*
* \param name The name this callable object has and
* it is reachable as via \a getChild() .
*/
Callable(const TQString& name);
/**
* Destructor.
*/
virtual ~Callable();
/**
* \return the name this object has. Each callable object
* has a name which is used e.g. on \a addChild to be able
* to identify the object itself.
*/
const TQString getName() const;
/**
* Return the class name. This could be something
* like "Kross::Api::Callable" for this object. The
* value is mainly used for display purposes.
*
* \return The name of this class.
*/
virtual const TQString getClassName() const;
/**
* Returns if the defined child is avaible.
*
* \return true if child exists else false.
*/
bool hasChild(const TQString& name) const;
/**
* Return the defined child or NULL if there is
* no such object with that name avaible.
*
* \param name The name of the Object to return.
* \return The Object matching to the defined
* name or NULL if there is no such Object.
*/
Object::Ptr getChild(const TQString& name) const;
/**
* Return all children.
*
* \return A \a ObjectMap of children this Object has.
*/
TQMap<TQString, Object::Ptr> getChildren() const;
/**
* Add a new child. Replaces a possible already existing
* child with such a name.
*
* \param name the name of the child
* \param object The Object to add.
* \return true if the Object was added successfully
* else false.
*/
bool addChild(const TQString& name, Object* object);
/**
* Same as the \a addChild method above but for callable
* objects which define there own name.
*/
bool addChild(Callable* object);
/**
* Remove an existing child.
*
* \param name The name of the Object to remove.
* If there doesn't exists an Object with
* such name just nothing will be done.
*/
void removeChild(const TQString& name);
/**
* Remove all children.
*/
void removeAllChildren();
/**
* Call the object.
*/
virtual Object::Ptr call(const TQString& name, List::Ptr arguments);
private:
/// Name this callable object has.
TQString m_name;
/// A list of childobjects.
TQMap<TQString, Object::Ptr> m_children;
};
}}
#endif
|
