qMRMLMarkupsOptionsWidgetsFactory.h

Go to the documentation of this file.

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

  Copyright (c) The Intervention Centre
  Oslo University Hospital, Oslo, Norway. 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.

  This file was originally developed by Rafael Palomar (The Intervention Centre,
  Oslo University Hospital), based on qMRMLMarkupsOptionsWidgetsFactory.h by
  Csaba Pinter (Perklab, Queen's University), and was supported by The Research
  Council of Norway through the ALive project (grant nr. 311393).

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

#ifndef __qslicermarkupsfactory_h_
#define __qslicermarkupsfactory_h_

// Markups widgets includes
#include "qMRMLMarkupsAbstractOptionsWidget.h"
#include "qSlicerMarkupsModuleWidgetsExport.h"

// Qt includes
#include <QObject>
#include <QMap>
#include <QPointer>
#include <QWidget>

// -----------------------------------------------------------------------------------------
class qMRMLMarkupsAbstractOptionsWidget;
class qMRMLMarkupsOptionsWidgetsFactoryCleanup;

class Q_SLICER_MODULE_MARKUPS_WIDGETS_EXPORT qMRMLMarkupsOptionsWidgetsFactory : public QObject
{
  Q_OBJECT

public:
  Q_INVOKABLE static qMRMLMarkupsOptionsWidgetsFactory* instance();

public:
  Q_INVOKABLE bool registerOptionsWidget(qMRMLMarkupsAbstractOptionsWidget* widget);

  Q_INVOKABLE bool unregisterOptionsWidget(const QString& className);

  Q_INVOKABLE bool unregisterOptionsWidget(qMRMLMarkupsAbstractOptionsWidget* widget);

  Q_INVOKABLE void unregisterAll();

  Q_INVOKABLE const QList<QString> registeredOptionsWidgetsClassNames() const
  { return this->RegisteredWidgets.keys(); }

  Q_INVOKABLE qMRMLMarkupsAbstractOptionsWidget* createWidget(const QString& widgetClassName);

signals:
  void optionsWidgetRegistered();
  void optionsWidgetUnregistered();

protected:
  QMap<QString, QPointer<qMRMLMarkupsAbstractOptionsWidget>> RegisteredWidgets;

private:
  static void cleanup();

private:
  qMRMLMarkupsOptionsWidgetsFactory(QObject* parent=nullptr);
  ~qMRMLMarkupsOptionsWidgetsFactory() override;

  Q_DISABLE_COPY(qMRMLMarkupsOptionsWidgetsFactory);
  friend class qMRMLMarkupsOptionsWidgetsFactoryCleanup;
  friend class PythonQtWrapper_qMRMLMarkupsOptionsWidgetsFactory; // Allow Python wrapping without enabling direct instantiation

private:
  static qMRMLMarkupsOptionsWidgetsFactory* Instance;
};

#endif // __qslicermarkupsfactory_h_