SUIT_FindActionDialog.h

Go to the documentation of this file.

// Copyright (C) 2007-2025  CEA, EDF, OPEN CASCADE
//
// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
// 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 for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef SUIT_FINDACTIONDIALOG_H
#define SUIT_FINDACTIONDIALOG_H
 
#include "SUIT.h"
#include "SUIT_ShortcutMgr.h"
#include <QDialog>
#include <QFrame>
#include <QTreeWidget>
#include <QList>
#include <QString>
#include <QVariant>
#include <memory>
#include <map>
#include <set>
#include <functional>
#include <utility>
 
 
class QCheckBox;
class QLineEdit;
class QLabel;
class QPushButton;
class QKeyEvent;
class SUIT_FindActionWidget;
class SUIT_FoundActionTree;
 
 
class SUIT_EXPORT SUIT_FindActionDialog : public QDialog
{
  Q_OBJECT
 
public:
  SUIT_FindActionDialog(QWidget* theParent);
  SUIT_FindActionDialog(const SUIT_FindActionDialog&) = delete;
  SUIT_FindActionDialog& operator=(const SUIT_FindActionDialog&) = delete;
  virtual ~SUIT_FindActionDialog() = default;
 
  void setActiveModuleID(const QString& theModuleID = SUIT_ShortcutMgr::ROOT_MODULE_ID);
 
private:
  void executeAction(const QString& theModuleID, const QString& theInModuleActionID);
 
private:
  SUIT_FindActionWidget* myFindActionWidget;
};
 
 
class SUIT_EXPORT SUIT_FindActionWidget : public QWidget
{
  Q_OBJECT
 
public:
  SUIT_FindActionWidget(
    QWidget* theParent,
    const std::function<void(const QString&, const QString&)> theCallback,
    const QString& theActionItemToolTip,
    bool theEnableItemsOfUnavailableActions = false,
    bool theShowKeySequenceColumn = false,
    const std::function<std::pair<QString, bool>(const QString&, const QString&)>& theKeySequenceGetter = std::function<std::pair<QString, bool>(const QString&, const QString&)>()
  );
  SUIT_FindActionWidget(const SUIT_FindActionWidget&) = delete;
  SUIT_FindActionWidget& operator=(const SUIT_FindActionWidget&) = delete;
  virtual ~SUIT_FindActionWidget() = default;
 
  void showOptions(bool theToShow);
 
  void setIncludedModuleIDs(const std::set<QString>& theModuleIDs = {}, bool doNotUpdateResults = false);
  const std::set<QString>& getIncludedModuleIDs() const;
 
  void updateUI();
 
  void setColumnWidth(int theColumnIdx, int theColumnWidth);
 
private slots:
  void onQueryChanged(const QString& theKeyword);
  void onSearchOptionUnavailableActionsChanged(int);
  void onSearchOptionInactiveModulesChanged(int);
 
private:
  QLineEdit* myQueryLineEdit;
  QCheckBox* myIncludeUnavailableActionsCB;
  QCheckBox* myIncludeInactiveModulesCB;
  SUIT_FoundActionTree* myFoundActionsTree;
 
  std::set<QString> myIncludedModuleIDs;
  SUIT_ActionSearcher myActionSearcher;
 
public:
  const std::function<void(const QString&, const QString&)> myCallback;
};
 
 
class SUIT_FoundActionTreeItem;
class SUIT_FoundActionTreeModule;
class SUIT_FoundActionTreeAction;
 
 
class SUIT_EXPORT SUIT_FoundActionTree : public QTreeWidget
{
  Q_OBJECT
 
public:
  enum ColumnIdx {
    Name,
    ToolTip,
    KeySequence
  };
 
  enum class SortKey {
    MatchMetrics,
    ID,
    Name,
    ToolTip,
    KeySequence
  };
 
  static const QList<std::pair<SUIT_FoundActionTree::SortKey, Qt::SortOrder>> DEFAULT_SORT_SCHEMA;
  static std::pair<QString, bool> getKeySequenceFromShortcutMgr(const QString& theModuleID, const QString& theInModuleActionID);
 
  SUIT_FoundActionTree(
    SUIT_FindActionWidget* theParent,
    const QString& theActionItemToolTip,
    bool theEnableItemsOfUnavailableActions = false,
    bool theShowKeySequenceColumn = false,
    const std::function<std::pair<QString, bool>(const QString&, const QString&)>& theKeySequenceGetter = std::function<std::pair<QString, bool>(const QString&, const QString&)>()
  );
  SUIT_FoundActionTree(const SUIT_FoundActionTree&) = delete;
  SUIT_FoundActionTree& operator=(const SUIT_FoundActionTree&) = delete;
  virtual ~SUIT_FoundActionTree() = default;
 
  void updateItems(const std::map<QString, std::map<QString, SUIT_ActionSearcher::AssetsAndSearchData>>& theActionAssetsAndSD);
 
  void sort(SUIT_FoundActionTree::SortKey theKey, Qt::SortOrder theOrder);
 
  void keyPressEvent(QKeyEvent* theEvent);
 
protected:
  bool eventFilter(QObject* theQObject, QEvent* theEvent);
 
private:
  std::pair<SUIT_FoundActionTreeModule*, int> findModuleItem(const QString& theModuleID) const;
  std::set<SUIT_FoundActionTreeAction*, std::function<bool(SUIT_FoundActionTreeAction*, SUIT_FoundActionTreeAction*)>> createActionSetWithComparator() const;
 
private slots:
  void onItemExecuted(QTreeWidgetItem* theWidgetItem, int theColIdx);
 
private:
  SUIT_FoundActionTree::SortKey mySortKey;
  Qt::SortOrder mySortOrder;
 
  std::map<QString, bool> myModuleItemExpansionStates;
 
public:
  const QString myActionItemToolTip;
  const bool myEnableItemsOfUnavailableActions; // If false, items of unavailable actions/modules are dimmed.
  const bool myShowKeySequenceColumn;
 
  const std::function<std::pair<QString, bool>(const QString&, const QString&)> myKeySequenceGetter;
};
 
 
class SUIT_FoundActionTreeItem : public QTreeWidgetItem
{
public:
  enum Type {
    Module,
    Action
  };
 
protected:
  SUIT_FoundActionTreeItem(const QString& theModuleID);
 
public:
  virtual ~SUIT_FoundActionTreeItem() = default;
  virtual SUIT_FoundActionTreeItem::Type type() const = 0;
 
  QString name() const;
  QString toolTip() const;
 
  virtual QVariant getValue(SUIT_FoundActionTree::SortKey theKey) const = 0;
 
  virtual void styleAsDimmed();
 
public:
  const QString myModuleID;
};
 
 
class SUIT_FoundActionTreeModule : public SUIT_FoundActionTreeItem
{
public:
  SUIT_FoundActionTreeModule(const QString& theModuleID);
  virtual ~SUIT_FoundActionTreeModule() = default;
  virtual SUIT_FoundActionTreeItem::Type type() const { return SUIT_FoundActionTreeItem::Type::Module; };
 
  void setAssets(const SUIT_ShortcutModuleAssets& theAssets, const QString& theLang);
 
  virtual QVariant getValue(SUIT_FoundActionTree::SortKey theKey) const;
};
 
 
class SUIT_FoundActionTreeAction : public SUIT_FoundActionTreeItem
{
private:
  SUIT_FoundActionTreeAction(const QString& theModuleID, const QString& theInModuleActionID);
 
public:
  static SUIT_FoundActionTreeAction* create(const QString& theModuleID, const QString& theInModuleActionID);
  virtual ~SUIT_FoundActionTreeAction() = default;
  virtual SUIT_FoundActionTreeItem::Type type() const { return SUIT_FoundActionTreeItem::Type::Action; };
 
  void setAssetsAndSearchData(const SUIT_ActionSearcher::AssetsAndSearchData& theAssetsAndSD, const QString& theLang);
  void setToolTip(const QString& theToolTip);
  void setKeySequence(const QString& theKeySequence);
  QString keySequence() const;
  void styleAsKeySequenceModified(bool theIsModified);
 
  virtual QVariant getValue(SUIT_FoundActionTree::SortKey theKey) const;
  double matchMetrics() const { return myMatchMetrics; };
 
  virtual bool isEnabled() const;
  bool isEnabledBufferedValue() const { return myIsEnabledBufferedValue; };
 
  const QString myInModuleActionID;
 
private:
  double myMatchMetrics;
  mutable bool myIsEnabledBufferedValue;
};
 
#endif // SUIT_FINDACTIONDIALOG_H