Added ParameterAction class for QActions acting on files.

Reduce inconsistencies in tr()-Strings provided for QActions that act on a current <something> (mostly files) by introducing a ParameterAction class that takes the tr()-Strings at construction time and provides a setParameter(QString) slot, allows for setting that parameter or an empty string, which will cause the displayed text to be updated.
2009-05-15 15:41:00 +02:00
parent 9106c72116
commit 81d69641ab
11 changed files with 261 additions and 128 deletions
--- a/src/libs/utils/parameteraction.h
+++ b/src/libs/utils/parameteraction.h
@@ -0,0 +1,85 @@
+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact:  Qt Software Information (qt-info@nokia.com)
+**
+** Commercial Usage
+**
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Nokia.
+**
+** GNU Lesser General Public License Usage
+**
+** Alternatively, 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at qt-sales@nokia.com.
+**
+**************************************************************************/
+
+#ifndef PARAMETERACTION_H
+#define PARAMETERACTION_H
+
+#include "utils_global.h"
+
+#include <QtGui/QAction>
+
+namespace Core {
+namespace Utils {
+
+/* ParameterAction: Intended for actions that act on a 'current',
+ * string-type parameter (typically file name) and have 2 states:
+ * 1) <no current parameter> displaying "Do XX" (empty text)
+ * 2) <parameter present> displaying "Do XX with %1".
+ * Provides a slot to set the parameter, changing display
+ * and enabled state accordingly.
+ * The text passed in should already be translated; parameterText
+ * should contain a %1 where the parameter is to be inserted. */
+
+class QTCREATOR_UTILS_EXPORT ParameterAction : public QAction
+{
+    Q_ENUMS(EnablingMode)
+    Q_PROPERTY(QString emptyText READ emptyText WRITE setEmptyText)
+    Q_PROPERTY(QString parameterText READ parameterText WRITE setParameterText)
+    Q_PROPERTY(EnablingMode enablingMode READ enablingMode WRITE setEnablingMode)
+    Q_OBJECT
+public:
+    enum EnablingMode { AlwaysEnabled, EnabledWithParameter };
+
+    explicit ParameterAction(const QString &emptyText,
+                             const QString &parameterText,
+                             EnablingMode em = AlwaysEnabled,
+                             QObject* parent = 0);
+
+    QString emptyText() const;
+    void setEmptyText(const QString &);
+
+    QString parameterText() const;
+    void setParameterText(const QString &);
+
+    EnablingMode enablingMode() const;
+    void setEnablingMode(EnablingMode m);
+
+public slots:
+    void setParameter(const QString &);
+
+private:
+    QString m_emptyText;
+    QString m_parameterText;
+    EnablingMode m_enablingMode;
+};
+
+}
+}
+
+#endif // PARAMETERACTION_H