src/libs/utils/parameteraction.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 PARAMETERACTION_H
  35 #define PARAMETERACTION_H
  36
  37 #include "utils_global.h"
  38
  39 #include <QtGui/QAction>
  40
  41 namespace Utils {
  42
  43 /* ParameterAction: Intended for actions that act on a 'current',
  44  * string-type parameter (typically file name) and have 2 states:
  45  * 1) <no current parameter> displaying "Do XX" (empty text)
  46  * 2) <parameter present> displaying "Do XX with %1".
  47  * Provides a slot to set the parameter, changing display
  48  * and enabled state accordingly.
  49  * The text passed in should already be translated; parameterText
  50  * should contain a %1 where the parameter is to be inserted. */
  51
  52 class QTCREATOR_UTILS_EXPORT ParameterAction : public QAction
  53 {
  54     Q_ENUMS(EnablingMode)
  55     Q_PROPERTY(QString emptyText READ emptyText WRITE setEmptyText)
  56     Q_PROPERTY(QString parameterText READ parameterText WRITE setParameterText)
  57     Q_PROPERTY(EnablingMode enablingMode READ enablingMode WRITE setEnablingMode)
  58     Q_OBJECT
  59 public:
  60     enum EnablingMode { AlwaysEnabled, EnabledWithParameter };
  61
  62     explicit ParameterAction(const QString &emptyText,
  63                              const QString &parameterText,
  64                              EnablingMode em = AlwaysEnabled,
  65                              QObject *parent = 0);
  66
  67     QString emptyText() const;
  68     void setEmptyText(const QString &);
  69
  70     QString parameterText() const;
  71     void setParameterText(const QString &);
  72
  73     EnablingMode enablingMode() const;
  74     void setEnablingMode(EnablingMode m);
  75
  76 public slots:
  77     void setParameter(const QString &);
  78
  79 private:
  80     QString m_emptyText;
  81     QString m_parameterText;
  82     EnablingMode m_enablingMode;
  83 };
  84
  85 } // namespace Utils
  86
  87 #endif // PARAMETERACTION_H