lib/creaDevManagerLib/wxCDMProjectHelpDialog.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 /*
  30  * wxCDMProjectHelpDialog.h
  31  *
  32  *  Created on: 3/1/2013
  33  *      Author: Daniel Felipe Gonzalez Obando
  34  */
  35
  36 #ifndef WXCDMPROJECTHELPDIALOG_H_
  37 #define WXCDMPROJECTHELPDIALOG_H_
  38
  39 #include <creaWx.h>
  40 #include <wx/dialog.h>
  41
  42 #include "wxCDMProjectDescriptionPanel.h"
  43
  44 /**
  45  * Project Panel Help Dialog
  46  */
  47 class wxCDMProjectHelpDialog : public wxDialog
  48 {
  49   DECLARE_EVENT_TABLE()
  50 public:
  51   /**
  52    * Project Panel Help Dialog Constructor.
  53    * @param parent Parent window.
  54    * @param project Project class reference.
  55    * @param id Dialog ID. By default wxID_ANY.
  56    * @param caption Dialog label. By default "Project Ready".
  57    * @param position Dialog position. By default wxDefaultPosition.
  58    * @param size Dialog size. By default 350, 700.
  59    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
  60    */
  61   wxCDMProjectHelpDialog(
  62       wxWindow* parent,
  63       modelCDMProject* project,
  64       wxWindowID id = wxID_ANY,
  65       const wxString& caption = wxT("Project Ready"),
  66       const wxPoint& position = wxDefaultPosition,
  67       const wxSize& size = wxSize(350,730),
  68       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
  69   );
  70   /**
  71    * Destructor.
  72    */
  73   ~wxCDMProjectHelpDialog();
  74   /**
  75    * Project Panel Help Dialog Creator.
  76    * @param parent Parent window.
  77    * @param id Dialog ID. By default wxID_ANY.
  78    * @param caption Dialog label. By default "Project Ready".
  79    * @param position Dialog position. By default wxDefaultPosition.
  80    * @param size Dialog size. By default 350, 700.
  81    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
  82    * @return if the creation was successful.
  83    */
  84   bool Create(
  85       wxWindow* parent,
  86       wxWindowID id = wxID_ANY,
  87       const wxString& caption = wxT("Project Ready"),
  88       const wxPoint& position = wxDefaultPosition,
  89       const wxSize& size = wxSize(350,730),
  90       long style = wxDEFAULT_DIALOG_STYLE
  91   );
  92
  93 protected:
  94   /**
  95    * Creates the help controls (text and buttons).
  96    */
  97   void CreateControls();
  98
  99 //attributes
 100 private:
 101   /**
 102    * Project class reference.
 103    */
 104   modelCDMProject* project;
 105
 106 //handlers
 107 protected:
 108   /**
 109    * Handler to close help dialog.
 110    * @param event Unused.
 111    */
 112   void OnFinish(wxCommandEvent& event);
 113
 114   /**
 115    * Handler when the disable help checkbox is changed.
 116    * @param event Check box event.
 117    */
 118   void OnDisableHelp(wxCommandEvent& event);
 119 };
 120
 121 #endif /* WXCDMPROJECTHELPDIALOG_H_ */