]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkWxBlackBox.h
New widget pipeline : progressing ...
[bbtk.git] / kernel / src / bbtkWxBlackBox.h
index dd870f95b3663bb6259e631bbe167137c1fdbeae..e2857e0d47c57d0f87ce4d0b548272b77bbb138a 100644 (file)
@@ -1,20 +1,34 @@
-/*=========================================================================
-                                                                                
+/*=========================================================================                                                                               
   Program:   bbtk
   Module:    $RCSfile: bbtkWxBlackBox.h,v $
   Language:  C++
-  Date:      $Date: 2008/04/24 10:24:58 $
-  Version:   $Revision: 1.15 $
-                                                                                
-  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
-  l'Image). All rights reserved. See Doc/License.txt or
-  http://www.creatis.insa-lyon.fr/Public/bbtk/License.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.
-                                                                                
-=========================================================================*//**
+  Date:      $Date: 2008/11/25 11:17:13 $
+  Version:   $Revision: 1.21 $
+========================================================================*/
+
+
+/* ---------------------------------------------------------------------
+
+* Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
+* Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
+*
+*  This software is governed by the CeCILL-B license under French law and 
+*  abiding by the rules of distribution of free software. You can  use, 
+*  modify and/ or redistribute the software under the terms of the CeCILL-B 
+*  license as circulated by CEA, CNRS and INRIA at the following URL 
+*  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html 
+*  or in the file LICENSE.txt.
+*
+*  As a counterpart to the access to the source code and  rights to copy,
+*  modify and redistribute granted by the license, users are provided only
+*  with a limited warranty  and the software's author,  the holder of the
+*  economic rights,  and the successive licensors  have only  limited
+*  liability. 
+*
+*  The fact that you are presently reading this means that you have had
+*  knowledge of the CeCILL-B license and that you accept its terms.
+* ------------------------------------------------------------------------ */                                                                         
+/**
  * \brief Short description in one line
  * 
  * Long description which 
@@ -63,15 +77,19 @@ namespace bbtk
   class BBTK_EXPORT WxBlackBox : public bbtk::AtomicBlackBox  
   { 
     BBTK_BLACK_BOX_INTERFACE(WxBlackBox,bbtk::AtomicBlackBox);
-    //   BBTK_DECLARE_INPUT(WinParent,WxParentToChildData*);
     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_OUTPUT(Widget, wxWindow*);//WxBlackBoxWidget*);
+    BBTK_DECLARE_INPUT(WinClose,Void);
+    BBTK_DECLARE_OUTPUT(Widget, wxWindow*);
 
   public:
+    /// Main processing method of the box. Overloaded to handle windows inclusion : if the output Widget is connected then the execution is transfered to the box to which it is connected (as the container window must be created and displayed - this box will be executed by the normal pipeline recursion mechanism)
+    virtual void bbExecute(bool force = false);
+
+
     typedef WxBlackBoxWindow Window;
     
     /// Returns the **OWN** window associated to the box
@@ -89,7 +107,9 @@ namespace bbtk
     Window* bbGetContainingWindow();
 
     /// Returns the parent wxWindow that must be used to create the widget 
-    wxWindow* bbGetWxParent();
+         //
+         // LG 24/11/08 : New widget pipeline
+         //    wxWindow* bbGetWxParent();
 
     /// Returns true iff the 'containing window' exists and is shown 
     /// (see bbGetContainingWindow).
@@ -105,6 +125,10 @@ namespace bbtk
     virtual void bbUserOnHide() {}
     //==================================================================    
 
+         // LG 24/11/08 : New widget pipeline
+         void bbCreateWidgetAndEventHandler(wxWindow* parent); 
+
+         
   protected:
     
   
@@ -112,7 +136,7 @@ namespace bbtk
     /// User callback called in the box contructor
     virtual void bbUserConstructor();
     /// User callback called in the box copy constructor
-    virtual void bbUserCopyConstructor();
+    virtual void bbUserCopyConstructor(bbtk::BlackBox::Pointer);
     /// User callback called in the box destructor
     virtual void bbUserDestructor();
     //==================================================================    
@@ -120,14 +144,16 @@ namespace bbtk
     //==================================================================    
     /// User callback for creating the widget associated to the box
     /// ** Must be defined **
-    virtual void bbUserCreateWidget() 
+         // LG 24/11/08 : New widget pipeline
+         virtual void bbUserCreateWidget(wxWindow* parent) 
     {
       bbtkError(bbGetTypeName()<<" is a WxBlackBox whose bbUserCreateWidget methods is not overloaded : is it a feature or a bug ?!?");
     }
     //==================================================================    
 
 
-    
+         wxWindow* bbCreateWidgetOfInput(const std::string& in, wxWindow* parent);
+
 
     //==================================================================
     /// Main processing method of the box.
@@ -154,6 +180,8 @@ namespace bbtk
     void bbShowWindow();
     /// Hides the WxBlackBoxWindow associated to the box (if exists)
     void bbHideWindow();
+    /// Closes (destroys) the WxBlackBoxWindow associated to the box (if exists)
+    void bbCloseWindow();
     //==================================================================
 
   private:
@@ -181,10 +209,10 @@ namespace bbtk
     void bbInitAttributes();
 
   protected :
-    /// Main processing method of the box. Overloaded to handle windows inclusion : if the output Widget is connected then the execution is transfered to the box to which it is connected (the container window must be created and displayed - this box will be also executed by the normal pipeline recursion mechanism)
-    virtual void bbExecute(bool force = false);
 
 
+    /// For Forward update mechanism when execution is called 
+    /// on a contained window
     /// Is set to true before transfering update to parent 
     /// in order to not re-transfer a second time...
     bool bbmUpdateTransferedToParent;
@@ -201,12 +229,27 @@ namespace bbtk
   /// Defines the bbUserCreateWidget method
 #define BBTK_CREATE_WIDGET(CALLBACK)                                   \
   public:                                                              \
-  inline void bbUserCreateWidget()                                     \
+  inline void bbUserCreateWidget(wxWindow* parent)                                     \
+  {                                                                    \
+    bbtkDebugMessageInc("wx",1,"**> Creating widget for ["             \
+                       <<bbGetFullName()<<"]"<<std::endl);             \
+    CALLBACK(parent);                                                          \
+    bbtkDebugMessageInc("wx",1,"<** Creating widget for ["             \
+                       <<bbGetFullName()<<"]"<<std::endl);             \
+  }
+  
+  //======================================================================
+
+  //======================================================================
+  /// Defines the bbUserOnShow method
+#define BBTK_ON_SHOW_WIDGET(CALLBACK)                                  \
+  public:                                                              \
+  inline void bbUserOnShow()                                   \
   {                                                                    \
-    bbtkDebugMessageInc("process",1,"**> Creating widget for ["                \
+    bbtkDebugMessageInc("wx",1,"**> Showing ["         \
                        <<bbGetFullName()<<"]"<<std::endl);             \
     CALLBACK();                                                                \
-    bbtkDebugMessageInc("process",2,"<** Creating widget for ["                \
+    bbtkDebugMessageInc("wx",1,"<** Showing ["         \
                        <<bbGetFullName()<<"]"<<std::endl);             \
   }
   
@@ -222,13 +265,15 @@ namespace bbtk
             "Title of the window (*)",
             std::string,"");
   BBTK_INPUT(WxBlackBox,WinWidth,
-            "Width of the window (* : only used if the widget is not inserted in another widget)",int,"");
+            "Width of the window (* : only used if the widget is not connected to a Layout box)",int,"");
   BBTK_INPUT(WxBlackBox,WinHeight,
             "Height of the window (*)",int,"");
   BBTK_INPUT(WxBlackBox,WinDialog,
             "Set to 'true' to create a dialog window, i.e. which blocks the pipeline until it is closed (modal) (*)",bool,"");
   BBTK_INPUT(WxBlackBox,WinHide,
-            "Any signal received hides the window (*)",Void,"");
+            "Any signal received hides the window (*)",Void,"signal");
+  BBTK_INPUT(WxBlackBox,WinClose,
+            "Any signal received closes the window (*)",Void,"signal");
   BBTK_OUTPUT(WxBlackBox,Widget,"Output widget",wxWindow*,"");
   BBTK_END_DESCRIBE_BLACK_BOX(WxBlackBox);
   //=================================================================
@@ -250,6 +295,7 @@ namespace bbtk
     virtual ~WxBlackBoxWindow();
     virtual void bbShow();
     virtual void bbHide();
+    virtual void bbClose();
     bool bbIsShown() { return mShown; }
     virtual WxBlackBox::Pointer bbGetBlackBox() { return mBox.lock(); }
     virtual wxDialog* bbGetDialog() { return 0; } 
@@ -270,6 +316,7 @@ namespace bbtk
     ~WxBlackBoxDialog();
     void bbShow();  
     void bbHide();
+    void bbClose();
     wxDialog* bbGetDialog() { return this; } 
   };
   //==================================================================
@@ -284,6 +331,7 @@ namespace bbtk
     ~WxBlackBoxFrame();
     void bbShow();
     void bbHide();
+    void bbClose();
     wxFrame* bbGetFrame() { return this; } 
   };
   //==================================================================