qSlicerCLIModuleUIHelper.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 Jean-Christophe Fillion-Robin, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1

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

#ifndef __qSlicerCLIModuleUIHelper_h
#define __qSlicerCLIModuleUIHelper_h

// Qt includes
#include <QButtonGroup>
#include <QObject>
#include <QWidget>

// CTK includes
#include <ctkPimpl.h>

#include <ModuleDescription.h>

#include "qSlicerBaseQTCLIExport.h"

class QWidget;
class qSlicerCLIModuleWidget;
class vtkMRMLCommandLineModuleNode;
class qSlicerCLIModuleUIHelperPrivate;

//-----------------------------------------------------------------------------
class Q_SLICER_BASE_QTCLI_EXPORT qSlicerWidgetValueWrapper: public QObject
{
  Q_OBJECT
public:
  qSlicerWidgetValueWrapper(const QString& _name, const QString& _label, QObject* parent);
  ~qSlicerWidgetValueWrapper() override;
  virtual QVariant value() = 0;
  QString label(){ return this->Label; }
  QString name(){ return this->Name; }

  virtual void setValue(const QString& _value) = 0;

  static QString toString(const QString& _value)
    {
    return _value;
    }

  static bool toBool(const QString& _value)
    {
    return (_value.compare("true", Qt::CaseInsensitive) == 0);
    }

  static int toInt(const QString& _value)
    {
    return _value.toInt();
    }

  static double toDouble(const QString& _value)
    {
    return _value.toDouble();
    }

signals:
  void valueChanged();

protected:
  QString Name;
  QString Label;
};

//-----------------------------------------------------------------------------
class Q_SLICER_BASE_QTCLI_EXPORT ButtonGroupWidgetWrapper: public QWidget
{
  Q_OBJECT
public:
  ButtonGroupWidgetWrapper(QWidget* parentWidget = nullptr);

  QButtonGroup* buttonGroup()const;
  QString checkedValue();

  void setCheckedValue(const QString& value);

signals:
  void valueChanged();

private:
  QButtonGroup* ButtonGroup;
};

//-----------------------------------------------------------------------------
class Q_SLICER_BASE_QTCLI_EXPORT qSlicerCLIModuleUIHelper: public QObject
{
  Q_OBJECT
public:

  qSlicerCLIModuleUIHelper(qSlicerCLIModuleWidget* cliModuleWidget);
  ~qSlicerCLIModuleUIHelper() override;

  QWidget* createTagWidget(const ModuleParameter& moduleParameter);

  void updateMRMLCommandLineModuleNode(vtkMRMLCommandLineModuleNode* commandLineModuleNode);

  void updateUi(vtkMRMLCommandLineModuleNode* commandLineModuleNode);

  void setCommandLineModuleParameter(vtkMRMLCommandLineModuleNode* node,
                                     const QString& name,
                                     const QVariant& value);
  void setValue(const QString& name, const QVariant& type);

signals:
  void valueChanged(const QString& tag, const QVariant& value);

protected slots:
  void onValueChanged();

protected:
  QScopedPointer<qSlicerCLIModuleUIHelperPrivate> d_ptr;

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

#endif