]> Creatis software - bbtk.git/blob - packages/wx/src/bbwxCheckBox.h
*** empty log message ***
[bbtk.git] / packages / wx / src / bbwxCheckBox.h
1 /*=========================================================================                                                                               
2   Program:   bbtk
3   Module:    $RCSfile: bbwxCheckBox.h,v $
4   Language:  C++
5   Date:      $Date: 2010/05/03 08:06:14 $
6   Version:   $Revision: 1.3 $
7 =========================================================================*/
8
9 /* ---------------------------------------------------------------------
10
11 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
12 * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
13 *
14 *  This software is governed by the CeCILL-B license under French law and 
15 *  abiding by the rules of distribution of free software. You can  use, 
16 *  modify and/ or redistribute the software under the terms of the CeCILL-B 
17 *  license as circulated by CEA, CNRS and INRIA at the following URL 
18 *  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html 
19 *  or in the file LICENSE.txt.
20 *
21 *  As a counterpart to the access to the source code and  rights to copy,
22 *  modify and redistribute granted by the license, users are provided only
23 *  with a limited warranty  and the software's author,  the holder of the
24 *  economic rights,  and the successive licensors  have only  limited
25 *  liability. 
26 *
27 *  The fact that you are presently reading this means that you have had
28 *  knowledge of the CeCILL-B license and that you accept its terms.
29 * ------------------------------------------------------------------------ */                                                                         
30
31 /**
32  * \file 
33  * \brief Short description in one line
34  * 
35  * Long description which 
36  * can span multiple lines
37 */
38
39 /**
40  * \class bbwx::CheckBox
41  * \brief 
42
43  * \class bbwx::CheckBoxWidget
44  * \brief 
45  */
46
47 #ifdef _USE_WXWIDGETS_
48
49 // Prevents multiple inclusions : use symbols of the form
50 // __FILENAME_INCLUDED__ 
51 // where FILENAME must be replaced by the actual file name
52 #ifndef __bbwxCheckBox_h_INCLUDED__
53 #define __bbwxCheckBox_h_INCLUDED__
54
55 // Include wxBlackBox definition
56 #include "bbtkWxBlackBox.h"
57
58 #include "bbwx_EXPORT.h"
59
60
61 // Namespace of the package "wx" is "bbwx" 
62 // Namespace associated to packages should be of the form :
63 // bbPACKAGENAME
64 namespace bbwx
65 {
66   
67   //------------------------------------------------------------------------
68   // The black box
69   class bbwx_EXPORT CheckBox : public bbtk::WxBlackBox
70   {
71     
72     BBTK_BLACK_BOX_INTERFACE(CheckBox,bbtk::WxBlackBox);
73     BBTK_DECLARE_INPUT(In,bool);
74     BBTK_DECLARE_INPUT(Title,std::string);
75         BBTK_DECLARE_INPUT(ReactiveOnKeystroke,int);
76     BBTK_DECLARE_OUTPUT(Out,bool);
77     BBTK_PROCESS(Process);
78     BBTK_CREATE_WIDGET(CreateWidget);
79     void Process();
80     void CreateWidget(wxWindow*);
81
82   protected:
83
84   };
85   //=================================================================
86  
87   //=================================================================
88   // the black box description
89   BBTK_BEGIN_DESCRIBE_BLACK_BOX(CheckBox,bbtk::WxBlackBox);
90   BBTK_NAME("CheckBox");
91   BBTK_AUTHOR("jpr@creatis.insa-lyon.fr");
92   // Already inserted for any WxBlackBox  BBTK_CATEGORY("widget");
93   BBTK_DESCRIPTION("CheckBox widget (wxCheckBox)");
94   BBTK_INPUT(CheckBox, In,   "Initial value of the CheckBox (default false)",bool,       "");
95   BBTK_INPUT(CheckBox, Title,"Title shown above the CheckBox (default '') ", std::string,"");
96   BBTK_OUTPUT(CheckBox,Out,  "Current value of the CheckBox",                bool,       "");
97   BBTK_INPUT(CheckBox,ReactiveOnKeystroke,"0: no event generated when the checkbox is clicked on, 1: event generated when the checkbox is clicked on (default 1) ", int,"");
98   BBTK_END_DESCRIBE_BLACK_BOX(CheckBox);
99   //=================================================================
100   
101
102
103 } //namespace bbwx
104
105 #endif  //__bbtkwxCheckBox_h_INCLUDED__
106
107 #endif //_USE_WXWIDGETS_