src/libs/utils/savedaction.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef SAVED_ACTION_H
  35 #define SAVED_ACTION_H
  36
  37 #include "utils_global.h"
  38
  39 #include <QtCore/QString>
  40 #include <QtCore/QVariant>
  41 #include <QtCore/QList>
  42
  43 #include <QtGui/QAction>
  44
  45 QT_BEGIN_NAMESPACE
  46 class QSettings;
  47 QT_END_NAMESPACE
  48
  49 namespace Utils {
  50
  51 enum ApplyMode { ImmediateApply, DeferedApply };
  52
  53 class QTCREATOR_UTILS_EXPORT SavedAction : public QAction
  54 {
  55     Q_OBJECT
  56
  57 public:
  58     SavedAction(QObject *parent = 0);
  59
  60     virtual QVariant value() const;
  61     Q_SLOT virtual void setValue(const QVariant &value, bool doemit = true);
  62
  63     virtual QVariant defaultValue() const;
  64     Q_SLOT virtual void setDefaultValue(const QVariant &value);
  65
  66     virtual QAction *updatedAction(const QString &newText);
  67     Q_SLOT virtual void trigger(const QVariant &data);
  68
  69     // used for persistency
  70     virtual QString settingsKey() const;
  71     Q_SLOT virtual void setSettingsKey(const QString &key);
  72     Q_SLOT virtual void setSettingsKey(const QString &group, const QString &key);
  73
  74     virtual QString settingsGroup() const;
  75     Q_SLOT virtual void setSettingsGroup(const QString &group);
  76
  77     virtual void readSettings(const QSettings *settings);
  78     Q_SLOT virtual void writeSettings(QSettings *settings);
  79
  80     virtual void connectWidget(QWidget *widget, ApplyMode applyMode = DeferedApply);
  81     virtual void disconnectWidget();
  82     Q_SLOT virtual void apply(QSettings *settings);
  83
  84     virtual QString textPattern() const;
  85     Q_SLOT virtual void setTextPattern(const QString &value);
  86
  87     QString toString() const;
  88
  89 signals:
  90     void valueChanged(const QVariant &newValue);
  91
  92 private:
  93     Q_SLOT void uncheckableButtonClicked();
  94     Q_SLOT void checkableButtonClicked(bool);
  95     Q_SLOT void lineEditEditingFinished();
  96     Q_SLOT void pathChooserEditingFinished();
  97     Q_SLOT void actionTriggered(bool);
  98     Q_SLOT void spinBoxValueChanged(int);
  99     Q_SLOT void spinBoxValueChanged(QString);
 100     Q_SLOT void groupBoxToggled(bool checked);
 101
 102     QVariant m_value;
 103     QVariant m_defaultValue;
 104     QString m_settingsKey;
 105     QString m_settingsGroup;
 106     QString m_textPattern;
 107     QString m_textData;
 108     QWidget *m_widget;
 109     ApplyMode m_applyMode;
 110 };
 111
 112 class QTCREATOR_UTILS_EXPORT SavedActionSet
 113 {
 114 public:
 115     SavedActionSet() {}
 116     ~SavedActionSet() {}
 117
 118     void insert(SavedAction *action, QWidget *widget);
 119     void apply(QSettings *settings);
 120     void finish();
 121     void clear() { m_list.clear(); }
 122
 123     // Search keywords for options dialog search.
 124     QString searchKeyWords() const;
 125
 126 private:
 127     QList<SavedAction *> m_list;
 128 };
 129
 130 } // namespace Utils
 131
 132 #endif // SAVED_ACTION_H