TrackedAction.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#include "MantidQtWidgets/Common/TrackedAction.h"
#include "MantidKernel/UsageService.h"
#include <QCoreApplication>
 
namespace MantidQt {
namespace MantidWidgets {
 
TrackedAction::TrackedAction(QObject *parent) : QAction(parent), m_isTracking(true), m_trackingName() {
  setupTracking();
}
 
TrackedAction::TrackedAction(const QString &text, QObject *parent)
    : QAction(text, parent), m_isTracking(true), m_trackingName() {
  setupTracking();
}
 
TrackedAction::TrackedAction(const QIcon &icon, const QString &text, QObject *parent)
    : QAction(icon, text, parent), m_isTracking(true), m_trackingName() {
  setupTracking();
}
 
void TrackedAction::setTrackingName(const std::vector<std::string> &name) { m_trackingName = name; }
 
std::vector<std::string> TrackedAction::getTrackingName() const {
  if (m_trackingName.empty()) {
    m_trackingName = generateTrackingName();
  }
  return m_trackingName;
}
 
void TrackedAction::setIsTracking(const bool enableTracking) { m_isTracking = enableTracking; }
 
bool TrackedAction::getIsTracking() const { return m_isTracking; }
 
void TrackedAction::setupTracking() { connect(this, SIGNAL(triggered(bool)), this, SLOT(trackActivation(bool))); }
 
std::vector<std::string> TrackedAction::generateTrackingName() const {
  return {QCoreApplication::applicationName().toStdString(), QAction::text().remove("&").remove(" ").toStdString()};
}
 
void TrackedAction::trackActivation(const bool checked) {
  UNUSED_ARG(checked);
  if (m_isTracking) {
    // do tracking
    registerUsage(getTrackingName());
  }
}
 
void TrackedAction::registerUsage(const std::vector<std::string> &name) {
  Mantid::Kernel::UsageService::Instance().registerFeatureUsage(Mantid::Kernel::FeatureType::Feature, name, false);
}
 
} // namespace MantidWidgets
} // namespace MantidQt