pqProxyGroupMenuManager.h

Go to the documentation of this file.

/*=========================================================================

   Program: ParaView
   Module:    pqProxyGroupMenuManager.h

   Copyright (c) 2005,2006 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2.

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

========================================================================*/
#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:
  void loadConfiguration(vtkPVXMLElement*);

  void lookForNewDefinitions();

  void removeProxyDefinitionUpdateObservers();

  void addProxyDefinitionUpdateObservers();

  void setEnabled(bool enable);

  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:
  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