Feature #1774

[bbtk.git] / kernel / appli / bbCreateBlackBox / xml-templates / widget-template.xml

diff --git a/kernel/appli/bbCreateBlackBox/xml-templates/widget-template.xml b/kernel/appli/bbCreateBlackBox/xml-templates/widget-template.xml
index 4e321db4dd9a015b9847b6ef4e7f7ba0cd72f85b..18e3a5daf5111bfc85f9b54433e388253b69d51c 100644 (file)
--- a/kernel/appli/bbCreateBlackBox/xml-templates/widget-template.xml
+++ b/kernel/appli/bbCreateBlackBox/xml-templates/widget-template.xml
@@ -1,36 +1,99 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
+<!--
+ # ---------------------------------------------------------------------
+ #
+ # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
+ #                        pour la SantÈ)
+ # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
+ # Previous Authors : Laurent Guigues, Jean-Pierre Roux
+ # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
+ #
+ #  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.
+ # ------------------------------------------------------------------------ */
+ -->
 
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!--==========================================================================
+   STARTS THE DESCRIPTION OF THE BLACK BOX -->
 <blackbox name="__BLACKBOXNAME__" widget>
-
+ <!--========================================================================
+    THE BOX DOCUMENTATION -->
   <author>__AUTHOR__</author>
   <description>__DESCRIPTION__</description>
   <category>__CategoryBlackBox__</category>
 
+<!--========================================================================
+    #include directives to be put in the .h generated
+    There must be one tag per file to include -->
+
+ <!--========================================================================
+    INPUTS/OUTPUTS DECLARATION -->
+
   <input name="Title" type="std::string" description="Title prepended to the text"/>
   <input name="In" type="std::string" description="Text"/>
 
   <createwidget><PRE>
-   bbSetOutputWidget( new wxStaticText ( bbGetWxParent() , -1 , _T("") ) );
-   Process();
+   bbSetOutputWidget( new wxStaticText ( parent , -1 , _T("") ) );
   </PRE></createwidget>
- 
+
+ <!--========================================================================
+    PROCESS section -->
+
   <process><PRE>
    std::string msg;
     if (bbGetInputTitle()!="")
       {
        msg = bbGetInputTitle()+": " + bbGetInputIn();
-      }  
-    else 
+      }
+    else
       {
        msg = bbGetInputIn();
       }
    ((wxStaticText*)bbGetOutputWidget())->SetLabel( bbtk::std2wx( msg ) ); 
   </PRE></process>
-  
+
+ <!--======================================================================
+   CONSTRUCTORS / DESTRUCTORS (OPTIONAL) -->
+
   <constructor><PRE> 
     bbSetInputIn("");
     bbSetInputTitle("");
-  </PRE></constructor>    
+  </PRE>
+  </constructor>
+
+  <!-- THE COPY-CONSTRUCTION METHOD BODY :
+    Here does nothing 
+    But this is where you should allocate the output pointers if any
+    and copy the pointed values (to avoid bug caused by multiple references)-->
+  <copyconstructor>
+  <PRE>
+
+  </PRE>
+  </copyconstructor>
+
+  <!-- THE DESTRUCTION METHOD BODY :
+    Here does nothing 
+    but this is where you should desallocate the output pointers if any -->
+
+  <destructor>
+  <PRE>
+
+  </PRE>
+  </destructor>
+
 
 
 </blackbox>