]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkKWBlackBox.h
*** empty log message ***
[bbtk.git] / kernel / src / bbtkKWBlackBox.h
index 6a2eb35f1a5767f7f564c645449d2ebcff422398..470c286040685c6d52424a6fc38718f3d2ae21e0 100644 (file)
@@ -2,8 +2,8 @@
   Program:   bbtk
   Module:    $RCSfile: bbtkKWBlackBox.h,v $
   Language:  C++
-  Date:      $Date: 2008/12/11 09:50:35 $
-  Version:   $Revision: 1.5 $
+  Date:      $Date: 2009/04/08 07:56:11 $
+  Version:   $Revision: 1.6 $
 ========================================================================*/
 
 
 
 #ifdef USE_KWWIDGETS
 
-#include "bbtkAtomicBlackBox.h"
+#include "bbtkWidgetBlackBox.h"
 
 
 #include "bbtkKW.h"
 
 
-//==================================================================
-// Forward declaration of the class of window associated to a KWBlackBox
-class vtkKWBlackBoxWindow;
-class vtkKWBlackBoxDialog;
-class vtkKWFrame;
-//==================================================================
-
 
 namespace bbtk
 {
 
 
 
-
-
   //==================================================================
   /// Widget black boxes
-  class BBTK_EXPORT KWBlackBox : public bbtk::AtomicBlackBox  
+  class BBTK_EXPORT KWBlackBox : public bbtk::WidgetBlackBox<vtkKWWidget>
   { 
-    BBTK_BLACK_BOX_INTERFACE(KWBlackBox,bbtk::AtomicBlackBox);
-    BBTK_DECLARE_INPUT(WinTitle,std::string);
-    BBTK_DECLARE_INPUT(WinWidth,int);
-    BBTK_DECLARE_INPUT(WinHeight,int);
-    BBTK_DECLARE_INPUT(WinDialog,bool);
-    BBTK_DECLARE_INPUT(WinHide,Void);
-    BBTK_DECLARE_INPUT(WinClose,Void);
-    BBTK_DECLARE_OUTPUT(Widget, vtkKWWidget*);
-
+    BBTK_BLACK_BOX_INTERFACE(KWBlackBox,bbtk::WidgetBlackBox<vtkKWWidget>);
   public:
-    
-    typedef vtkKWBlackBoxDialog Window;
-    
-    /// Returns the **OWN** window associated to the box
-    /// If 0 returned = no window
-    Window* bbGetWindow() { return bbmWindow; }
-
-    /// Returns the window containing the widget associated to the box
-    /// Which can be the own window of **ANOTHER** box in case of 
-    /// a hierarchy of widgets.
-    /// More precisely :
-    /// If bbGetWindow() != 0 then returns bbGetWindow()
-    /// Else if the output 'Widget' is connected 
-    ///  then returns bbGetContainingWindow() of the box connected to 'Widget'
-    /// Else returns 0;
-    Window* bbGetContainingWindow();
-
-
-    /// Returns true iff the 'containing window' exists and is shown 
-    /// (see bbGetContainingWindow).
-    bool bbIsShown();
-
-    //==================================================================    
-    /// User callback invoked when the containing window is shown
-    virtual void bbUserOnShow() {}
+   //==================================================================    
+    /// Callback for creating a Dialog window (modal)
+    virtual void bbCreateDialogWindow();
     //==================================================================    
+
     //==================================================================    
-    /// User callback invoked when the containing window is hidden
-    virtual void bbUserOnHide() {}
+    /// Callback for creating a Frame window 
+    virtual void bbCreateFrameWindow();
     //==================================================================    
 
-    /// Sets the window
-    inline void bbSetWindow(Window* w) { bbmWindow=w; }
-
-         
-  protected:
+    //==================================================================
+    //    virtual void InitWindowManagerIfNeeded();
+    virtual void IncNbWindowsAlive();
+    virtual void DecNbWindowsAlive();
+    virtual int  GetNbWindowsAlive();
+    virtual bool IsSomeWindowAlive();
     
-  
+    virtual void IncNbWindowsShown();
+    virtual void DecNbWindowsShown();
+    virtual int  GetNbWindowsShown();
+    virtual bool IsSomeWindowShown();
     //==================================================================
-    /// User callback called in the box contructor
-    virtual void bbUserConstructor();
-    /// User callback called in the box copy constructor
-    virtual void bbUserCopyConstructor(bbtk::BlackBox::Pointer);
-    /// User callback called in the box destructor
-    virtual void bbUserDestructor();
-    //==================================================================    
-
-    //==================================================================    
-    /// User callback for creating the widget associated to the box
-    /// ** Must be defined **
-    // LG 24/11/08 : New widget pipeline
-    virtual void bbUserCreateWidget(vtkKWFrame* parent) 
-    {
-      bbtkError(bbGetTypeName()<<" is a KWBlackBox whose bbUserCreateWidget methods is not overloaded : is it a feature or a bug ?!?");
-    }
-    //==================================================================    
 
 
     //==================================================================
     vtkKWWidget* bbCreateWidgetOfInput(const std::string& in, 
                                       vtkKWFrame* parent);
     //==================================================================
 
 
-    //==================================================================
-    /// Overloaded processing method for KWBlackBoxes
-    virtual void bbProcess();
-    //==================================================================
-
-    //==================================================================
-    /// If necessary creates the KWBlackBoxWindow associated to the box
-    /// and shows it 
-    /// (does nothing if the box output 'Widget' is connected which 
-    /// means that the box does not have its own window but is contained 
-    /// into another window)
-    void bbShowWindow();
-    /// Hides the KWBlackBoxWindow associated to the box (if exists)
-    void bbHideWindow();
-    /// Closes (destroys) the KWBlackBoxWindow associated to the box (if exists)
-    void bbCloseWindow();
-    //==================================================================
-
-  private:
-    /// friendship
-    friend class vtkKWBlackBoxWindow;
-    //    friend class KWBlackBoxWidgetEventHandler;
-
-    /// The KWBlackBoxWindow associated to the box
-    Window* bbmWindow;
-
-
-    void bbInitAttributes();
-
   };
   //=================================================================
  
 
-  //======================================================================
-  /// Defines the bbUserCreateWidget method
-#define BBTK_CREATE_KWWIDGET(CALLBACK)                                 \
-  public:                                                              \
-  inline void bbUserCreateWidget(vtkKWFrame* parent)                   \
-  {                                                                    \
-    bbtkDebugMessageInc("kw",1,"**> Creating widget for ["             \
-                       <<bbGetFullName()<<"]"<<std::endl);             \
-    CALLBACK(parent);                                                  \
-    bbtkDebugMessageInc("kw",1,"<** Creating widget for ["             \
-                       <<bbGetFullName()<<"]"<<std::endl);             \
-  }
-  
-  //======================================================================
-
-  //======================================================================
-  /// Defines the bbUserOnShow method
-#define BBTK_ON_SHOW_WIDGET(CALLBACK)                                  \
-  public:                                                              \
-  inline void bbUserOnShow()                                   \
-  {                                                                    \
-    bbtkDebugMessageInc("wx",1,"**> Showing ["         \
-                       <<bbGetFullName()<<"]"<<std::endl);             \
-    CALLBACK();                                                                \
-    bbtkDebugMessageInc("wx",1,"<** Showing ["         \
-                       <<bbGetFullName()<<"]"<<std::endl);             \
-  }
-  
-  //======================================================================
-
   //=================================================================
   // KWBlackBoxDescriptor declaration
-  BBTK_BEGIN_DESCRIBE_BLACK_BOX(KWBlackBox,bbtk::AtomicBlackBox);
+  class KWBlackBoxDescriptor : public WidgetBlackBoxDescriptor<vtkKWWidget>
+  BBTK_BEGIN_DESCRIBE_BLACK_BOX_BODY(KWBlackBox);
   BBTK_NAME("KWBlackBox");
-  // BBTK_DESCRIPTION("Widget box. The inputs marked with (*) are only used if the widget is not inserted in another widget.\n");
-  BBTK_CATEGORY("widget");
-  BBTK_INPUT(KWBlackBox,WinTitle,
-            "Title of the window (*)",
-            std::string,"");
-  BBTK_INPUT(KWBlackBox,WinWidth,
-            "Width of the window (* : only used if the widget is not connected to a Layout box)",int,"");
-  BBTK_INPUT(KWBlackBox,WinHeight,
-            "Height of the window (*)",int,"");
-  BBTK_INPUT(KWBlackBox,WinDialog,
-            "Set to 'true' to create a dialog window, i.e. which blocks the pipeline until it is closed (modal) (*)",bool,"");
-  BBTK_INPUT(KWBlackBox,WinHide,
-            "Any signal received hides the window (*)",Void,"signal");
-  BBTK_INPUT(KWBlackBox,WinClose,
-            "Any signal received closes the window (*)",Void,"signal");
-  BBTK_OUTPUT(KWBlackBox,Widget,"Output widget",vtkKWWidget*,"");
   BBTK_END_DESCRIBE_BLACK_BOX(KWBlackBox);
   //=================================================================
 
@@ -241,34 +116,6 @@ namespace bbtk
 
 
 
-  /*
-  //=================================================================
-  // Handles the destroy events of a widget associated to a KWBlackBox 
-  // in order to signal the widget death to its associated box
-  class BBTK_EXPORT KWBlackBoxWidgetEventHandler : public wxEvtHandler
-  {
-  public:
-    /// Ctor with the box and widget 
-    KWBlackBoxWidgetEventHandler( KWBlackBox::Pointer box, wxWindow *widget );
-    /// Dtor
-    ~KWBlackBoxWidgetEventHandler();
-    /// Returns true iff is the handler for that window  
-    bool IsHandlerOf( wxWindow* w ) { return mWindow == w; }
-    // wxWindow* GetKWWindow() { return mWindow; }
-    /// Method processing the destroy event of the widget
-    void OnWindowDestroy(wxWindowDestroyEvent&);
-    //
-    //bool IsDead() { return mDead; }
-
-  private:
-    KWBlackBox::WeakPointer mBox;
-    wxWindow* mWindow;
-    //bool mDead;
-  };  
-  //=================================================================
-  */
-
-
 } //namespace bbtk