pqProxyGroupMenuManager.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
#ifndef pqProxyGroupMenuManager_h
#define pqProxyGroupMenuManager_h

#include "pqApplicationComponentsModule.h"

#include <QMenu>

#include "vtkParaViewDeprecation.h" // for deprecation macro

#include <memory> // for unique_ptr

class pqProxyCategory;
class pqProxyInfo;
class vtkPVXMLElement;
class vtkSMProxy;

class PQAPPLICATIONCOMPONENTS_EXPORT pqProxyGroupMenuManager : public QObject
{
  Q_OBJECT
  typedef QObject Superclass;

public:
  pqProxyGroupMenuManager(QMenu* menu, const QString& resourceTagName,
    bool supportsQuickLaunch = true, bool enableFavorites = false);
  ~pqProxyGroupMenuManager() override;

  QMenu* menu() const { return static_cast<QMenu*>(this->parent()); }

  QWidget* widgetActionsHolder() const;
  QMenu* getFavoritesMenu();

  void setRecentlyUsedMenuSize(unsigned int val) { this->RecentlyUsedMenuSize = val; }
  unsigned int recentlyUsedMenuSize() const { return this->RecentlyUsedMenuSize; }
  bool supportsQuickLaunch() const { return this->SupportsQuickLaunch; }
  void setEnableFavorites(bool enable) { this->EnableFavorites = enable; }

  PARAVIEW_DEPRECATED_IN_5_13_0("Use pqProxyAction::GetProxyPrototype instead.")
  vtkSMProxy* getPrototype(QAction* action) const;

  void addProxy(const QString& xmlgroup, const QString& xmlname);

  void removeProxy(const QString& xmlgroup, const QString& xmlname);


  QStringList getToolbarCategories() const;
  QString getToolbarName(pqProxyCategory* category);
  QString categoryLabel(const QString& category);
  PARAVIEW_DEPRECATED_IN_5_13_0(
    "This was mostly unused. Also it is better to avoid test-dedicated code paths.")
  bool hideForTests(const QString&) const { return false; };


  QList<QAction*> actions() const;
  QList<QAction*> categoryActions(const QString& category);
  QList<QAction*> categoryActions(pqProxyCategory* category);
  QList<QAction*> actionsInToolbars();
  QAction* getAction(pqProxyInfo* proxy);
  void updateActionIcon(pqProxyInfo* proxy);

  void addProxyDefinitionUpdateListener(const QString& proxyGroupName);
  void removeProxyDefinitionUpdateListener(const QString& proxyGroupName);


  pqProxyCategory* getApplicationCategory();
  pqProxyCategory* getMenuCategory();
  pqProxyCategory* getFavoritesCategory();
  bool isFavorites(pqProxyCategory* category);

public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)

  void loadConfiguration(vtkPVXMLElement*);
  void lookForNewDefinitions();
  void removeProxyDefinitionUpdateObservers();
  void addProxyDefinitionUpdateObservers();

  PARAVIEW_DEPRECATED_IN_5_13_0("Inner member is not used")
  void setEnabled(bool){};

  virtual void populateMenu();

  void writeCategoryToSettings();

Q_SIGNALS:
  void triggered(const QString& group, const QString& name);

  void menuPopulated();

  void categoriesUpdated();

protected Q_SLOTS:
  void triggered();
  void quickLaunch();
  void switchActiveServer();
  void updateMenuStyle();
  void updateActionsStyle();

  void populateRecentlyUsedMenu();

  PARAVIEW_DEPRECATED_IN_5_13_0(
    "Favorites are now a specific category, configurable as the others.")
  void populateFavoritesMenu();

protected: // NOLINT(readability-redundant-access-specifiers)
  QString ResourceTagName;
  vtkPVXMLElement* MenuRoot = nullptr;
  int RecentlyUsedMenuSize = 0;
  PARAVIEW_DEPRECATED_IN_5_13_0("Inner member is not used")
  bool Enabled;
  bool EnableFavorites = false;

  void loadRecentlyUsedItems();
  void saveRecentlyUsedItems();

  PARAVIEW_DEPRECATED_IN_5_13_0(
    "Favorites are now a specific category, configurable as the others.")
  void loadFavoritesItems();

  PARAVIEW_DEPRECATED_IN_5_13_0(
    "Favorites are now a specific category, configurable as the others.")
  QAction* getAddToFavoritesAction(const QString& path);

  QAction* getAction(const QString& pgroup, const QString& proxyname);

private Q_SLOTS:
  void populateAlphabeticalMenu();
  void populateMiscMenu();
  void populateCategoriesMenus();

private: // NOLINT(readability-redundant-access-specifiers)
  Q_DISABLE_COPY(pqProxyGroupMenuManager)

  QAction* createAction(pqProxyInfo* proxy);

  QAction* createAddToFavoritesAction();

  void clearMenu();
  void clearCategoriesMenus();
  void populateSubCategoriesMenus(QMenu* parent, pqProxyCategory* category);
  void populateCategoryMenu(QMenu* parent, pqProxyCategory* category);

  void loadCategorySettings();

  struct pqInternal;
  std::unique_ptr<pqInternal> Internal;
  bool SupportsQuickLaunch = true;
};

#endif