lib/creaDevManagerLib/wxCDMApplicationHelpDialog.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  * wxCDMApplicationHelpDialog.h
  31  *
  32  *  Created on: 11/1/2013
  33  *      Author: Daniel Felipe Gonzalez Obando
  34  */
  35
  36 #ifndef WXCDMAPPLICATIONHELPDIALOG_H_
  37 #define WXCDMAPPLICATIONHELPDIALOG_H_
  38
  39 #include <creaWx.h>
  40 #include <wx/dialog.h>
  41
  42 #include "modelCDMApplication.h"
  43
  44 #include <vector>
  45
  46 /**
  47  * Application Panel Help Dialog
  48  */
  49 class wxCDMApplicationHelpDialog : public wxDialog
  50 {
  51   DECLARE_EVENT_TABLE()
  52 public:
  53   /**
  54    * Application Panel Help Dialog Constructor.
  55    * @param parent Parent window.
  56    * @param application Application class reference.
  57    * @param id Dialog ID. By default wxID_ANY.
  58    * @param caption Dialog label. By default "Working with Applications".
  59    * @param position Dialog position. By default wxDefaultPosition.
  60    * @param size Dialog size. By default 410, 670.
  61    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
  62    */
  63   wxCDMApplicationHelpDialog(
  64       wxWindow* parent,
  65       modelCDMApplication* application,
  66       wxWindowID id = wxID_ANY,
  67       const wxString& caption = wxT("Working With Applications"),
  68       const wxPoint& position = wxDefaultPosition,
  69       const wxSize& size = wxSize(410,670),
  70       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
  71   );
  72   /**
  73    * Destructor.
  74    */
  75   ~wxCDMApplicationHelpDialog();
  76   /**
  77    * Application Panel Help Dialog Creator.
  78    * @param parent Parent window.
  79    * @param id Dialog ID. By default wxID_ANY.
  80    * @param caption Dialog label. By default "Working with Applications".
  81    * @param position Dialog position. By default wxDefaultPosition.
  82    * @param size Dialog size. By default 410, 670.
  83    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
  84    * @return if the creation was successful.
  85    */
  86   bool Create(
  87       wxWindow* parent,
  88       wxWindowID id = wxID_ANY,
  89       const wxString& caption = wxT("Working With Applications"),
  90       const wxPoint& position = wxDefaultPosition,
  91       const wxSize& size = wxSize(410,670),
  92       long style = wxDEFAULT_DIALOG_STYLE
  93   );
  94
  95 protected:
  96   /**
  97    * Creates the help controls (text and buttons).
  98    */
  99   void CreateControls();
 100
 101 private:
 102   /**
 103    * Application class reference.
 104    */
 105   modelCDMApplication* application;
 106
 107   //handlers
 108 protected:
 109   /**
 110    * Handler to close help dialog.
 111    * @param event Unused.
 112    */
 113   void OnFinish(wxCommandEvent& event);
 114
 115   /**
 116    * Handler when a cmakelists button is pressed.
 117    * @param event cmakelists event.
 118    */
 119   void OnCMakeLists(wxCommandEvent& event);
 120
 121   /**
 122    * Handler when a cmakelists button is hovered.
 123    * @param event cmakelists event.
 124    */
 125   void OnCMakeListsEnter(wxMouseEvent& event);
 126   /**
 127    * Handler when a cmakelists button hover finishes.
 128    * @param event cmakelists event.
 129    */
 130   void OnCMakeListsExit(wxMouseEvent& event);
 131
 132   /**
 133    * Handler when the disable help checkbox is changed.
 134    * @param event check box event.
 135    */
 136   void OnDisableHelp(wxCommandEvent& event);
 137 };
 138
 139 #endif /* WXCDMAPPLICATIONHELPDIALOG_H_ */