lib/creaDevManagerLib/wxCDMLibraryDescriptionPanel.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  * wxCDMLibraryDescriptionPanel.h
  30  *
  31  *  Created on: Nov 27, 2012
  32  *      Author: Daniel Felipe Gonzalez Obando
  33  */
  34
  35 #ifndef WXCDMLIBRARYDESCRIPTIONPANEL_H_
  36 #define WXCDMLIBRARYDESCRIPTIONPANEL_H_
  37
  38 #include <creaWx.h>
  39 #include <wx/panel.h>
  40 #include <wx/hyperlink.h>
  41
  42 #include "modelCDMLibrary.h"
  43
  44 /**
  45  * Library description panel. Shows the available actions on the described library.
  46  */
  47 class wxCDMLibraryDescriptionPanel : public wxPanel
  48 {
  49   DECLARE_EVENT_TABLE()
  50 public:
  51
  52   /**
  53    * Library description panel Constructor.
  54    * @param parent Parent window reference.
  55    * @param library Project class reference.
  56    * @param id Panel ID. By default -1.
  57    * @param caption Panel label. By default "Description Frame".
  58    * @param pos Panel position. By default wxDefaultPosition.
  59    * @param size Panel size. By default wxDefaultSize.
  60    * @param style Panel style. By default wxDEFAULT_FRAME_STYLE.
  61    */
  62   wxCDMLibraryDescriptionPanel(
  63       wxWindow* parent,
  64       modelCDMLibrary* library,
  65       wxWindowID id = -1,
  66       const wxString& caption = _("Description Frame"),
  67       const wxPoint& pos = wxDefaultPosition,
  68       const wxSize& size = wxDefaultSize,
  69       long style = wxDEFAULT_FRAME_STYLE
  70   );
  71
  72   /**
  73    * Destructor.
  74    */
  75   ~wxCDMLibraryDescriptionPanel();
  76
  77   /**
  78    * Library description panel Creator.
  79    * @param parent Parent window reference.
  80    * @param library Project class reference.
  81    * @param id Panel ID. By default -1.
  82    * @param caption Panel label. By default "Description Frame".
  83    * @param pos Panel position. By default wxDefaultPosition.
  84    * @param size Panel size. By default wxDefaultSize.
  85    * @param style Panel style. By default wxDEFAULT_FRAME_STYLE.
  86    * @return True if creation was successful.
  87    */
  88   bool Create(
  89       wxWindow* parent,
  90       modelCDMLibrary* library,
  91       wxWindowID id = -1,
  92       const wxString& caption = _("Description Frame"),
  93       const wxPoint& pos = wxDefaultPosition,
  94       const wxSize& size = wxDefaultSize,
  95       long style = wxDEFAULT_FRAME_STYLE
  96   );
  97
  98   /**
  99    * Creates all the controls in the panel (property and action controls).
 100    */
 101   void CreateControls();
 102
 103 private:
 104   /**
 105    * Library described.
 106    */
 107   modelCDMLibrary* library;
 108   /**
 109    * Control with the described library name.
 110    */
 111   wxStaticText* libraryNametc;
 112
 113   //handlers
 114 protected:
 115   /**
 116    * Handles when a return link is pressed.
 117    * @param event Has the link reference to know where to return
 118    */
 119   void OnBtnReturn(wxHyperlinkEvent& event);
 120   /**
 121    * Handles when the set executable name button is pressed.
 122    * @param event Unused.
 123    */
 124   void OnBtnSetExeName(wxCommandEvent& event);
 125   /**
 126    * Handles when a 3rd Party Library checkbox state is changed. It calls to include/exclude the selected library.
 127    * @param event CheckBox event.
 128    */
 129   void On3rdLibraryChBChange(wxCommandEvent& event);
 130   /**
 131    * Handles when a Custom Library checkbox state is changed. It calls to include/exclude the selected library.
 132    * @param event CheckBox event.
 133    */
 134   void OnLibraryChBChange(wxCommandEvent& event);
 135   /**
 136    * Handles when the create class button is pressed.
 137    * @param event Unused.
 138    */
 139   void OnBtnCreateClass(wxCommandEvent& event);
 140   /**
 141    * Handles when the create folder buttonis pressed.
 142    * @param event Unused.
 143    */
 144   void OnBtnCreateFolder(wxCommandEvent& event);
 145   /**
 146    * Handles when Edit Cmakelists button is pressed.
 147    * @param event Unused.
 148    */
 149   void OnBtnEditCMakeLists(wxCommandEvent& event);
 150   /**
 151    * Handles when the open containing folder button is pressed.
 152    * @param event Unused.
 153    */
 154   void OnBtnOpenFolder(wxCommandEvent& event);
 155   /**
 156    * Handles when the edit cmakelists button is hovered.
 157    * @param event Unused.
 158    */
 159   void OnCMakeMouseEnter(wxMouseEvent& event);
 160   /**
 161    * Handles when the edit cmakelists button exits hover.
 162    * @param event Unused.
 163    */
 164   void OnCMakeMouseExit(wxMouseEvent& event);
 165
 166 };
 167
 168 #endif /* WXCDMLIBRARYDESCRIPTIONPANEL_H_ */