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/hyperlink.h>
  40 #include <wx/event.h>
  41
  42 #include "modelCDMProject.h"
  43
  44 /**
  45  * Package manager description panel. Shows the available packages in the project and the actions corresponding to package management.
  46  */
  47 class wxCDMPackageManagerPanel : public wxScrolledWindow
  48 {
  49   DECLARE_EVENT_TABLE()
  50 public:
  51
  52   /**
  53    * Package manager description panel Constructor.
  54    * @param parent Parent window reference.
  55    * @param project 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   wxCDMPackageManagerPanel(
  63       wxWindow* parent,
  64       modelCDMProject* project,
  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   ~wxCDMPackageManagerPanel();
  76
  77   /**
  78    * Package manager description panel Creator.
  79    * @param parent Parent window reference.
  80    * @param project 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    */
  87   bool Create(
  88       wxWindow* parent,
  89       modelCDMProject* project,
  90       wxWindowID id = -1,
  91       const wxString& caption = _("Description Frame"),
  92       const wxPoint& pos = wxDefaultPosition,
  93       const wxSize& size = wxDefaultSize,
  94       long style = wxDEFAULT_FRAME_STYLE
  95   );
  96
  97   /**
  98    * Creates all the controls in the panel (property and action controls).
  99    */
 100   void CreateControls();
 101
 102   /**
 103    * Retrieves the described project class reference.
 104    * @return Project reference.
 105    */
 106   modelCDMProject* GetProject() const;
 107
 108 private:
 109   /**
 110    * Project described.
 111    */
 112   modelCDMProject* project;
 113
 114   //handlers
 115 protected:
 116   /**
 117    * Handles when a return link is pressed.
 118    * @param event Has the link reference to know where to return
 119    */
 120   void OnBtnReturn(wxHyperlinkEvent& event);
 121   /**
 122    * Handles when a package checkbox is (un)checked.
 123    * @param event Has the link reference to know which package was selected.
 124    */
 125   void OnChBPackageChange(wxCommandEvent& event);
 126   /**
 127    * Handles when a packages link is pressed.
 128    * @param event Has the link reference to know which package was selected.
 129    */
 130   void OnLnkPackageSelect(wxHyperlinkEvent& event);
 131   /**
 132    * Handles when the create package button is pressed.
 133    */
 134   void OnBtnCreatePackage(wxCommandEvent& event);
 135   /**
 136    * Handles when the open package cmakelists file button is pressed.
 137    */
 138   void OnBtnEditCMakeLists(wxCommandEvent& event);
 139
 140   /**
 141    * Handles when a package link is hovered.
 142    * @param event Has the link reference to know which package was selected.
 143    */
 144   void OnMouseEnter(wxMouseEvent& event);
 145   /**
 146    * Handles when a package link button finishes hover.
 147    * @param event Has the link reference to know which package was selected.
 148    */
 149   void OnMouseExit(wxMouseEvent& event);
 150   /**
 151    * Handles when the open cmakelists file button is hovered.
 152    */
 153   void OnCMakeMouseEnter(wxMouseEvent& event);
 154   /**
 155    * Handles when the open cmakelists file button finishes hover.
 156    */
 157   void OnCMakeMouseExit(wxMouseEvent& event);
 158 };
 159
 160 #endif /* WXCDMPACKAGEMANAGERPANEL_H_ */