kernel/src/bbtkWidgetBlackBox.h

   1 /*=========================================================================
   2   Program:   bbtk
   3   Module:    $RCSfile: bbtkWidgetBlackBox.h,v $
   4   Language:  C++
   5   Date:      $Date: 2009/05/28 08:12:06 $
   6   Version:   $Revision: 1.4 $
   7 ========================================================================*/
   8
   9
  10 /* ---------------------------------------------------------------------
  11
  12 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
  13 * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
  14 *
  15 *  This software is governed by the CeCILL-B license under French law and
  16 *  abiding by the rules of distribution of free software. You can  use,
  17 *  modify and/ or redistribute the software under the terms of the CeCILL-B
  18 *  license as circulated by CEA, CNRS and INRIA at the following URL
  19 *  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  20 *  or in the file LICENSE.txt.
  21 *
  22 *  As a counterpart to the access to the source code and  rights to copy,
  23 *  modify and redistribute granted by the license, users are provided only
  24 *  with a limited warranty  and the software's author,  the holder of the
  25 *  economic rights,  and the successive licensors  have only  limited
  26 *  liability.
  27 *
  28 *  The fact that you are presently reading this means that you have had
  29 *  knowledge of the CeCILL-B license and that you accept its terms.
  30 * ------------------------------------------------------------------------ */
  31 /**
  32  * \brief Short description in one line
  33  *
  34  * Long description which
  35  * can span multiple lines
  36  */
  37 /**
  38  * \file
  39  * \brief
  40  */
  41 /**
  42  * \class bbtk::
  43  * \brief
  44  */
  45 #ifndef __bbtkWidgetBlackBox_h_INCLUDED__
  46 #define __bbtkWidgetBlackBox_h_INCLUDED__
  47
  48 #include "bbtkAtomicBlackBox.h"
  49
  50 namespace bbtk
  51 {
  52
  53
  54
  55
  56   //==================================================================
  57   /// Generic (template) Widget black box from which all
  58   /// widget black boxes for a specific GUI toolkit inherit with
  59   /// apropriate traits.
  60   /// Declares the common inputs / outputs and interface to all widget boxes
  61   template <class W>
  62   class /*BBTK_EXPORT*/ WidgetBlackBox : public bbtk::AtomicBlackBox
  63   {
  64   public:
  65     //    typedef WidgetTraits Traits;
  66     typedef W Widget;
  67     typedef Widget* WidgetPointer;
  68
  69
  70     BBTK_BLACK_BOX_INTERFACE(WidgetBlackBox,bbtk::AtomicBlackBox);
  71     BBTK_DECLARE_INPUT(WinTitle,std::string);
  72     BBTK_DECLARE_INPUT(WinWidth,int);
  73     BBTK_DECLARE_INPUT(WinHeight,int);
  74     BBTK_DECLARE_INPUT(WinDialog,bool);
  75     BBTK_DECLARE_INPUT(WinHide,Void);
  76     BBTK_DECLARE_INPUT(WinClose,Void);
  77     BBTK_DECLARE_OUTPUT(Widget,Widget*);
  78
  79     //==================================================================
  80     /// Overloaded bbCreateWindow method for WidgetBlackBoxes which handles
  81     /// the window creation if needed
  82     virtual void bbCreateWindow();
  83     virtual bool bbWindowIsCreated() { return false; }
  84     //==================================================================
  85
  86     //==================================================================
  87     /// Overloaded bbShowWindow method for WidgetBlackBoxes which handles
  88     /// the window creation if needed
  89     virtual void bbShowWindow() {}
  90     //==================================================================
  91
  92
  93     /// Convenient method which returns true iff the output Widget is connected
  94     bool bbIsOutputWidgetConnected();
  95
  96     //==================================================================
  97     void bbSetShown(bool);
  98     bool bbIsShown();
  99     //==================================================================
 100
 101
 102     //==================================================================
 103     /// User callback for creating the widget associated to the box
 104     /// ** Must be defined ** in user classes
 105     virtual void bbUserCreateWidget(Widget* parent)
 106     {
 107       bbtkError(bbGetTypeName()<<" is a WidgetBlackBox whose bbUserCreateWidget methods is not overloaded : is it a feature or a bug ?!?");
 108     }
 109     //==================================================================
 110
 111
 112   protected:
 113
 114
 115
 116     //==================================================================
 117     /// Convenient method for layout widgets which creates and returns
 118     /// (calls bbUserCreateWidget)
 119     /// the widget of the box connected to the input in.
 120     /// Returns NULL if the input is not connected
 121     Widget* bbCreateWidgetOfInput(const std::string& in,
 122                                   Widget* parent);
 123     //==================================================================
 124
 125    //==================================================================
 126     /// Callback for creating a Dialog window (modal)
 127     /// ** Must be defined ** in toolkit specific descendants
 128     virtual void bbCreateDialogWindow()
 129     {
 130       bbtkError(bbGetTypeName()<<" is a WidgetBlackBox whose bbCreateDialogWindow method is not overloaded ?!?");
 131     }
 132     //==================================================================
 133
 134  //==================================================================
 135     /// Callback for creating a Frame window
 136     /// ** Must be defined ** in toolkit specific descendants
 137     virtual void bbCreateFrameWindow()
 138     {
 139       bbtkError(bbGetTypeName()<<" is a WidgetBlackBox whose bbCreateFrameWindow method is not overloaded ?!?");
 140     }
 141     //==================================================================
 142     //==================================================================
 143     /// Overloaded processing method for WidgetBlackBoxes
 144     virtual void bbProcess();
 145     //==================================================================
 146
 147     //==================================================================
 148     /// Destroys the WidgetBlackBoxWindow associated to the box (if exists)
 149     virtual void bbDestroyWindow() {}
 150     //==================================================================
 151
 152
 153
 154   private:
 155
 156     /// Set to true when the
 157     /// window containing the widget is shown
 158     bool bbmShown;
 159     /// Contains the "nested" WidgetBlackBoxes,
 160     /// i.e. if this WidgetBox is a Layout the ones
 161     /// which are inserted into the layout
 162     /// The list is updated by the method bbCreateWidgetOfInput
 163     /// It is emptied when ?
 164     std::vector<BlackBox::WeakPointer> bbmNestedWidgetBoxes;
 165   };
 166   //=================================================================
 167
 168
 169   //======================================================================
 170   /// Defines the bbUserCreateWidget method
 171 #define BBTK_CREATE_WIDGET(CALLBACK)                                    \
 172   public:                                                               \
 173   inline void bbUserCreateWidget(Widget* parent)                        \
 174   {                                                                     \
 175     bbtkBlackBoxDebugMessage("widget",1,"**> Creating widget"           \
 176                              <<std::endl);                              \
 177     CALLBACK(parent);                                                   \
 178   }
 179
 180   //======================================================================
 181
 182   //======================================================================
 183   /// Defines the bbUserOnShow method
 184 #define BBTK_ON_SHOW_WIDGET(CALLBACK)                                   \
 185   public:                                                               \
 186   inline void bbUserOnShow()                                            \
 187   {                                                                     \
 188     bbtkBlackBoxDebugMessage("widget",1,"**> Showing"                   \
 189                              <<std::endl);                              \
 190     CALLBACK();                                                         \
 191   }
 192
 193   //======================================================================
 194
 195   //=================================================================
 196   // WidgetBlackBoxDescriptor declaration
 197   BBTK_BEGIN_DESCRIBE_TEMPLATE_BLACK_BOX(WidgetBlackBox,bbtk::AtomicBlackBox);
 198   BBTK_NAME("WidgetBlackBox_"+HumanTypeName<T>());
 199   // BBTK_DESCRIPTION("Widget box. The inputs marked with (*) are only used if the widget is not inserted in another widget.\n");
 200   BBTK_CATEGORY("widget");
 201   BBTK_TEMPLATE_INPUT(WidgetBlackBox,WinTitle,
 202              "Title of the window (*)",
 203              std::string);
 204   BBTK_TEMPLATE_INPUT(WidgetBlackBox,WinWidth,
 205              "Width of the window (* : only used if the widget is not connected to a Layout box)",int);
 206   BBTK_TEMPLATE_INPUT(WidgetBlackBox,WinHeight,
 207              "Height of the window (*)",int);
 208   BBTK_TEMPLATE_INPUT(WidgetBlackBox,WinDialog,
 209              "Set to 'true' to create a dialog window, i.e. which blocks the pipeline until it is closed (modal) (*)",bool);
 210   BBTK_TEMPLATE_INPUT(WidgetBlackBox,WinHide,
 211              "Any signal received hides the window (*)",Void);
 212   BBTK_TEMPLATE_INPUT(WidgetBlackBox,WinClose,
 213              "Any signal received closes the window (*)",Void);
 214   typedef typename WidgetBlackBox<T>::WidgetPointer WidgetPointer;
 215   BBTK_TEMPLATE_OUTPUT(WidgetBlackBox,Widget,"Output widget",WidgetPointer);
 216   BBTK_END_DESCRIBE_BLACK_BOX(WidgetBlackBox);
 217   //=================================================================
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227 } //namespace bbtk
 228
 229 // template code inclusion
 230 #include "bbtkWidgetBlackBox.txx"
 231
 232 // WidgetBlackBoxWindow interface + code inclusion
 233 #include "bbtkWidgetBlackBoxWindow.h"
 234
 235 #endif  //__bbtkWidgetBlackBox_h__