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
|
/***************************************************************************
* This file is part of the KDE project
* copyright (C) 2005 by Sebastian Sauer (mail@dipe.org)
* copyright (C) 2005 by Tobi Krebs (tobi.krebs@gmail.com)
*
* 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 KOMACRO_MACRO_H
#define KOMACRO_MACRO_H
#include <tqobject.h>
#include <ksharedptr.h>
#include "action.h"
#include "xmlhandler.h"
namespace KoMacro {
// Forward declarations.
class Manager;
class MacroItem;
class Context;
/**
* The Macro class implements all the action-handling. Internaly the
* Macro provides a collection of @a MacroItem instances which each
* of them points to an @a Action instance.
*/
class KOMACRO_EXPORT Macro
: public TQObject // TQt functionality like signals and slots
, public KShared // shared reference-counting
, public XMLHandler // to (un-)serialize from/to XML
{
Q_OBJECT
TQ_OBJECT
public:
/**
* A TQMap of @a Macro instances accessible by there unique name. Each
* class should use this typemap rather then the TQMap direct. That
* way we are more flexible on future changes.
*/
typedef TQMap<TQString, KSharedPtr<Macro > > Map;
/**
* Constructor.
*
* @param name The internal name this @a Macro has. This
* name will be used as unique identifier.
*/
explicit Macro(const TQString& name);
/**
* Destructor.
*/
virtual ~Macro();
/**
* @return the name this @a Macro instance has.
*/
const TQString name() const;
/**
* Set the @p name this @a Macro instance has.
*/
void setName(const TQString& name);
/**
* @return a string-representation of the macro.
*/
virtual const TQString toString() const;
/**
* @return a list of @a MacroItem instances which
* are tqchildren of this @a Macro .
*/
TQValueList< KSharedPtr<MacroItem> >& items() const;
/**
* Add the @a MacroItem @p item to the list of items
* this @a Macro has.
*/
void addItem(KSharedPtr<MacroItem> item);
/**
* Removes all @a MacroItem instances this @a Macro has.
*/
void clearItems();
/**
* Connect the TQt signal @p signal of the TQObject @p sender
* with this @a Macro . If the signal got emitted this
* @a Macro instance will be activated and the in the
* signal passed arguments are transfered into the
* activation @a Context .
*/
//void connectSignal(const TQObject* sender, const char* signal);
public slots:
/**
* Called if the @a Macro should be executed.
*
* @param context The @a Context this @a Macro should
* be executed in.
*/
virtual KSharedPtr<Context> execute(TQObject* sender);
private:
/// @internal d-pointer class.
class Private;
/// @internal d-pointer instance.
Private* const d;
};
}
#endif
|
