packages/kw/src/bbkwSlider.h

   1 /*=========================================================================
   2   Program:   bbtk
   3   Module:    $RCSfile: bbkwSlider.h,v $
   4   Language:  C++
   5   Date:      $Date: 2008/12/03 13:35:27 $
   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 bbkw::Slider
  41  * \brief
  42
  43  * \class bbkw::SliderWidget
  44  * \brief
  45  */
  46
  47 #ifdef USE_KWWIDGETS
  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 __bbkwSlider_h_INCLUDED__
  53 #define __bbkwSlider_h_INCLUDED__
  54
  55 // Include KWBlackBox definition
  56 #include "bbtkKWBlackBox.h"
  57
  58 class vtkObject;
  59 class vtkCommand;
  60 #include "vtkCommand.h"
  61
  62 // Namespace of the package "kw" is "bbkw"
  63 // Namespace associated to packages should be of the form :
  64 // bbPACKAGENAME
  65 namespace bbkw
  66 {
  67
  68   //------------------------------------------------------------------------
  69   // The black box
  70   class /*BBTK_EXPORT*/ Slider : public bbtk::KWBlackBox, public vtkCommand
  71   {
  72
  73     BBTK_BLACK_BOX_INTERFACE(Slider,bbtk::KWBlackBox);
  74     BBTK_DECLARE_INPUT(In,int);
  75     BBTK_DECLARE_INPUT(Min,int);
  76     BBTK_DECLARE_INPUT(Max,int);
  77     BBTK_DECLARE_INPUT(Label,bool);
  78     BBTK_DECLARE_INPUT(Title,std::string);
  79     BBTK_DECLARE_INPUT(Orientation,std::string);
  80     BBTK_DECLARE_INPUT(ChangeResolution,bool);
  81     BBTK_DECLARE_INPUT(ReactiveOnTrack,int);
  82     BBTK_DECLARE_OUTPUT(Out,int);
  83     BBTK_PROCESS(Process);
  84     BBTK_CREATE_KWWIDGET(CreateWidget);
  85     void Process();
  86     void CreateWidget(vtkKWFrame*);
  87     virtual void Execute(vtkObject* caller, unsigned long, void*);
  88
  89  protected:
  90     virtual void bbUserConstructor();
  91   };
  92   //=================================================================
  93
  94   //=================================================================
  95   // the black box description
  96   BBTK_BEGIN_DESCRIBE_BLACK_BOX(Slider,bbtk::KWBlackBox);
  97   BBTK_NAME("kwSlider");
  98   BBTK_AUTHOR("laurent.guigues@creatis.insa-lyon.fr");
  99   // Already inserted for any KWBlackBox  BBTK_CATEGORY("widget");
 100   BBTK_DESCRIPTION("Slider widget (vtkKWScale)");
 101   BBTK_INPUT(Slider,In,"Initial position of the slider (default 0)",int,"");
 102   BBTK_INPUT(Slider,Min,"Minimum value of the slider (default 0)",int,"");
 103   BBTK_INPUT(Slider,Max,"Maximum value of the slider (default 500)",int,"");
 104   BBTK_INPUT(Slider,Label,"Show slider labels ? (default FALSE) ",bool,"");
 105   BBTK_INPUT(Slider,Title,"Title shown above the slider (default '') ", std::string,"");
 106   BBTK_INPUT(Slider,Orientation, "Orientation : (default H)  0=H=HORIZONTAL, 1=V=VERTICAL ",std::string,"");
 107   BBTK_INPUT(Slider,ChangeResolution, "Can the user change the resolution of the slider ? (default FALSE) ",bool,"");
 108   BBTK_INPUT(Slider,ReactiveOnTrack, "Slider sends info when track moves (default 0 = no)",int,"");
 109   BBTK_OUTPUT(Slider,Out,"Current position of the slider",int,"");
 110   BBTK_END_DESCRIBE_BLACK_BOX(Slider);
 111   //=================================================================
 112
 113
 114
 115 } //namespace bbkw
 116
 117 #endif  //__bbtkkwSlider_h_INCLUDED__
 118
 119 #endif // USE_KWWIDGETS