]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkWxBlackBox.h
fix default_temp_dir trouble
[bbtk.git] / kernel / src / bbtkWxBlackBox.h
index 619632306e42a3fc23676fef1a1f609a3ea5d6f9..f11ddebe5367aaa8705df473e93c533663564b54 100644 (file)
@@ -1,20 +1,34 @@
-/*=========================================================================
-                                                                                
+/*=========================================================================                                                                               
   Program:   bbtk
   Module:    $RCSfile: bbtkWxBlackBox.h,v $
   Language:  C++
-  Date:      $Date: 2008/04/21 12:43:05 $
-  Version:   $Revision: 1.12 $
-                                                                                
-  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/10/17 08:18:15 $
+  Version:   $Revision: 1.18 $
+========================================================================*/
+
+
+/* ---------------------------------------------------------------------
+
+* 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 
@@ -69,9 +83,14 @@ namespace bbtk
     BBTK_DECLARE_INPUT(WinHeight,int);
     BBTK_DECLARE_INPUT(WinDialog,bool);
     BBTK_DECLARE_INPUT(WinHide,Void);
+    BBTK_DECLARE_INPUT(WinClose,Void);
     BBTK_DECLARE_OUTPUT(Widget, wxWindow*);//WxBlackBoxWidget*);
 
   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
@@ -154,6 +173,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 +202,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;
@@ -193,7 +214,6 @@ namespace bbtk
     void bbSetUpdateTransferedToParent(bool b) 
     { bbmUpdateTransferedToParent = b; }
 
-
   };
   //=================================================================
  
@@ -204,10 +224,10 @@ namespace bbtk
   public:                                                              \
   inline void bbUserCreateWidget()                                     \
   {                                                                    \
-    bbtkDebugMessageInc("Process",1,"=> "<<bbGetTypeName()<<"::bbUserCreateWidget() [" \
+    bbtkDebugMessageInc("process",1,"**> Creating widget for ["                \
                        <<bbGetFullName()<<"]"<<std::endl);             \
     CALLBACK();                                                                \
-    bbtkDebugMessageDec("Process",1,"<= "<<bbGetTypeName()<<"::bbUserCreateWidget() [" \
+    bbtkDebugMessageInc("process",2,"<** Creating widget for ["                \
                        <<bbGetFullName()<<"]"<<std::endl);             \
   }
   
@@ -223,13 +243,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);
   //=================================================================
@@ -251,12 +273,13 @@ namespace bbtk
     virtual ~WxBlackBoxWindow();
     virtual void bbShow();
     virtual void bbHide();
+    virtual void bbClose();
     bool bbIsShown() { return mShown; }
-    virtual WxBlackBox::Pointer bbGetBlackBox() { return mBox; }
+    virtual WxBlackBox::Pointer bbGetBlackBox() { return mBox.lock(); }
     virtual wxDialog* bbGetDialog() { return 0; } 
     virtual wxFrame* bbGetFrame() { return 0; } 
   private:
-    WxBlackBox::Pointer mBox;
+    WxBlackBox::WeakPointer mBox;
     bool mShown;
   };
   //==================================================================
@@ -271,6 +294,7 @@ namespace bbtk
     ~WxBlackBoxDialog();
     void bbShow();  
     void bbHide();
+    void bbClose();
     wxDialog* bbGetDialog() { return this; } 
   };
   //==================================================================
@@ -285,6 +309,7 @@ namespace bbtk
     ~WxBlackBoxFrame();
     void bbShow();
     void bbHide();
+    void bbClose();
     wxFrame* bbGetFrame() { return this; } 
   };
   //==================================================================
@@ -310,7 +335,7 @@ namespace bbtk
     //bool IsDead() { return mDead; }
 
   private:
-    WxBlackBox::Pointer mBox;
+    WxBlackBox::WeakPointer mBox;
     wxWindow* mWindow;
     //bool mDead;
   };