lib/creaDevManagerLib/wxCDMPackageManagerPanel.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  * wxCDMPackageManagerPanel.h
  30  *
  31  *  Created on: Dec 10, 2012
  32  *      Author: Daniel Felipe Gonzalez Obando
  33  */
  34
  35 #ifndef WXCDMPACKAGEMANAGERPANEL_H_
  36 #define WXCDMPACKAGEMANAGERPANEL_H_
  37
  38 #include <creaWx.h>
  39 #include <wx/panel.h>
  40 #include <wx/hyperlink.h>
  41 #include <wx/event.h>
  42
  43 #include "modelCDMProject.h"
  44
  45 /**
  46  * Package manager description panel. Shows the available packages in the project and the actions corresponding to package management.
  47  */
  48 class wxCDMPackageManagerPanel : public wxPanel
  49 {
  50   DECLARE_EVENT_TABLE()
  51 public:
  52
  53   /**
  54    * Package manager description panel Constructor.
  55    * @param parent Parent window reference.
  56    * @param project Project class reference.
  57    * @param id Panel ID. By default -1.
  58    * @param caption Panel label. By default "Description Frame".
  59    * @param pos Panel position. By default wxDefaultPosition.
  60    * @param size Panel size. By default wxDefaultSize.
  61    * @param style Panel style. By default wxDEFAULT_FRAME_STYLE.
  62    */
  63   wxCDMPackageManagerPanel(
  64       wxWindow* parent,
  65       modelCDMProject* project,
  66       wxWindowID id = -1,
  67       const wxString& caption = _("Description Frame"),
  68       const wxPoint& pos = wxDefaultPosition,
  69       const wxSize& size = wxDefaultSize,
  70       long style = wxDEFAULT_FRAME_STYLE
  71   );
  72
  73   /**
  74    * Destructor.
  75    */
  76   ~wxCDMPackageManagerPanel();
  77
  78   /**
  79    * Package manager description panel Creator.
  80    * @param parent Parent window reference.
  81    * @param project Project class reference.
  82    * @param id Panel ID. By default -1.
  83    * @param caption Panel label. By default "Description Frame".
  84    * @param pos Panel position. By default wxDefaultPosition.
  85    * @param size Panel size. By default wxDefaultSize.
  86    * @param style Panel style. By default wxDEFAULT_FRAME_STYLE.
  87    */
  88   bool Create(
  89       wxWindow* parent,
  90       modelCDMProject* project,
  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   /**
 104    * Retrieves the described project class reference.
 105    * @return Project reference.
 106    */
 107   modelCDMProject* GetProject() const;
 108
 109 private:
 110   /**
 111    * Project described.
 112    */
 113   modelCDMProject* project;
 114
 115   //handlers
 116 protected:
 117   /**
 118    * Handles when a return link is pressed.
 119    * @param event Has the link reference to know where to return
 120    */
 121   void OnBtnReturn(wxHyperlinkEvent& event);
 122   /**
 123    * Handles when a package checkbox is (un)checked.
 124    * @param event Has the link reference to know which package was selected.
 125    */
 126   void OnChBPackageChange(wxCommandEvent& event);
 127   /**
 128    * Handles when a packages link is pressed.
 129    * @param event Has the link reference to know which package was selected.
 130    */
 131   void OnLnkPackageSelect(wxHyperlinkEvent& event);
 132   /**
 133    * Handles when the create package button is pressed.
 134    */
 135   void OnBtnCreatePackage(wxCommandEvent& event);
 136   /**
 137    * Handles when the open package cmakelists file button is pressed.
 138    */
 139   void OnBtnEditCMakeLists(wxCommandEvent& event);
 140
 141   /**
 142    * Handles when a package link is hovered.
 143    * @param event Has the link reference to know which package was selected.
 144    */
 145   void OnMouseEnter(wxMouseEvent& event);
 146   /**
 147    * Handles when a package link button finishes hover.
 148    * @param event Has the link reference to know which package was selected.
 149    */
 150   void OnMouseExit(wxMouseEvent& event);
 151   /**
 152    * Handles when the open cmakelists file button is hovered.
 153    */
 154   void OnCMakeMouseEnter(wxMouseEvent& event);
 155   /**
 156    * Handles when the open cmakelists file button finishes hover.
 157    */
 158   void OnCMakeMouseExit(wxMouseEvent& event);
 159 };
 160
 161 #endif /* WXCDMPACKAGEMANAGERPANEL_H_ */