packages/wx/src/bbwxColourSelectorButton.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: bbwxColourSelectorButton.h,v $
  31   Language:  C++
  32   Date:      $Date: 2012/11/16 08:52:14 $
  33   Version:   $Revision: 1.12 $
  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 bbwx::ColourSelectorButton
  47  * \brief
  48
  49
  50  */
  51
  52 #ifdef _USE_WXWIDGETS_
  53
  54 // Prevents multiple inclusions : use symbols of the form
  55 // __FILENAME_INCLUDED__
  56 // where FILENAME must be replaced by the actual file name
  57 #ifndef __bbwxColourSelectorButton_h_INCLUDED_H__
  58 #define __bbwxColourSelectorButton_h_INCLUDED_H__
  59
  60 // Include wxBlackBox definition
  61 #include "bbtkWxBlackBox.h"
  62 #include "bbwx_EXPORT.h"
  63
  64 // Namespace of the package "wx" is "bbwx"
  65 // Namespace associated to packages should be of the form :
  66 // bbPACKAGENAME
  67 namespace bbwx
  68 {
  69
  70
  71   //------------------------------------------------------------------------
  72   // The black box
  73   class bbwx_EXPORT ColourSelectorButton : public bbtk::WxBlackBox
  74   {
  75     BBTK_BLACK_BOX_INTERFACE(ColourSelectorButton,bbtk::WxBlackBox);
  76     BBTK_DECLARE_INPUT(In,std::string);
  77     BBTK_DECLARE_OUTPUT(Out,std::string);
  78     BBTK_PROCESS(Process);
  79     BBTK_CREATE_WIDGET(CreateWidget);
  80     void Process();
  81     void CreateWidget(wxWindow*);
  82   protected:
  83
  84   };
  85   //=================================================================
  86
  87   //=================================================================
  88   // BlackBox description
  89   BBTK_BEGIN_DESCRIBE_BLACK_BOX(ColourSelectorButton,bbtk::WxBlackBox);
  90   // Already inserted for any WxBlackBox  BBTK_CATEGORY("widget");
  91   BBTK_NAME("ColourSelectorButton");
  92   BBTK_AUTHOR("laurent.guigues@creatis.insa-lyon.fr");
  93   BBTK_DESCRIPTION("A button which displays a colour picker dialog when clicked");
  94   BBTK_INPUT(ColourSelectorButton,In,"Initial colour",std::string,"colour");
  95   BBTK_OUTPUT(ColourSelectorButton,Out,"Colour choosen in format '[0,1] [0,1] [0,1]'",std::string,"colour");
  96   BBTK_END_DESCRIBE_BLACK_BOX(ColourSelectorButton);
  97   //=================================================================
  98
  99 }//namespace bbtk
 100 #endif  // __bbtkWxColourSelector_h__
 101
 102 #endif //USE_WXWIDGETS