src/plugins/macros/imacrohandler.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2010 Nicolas Arnaud-Cormos.
   6 **
   7 ** Contact: Nokia Corporation (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #ifndef MACROSPLUGIN_IMACROHANDLER_H
  34 #define MACROSPLUGIN_IMACROHANDLER_H
  35
  36 #include "macros_global.h"
  37 #include <QtCore/QObject>
  38
  39 namespace Macros {
  40
  41 class Macro;
  42 class MacroEvent;
  43 class MacroManager;
  44
  45 class MACROS_EXPORT IMacroHandler: public QObject
  46 {
  47 public:
  48     IMacroHandler();
  49     virtual ~IMacroHandler();
  50
  51     virtual void startRecording(Macro* macro);
  52     virtual void endRecordingMacro(Macro* macro);
  53
  54     virtual bool canExecuteEvent(const MacroEvent &macroEvent) = 0;
  55     virtual bool executeEvent(const MacroEvent &macroEvent) = 0;
  56
  57 protected:
  58     void addMacroEvent(const MacroEvent& event);
  59
  60     void setCurrentMacro(Macro *macro);
  61
  62     bool isRecording() const;
  63
  64 private:
  65     friend class MacroManager;
  66
  67     class IMacroHandlerPrivate;
  68     IMacroHandlerPrivate *d;
  69 };
  70
  71 } // namespace Macros
  72
  73 #endif // MACROSPLUGIN_IMACROHANDLER_H