Salome HOME
Merge remote-tracking branch 'origin/BR_LAND_COVER' into BR_v14_rc
[modules/hydro.git] / src / HYDROGUI / HYDROGUI_DataOwner.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_DATAOWNER_H
20 #define HYDROGUI_DATAOWNER_H
21
22 #include <SUIT_DataOwner.h>
23
24 #include <AIS_InteractiveObject.hxx>
25
26
27 /*!
28   This class provide data owner objects.
29 */
30 class HYDROGUI_DataOwner : public SUIT_DataOwner
31 {
32 public:
33     /**
34      * Constructor. Initialize by \a AIS_InteractiveObject.
35      */
36     HYDROGUI_DataOwner( const Handle(AIS_InteractiveObject)& theIO );
37
38     /**
39      * Constructor.
40      */
41     HYDROGUI_DataOwner();
42
43     /**
44      * Destructor.
45      */
46     virtual ~HYDROGUI_DataOwner();
47
48     /**
49      * Gets key string, used for data owners comparison.
50      * \return the empty string
51      */
52     virtual QString keyString() const;
53
54     /**
55      * Gets SALOME_InteractiveObject.
56      * \return the SALOME interactive object
57      */
58     const Handle(AIS_InteractiveObject)& IO() const;
59
60 private:
61     Handle(AIS_InteractiveObject) myIO; ///< the AIS interactive object
62 };
63
64 typedef SMART(HYDROGUI_DataOwner) HYDROGUI_DataOwnerPtr;
65
66 #endif