]> Creatis software - bbtk.git/blob - packages/wx/src/bbwxCommandButton.h
Feature #1774
[bbtk.git] / packages / wx / src / bbwxCommandButton.h
1 /*
2  # ---------------------------------------------------------------------
3  #
4  # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
5  #                        pour la SantÈ)
6  # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
7  # Previous Authors : Laurent Guigues, Jean-Pierre Roux
8  # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
9  #
10  #  This software is governed by the CeCILL-B license under French law and
11  #  abiding by the rules of distribution of free software. You can  use,
12  #  modify and/ or redistribute the software under the terms of the CeCILL-B
13  #  license as circulated by CEA, CNRS and INRIA at the following URL
14  #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
15  #  or in the file LICENSE.txt.
16  #
17  #  As a counterpart to the access to the source code and  rights to copy,
18  #  modify and redistribute granted by the license, users are provided only
19  #  with a limited warranty  and the software's author,  the holder of the
20  #  economic rights,  and the successive licensors  have only  limited
21  #  liability.
22  #
23  #  The fact that you are presently reading this means that you have had
24  #  knowledge of the CeCILL-B license and that you accept its terms.
25  # ------------------------------------------------------------------------ */
26
27
28 /*=========================================================================
29   Program:   bbtk
30   Module:    $RCSfile: bbwxCommandButton.h,v $
31   Language:  C++
32   Date:      $Date: 2012/11/16 08:52:14 $
33   Version:   $Revision: 1.10 $
34 =========================================================================*/
35
36 /**
37  * \brief Short description in one line 
38  *  
39  * Long description which  
40  * can span multiple lines 
41  */ 
42 /** 
43  * \file  
44  * \brief 
45  */ 
46 /** 
47  * \class CommandButton
48  * \brief 
49  */ 
50  
51  
52 #ifdef USE_WXWIDGETS
53  
54 #ifndef __bbwxCommandButton_h_INCLUDED_H__ 
55 #define __bbwxCommandButton_h_INCLUDED_H__ 
56  
57  
58 #include "bbtkWxBlackBox.h" 
59 #include "bbwx_EXPORT.h"
60  
61  
62 namespace bbwx 
63
64   
65   //--------------------------------------------------------------------------
66   class bbwx_EXPORT CommandButton : public bbtk::WxBlackBox 
67   {     
68     friend class CommandButtonWidget;
69     BBTK_BLACK_BOX_INTERFACE(CommandButton,bbtk::WxBlackBox); 
70     BBTK_DECLARE_INPUT(In, std::string );       
71     BBTK_DECLARE_INPUT(Label, std::string ); 
72     BBTK_DECLARE_INPUT(Colour, std::vector<double> );   
73     //    BBTK_DECLARE_OUTPUT(Out,int); 
74     BBTK_PROCESS(Process); 
75     void Process(); 
76     BBTK_CREATE_WIDGET(CreateWidget);
77     void CreateWidget(wxWindow*);
78   protected: 
79     
80     
81   private: 
82     void UpdateColour();
83     void UpdateLabel();
84   }; 
85   
86   //================================================================= 
87   // UserBlackBox description 
88   BBTK_BEGIN_DESCRIBE_BLACK_BOX(CommandButton,bbtk::WxBlackBox); 
89   BBTK_NAME("CommandButton"); 
90   BBTK_AUTHOR("eduardo.davila@creatis.insa-lyon.fr"); 
91   BBTK_DESCRIPTION("Button which executes bbi commands"); 
92   
93   typedef std::vector<double> vectorcolour;
94   
95   BBTK_INPUT(CommandButton,In,"Commands to be executed separated by commas (;). Each single quote (') is replaced by a double quote (\").",std::string,"");   
96   BBTK_INPUT(CommandButton,Label,"Label of the button",std::string,""); 
97   BBTK_INPUT(CommandButton,Colour,"Colour of the button (-1 -1 -1  Background)",vectorcolour,"colour"); 
98   //    BBTK_OUTPUT(CommandButton,Out,"..Out..",int); 
99   BBTK_END_DESCRIBE_BLACK_BOX(CommandButton); 
100   //================================================================= 
101   
102   
103 }//namespace  bbwx 
104
105 #endif  // __bbwxCommandButton_h_INCLUDED_H__ 
106
107 #endif //USE_WXWIDGETS