packages/kw/src/bbkwSlider.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: bbkwSlider.h,v $
  31   Language:  C++
  32   Date:      $Date: 2012/11/16 08:51:05 $
  33   Version:   $Revision: 1.4 $
  34 =========================================================================*/
  35
  36
  37 /**
  38  * \file
  39  * \brief Short description in one line
  40  *
  41  * Long description which
  42  * can span multiple lines
  43 */
  44
  45 /**
  46  * \class bbkw::Slider
  47  * \brief
  48
  49  * \class bbkw::SliderWidget
  50  * \brief
  51  */
  52
  53 #ifdef USE_KWWIDGETS
  54
  55 // Prevents multiple inclusions : use symbols of the form
  56 // __FILENAME_INCLUDED__
  57 // where FILENAME must be replaced by the actual file name
  58 #ifndef __bbkwSlider_h_INCLUDED__
  59 #define __bbkwSlider_h_INCLUDED__
  60
  61 // Include KWBlackBox definition
  62 #include "bbtkKWBlackBox.h"
  63
  64 class vtkObject;
  65 class vtkCommand;
  66 #include "vtkCommand.h"
  67
  68 // Namespace of the package "kw" is "bbkw"
  69 // Namespace associated to packages should be of the form :
  70 // bbPACKAGENAME
  71 namespace bbkw
  72 {
  73
  74   //------------------------------------------------------------------------
  75   // The black box
  76   class /*BBTK_EXPORT*/ Slider : public bbtk::KWBlackBox, public vtkCommand
  77   {
  78
  79     BBTK_BLACK_BOX_INTERFACE(Slider,bbtk::KWBlackBox);
  80     BBTK_DECLARE_INPUT(In,int);
  81     BBTK_DECLARE_INPUT(Min,int);
  82     BBTK_DECLARE_INPUT(Max,int);
  83     BBTK_DECLARE_INPUT(Label,bool);
  84     BBTK_DECLARE_INPUT(Title,std::string);
  85     BBTK_DECLARE_INPUT(Orientation,std::string);
  86     BBTK_DECLARE_INPUT(ChangeResolution,bool);
  87     BBTK_DECLARE_INPUT(ReactiveOnTrack,int);
  88     BBTK_DECLARE_OUTPUT(Out,int);
  89     BBTK_PROCESS(Process);
  90     BBTK_CREATE_KWWIDGET(CreateWidget);
  91     void Process();
  92     void CreateWidget(vtkKWFrame*);
  93     virtual void Execute(vtkObject* caller, unsigned long, void*);
  94
  95  protected:
  96     virtual void bbUserConstructor();
  97   };
  98   //=================================================================
  99
 100   //=================================================================
 101   // the black box description
 102   BBTK_BEGIN_DESCRIBE_BLACK_BOX(Slider,bbtk::KWBlackBox);
 103   BBTK_NAME("kwSlider");
 104   BBTK_AUTHOR("laurent.guigues@creatis.insa-lyon.fr");
 105   // Already inserted for any KWBlackBox  BBTK_CATEGORY("widget");
 106   BBTK_DESCRIPTION("Slider widget (vtkKWScale)");
 107   BBTK_INPUT(Slider,In,"Initial position of the slider (default 0)",int,"");
 108   BBTK_INPUT(Slider,Min,"Minimum value of the slider (default 0)",int,"");
 109   BBTK_INPUT(Slider,Max,"Maximum value of the slider (default 500)",int,"");
 110   BBTK_INPUT(Slider,Label,"Show slider labels ? (default FALSE) ",bool,"");
 111   BBTK_INPUT(Slider,Title,"Title shown above the slider (default '') ", std::string,"");
 112   BBTK_INPUT(Slider,Orientation, "Orientation : (default H)  0=H=HORIZONTAL, 1=V=VERTICAL ",std::string,"");
 113   BBTK_INPUT(Slider,ChangeResolution, "Can the user change the resolution of the slider ? (default FALSE) ",bool,"");
 114   BBTK_INPUT(Slider,ReactiveOnTrack, "Slider sends info when track moves (default 0 = no)",int,"");
 115   BBTK_OUTPUT(Slider,Out,"Current position of the slider",int,"");
 116   BBTK_END_DESCRIBE_BLACK_BOX(Slider);
 117   //=================================================================
 118
 119
 120
 121 } //namespace bbkw
 122
 123 #endif  //__bbtkkwSlider_h_INCLUDED__
 124
 125 #endif // USE_KWWIDGETS