Salome HOME
HYDROGUI_Zone class is introduced.
[modules/hydro.git] / src / HYDROGUI / HYDROGUI_Zone.h
1 // Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License.
10 //
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 // Lesser General Public License for more details.
15 //
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22
23 #ifndef HYDROGUI_ZONE_H
24 #define HYDROGUI_ZONE_H
25
26 #include "HYDROGUI_DataObject.h"
27
28 #include <HYDROData_Zone.h>
29
30 #include <QString>
31 #include <QColor>
32
33 /**
34  * \class HYDROGUI_Zone
35  * \brief Browser item presenting a zone, used for object browser tree creation.
36  *
37  * This is an Object Browser item that contains reference to a zone data structure 
38  * element inside.
39  */
40 class HYDROGUI_Zone : public HYDROGUI_DataObject
41 {
42 public:
43   /**
44    * Constructor.
45    * \param theParent parent data object
46    * \param theData reference to the corresponding object from data structure
47    * \param theParentEntry entry of the parent data object (for reference objects)
48    */
49   HYDROGUI_Zone( SUIT_DataObject* theParent,
50                        Handle(HYDROData_Zone) theData,
51                        const QString& theParentEntry );
52     
53   /**
54    * Returns the text for the specified column.
55    */
56   QString text( const int = NameId ) const override;
57
58   /**
59    * Returns the color for the specified column.
60    */
61   QColor  color( const ColorRole, const int = NameId ) const override;
62
63   /**
64    * Returns true if it is a zone which needs merge of bathymetries.
65    */
66   bool    isMergingNeed() const override;
67
68   QStringList getBathymetries() const;
69
70 private:
71   QString getRefObjectNames() const;
72   QString getBathimetryName() const;
73 };
74 #endif