]> Creatis software - bbtk.git/blob - kernel/src/bbtkWxBlackBox.h
#3073 BBTK Bug New Normal - message documentation in boxes
[bbtk.git] / kernel / src / bbtkWxBlackBox.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: bbtkWxBlackBox.h,v $
31   Language:  C++
32   Date:      $Date: 2012/11/16 08:49:01 $
33   Version:   $Revision: 1.33 $
34 ========================================================================*/
35
36
37
38 /**
39  * \brief Short description in one line
40  * 
41  * Long description which 
42  * can span multiple lines
43  */
44 /**
45  * \file 
46  * \brief 
47  */
48 /**
49  * \class bbtk::
50  * \brief 
51  */
52
53
54 #ifdef USE_WXWIDGETS
55
56
57 #ifndef __bbtkWxBlackBox_h__
58 #define __bbtkWxBlackBox_h__
59
60
61
62 #include "bbtkWidgetBlackBox.h"
63 #include "bbtkWx.h"
64
65
66 namespace bbtk
67 {
68
69  
70
71   //==================================================================
72   /// Widget black boxes
73 //EED 10/06/2009 /*BBTK_EXPORT*/
74   class BBTK_EXPORT WxBlackBox : public bbtk::WidgetBlackBox<wxWindow>
75   { 
76   public:
77     BBTK_BLACK_BOX_INTERFACE(WxBlackBox,bbtk::WidgetBlackBox<wxWindow>);
78
79           
80     //  protected:
81     
82   public:
83   
84    //==================================================================    
85     /// Callback for creating a Dialog window (modal)
86     /// ** Must be defined ** in toolkit specific descendants 
87     virtual void bbCreateDialogWindow();
88     //==================================================================    
89
90     //==================================================================    
91     /// Callback for creating a Frame window 
92     /// ** Must be defined ** in toolkit specific descendants 
93     virtual void bbCreateFrameWindow();
94     //==================================================================    
95
96      
97     //==================================================================    
98     wxWindow* bbGetWindow() { return bbmWindow; }
99     void bbSetWindow(wxWindow*) ;
100     bool bbWindowIsCreated() { return (bbGetWindow() != 0); }
101     //==================================================================    
102
103
104     //==================================================================    
105     virtual void bbShowWindow();
106     //==================================================================   
107  
108     //==================================================================    
109     virtual void bbDestroyWindow();
110     //==================================================================    
111
112     //==================================================================    
113         virtual void PutWinTitle();
114     //==================================================================    
115
116         virtual std::string ConstructWinTitle();
117
118   private:
119
120     wxWindow* bbmWindow;
121  
122   };
123   //=================================================================
124  
125
126   //=================================================================
127   // WxBlackBoxDescriptor declaration
128   class WxBlackBoxDescriptor : public WidgetBlackBoxDescriptor<wxWindow>
129   BBTK_BEGIN_DESCRIBE_BLACK_BOX_BODY(WxBlackBox);
130   BBTK_NAME("WxBlackBox");
131   BBTK_END_DESCRIBE_BLACK_BOX(WxBlackBox);
132   //=================================================================
133
134
135 } //namespace bbtk
136
137 #endif  //__bbtkWxBlackBox_h__
138
139 #endif  //USE_WXWIDGETS