qSlicerModulesMenu.h

Go to the documentation of this file.

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

  Program: 3D Slicer

  Copyright (c) Kitware Inc.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  This file was originally developed by Julien Finet, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1

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

#ifndef __qSlicerModulesMenu_h
#define __qSlicerModulesMenu_h

// Qt includes
#include <QMenu>

// CTK includes
#include "qSlicerBaseQTGUIExport.h"

class qSlicerAbstractCoreModule;
class qSlicerModulesMenuPrivate;
class qSlicerModuleManager;

class Q_SLICER_BASE_QTGUI_EXPORT qSlicerModulesMenu: public QMenu
{
  Q_OBJECT
  Q_PROPERTY(QString currentModule READ currentModule WRITE setCurrentModule NOTIFY currentModuleChanged)
  Q_PROPERTY(bool duplicateActions READ duplicateActions WRITE setDuplicateActions)

  Q_PROPERTY(bool showHiddenModules READ showHiddenModules WRITE setShowHiddenModules)

  Q_PROPERTY(QStringList topLevelCategoryOrder READ topLevelCategoryOrder WRITE setTopLevelCategoryOrder)
public:
  typedef QMenu Superclass;

  qSlicerModulesMenu(const QString& title, QWidget* parent = nullptr);
  qSlicerModulesMenu(QWidget* parent = nullptr);
  ~qSlicerModulesMenu() override;

  Q_INVOKABLE QAction* moduleAction(const QString& moduleName)const;

  inline void addModules(const QStringList& moduleNames);

  inline void removeModules(const QStringList& moduleNames);

  QString currentModule()const;

  void setModuleManager(qSlicerModuleManager* moduleManager);
  qSlicerModuleManager* moduleManager()const;

  void setDuplicateActions(bool duplicate);
  bool duplicateActions()const;

  void setShowHiddenModules(bool show);
  bool showHiddenModules()const;

  void setTopLevelCategoryOrder(const QStringList& categories);
  QStringList topLevelCategoryOrder()const;

  Q_INVOKABLE bool removeCategory(const QString& categoryName);

public slots:
  void addModule(const QString& moduleName);

  bool removeModule(const QString& moduleName);

  void setCurrentModuleByTitle(const QString& title);

  void setCurrentModule(const QString& moduleName);

  void addModule(qSlicerAbstractCoreModule*);

  bool removeModule(qSlicerAbstractCoreModule*);

signals:
  void currentModuleChanged(const QString& name);

protected slots:
  void onActionTriggered();
  void actionSelected(QAction* action);

protected:
  QScopedPointer<qSlicerModulesMenuPrivate> d_ptr;

private:
  Q_DECLARE_PRIVATE(qSlicerModulesMenu);
  Q_DISABLE_COPY(qSlicerModulesMenu);
};

//---------------------------------------------------------------------------
void qSlicerModulesMenu::addModules(const QStringList& moduleNames)
{
  foreach(const QString& moduleName, moduleNames)
    {
    this->addModule(moduleName);
    }
}

//---------------------------------------------------------------------------
void qSlicerModulesMenu::removeModules(const QStringList& moduleNames)
{
  foreach(const QString& moduleName, moduleNames)
    {
    this->removeModule(moduleName);
    }
}

#endif