packages/wx/src/bbwxColourSelectorButton.h

   1 /*=========================================================================
   2   Program:   bbtk
   3   Module:    $RCSfile: bbwxColourSelectorButton.h,v $
   4   Language:  C++
   5   Date:      $Date: 2009/05/15 14:58:03 $
   6   Version:   $Revision: 1.11 $
   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 /**
  33  * \file
  34  * \brief Short description in one line
  35  *
  36  * Long description which
  37  * can span multiple lines
  38 */
  39
  40 /**
  41  * \class bbwx::ColourSelectorButton
  42  * \brief
  43
  44
  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 __bbwxColourSelectorButton_h_INCLUDED_H__
  53 #define __bbwxColourSelectorButton_h_INCLUDED_H__
  54
  55 // Include wxBlackBox definition
  56 #include "bbtkWxBlackBox.h"
  57 #include "bbwx_EXPORT.h"
  58
  59 // Namespace of the package "wx" is "bbwx"
  60 // Namespace associated to packages should be of the form :
  61 // bbPACKAGENAME
  62 namespace bbwx
  63 {
  64
  65
  66   //------------------------------------------------------------------------
  67   // The black box
  68   class bbwx_EXPORT ColourSelectorButton : public bbtk::WxBlackBox
  69   {
  70     BBTK_BLACK_BOX_INTERFACE(ColourSelectorButton,bbtk::WxBlackBox);
  71     BBTK_DECLARE_INPUT(In,std::string);
  72     BBTK_DECLARE_OUTPUT(Out,std::string);
  73     BBTK_PROCESS(Process);
  74     BBTK_CREATE_WIDGET(CreateWidget);
  75     void Process();
  76     void CreateWidget(wxWindow*);
  77   protected:
  78
  79   };
  80   //=================================================================
  81
  82   //=================================================================
  83   // BlackBox description
  84   BBTK_BEGIN_DESCRIBE_BLACK_BOX(ColourSelectorButton,bbtk::WxBlackBox);
  85   // Already inserted for any WxBlackBox  BBTK_CATEGORY("widget");
  86   BBTK_NAME("ColourSelectorButton");
  87   BBTK_AUTHOR("laurent.guigues@creatis.insa-lyon.fr");
  88   BBTK_DESCRIPTION("A button which displays a colour picker dialog when clicked");
  89   BBTK_INPUT(ColourSelectorButton,In,"Initial colour",std::string,"colour");
  90   BBTK_OUTPUT(ColourSelectorButton,Out,"Colour choosen in format '[0,1] [0,1] [0,1]'",std::string,"colour");
  91   BBTK_END_DESCRIBE_BLACK_BOX(ColourSelectorButton);
  92   //=================================================================
  93
  94 }//namespace bbtk
  95 #endif  // __bbtkWxColourSelector_h__
  96
  97 #endif //USE_WXWIDGETS