Newer
Older
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nicolas Arnaud-Cormos.
**
**
**
** GNU Lesser General Public License Usage
**
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this file.
** Please review the following information to ensure the GNU Lesser General
** Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
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
**
**************************************************************************/
#include "imacrohandler.h"
#include "macro.h"
using namespace Macros;
/*!
\class Macro::IEventHandler
\brief Base class for all macro event handlers.
An event handler is used to handle a specific type of macro events.
They are used to create and replay macro events, use MacroManager::registerEventHandler
to add a new event handler.
*/
/*!
\fn void IEventHandler::startRecording(Macro* macro)
This method is called when starting to record a macro, it can be used
to initialize some data.
*/
/*!
\fn void IEventHandler::endRecordingMacro(Macro* macro)
This method is called after recording a macro, to cleanup everything.
*/
/*!
\fn bool IEventHandler::canExecuteEvent(const MacroEvent ¯oEvent)
When replaying a macro, the manager iterate through all macro events
in the macro and call this method to know which handler to use.
If the method returns true, executeEvent is called.
*/
/*!
\fn bool IEventHandler::executeEvent(const MacroEvent ¯oEvent)
This method execute a specific macro event, using the values stored in
the macro event.
*/
class IMacroHandler::IMacroHandlerPrivate
{
public:
IMacroHandlerPrivate();
Macro *currentMacro;
};
IMacroHandler::IMacroHandlerPrivate::IMacroHandlerPrivate() :
currentMacro(0)
{
}
// ---------- IMacroHandler ------------
IMacroHandler::IMacroHandler():
d(new IMacroHandlerPrivate)
{
}
IMacroHandler::~IMacroHandler()
{
delete d;
}
void IMacroHandler::startRecording(Macro* macro)
{
d->currentMacro = macro;
}
void IMacroHandler::endRecordingMacro(Macro* macro)
{
Q_UNUSED(macro)
d->currentMacro = 0;
}
void IMacroHandler::addMacroEvent(const MacroEvent& event)
{
if (d->currentMacro)
d->currentMacro->append(event);
}
void IMacroHandler::setCurrentMacro(Macro *macro)
{
d->currentMacro = macro;
}
bool IMacroHandler::isRecording() const
{
return d->currentMacro != 0;
}