-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File: ModuleBase_Tools.h
-// Created: 11 July 2014
-// Author: Vitaly Smetannikov
+// Copyright (C) 2014-2017 CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or
+// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+//
#ifndef ModuleBase_Tools_H
#define ModuleBase_Tools_H
#include <ModelAPI_Attribute.h>
#include <ModelAPI_Feature.h>
+#include <ModelAPI_Folder.h>
#include <TopAbs_ShapeEnum.hxx>
#include <TopoDS_Shape.hxx>
#include <map>
-class Handle_AIS_InteractiveContext;
-
class QWidget;
class QLayout;
class QDoubleSpinBox;
class QAction;
+class ModuleBase_IWorkshop;
class ModuleBase_ParamIntSpinBox;
class ModuleBase_ParamSpinBox;
-class ModuleBase_IWorkshop;
+class ModuleBase_ViewerPrs;
class GeomAPI_Shape;
+class Events_InfoMessage;
+
namespace ModuleBase_Tools {
/// Methods to adjust margins and spacings.
const QString& theToolTip = QString(),
const QString& theStatusTip = QString());
+#ifdef _DEBUG
+/// Returns name of data of the object if it is not NULL
+/// \param theObj an object
+/// \return a string
+MODULEBASE_EXPORT QString objectName(const ObjectPtr& theObj);
+
/// Converts the object to the feature or a result and generate information string
/// \param theObj an object
/// \param isUseAttributesInfo a flag whether the attribute values information is used
/// \return a string
MODULEBASE_EXPORT QString objectInfo(const ObjectPtr& theObj,
const bool isUseAttributesInfo = false);
-
-/// Converts the AIS context information in a string information.
-/// \param theContext a viewer context
-/// \param thePrefix additional information where the method is called
-MODULEBASE_EXPORT void selectionInfo(Handle_AIS_InteractiveContext& theContext,
- const std::string& thePrefix);
+#endif
/// Converts string value (name of shape type) to shape enum value
/// \param theType - string with shape type name
/// \param hasFeature will be set to true if list contains Feature objects
/// \param hasParameter will be set to true if list contains Parameter objects
/// \param hasCompositeOwner will be set to true if list contains Sub-Feature objects
+/// \param hasResultInHistory will be set to true if one of result is in history
+/// \param hasFolder will be set to true if one of folder is in the list
MODULEBASE_EXPORT void checkObjects(const QObjectPtrList& theObjects, bool& hasResult,
- bool& hasFeature, bool& hasParameter, bool& hasCompositeOwner);
+ bool& hasFeature, bool& hasParameter, bool& hasCompositeOwner,
+ bool& hasResultInHistory, bool& hasFolder);
/// Sets the default coeffient into the driver calculated accordingly the shape type.
/// It provides 1.e-4 for results of construction type
/// Obtains the color from the property manager and converts it to the OCCT color
/// \param theSection a property section
/// \param theName a property item name
-/// \param theDefault a default color value
/// \return quantity color
MODULEBASE_EXPORT Quantity_Color color(const std::string& theSection,
- const std::string& theName,
- const std::string& theDefault);
+ const std::string& theName);
/// Returns the object from the attribute
/// \param theObj an object
/// \param theObj an object
MODULEBASE_EXPORT TopAbs_ShapeEnum getCompoundSubType(const TopoDS_Shape& theShape);
+/// Returns either presentation shape or shape of BREP owner if it is casted to it
+/// \param thePrs selection presentation
+/// \return shape
+MODULEBASE_EXPORT TopoDS_Shape getSelectedShape(
+ const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
+
/// Returns list of parameters accessible in the active part and partset
/// \theParameters a list of parameter names
MODULEBASE_EXPORT void getParameters(QStringList& theParameters);
std::set<FeaturePtr>& theFeatures);
+/// Converts a list of objects to set of folders.
+/// \param theObjects a list of objects
+/// \param theFeatures an out conteiner of features
+void MODULEBASE_EXPORT convertToFolders(const QObjectPtrList& theObjects,
+ std::set<FolderPtr>& theFolders);
+
+
+/// Returns translation from the given data.
+/// If translation is not exists then it returns a string
+/// from the info data without translation
+/// \param theMessage a message which dave to be translated
+QString MODULEBASE_EXPORT translate(const Events_InfoMessage& theMessage);
+
/// Returns translation from the given data.
/// If translation is not exists then it returns a string
/// from the info data without translation
/// \param theContext context of the message (Feature Id)
/// \param theMessage a message which dave to be translated
-/// \param theParams a list of parameters (can be empty)
-void MODULEBASE_EXPORT translate(const std::string& theContext, std::string& theMessage);
+QString MODULEBASE_EXPORT translate(const std::string& theContext, const std::string& theMessage);
/// Set Highlighting of points as a Ball shape
/// \param theAIS - the presentation
