QmitkServiceListWidget.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.

This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.

See LICENSE.txt or http://www.mitk.org for details.

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

#ifndef _QmitkServiceListWidget_H_INCLUDED
#define _QmitkServiceListWidget_H_INCLUDED

#include "MitkQtWidgetsExports.h"
#include "ui_QmitkServiceListWidgetControls.h"
#include <vector>

// QT headers
#include <QListWidgetItem>
#include <QWidget>

// Microservices
#include "mitkServiceInterface.h"
#include "usModuleContext.h"
#include "usServiceEvent.h"
#include "usServiceReference.h"

class MITKQTWIDGETS_EXPORT QmitkServiceListWidget : public QWidget
{
  // this is needed for all Qt objects that should have a MOC object (everything that derives from QObject)
  Q_OBJECT

private:
  us::ModuleContext *m_Context;
  std::string m_Filter;
  std::string m_Interface;
  std::string m_NamingProperty;
  bool m_AutomaticallySelectFirstEntry;

public:
  static const std::string VIEW_ID;

  QmitkServiceListWidget(QWidget *p = 0, Qt::WindowFlags f1 = 0);
  virtual ~QmitkServiceListWidget();

  void SetAutomaticallySelectFirstEntry(bool automaticallySelectFirstEntry);

  virtual void CreateQtPartControl(QWidget *parent);
  virtual void CreateConnections();

  bool GetIsServiceSelected();

  us::ServiceReferenceU GetSelectedServiceReference();

  std::vector<us::ServiceReferenceU> GetAllServiceReferences();

  template <class T>
  std::vector<T *> GetAllServices()
  {
    // if (this->m_Controls->m_ServiceList->currentRow()==-1) return NULL;
    std::vector<us::ServiceReferenceU> refs = GetAllServiceReferences();
    std::vector<T *> result;
    for (int i = 0; i < refs.size(); i++)
    {
      result.push_back(m_Context->GetService(us::ServiceReference<T>(refs[i])));
    }
    return result;
  }

  template <class T>
  T *GetSelectedService()
  {
    if (this->m_Controls->m_ServiceList->currentRow() == -1)
      return NULL;
    us::ServiceReferenceU ref = GetServiceForListItem(this->m_Controls->m_ServiceList->currentItem());
    return (m_Context->GetService(us::ServiceReference<T>(ref)));
  }

  template <class T>
  void Initialize(const std::string &namingProperty = static_cast<std::string>(""),
                  const std::string &filter = static_cast<std::string>(""))
  {
    std::string interfaceName(us_service_interface_iid<T>());
    m_Interface = interfaceName;
    InitPrivate(namingProperty, filter);
  }

  template <class T>
  T *TranslateReference(const us::ServiceReferenceU &reference)
  {
    return m_Context->GetService(us::ServiceReference<T>(reference));
  }

  void OnServiceEvent(const us::ServiceEvent event);

signals:

  void ServiceRegistered(us::ServiceReferenceU);

  void ServiceUnregistering(us::ServiceReferenceU);

  void ServiceModified(us::ServiceReferenceU);

  void ServiceModifiedEndMatch(us::ServiceReferenceU);

  void ServiceSelectionChanged(us::ServiceReferenceU);

public slots:

protected slots:

  void OnServiceSelectionChanged();

protected:
  Ui::QmitkServiceListWidgetControls *m_Controls; 

  struct ServiceListLink
  {
    us::ServiceReferenceU service;
    QListWidgetItem *item;
  };

  void InitPrivate(const std::string &namingProperty, const std::string &filter);

  std::vector<ServiceListLink> m_ListContent;

  QListWidgetItem *AddServiceToList(const us::ServiceReferenceU &serviceRef);

  bool RemoveServiceFromList(const us::ServiceReferenceU &serviceRef);

  bool ChangeServiceOnList(const us::ServiceReferenceU &serviceRef);

  us::ServiceReferenceU GetServiceForListItem(QListWidgetItem *item);

  std::vector<us::ServiceReferenceU> GetAllRegisteredServices();

  QString CreateCaptionForService(const us::ServiceReferenceU &serviceRef);
};

#endif // _QmitkServiceListWidget_H_INCLUDED