Salome HOME
Merge branch 'master' of https://git.salome-platform.org/git/modules/hydro
[modules/hydro.git] / src / HYDROGUI / HYDROGUI_Region.h
1 // Copyright (C) 2014-2015  EDF-R&D
2 // This library is free software; you can redistribute it and/or
3 // modify it under the terms of the GNU Lesser General Public
4 // License as published by the Free Software Foundation; either
5 // version 2.1 of the License, or (at your option) any later version.
6 //
7 // This library is distributed in the hope that it will be useful,
8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
10 // Lesser General Public License for more details.
11 //
12 // You should have received a copy of the GNU Lesser General Public
13 // License along with this library; if not, write to the Free Software
14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
15 //
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
17 //
18
19 #ifndef HYDROGUI_REGION_H
20 #define HYDROGUI_REGION_H
21
22 #include "HYDROGUI_DataObject.h"
23
24 #include <HYDROData_Region.h>
25
26 #include <QString>
27 #include <QColor>
28
29 class HYDROGUI_Zone;
30
31 /**
32  * \class HYDROGUI_Region
33  * \brief Browser item presenting a zone, used for object browser tree creation.
34  *
35  * This is an Object Browser item that contains reference to a zone data structure 
36  * element inside.
37  */
38 class HYDROGUI_Region : public HYDROGUI_DataObject
39 {
40 public:
41   /**
42    * Constructor.
43    * \param theParent parent data object
44    * \param theData reference to the corresponding object from data structure
45    * \param theParentEntry entry of the parent data object (for reference objects)
46    * \param theIsInOperation if true then the tree is used for a browser within an operation, it is false by default
47    */
48   HYDROGUI_Region( SUIT_DataObject*         theParent,
49                    Handle(HYDROData_Region) theData,
50                    const QString&           theParentEntry,
51                    const bool               theIsInOperation = false );
52
53   bool isDropAccepted() const { return true; }
54
55   /**
56    * Add zones to the region. 
57    */
58   bool addZones( const QList<HYDROGUI_Zone*>& theZonesList );
59 };
60 #endif