2 # ---------------------------------------------------------------------
4 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
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
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.
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
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 # ------------------------------------------------------------------------
32 * Created on: 29/1/2013
33 * Author: Daniel Felipe Gonzalez Obando
36 #ifndef _WXCDMTREEITEMID_H_
37 #define _WXCSMTREEITEMID_H_
41 #include <wx/treectrl.h>
42 #include <wx/treebase.h>
46 * Class Name: wxCDMTreeItemId
47 * Class Id manager for the project tree control.
52 //---------------------------------------------
53 //Methods and attributes exposed to other classes
54 //---------------------------------------------
62 * @param id Original TreeItem Id.
64 wxCDMTreeItemId(const wxTreeItemId& id);
71 * Retrieves the id from the wxTreeItemId object
74 const wxTreeItemId& GetWxId() const;
76 * Retrieves the private id of the tree item.
79 const wxTreeItemIdValue& GetId() const;
83 * @param id comparing tree item id
84 * @return true if the id value is the same.
86 bool operator == (const wxCDMTreeItemId& id) const;
89 * @param id comparing tree item id
90 * @return true if the id value is not the same.
92 bool operator != (const wxCDMTreeItemId& id) const;
95 * @param id comparing tree item id
96 * @return true if the id value is less than the one in the given id.
98 bool operator < (const wxCDMTreeItemId& id) const;
100 * operator << allows to manage output stream printing of the object.
101 * @param stream Target stream.
102 * @param id Tree item id to print.
103 * @return Stream modified.
105 friend std::ostream& operator << (std::ostream& stream, const wxCDMTreeItemId& id);
107 //---------------------------------------------
108 //Methods and attributes exposed only to classes
109 //that are derived from this class
110 //---------------------------------------------
119 wxTreeItemIdValue _id;
120 //---------------------------------------------
121 //Methods and attributes only visible by this class
122 //---------------------------------------------
127 //-end of _WXCDMTREEITEMID_H_------------------------------------------------------