mirror of
https://github.com/OPM/ResInsight.git
synced 2025-02-11 16:06:04 -06:00
01921a50ab
Move Add and Delete command features there. Implement generic Toggle Commands. Make library an cmake "OBJECT" library to allow "registering by static initialization". Add the concept of CurrentContextMenuTargetWidget into CmdFeatureManager to support the toggle commands. Updated test application to use the new commands
351 lines
12 KiB
C++
351 lines
12 KiB
C++
//##################################################################################################
|
|
//
|
|
// Custom Visualization Core library
|
|
// Copyright (C) 2011-2013 Ceetron AS
|
|
//
|
|
// This library may be used under the terms of either the GNU General Public License or
|
|
// the GNU Lesser General Public License as follows:
|
|
//
|
|
// GNU General Public License Usage
|
|
// This library is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This library is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
// FITNESS FOR A PARTICULAR PURPOSE.
|
|
//
|
|
// See the GNU General Public License at <<http://www.gnu.org/licenses/gpl.html>>
|
|
// for more details.
|
|
//
|
|
// GNU Lesser General Public License Usage
|
|
// This library is free software; you can redistribute it and/or modify
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
// the Free Software Foundation; either version 2.1 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This library is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
// FITNESS FOR A PARTICULAR PURPOSE.
|
|
//
|
|
// See the GNU Lesser General Public License at <<http://www.gnu.org/licenses/lgpl-2.1.html>>
|
|
// for more details.
|
|
//
|
|
//##################################################################################################
|
|
|
|
|
|
#include "cafCmdFeatureManager.h"
|
|
|
|
#include "cafCmdFeature.h"
|
|
#include "cafCmdSelectionHelper.h"
|
|
#include "cafFactory.h"
|
|
|
|
#include <QAction>
|
|
#include <QKeySequence>
|
|
|
|
namespace caf
|
|
{
|
|
|
|
typedef Factory<CmdFeature, std::string> CommandFeatureFactory;
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
CmdFeatureManager::CmdFeatureManager()
|
|
{
|
|
// Make sure all command features are created. The command feature is registered
|
|
// in the command factory, and instantiated when required. This will enable possibility
|
|
// of searching through all command features instead of having to use the string keys to
|
|
// be sure all command features are present.
|
|
std::vector<std::string> keys = CommandFeatureFactory::instance()->allKeys();
|
|
for (size_t i = 0; i < keys.size(); i++)
|
|
{
|
|
createFeature(keys[i]);
|
|
}
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
CmdFeatureManager::~CmdFeatureManager()
|
|
{
|
|
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
CmdFeatureManager* CmdFeatureManager::instance()
|
|
{
|
|
static CmdFeatureManager* singleton = new CmdFeatureManager;
|
|
return singleton;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
/// Get action for the specified command.
|
|
/// The action is owned by the PdmCommandItemManager
|
|
//--------------------------------------------------------------------------------------------------
|
|
QAction* CmdFeatureManager::action(const QString& commandId)
|
|
{
|
|
std::pair<CmdFeature*, size_t> featurePair = createFeature(commandId.toStdString());
|
|
|
|
QAction* act = featurePair.first->action();
|
|
m_actionToFeatureIdxMap[act] = featurePair.second;
|
|
|
|
return act;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
/// Get action for the specified command, with custom action text
|
|
/// The action is owned by the PdmCommandItemManager
|
|
//--------------------------------------------------------------------------------------------------
|
|
QAction* CmdFeatureManager::action(const QString& commandId, const QString& customActionText)
|
|
{
|
|
std::pair<CmdFeature*, size_t> featurePair = createFeature(commandId.toStdString());
|
|
|
|
QAction* act = featurePair.first->actionWithCustomText(customActionText);
|
|
m_actionToFeatureIdxMap[act] = featurePair.second;
|
|
|
|
return act;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
/// Get action for the specified command, with custom action text
|
|
/// The action is owned by the PdmCommandItemManager
|
|
//--------------------------------------------------------------------------------------------------
|
|
QAction* CmdFeatureManager::actionWithUserData(const QString& commandId, const QString& customActionText, const QVariant& userData)
|
|
{
|
|
std::pair<CmdFeature*, size_t> featurePair = createFeature(commandId.toStdString());
|
|
|
|
QAction* act = featurePair.first->actionWithUserData(customActionText, userData);
|
|
m_actionToFeatureIdxMap[act] = featurePair.second;
|
|
|
|
return act;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
std::pair<CmdFeature*, size_t> CmdFeatureManager::createFeature(const std::string& commandId)
|
|
{
|
|
std::pair<CmdFeature*, size_t> featurePair = this->findExistingCmdFeature(commandId);
|
|
|
|
if (featurePair.first)
|
|
{
|
|
return featurePair;
|
|
}
|
|
|
|
CmdFeature* feature = CommandFeatureFactory::instance()->create(commandId);
|
|
CAF_ASSERT(feature); // The command ID is not known in the factory
|
|
|
|
feature->setParent(this);
|
|
size_t index = m_commandFeatures.size();
|
|
m_commandFeatures.push_back(feature);
|
|
m_commandIdToFeatureIdxMap[commandId] = index;
|
|
|
|
return std::make_pair(feature, index);
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
std::pair<CmdFeature*, size_t> CmdFeatureManager::findExistingCmdFeature(const std::string& commandId)
|
|
{
|
|
std::map<std::string, size_t>::const_iterator it;
|
|
it = m_commandIdToFeatureIdxMap.find(commandId);
|
|
|
|
if (it != m_commandIdToFeatureIdxMap.end())
|
|
{
|
|
size_t itemIndex = it->second;
|
|
|
|
CmdFeature* item = m_commandFeatures[itemIndex];
|
|
item->refreshEnabledState();
|
|
|
|
return std::make_pair(item, itemIndex);
|
|
}
|
|
else
|
|
{
|
|
return std::make_pair(static_cast<CmdFeature*>(nullptr), -1);
|
|
}
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
caf::CmdFeature* CmdFeatureManager::commandFeature(const std::string& commandId) const
|
|
{
|
|
std::map<std::string, size_t>::const_iterator it;
|
|
it = m_commandIdToFeatureIdxMap.find(commandId);
|
|
|
|
if (it != m_commandIdToFeatureIdxMap.end())
|
|
{
|
|
size_t itemIndex = it->second;
|
|
|
|
CmdFeature* item = m_commandFeatures[itemIndex];
|
|
|
|
return item;
|
|
}
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void CmdFeatureManager::refreshStates(const QStringList& commandIdList)
|
|
{
|
|
if (commandIdList.size() == 0)
|
|
{
|
|
for (size_t i = 0; i < m_commandFeatures.size(); i++)
|
|
{
|
|
CmdFeature* cmdFeature = m_commandFeatures[i];
|
|
|
|
if (cmdFeature)
|
|
{
|
|
cmdFeature->refreshEnabledState();
|
|
cmdFeature->refreshCheckedState();
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
for (int i = 0; i < commandIdList.size(); i++)
|
|
{
|
|
std::pair<CmdFeature*, size_t> featurePair = findExistingCmdFeature(commandIdList.at(i).toStdString());
|
|
|
|
if (featurePair.first)
|
|
{
|
|
featurePair.first->refreshEnabledState();
|
|
featurePair.first->refreshCheckedState();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void CmdFeatureManager::refreshEnabledState(const QStringList& commandIdList)
|
|
{
|
|
if (commandIdList.size() == 0)
|
|
{
|
|
for (size_t i = 0; i < m_commandFeatures.size(); i++)
|
|
{
|
|
m_commandFeatures[i]->refreshEnabledState();
|
|
}
|
|
}
|
|
else
|
|
{
|
|
for (int i = 0; i < commandIdList.size(); i++)
|
|
{
|
|
std::pair<CmdFeature*, size_t> featurePair = findExistingCmdFeature(commandIdList.at(i).toStdString());
|
|
|
|
if (featurePair.first)
|
|
{
|
|
featurePair.first->refreshEnabledState();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void CmdFeatureManager::refreshCheckedState(const QStringList& commandIdList)
|
|
{
|
|
if (commandIdList.size() == 0)
|
|
{
|
|
for (size_t i = 0; i < m_commandFeatures.size(); i++)
|
|
{
|
|
m_commandFeatures[i]->refreshCheckedState();
|
|
}
|
|
}
|
|
else
|
|
{
|
|
for (int i = 0; i < commandIdList.size(); i++)
|
|
{
|
|
std::pair<CmdFeature*, size_t> featurePair = findExistingCmdFeature(commandIdList.at(i).toStdString());
|
|
|
|
if (featurePair.first)
|
|
{
|
|
featurePair.first->refreshCheckedState();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
CmdFeature* CmdFeatureManager::getCommandFeature(const std::string& commandId)
|
|
{
|
|
std::pair<CmdFeature*, size_t> featurePair = createFeature(commandId);
|
|
|
|
return featurePair.first;
|
|
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
std::vector<CmdFeature*> CmdFeatureManager::commandFeaturesMatchingSubString(const std::string& subString) const
|
|
{
|
|
std::vector<CmdFeature*> matches;
|
|
|
|
std::vector<std::string> keys = CommandFeatureFactory::instance()->allKeys();
|
|
for (size_t i = 0; i < keys.size(); i++)
|
|
{
|
|
if (keys[i].find(subString) != std::string::npos)
|
|
{
|
|
caf::CmdFeature* cmdFeature = commandFeature(keys[i]);
|
|
if (cmdFeature)
|
|
{
|
|
matches.push_back(cmdFeature);
|
|
}
|
|
}
|
|
}
|
|
|
|
return matches;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
std::vector<CmdFeature*> CmdFeatureManager::commandFeaturesMatchingKeyboardShortcut(const QKeySequence& keySequence) const
|
|
{
|
|
std::vector<CmdFeature*> matches;
|
|
|
|
std::vector<std::string> keys = CommandFeatureFactory::instance()->allKeys();
|
|
for (size_t i = 0; i < keys.size(); i++)
|
|
{
|
|
caf::CmdFeature* cmdFeature = commandFeature(keys[i]);
|
|
if (cmdFeature)
|
|
{
|
|
if (cmdFeature->action()->shortcut().matches(keySequence) == QKeySequence::ExactMatch)
|
|
{
|
|
matches.push_back(cmdFeature);
|
|
}
|
|
}
|
|
}
|
|
|
|
return matches;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void CmdFeatureManager::setCurrentContextMenuTargetWidget(QWidget * targetWidget)
|
|
{
|
|
m_currentContextMenuTargetWidget = targetWidget;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
QWidget* CmdFeatureManager::currentContextMenuTargetWidget()
|
|
{
|
|
return m_currentContextMenuTargetWidget;
|
|
}
|
|
|
|
} // end namespace caf
|