kernel/src/bbtkWidgetBlackBox.h

   1 /*=========================================================================
   2   Program:   bbtk
   3   Module:    $RCSfile: bbtkWidgetBlackBox.h,v $
   4   Language:  C++
   5   Date:      $Date: 2009/06/08 14:50:04 $
   6   Version:   $Revision: 1.5 $
   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     bool bbIsShown();
  98     //==================================================================
  99
 100
 101     //==================================================================
 102     /// User callback for creating the widget associated to the box
 103     /// ** Must be defined ** in user classes
 104     virtual void bbUserCreateWidget(Widget* parent)
 105     {
 106       bbtkError(bbGetTypeName()<<" is a WidgetBlackBox whose bbUserCreateWidget methods is not overloaded : is it a feature or a bug ?!?");
 107     }
 108     //==================================================================
 109
 110
 111   protected:
 112
 113     void bbSetShown(bool);
 114
 115     //==================================================================
 116     /// Convenient method for layout widgets which creates and returns
 117     /// (calls bbUserCreateWidget)
 118     /// the widget of the box connected to the input in.
 119     /// Returns NULL if the input is not connected
 120     Widget* bbCreateWidgetOfInput(const std::string& in,
 121                                   Widget* parent);
 122     //==================================================================
 123
 124    //==================================================================
 125     /// Callback for creating a Dialog window (modal)
 126     /// ** Must be defined ** in toolkit specific descendants
 127     virtual void bbCreateDialogWindow()
 128     {
 129       bbtkError(bbGetTypeName()<<" is a WidgetBlackBox whose bbCreateDialogWindow method is not overloaded ?!?");
 130     }
 131     //==================================================================
 132
 133  //==================================================================
 134     /// Callback for creating a Frame window
 135     /// ** Must be defined ** in toolkit specific descendants
 136     virtual void bbCreateFrameWindow()
 137     {
 138       bbtkError(bbGetTypeName()<<" is a WidgetBlackBox whose bbCreateFrameWindow method is not overloaded ?!?");
 139     }
 140     //==================================================================
 141     //==================================================================
 142     /// Overloaded processing method for WidgetBlackBoxes
 143     virtual void bbProcess();
 144     //==================================================================
 145
 146     //==================================================================
 147     /// Destroys the WidgetBlackBoxWindow associated to the box (if exists)
 148     virtual void bbDestroyWindow() {}
 149     //==================================================================
 150
 151
 152
 153   private:
 154
 155     /// Set to true when the
 156     /// window containing the widget is shown
 157     bool bbmShown;
 158     /// Contains the "nested" WidgetBlackBoxes,
 159     /// i.e. if this WidgetBox is a Layout the ones
 160     /// which are inserted into the layout
 161     /// The list is updated by the method bbCreateWidgetOfInput
 162     /// It is emptied when ?
 163     std::vector<BlackBox::WeakPointer> bbmNestedWidgetBoxes;
 164   };
 165   //=================================================================
 166
 167
 168   //======================================================================
 169   /// Defines the bbUserCreateWidget method
 170 #define BBTK_CREATE_WIDGET(CALLBACK)                                    \
 171   public:                                                               \
 172   inline void bbUserCreateWidget(Widget* parent)                        \
 173   {                                                                     \
 174     bbtkBlackBoxDebugMessage("widget",1,"**> Creating widget"           \
 175                              <<std::endl);                              \
 176     CALLBACK(parent);                                                   \
 177   }
 178
 179   //======================================================================
 180
 181   //======================================================================
 182   /// Defines the bbUserOnShow method
 183 #define BBTK_ON_SHOW_WIDGET(CALLBACK)                                   \
 184   public:                                                               \
 185   inline void bbUserOnShow()                                            \
 186   {                                                                     \
 187     bbtkBlackBoxDebugMessage("widget",1,"**> Showing"                   \
 188                              <<std::endl);                              \
 189     CALLBACK();                                                         \
 190   }
 191
 192   //======================================================================
 193
 194   //=================================================================
 195   // WidgetBlackBoxDescriptor declaration
 196   BBTK_BEGIN_DESCRIBE_TEMPLATE_BLACK_BOX(WidgetBlackBox,bbtk::AtomicBlackBox);
 197   BBTK_NAME("WidgetBlackBox_"+HumanTypeName<T>());
 198   // BBTK_DESCRIPTION("Widget box. The inputs marked with (*) are only used if the widget is not inserted in another widget.\n");
 199   BBTK_CATEGORY("widget");
 200   BBTK_TEMPLATE_INPUT(WidgetBlackBox,WinTitle,
 201              "Title of the window (*)",
 202              std::string);
 203   BBTK_TEMPLATE_INPUT(WidgetBlackBox,WinWidth,
 204              "Width of the window (* : only used if the widget is not connected to a Layout box)",int);
 205   BBTK_TEMPLATE_INPUT(WidgetBlackBox,WinHeight,
 206              "Height of the window (*)",int);
 207   BBTK_TEMPLATE_INPUT(WidgetBlackBox,WinDialog,
 208              "Set to 'true' to create a dialog window, i.e. which blocks the pipeline until it is closed (modal) (*)",bool);
 209   BBTK_TEMPLATE_INPUT(WidgetBlackBox,WinHide,
 210              "Any signal received hides the window (*)",Void);
 211   BBTK_TEMPLATE_INPUT(WidgetBlackBox,WinClose,
 212              "Any signal received closes the window (*)",Void);
 213   typedef typename WidgetBlackBox<T>::WidgetPointer WidgetPointer;
 214   BBTK_TEMPLATE_OUTPUT(WidgetBlackBox,Widget,"Output widget",WidgetPointer);
 215   BBTK_END_DESCRIBE_BLACK_BOX(WidgetBlackBox);
 216   //=================================================================
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226 } //namespace bbtk
 227
 228 // template code inclusion
 229 #include "bbtkWidgetBlackBox.txx"
 230
 231 // WidgetBlackBoxWindow interface + code inclusion
 232 #include "bbtkWidgetBlackBoxWindow.h"
 233
 234 #endif  //__bbtkWidgetBlackBox_h__