qSlicerBaseQTGUIPythonQtDecorators.h

Go to the documentation of this file.

/*=auto=========================================================================
 
 Portions (c) Copyright 2005 Brigham and Women's Hospital (BWH)
 All Rights Reserved.
 
 See COPYRIGHT.txt
 or http://www.slicer.org/copyright/copyright.txt for details.
 
 Program:   3D Slicer
 
=========================================================================auto=*/
 
#ifndef __qSlicerBaseQTGUIPythonQtDecorators_h
#define __qSlicerBaseQTGUIPythonQtDecorators_h
 
// PythonQt includes
#include <PythonQt.h>
 
// CTK includes
#include <ctkErrorLogModel.h>
 
#include "vtkSlicerConfigure.h" // For Slicer_USE_QtTesting
 
// CTK includes
#ifdef Slicer_USE_QtTesting
# include <ctkQtTestingUtility.h>
#endif
 
// Slicer includes
#include "qSlicerAbstractModuleRepresentation.h"
#include "qSlicerAbstractModuleWidget.h"
#include "qSlicerAbstractModule.h"
#include "qSlicerCommandOptions.h"
#include "qSlicerIOManager.h"
#include "qSlicerIOOptionsWidget.h"
#include "qSlicerPythonManager.h"
 
#include "qSlicerBaseQTGUIExport.h"
 
// NOTE:
//
// For decorators it is assumed that the methods will never be called
// with the self argument as nullptr.  The self argument is the first argument
// for non-static methods.
//
 
class qSlicerBaseQTGUIPythonQtDecorators : public QObject
{
  Q_OBJECT
 
public:
  qSlicerBaseQTGUIPythonQtDecorators()
  {
    PythonQt::self()->registerClass(&qSlicerAbstractModuleWidget::staticMetaObject);
    PythonQt::self()->registerClass(&qSlicerPythonManager::staticMetaObject);
    PythonQt::self()->registerClass(&qSlicerCommandOptions::staticMetaObject);
#ifdef Slicer_USE_QtTesting
    PythonQt::self()->registerClass(&ctkQtTestingUtility::staticMetaObject);
#endif
    PythonQt::self()->registerClass(&ctkErrorLogModel::staticMetaObject);
    PythonQt::self()->registerClass(&ctkErrorLogTerminalOutput::staticMetaObject);
    // Note: Use registerCPPClassForPythonQt to register pure Cpp classes
  }
 
public slots:
 
  //----------------------------------------------------------------------------
  // qSlicerAbstractModule
 
  //----------------------------------------------------------------------------
  qSlicerAbstractModuleWidget* widgetRepresentation(qSlicerAbstractModule* _module) { return dynamic_cast<qSlicerAbstractModuleWidget*>(_module->widgetRepresentation()); }
 
  //----------------------------------------------------------------------------
  qSlicerAbstractModuleWidget* createNewWidgetRepresentation(qSlicerAbstractModule* _module)
  {
    return dynamic_cast<qSlicerAbstractModuleWidget*>(_module->createNewWidgetRepresentation());
  }
 
  //----------------------------------------------------------------------------
  // qSlicerAbstractModule
 
  //----------------------------------------------------------------------------
  qSlicerAbstractModule* module(qSlicerAbstractModuleWidget* _moduleWidget) { return dynamic_cast<qSlicerAbstractModule*>(_moduleWidget->module()); }
 
  //----------------------------------------------------------------------------
  // qSlicerIOManager
 
  // The returned options widgets are owned by Python (they are deleted when they are no longer
  // referenced in Python), unless they have a parent (then the parent deletes them).
 
  //----------------------------------------------------------------------------
  PythonQtPassOwnershipToPython<qSlicerIOOptionsWidget*> fileOptionsWidget(qSlicerIOManager* ioManager, const QString& fileDescription, QWidget* parent = nullptr)
  {
    return ioManager->fileOptionsWidget(fileDescription, parent);
  }
 
  //----------------------------------------------------------------------------
  PythonQtPassOwnershipToPython<qSlicerIOOptionsWidget*> fileWriterOptionsWidget(qSlicerIOManager* ioManager,
                                                                                 vtkObject* object,
                                                                                 const QString& extension = QString(),
                                                                                 QWidget* parent = nullptr)
  {
    return ioManager->fileWriterOptionsWidget(object, extension, parent);
  }
};
 
//-----------------------------------------------------------------------------
void initqSlicerBaseQTGUIPythonQtDecorators()
{
  PythonQt::self()->addDecorators(new qSlicerBaseQTGUIPythonQtDecorators);
}
 
#endif