QmitkBaseComponent.h

Go to the documentation of this file.

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

Program:   Medical Imaging & Interaction Toolkit
Language:  C++
Date:      $Date$
Version:   $Revision: 18127 $

Copyright (c) German Cancer Research Center, Division of Medical and
Biological Informatics. All rights reserved.
See MITKCopyright.txt or https://www.mitk.org/copyright.html for details.

This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.  See the above copyright notices for more information.

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

#ifndef QMITK_BASECOMPONENT_H
#define QMITK_BASECOMPONENT_H


#include <qstring.h>
#include "QmitkExtExports.h"
#include <qobject.h>
#include <vector>
#include <mitkCommon.h>


class QGroupBox;

class QmitkExt_EXPORT QmitkBaseComponent : public QObject
{
  Q_OBJECT

public:

  /***************       CONSTRUCTOR      ***************/
  QmitkBaseComponent(QObject *parent=0, const char *name=0);

  /***************        DESTRUCTOR      ***************/
  virtual  ~QmitkBaseComponent();

  virtual QWidget* CreateControlWidget(QWidget* parent);

  virtual void CreateConnections();

  virtual void TreeChanged();

  void SetFunctionalityName(QString name);

  virtual QWidget* GetGUIControls();

  virtual QString GetFunctionalityName();


  /*************** GET CONTENT CONTAINER  ***************/
  virtual QGroupBox * GetContentContainer();

  /************ GET MAIN CHECK BOX CONTAINER ************/
  virtual QGroupBox * GetMainCheckBoxContainer();

  virtual void SetContentContainerVisibility(bool);

  /***************      OHTER METHODS     ***************/
  virtual void Activated();

  virtual void Deactivated();


  //##Documentation
  //## @brief Is the functionalityComponent currently active?
  //##
  //## @warning Will only work if in sub-classes the superclass-methods are called in Activated() and Deactivated()!
  virtual bool IsActivated();

  //##Documentation
  //## @brief Is the functionalityComponent currently available? Some components can only be available if other components
  //## are active. That can be checked here
  //##
  //## @warning Will only work if in sub-classes the superclass-methods are called in Activated() and Deactivated()!
  virtual bool IsAvailable();

protected:

  /***************        SET AND GET     ***************/
  virtual void SetAvailability(bool available);

  QObject* GetParent();

  std::vector<QmitkBaseComponent*> m_AddedChildList;


  /********************SIGN ON / OFF ************************************/

  void AddComponentListener(QmitkBaseComponent* component);

  void RemoveComponentListener(QmitkBaseComponent* component);


  QString m_FuncName;

  QObject * m_Parent;

  QWidget* m_GUI;

private:
  bool m_Available;

  bool m_Activated;

};

#endif