1 // Copyright (C) 2007-2013 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 #ifndef HYDROGUI_DATAOBJECT_H
24 #define HYDROGUI_DATAOBJECT_H
26 #include <HYDROData_Entity.h>
28 #include <LightApp_DataObject.h>
36 * \class HYDROGUI_DataObject
37 * \brief Module data object, used for object browser tree creation.
39 * This is an Object Browser object that contains reference to data structure
41 * This class inherits CAM_DataObject virtually, so it is necessary to call in the class
42 * constructor the CAM object constructor manually for the correct initialization
44 class HYDROGUI_DataObject : public LightApp_DataObject
49 RefObjectId = RefEntryId + 1, //!< Ref.Object column
50 AltitudeObjId //!< Altitude column
55 IsInOperationRole = Qtx::AppropriateRole + 100 //!< Filter value role
60 * \param theParent parent data object
61 * \param theData reference to the corresponding object from data structure
62 * \param theParentEntry entry of the parent data object (for reference objects)
63 * \param theIsInOperation if true then the tree is used for a browser within an operation, it is false by default
65 HYDROGUI_DataObject( SUIT_DataObject* theParent,
66 Handle(HYDROData_Entity) theData,
67 const QString& theParentEntry,
68 const bool theIsInOperation = false );
71 * Returns the unique object identifier string.
73 virtual QString entry() const;
76 * Returns the entry of the referenced object.
78 virtual QString refEntry() const;
81 * Returns the name of object.
83 virtual QString name() const;
86 * Returns the font of displayed object name.
88 virtual QFont font( const int = SUIT_DataObject::NameId ) const;
91 * Returns the object color.
93 virtual QColor color( const ColorRole, const int = NameId ) const;
96 * Returns the object icon.
98 virtual QPixmap icon( const int = NameId ) const;
101 * Returns true if renaming is allowed for the object.
103 virtual bool renameAllowed( const int = NameId ) const;
106 * Returns the model data object.
108 const Handle(HYDROData_Entity)& modelObject() const { return myData; }
111 * Redefines the object.
113 void setObject( const Handle(HYDROData_Entity)& theObject ) { myData = theObject; }
116 * Returns the entry prefix for all HYDRO data objects.
118 static QString entryPrefix() { return QString( "HYDRO:" ); }
121 * Returns the full entry for the specified data object.
123 static QString dataObjectEntry( const Handle(HYDROData_Entity)& theObject,
124 const bool theWithPrefix = true );
126 * Sets the validity flag: if object is valid or not.
127 * \param theIsValid is true for valid objects, false for invalid
129 void setIsValid( const bool theIsValid );
132 * Returns the validity flag: is object valid or not
133 * \return false if object is not valid
135 bool isValid() const;
138 * Returns the usage within active operation flag:
139 * is the object is used in the local tree of an active operation dialog or not.
140 * \return false if the object is used in the main object browser tree
142 bool isInOperation() const { return myIsInOperation; }
144 void updateBy( SUIT_DataObject* );
147 Handle(HYDROData_Entity) myData; ///< object from data model
148 QString myParentEntry;
149 bool myIsValid; ///< indicates if the object is valid
150 bool myIsInOperation; ///< indicates if the object is used within an active operation
155 * \class HYDROGUI_NamedObject
156 * \brief Module data object, used for object browser tree creation.
158 * It contains only name inside, without additional data: it is just information
159 * or grouping object in the Object Browser.
160 * This class inherits CAM_DataObject virtually, so it is necessary to call in the class
161 * constructor the CAM object constructor manually for the correct initialization
163 class HYDROGUI_NamedObject : public virtual LightApp_DataObject
168 * \param theParent parent data object
169 * \param theName displayed name
170 * \param theIsInOperation if true then the tree is used for a browser within an operation, it is false by default
172 HYDROGUI_NamedObject( SUIT_DataObject* theParent,
173 const QString& theName,
174 const QString& theParentEntry,
175 const bool theIsInOperation = false );
178 * Returns the unique object identifier string.
180 virtual QString entry() const;
183 * Returns the name of object.
185 virtual QString name() const;
188 * Returns the font of displayed object name.
190 virtual QFont font( const int = SUIT_DataObject::NameId ) const;
193 * Returns the object icon.
195 virtual QPixmap icon( const int = NameId ) const;
198 * Returns the usage within active operation flag:
199 * is the object is used in the local tree of an active operation dialog or not.
200 * \return false if the object is used in the main object browser tree
202 bool isInOperation() const { return myIsInOperation; }
204 void updateBy( SUIT_DataObject* );
207 QString myName; ///< name in the OB
208 QString myParentEntry;
210 bool myIsInOperation; ///< indicates if the object is used within an active operation
214 * \brief Module data object, used for dropping items in the object browser.
216 * It inherits NamedObject with only difference - it accepts dropping.
218 class HYDROGUI_DropTargetObject : public HYDROGUI_NamedObject
223 * \param theParent parent data object
224 * \param theName displayed name
225 * \param theIsInOperation if true then the tree is used for a browser within an operation, it is false by default
227 HYDROGUI_DropTargetObject( SUIT_DataObject* theParent,
228 const QString& theName,
229 const QString& theParentEntry,
230 const bool theIsInOperation = false );
232 bool isDropAccepted() const { return true; }