src/plugins/macros/macro.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_MACRO_H
  34 #define MACROSPLUGIN_MACRO_H
  35
  36 #include "macros_global.h"
  37
  38 #include <QtCore/QList>
  39 #include <QtCore/QString>
  40
  41 namespace Macros {
  42
  43 class MacroEvent;
  44
  45 class MACROS_EXPORT Macro
  46 {
  47 public:
  48     Macro();
  49     Macro(const Macro& other);
  50     ~Macro();
  51     Macro& operator=(const Macro& other);
  52
  53     void load(QString fileName = QString());
  54     void loadHeader(const QString &fileName);
  55     void save(const QString &fileName);
  56
  57     const QString &description() const;
  58     void setDescription(const QString &text);
  59
  60     const QString &version() const;
  61     const QString &fileName() const;
  62     QString displayName() const;
  63
  64     void append(const MacroEvent &event);
  65     const QList<MacroEvent> &events() const;
  66
  67     bool isWritable() const;
  68
  69 private:
  70     class MacroPrivate;
  71     MacroPrivate* d;
  72 };
  73
  74 } // namespace Macros
  75
  76 #endif // MACROSPLUGIN_MACRO_H