lib/creaDevManagerLib/wxCDMBlackBoxDescriptionPanel.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  * wxCDMBlackBoxDescriptionPanel.h
  30  *
  31  *  Created on: Nov 27, 2012
  32  *      Author: Daniel Felipe Gonzalez Obando
  33  */
  34
  35 #ifndef WXCDMBLACKBOXDESCRIPTIONPANEL_H_
  36 #define WXCDMBLACKBOXDESCRIPTIONPANEL_H_
  37
  38 #include <creaWx.h>
  39 #include <wx/hyperlink.h>
  40
  41 #include "modelCDMBlackBox.h"
  42
  43 /**
  44  * Black box description panel. Shows the properties and available actions for the described black box.
  45  */
  46 class wxCDMBlackBoxDescriptionPanel : public wxScrolledWindow
  47 {
  48   DECLARE_EVENT_TABLE()
  49 public:
  50   /**
  51    * Black box description panel Constructor.
  52    * @param parent Parent window reference.
  53    * @param blackBox Black box class reference.
  54    * @param id Panel ID. By default -1.
  55    * @param caption Panel label. By default "Description Frame".
  56    * @param pos Panel position. By default wxDefaultPosition.
  57    * @param size Panel size. By default wxDefaultSize.
  58    * @param style Panel style. By default wxDEFAULT_FRAME_STYLE.
  59    */
  60   wxCDMBlackBoxDescriptionPanel(
  61       wxWindow* parent,
  62       modelCDMBlackBox* blackBox,
  63       wxWindowID id = -1,
  64       const wxString& caption = _("Description Frame"),
  65       const wxPoint& pos = wxDefaultPosition,
  66       const wxSize& size = wxDefaultSize,
  67       long style = wxDEFAULT_FRAME_STYLE
  68   );
  69
  70   /**
  71    * Destructor.
  72    */
  73   ~wxCDMBlackBoxDescriptionPanel();
  74
  75   /**
  76    * Black box description panel Creator.
  77    * @param parent Parent window reference.
  78    * @param blackBox Black box class reference.
  79    * @param id Panel ID. By default -1.
  80    * @param caption Panel label. By default "Description Frame".
  81    * @param pos Panel position. By default wxDefaultPosition.
  82    * @param size Panel size. By default wxDefaultSize.
  83    * @param style Panel style. By default wxDEFAULT_FRAME_STYLE.
  84    * @return True if the creatios was successful.
  85    */
  86   bool Create(
  87       wxWindow* parent,
  88       modelCDMBlackBox* blackBox,
  89       wxWindowID id = -1,
  90       const wxString& caption = _("Description Frame"),
  91       const wxPoint& pos = wxDefaultPosition,
  92       const wxSize& size = wxDefaultSize,
  93       long style = wxDEFAULT_FRAME_STYLE
  94   );
  95
  96   /**
  97    * Creates all the controls in the panel (property and action controls).
  98    */
  99   void CreateControls();
 100
 101 private:
 102   /**
 103    * Black box described.
 104    */
 105   modelCDMBlackBox* blackBox;
 106   /**
 107    * Black box author control.
 108    */
 109   wxStaticText* authortc;
 110   /**
 111    * Black box description control
 112    */
 113   wxStaticText* descriptiontc;
 114   /**
 115    * Black box categories control.
 116    */
 117   wxStaticText* categoriestc;
 118
 119   //handlers
 120 protected:
 121   /**
 122    * Handles when a return link is pressed.
 123    * @param event Has the link reference to know where to return
 124    */
 125   void OnBtnReturn(wxHyperlinkEvent& event);
 126   /**
 127    * Handles when the set author button is pressed.
 128    */
 129   void OnBtnSetAuthor(wxCommandEvent& event);
 130   /**
 131    * Handles when the set description button is pressed.
 132    */
 133   void OnBtnSetDescription(wxCommandEvent& event);
 134   /**
 135    * Handles when the set categories button is pressed.
 136    */
 137   void OnBtnSetCategories(wxCommandEvent& event);
 138   /**
 139    * Handles when the open Cxx button is pressed.
 140    */
 141   void OnBtnOpenCxx(wxCommandEvent& event);
 142   /**
 143    * Handles when the open Hxx button is pressed.
 144    */
 145   void OnBtnOpenHxx(wxCommandEvent& event);
 146   /**
 147    * Handles when the open Folder button is pressed.
 148    */
 149   void OnBtnOpenFolder(wxCommandEvent& event);
 150
 151   /**
 152    * Handles when the open Cxx button is hovered.
 153    */
 154   void OnCxxMouseEnter(wxMouseEvent& event);
 155   /**
 156    * Handles when the open Cxx button finishes hover.
 157    */
 158   void OnCxxMouseExit(wxMouseEvent& event);
 159   /**
 160    * Handles when the open Hxx button is hovered.
 161    */
 162   void OnHxxMouseEnter(wxMouseEvent& event);
 163   /**
 164    * Handles when the open Hxx button finishes hover.
 165    */
 166   void OnHxxMouseExit(wxMouseEvent& event);
 167
 168
 169 };
 170
 171 #endif /* WXCDMBLACKBOXDESCRIPTIONPANEL_H_ */