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