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>
 
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);
  ~pqProxyGroupMenuManager() override;
 
  QMenu* menu() const { return static_cast<QMenu*>(this->parent()); }
 
  void setRecentlyUsedMenuSize(unsigned int val) { this->RecentlyUsedMenuSize = val; }
 
  unsigned int recentlyUsedMenuSize() const { return this->RecentlyUsedMenuSize; }
 
  QWidget* widgetActionsHolder() const;
 
  QList<QAction*> actions() const;
 
  vtkSMProxy* getPrototype(QAction* action) const;
 
  void addProxy(const QString& xmlgroup, const QString& xmlname);
 
  void removeProxy(const QString& xmlgroup, const QString& xmlname);
 
  QStringList getToolbarCategories() const;
 
  QList<QAction*> actions(const QString& category);
 
  QList<QAction*> actionsInToolbars();
 
  bool hideForTests(const QString& category) const;
 
  void addProxyDefinitionUpdateListener(const QString& proxyGroupName);
  void removeProxyDefinitionUpdateListener(const QString& proxyGroupName);
 
  bool supportsQuickLaunch() const { return this->SupportsQuickLaunch; }
 
  void setEnableFavorites(bool enable) { this->EnableFavorites = enable; }
 
  QMenu* getFavoritesMenu();
 
  QString categoryLabel(const QString& category);
 
public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  void loadConfiguration(vtkPVXMLElement*);
 
  void lookForNewDefinitions();
 
  void removeProxyDefinitionUpdateObservers();
 
  void addProxyDefinitionUpdateObservers();
 
  void setEnabled(bool enable);
 
  virtual void populateMenu();
 
Q_SIGNALS:
  void triggered(const QString& group, const QString& name);
 
  void menuPopulated();
 
protected Q_SLOTS:
  void triggered();
  void quickLaunch();
  void switchActiveServer();
  void updateMenuStyle();
 
  void populateRecentlyUsedMenu();
 
  void populateFavoritesMenu();
 
protected: // NOLINT(readability-redundant-access-specifiers)
  QString ResourceTagName;
  vtkPVXMLElement* MenuRoot;
  int RecentlyUsedMenuSize;
  bool Enabled;
  bool EnableFavorites;
 
  void loadRecentlyUsedItems();
  void saveRecentlyUsedItems();
 
  void loadFavoritesItems();
 
  QAction* getAction(const QString& pgroup, const QString& proxyname);
 
  QAction* getAddToCategoryAction(const QString& path);
 
private:
  Q_DISABLE_COPY(pqProxyGroupMenuManager)
 
  class pqInternal;
  pqInternal* Internal;
  bool SupportsQuickLaunch;
};
 
#endif