packages/wx/src/bbwxSlider.h

   1 /*=========================================================================
   2   Program:   bbtk
   3   Module:    $RCSfile: bbwxSlider.h,v $
   4   Language:  C++
   5   Date:      $Date: 2009/05/15 14:58:03 $
   6   Version:   $Revision: 1.18 $
   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 bbwx::Slider
  41  * \brief
  42
  43  * \class bbwx::SliderWidget
  44  * \brief
  45  */
  46
  47 #ifdef _USE_WXWIDGETS_
  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 __bbwxSlider_h_INCLUDED__
  53 #define __bbwxSlider_h_INCLUDED__
  54
  55 // Include wxBlackBox definition
  56 #include "bbtkWxBlackBox.h"
  57
  58 #include "bbwx_EXPORT.h"
  59
  60
  61 // Namespace of the package "wx" is "bbwx"
  62 // Namespace associated to packages should be of the form :
  63 // bbPACKAGENAME
  64 namespace bbwx
  65 {
  66
  67   //------------------------------------------------------------------------
  68   // The black box
  69   class bbwx_EXPORT Slider : public bbtk::WxBlackBox
  70   {
  71     BBTK_BLACK_BOX_INTERFACE(Slider,bbtk::WxBlackBox);
  72     BBTK_DECLARE_INPUT(In,int);
  73     BBTK_DECLARE_INPUT(Min,int);
  74     BBTK_DECLARE_INPUT(Max,int);
  75     BBTK_DECLARE_INPUT(Label,bool);
  76     BBTK_DECLARE_INPUT(Title,std::string);
  77     BBTK_DECLARE_INPUT(Orientation,std::string);
  78     BBTK_DECLARE_INPUT(ChangeResolution,bool);
  79     BBTK_DECLARE_INPUT(ReactiveOnTrack,bool);
  80     BBTK_DECLARE_OUTPUT(Out,int);
  81     BBTK_PROCESS(Process);
  82     BBTK_CREATE_WIDGET(CreateWidget);
  83     void Process();
  84     void CreateWidget(wxWindow*);
  85
  86   protected:
  87
  88   };
  89   //=================================================================
  90
  91   //=================================================================
  92   // the black box description
  93   BBTK_BEGIN_DESCRIBE_BLACK_BOX(Slider,bbtk::WxBlackBox);
  94   BBTK_NAME("Slider");
  95   BBTK_AUTHOR("eduardo.davila@creatis.insa-lyon.fr");
  96   // Already inserted for any WxBlackBox  BBTK_CATEGORY("widget");
  97   BBTK_DESCRIPTION("Slider widget (wxSlider)");
  98   BBTK_INPUT(Slider,In,               "Initial position of the slider (default 0)",                          int,         "");
  99   BBTK_INPUT(Slider,Min,              "Minimum value of the slider (default 0)",                             int,         "");
 100   BBTK_INPUT(Slider,Max,              "Maximum value of the slider (default 500)",                           int,         "");
 101   BBTK_INPUT(Slider,Label,            "Show slider labels ? (default FALSE) ",                               bool,        "");
 102   BBTK_INPUT(Slider,Title,            "Title shown above the slider (default '') ",                          std::string, "");
 103   BBTK_INPUT(Slider,Orientation,      "Orientation : (default H)  0=H=HORIZONTAL, 1=V=VERTICAL ",            std::string, "");
 104   BBTK_INPUT(Slider,ChangeResolution, "Can the user change the resolution of the slider ? (default FALSE) ", bool,        "");
 105   BBTK_INPUT(Slider,ReactiveOnTrack,  "Slider sends info when track moves (default : FALSE)",                bool,        "");
 106
 107   BBTK_OUTPUT(Slider,Out,"Current position of the slider",int,"");
 108   BBTK_END_DESCRIBE_BLACK_BOX(Slider);
 109   //=================================================================
 110
 111 } //namespace bbwx
 112
 113 #endif  //__bbtkwxSlider_h_INCLUDED__
 114
 115 #endif //_USE_WXWIDGETS_