qSlicerMultiVolumeExplorerModule.h

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

  Program: 3D Slicer

  Portions (c) Copyright Brigham and Women's Hospital (BWH) All Rights Reserved.

  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.

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

#ifndef __qSlicerMultiVolumeExplorerModule_h
#define __qSlicerMultiVolumeExplorerModule_h

// SlicerQt includes
#include <qSlicerLoadableModule.h>

#include "qSlicerMultiVolumeExplorerModuleExport.h"

class qSlicerMultiVolumeExplorerModulePrivate;

/// \ingroup Slicer_QtModules_ExtensionTemplate
class Q_SLICER_QTMODULES_MULTIVOLUMEEXPLORER_EXPORT qSlicerMultiVolumeExplorerModule :
  public qSlicerLoadableModule
{
  Q_OBJECT
#ifdef Slicer_HAVE_QT5
  Q_PLUGIN_METADATA(IID "org.slicer.modules.loadable.qSlicerLoadableModule/1.0");
#endif
  Q_INTERFACES(qSlicerLoadableModule);

public:

  typedef qSlicerLoadableModule Superclass;
  explicit qSlicerMultiVolumeExplorerModule(QObject *parent=0);
  virtual ~qSlicerMultiVolumeExplorerModule();

  qSlicerGetTitleMacro(QTMODULE_TITLE);

  /// Help to use the module
  virtual QString helpText() const override;

  /// Return acknowledgements
  virtual QString acknowledgementText() const override;

  /// Return a custom icon for the module
  virtual QIcon icon() const override;

  /// Return the categories
  virtual QStringList categories() const override;

  /// Return the dependencies
  virtual QStringList dependencies() const override;

  /// Return the contributors
  virtual QStringList contributors() const override;

protected:

  /// Initialize the module. Register the volumes reader/writer
  virtual void setup() override;

  /// Create and return the widget representation associated to this module
  virtual qSlicerAbstractModuleRepresentation * createWidgetRepresentation() override;

  /// Create and return the logic associated to this module
  virtual vtkMRMLAbstractLogic* createLogic() override;

protected:
  QScopedPointer<qSlicerMultiVolumeExplorerModulePrivate> d_ptr;

private:
  Q_DECLARE_PRIVATE(qSlicerMultiVolumeExplorerModule);
  Q_DISABLE_COPY(qSlicerMultiVolumeExplorerModule);

};

#endif