lib/creaDevManagerLib/wxCDMProjectsTreeCtrl.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 /*
  30  * wxCreaDevManagerTreeCtrl.h
  31  *
  32  *  Created on: 19/10/2012
  33  *      Author: Daniel Felipe Gonzalez Obando
  34  */
  35
  36 #ifndef WXCDMPROJECTSTREECTRL_H_
  37 #define WXCDMPROJECTSTREECTRL_H_
  38
  39 #include <creaWx.h>
  40 #include <wx/treectrl.h>
  41 #include "modelCDMProject.h"
  42 #include "modelCDMIProjectTreeNode.h"
  43
  44 #include <vector>
  45 #include <map>
  46
  47 /**
  48  * Project Tree Control. Shows a project's content in a hierarchy tree control.
  49  */
  50 class wxCDMProjectsTreeCtrl: public wxTreeCtrl
  51 {
  52 public:
  53   /**
  54    * Project Tree Control Constructor.
  55    * @param parent Parent window reference.
  56    * @param id Control ID, by default wxID_ANY.
  57    * @param pos Control position. By default wxDefaultPosition.
  58    * @param size Control size. By default wxDefaultSize.
  59    * @param style Control style. By default wxTR_DEFAULT_STYLE.
  60    * @param validator Validator. By default wxDefaultValidator.
  61    * @param name Control Name. By default "Projects tree".
  62    */
  63   wxCDMProjectsTreeCtrl(
  64       wxWindow *parent,
  65       wxWindowID id=wxID_ANY,
  66       const wxPoint &pos=wxDefaultPosition,
  67       const wxSize &size=wxDefaultSize,
  68       long style=wxTR_DEFAULT_STYLE,
  69       const wxValidator &validator=wxDefaultValidator,
  70       const wxString &name=_("Projects tree")
  71   );
  72   /**
  73    * Destructor.
  74    */
  75   ~wxCDMProjectsTreeCtrl();
  76   /**
  77    * Project Tree Control Creator.
  78    * @param parent Parent window reference.
  79    * @param id Control ID, by default wxID_ANY.
  80    * @param pos Control position. By default wxDefaultPosition.
  81    * @param size Control size. By default wxDefaultSize.
  82    * @param style Control style. By default wxTR_DEFAULT_STYLE.
  83    * @param validator Validator. By default wxDefaultValidator.
  84    * @param name Control Name. By default "Projects tree".
  85    * @return True if the creation was successful.
  86    */
  87   bool Create(
  88       wxWindow *parent,
  89       wxWindowID id=wxID_ANY,
  90       const wxPoint &pos=wxDefaultPosition,
  91       const wxSize &size=wxDefaultSize,
  92       long style=wxTR_DEFAULT_STYLE,
  93       const wxValidator &validator=wxDefaultValidator,
  94       const wxString &name=_("Projects tree")
  95   );
  96
  97   /**
  98    * Builds the tree hierarchy with the given model elements.
  99    */
 100   void BuildTree(std::map< wxTreeItemId, modelCDMIProjectTreeNode* >& modelElements, modelCDMProject* tree = NULL);
 101
 102 private:
 103
 104   /**
 105    * A Icon ID.
 106    */
 107   int ID_AIcon;
 108   /**
 109    * Ap Icon ID.
 110    */
 111   int ID_ApIcon;
 112   /**
 113    * BB Icon ID.
 114    */
 115   int ID_BBIcon;
 116   /**
 117    * C Icon ID.
 118    */
 119   int ID_Cicon;
 120   /**
 121    * CM Icon ID.
 122    */
 123   int ID_CMIcon;
 124   /**
 125    * Fd Icon ID.
 126    */
 127   int ID_FdIcon;
 128   /**
 129    * Fl Icon ID.
 130    */
 131   int ID_FlIcon;
 132   /**
 133    * Lb Icon ID.
 134    */
 135   int ID_LbIcon;
 136   /**
 137    * L Icon ID.
 138    */
 139   int ID_LIcon;
 140   /**
 141    * Pr Icon ID.
 142    */
 143   int ID_PrIcon;
 144   /**
 145    * Pk Icon ID.
 146    */
 147   int ID_PkIcon;
 148
 149   /**
 150    * Builds the tree with the hierarchy given and fills the modelElements map.
 151    * @param tree Root node of the tree.
 152    * @param modelElements Id->node map.
 153    * @param parent ID of the root node ID.
 154    */
 155   void BuildTree(const std::vector<modelCDMIProjectTreeNode*>& tree, std::map< wxTreeItemId, modelCDMIProjectTreeNode* >& modelElements, const wxTreeItemId& parent);
 156   /**
 157    * Retrieves the icon ID of the given node by its type.
 158    * @param node Node to search its icon.
 159    * @return Icon ID
 160    */
 161   int GetIconId(modelCDMIProjectTreeNode* node);
 162 };
 163
 164 #endif /* WXCDMPROJECTSTREECTRL_H_ */