vtkSlicerModuleGUI.h

Go to the documentation of this file.

#ifndef __vtkSlicerModuleGUI_h
#define __vtkSlicerModuleGUI_h

#include "vtkObject.h"
#include "vtkKWObject.h"
#include "vtkKWUserInterfacePanel.h"
#include "vtkKWWidget.h"
#include "vtkKWText.h"
#include "vtkKWTextWithHyperlinksWithScrollbars.h"
#include "vtkKWIcon.h"
#include "vtkKWNotebook.h"
#include "vtkKWFrame.h"
#include "vtkSmartPointer.h"
#include "vtkIntArray.h"

#include "vtkSlicerBaseGUIWin32Header.h"
#include "vtkSlicerModuleCollapsibleFrame.h"
#include "vtkSlicerApplicationGUI.h"
#include "vtkSlicerComponentGUI.h"
#include "vtkSlicerBaseAcknowledgementLogoIcons.h"

//
class VTK_SLICER_BASE_GUI_EXPORT vtkSlicerModuleGUI : public vtkSlicerComponentGUI
{

 public:
    static vtkSlicerModuleGUI* New ( );
    vtkTypeRevisionMacro ( vtkSlicerModuleGUI, vtkKWObject );
    void PrintSelf (ostream& os, vtkIndent indent );

    vtkGetObjectMacro ( UIPanel, vtkKWUserInterfacePanel );
    vtkSetObjectMacro ( UIPanel, vtkKWUserInterfacePanel );
    vtkGetObjectMacro (HelpAndAboutFrame, vtkSlicerModuleCollapsibleFrame );
    vtkGetObjectMacro (HelpAndAboutNotebook, vtkKWNotebook);
    vtkGetObjectMacro (HelpText, vtkKWTextWithHyperlinksWithScrollbars );
    vtkGetObjectMacro (AboutText, vtkKWTextWithHyperlinksWithScrollbars );
    vtkGetObjectMacro (LogoFrame, vtkKWFrame );

  vtkSlicerBaseAcknowledgementLogoIcons* GetAcknowledgementIcons ();

  vtkGetObjectMacro ( ApplicationGUI, vtkSlicerApplicationGUI );
  vtkSetObjectMacro ( ApplicationGUI, vtkSlicerApplicationGUI );

  vtkSetStringMacro(Category);
  virtual const char *GetCategory() const {return this->Category;}

  virtual unsigned short GetIndex() const {return this->Index;}
  vtkSetMacro(Index, unsigned short);
  
  virtual vtkKWIcon* GetLogo() const;

  virtual void SetModuleLogic( vtkSlicerLogic * ); 
  
  vtkGetStringMacro (ModuleName);
  vtkSetStringMacro (ModuleName);

  //Description:
  virtual void Init() { };

  virtual void BuildHelpAndAboutFrame ( vtkKWWidget *parent,
                                        const char *help,
                                        const char *about);

  virtual void CreateModuleEventBindings ( ) { };
  virtual void ReleaseModuleEventBindings ( ) { };

  virtual void SetActiveViewer(vtkSlicerViewerWidget * vtkNotUsed( activeViewer ) ){};
  
    virtual void ProcessLogicEvents ( vtkObject * /*caller*/,
      unsigned long /*event*/, void * /*callData*/ ) { };
    virtual void ProcessGUIEvents ( vtkObject * /*caller*/, 
      unsigned long /*event*/, void * /*callData*/ ) { };
    
    virtual void ProcessMRMLEvents ( vtkObject * /*caller*/, 
      unsigned long /*event*/, void * /*callData*/ ) { };

  virtual vtkIntArray* NewObservableEvents() { return vtkIntArray::New(); };

 //BTX
  enum
    {
      ModuleSelectedEvent = 73300,
   };
//ETX
 protected:

  char *ModuleName;

    vtkKWUserInterfacePanel *UIPanel;
    
    vtkSlicerModuleCollapsibleFrame *HelpAndAboutFrame;
    vtkKWNotebook *HelpAndAboutNotebook;

    vtkKWTextWithHyperlinksWithScrollbars *HelpText;

    vtkKWTextWithHyperlinksWithScrollbars *AboutText;
    vtkKWFrame *LogoFrame;

    bool Built;

    bool Visited;

    unsigned short Index;

    char *Category;
    


    vtkSlicerModuleGUI ( );
    virtual ~vtkSlicerModuleGUI ( );

    static vtkSlicerBaseAcknowledgementLogoIcons *AcknowledgementIcons;
    vtkSlicerApplicationGUI *ApplicationGUI;
//BTX
    vtkSmartPointer<vtkKWIcon> Logo;
//ETX
 private:
    vtkSlicerModuleGUI ( const vtkSlicerModuleGUI& ); 
    void operator = ( const vtkSlicerModuleGUI& ); 
};


#endif