packages/wx/src/bbwxFileSelector.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: bbwxFileSelector.h,v $
  31   Language:  C++
  32   Date:      $Date: 2012/11/16 08:52:14 $
  33   Version:   $Revision: 1.9 $
  34 =========================================================================*/
  35
  36 /**
  37  * \brief Short description in one line
  38  *
  39  * Long description which
  40  * can span multiple lines
  41  */
  42 /**
  43  * \file
  44  * \brief Pattern for the definition of a new type of Node (header)
  45  */
  46 /**
  47  * \class bbtk::NodePatern
  48  * \brief Pattern for the definition of a new type of Node
  49  */
  50
  51
  52 #ifdef USE_WXWIDGETS
  53
  54
  55 #ifndef __bbWxFileSelector_h__
  56 #define __bbWxFileSelector_h__
  57
  58 #include "bbtkAtomicBlackBox.h"
  59 #include "bbwx_EXPORT.h"
  60
  61
  62 namespace bbwx
  63 {
  64
  65
  66
  67
  68   //=================================================================
  69   class bbwx_EXPORT FileSelector : public bbtk::AtomicBlackBox
  70   {
  71     BBTK_BLACK_BOX_INTERFACE(FileSelector,bbtk::AtomicBlackBox);
  72     BBTK_DECLARE_INPUT(Title,std::string);
  73     BBTK_DECLARE_INPUT(Message,std::string);
  74     BBTK_DECLARE_INPUT(DefaultDir,std::string);
  75     BBTK_DECLARE_INPUT(DefaultFile,std::string);
  76     BBTK_DECLARE_INPUT(Wildcard,std::string);
  77     BBTK_DECLARE_INPUT(OpenSave,std::string);
  78     BBTK_DECLARE_OUTPUT(Out,std::string);
  79     BBTK_PROCESS(Process);
  80     void Process();
  81
  82   protected:
  83
  84   };
  85   //=================================================================
  86
  87
  88   //=================================================================
  89   // AtomicBlackBox description
  90   BBTK_BEGIN_DESCRIBE_BLACK_BOX(FileSelector,bbtk::AtomicBlackBox);
  91   BBTK_NAME("FileSelector");
  92   BBTK_AUTHOR("laurent.guigues@creatis.insa-lyon.fr");
  93   BBTK_CATEGORY("widget, Selector");
  94   BBTK_DESCRIPTION("Pops up a file selection dialog for reading or saving (wxFileDialog)");
  95   BBTK_INPUT(FileSelector,Title,"Title of the dialog",std::string,"");
  96   BBTK_INPUT(FileSelector,Message,"Message to show on the dialog",
  97              std::string,"");
  98   BBTK_INPUT(FileSelector,DefaultDir,"The default directory",std::string,"");
  99   BBTK_INPUT(FileSelector,DefaultFile,"The default filename",std::string,"file name");
 100   BBTK_INPUT(FileSelector,Wildcard,"A wildcard, such as \"*.*\" or \"BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif\"",std::string,"wildcard");
 101   BBTK_INPUT(FileSelector,OpenSave,"Open for an open dialog (default) / Save for a save dialog",std::string,"");
 102   BBTK_OUTPUT(FileSelector,Out,"The file selected by the user",std::string,"file name");
 103   BBTK_END_DESCRIBE_BLACK_BOX(FileSelector);
 104   //=================================================================
 105
 106
 107
 108 }
 109
 110
 111
 112 //namespace bbtk
 113 #endif  //__bbtkWxFileSelector_h__
 114
 115 #endif //USE_WXWIDGETS