ModuleBase_Tools.h

// Copyright (C) 2014-2025  CEA, EDF
//
// 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
//
 
#ifndef ModuleBase_Tools_H
#define ModuleBase_Tools_H
 
#include "ModuleBase.h"
#include "ModuleBase_Definitions.h"
 
#include <ModelAPI_Attribute.h>
#include <ModelAPI_Feature.h>
#include <ModelAPI_Folder.h>
 
#include <TopAbs_ShapeEnum.hxx>
#include <TopoDS_Shape.hxx>
#include <Prs3d_Drawer.hxx>
#include <AIS_Shape.hxx>
 
#include <Quantity_Color.hxx>
 
#include <QIcon>
#include <QPixmap>
#include <QLocale>
 
#include <map>
 
class QWidget;
class QLayout;
class QDoubleSpinBox;
class QAction;
class ModuleBase_IWorkshop;
class ModuleBase_ParamIntSpinBox;
class ModuleBase_ParamSpinBox;
class ModuleBase_ViewerPrs;
 
class GeomAPI_Shape;
 
class Events_InfoMessage;
 
namespace ModuleBase_Tools {
 
MODULEBASE_EXPORT void adjustMargins(QWidget* theWidget);
MODULEBASE_EXPORT void adjustMargins(QLayout* theLayout);
 
MODULEBASE_EXPORT void zeroMargins(QWidget* theWidget);
MODULEBASE_EXPORT void zeroMargins(QLayout* theLayout);
 
MODULEBASE_EXPORT void activateWindow(QWidget* theWidget, const QString& theInfo = QString());
 
MODULEBASE_EXPORT void setFocus(QWidget* theWidget, const QString& theInfo = QString());
 
 
MODULEBASE_EXPORT void setShadowEffect(QWidget* theWidget, const bool isSetEffect);
 
 
 
MODULEBASE_EXPORT QPixmap composite(const QString& theAdditionalIcon, const QString& theIcon);
 
 
MODULEBASE_EXPORT QPixmap composite(const QImage& theAdditionalIcon, QImage& theIcon);
 
 
MODULEBASE_EXPORT QPixmap lighter(const QString& theIcon, const int theLighterValue = 200);
 
MODULEBASE_EXPORT void setSpinValue(QDoubleSpinBox* theSpin, double theValue);
 
MODULEBASE_EXPORT void setSpinValue(ModuleBase_ParamSpinBox* theSpin, double theValue);
 
MODULEBASE_EXPORT void setSpinText(ModuleBase_ParamSpinBox* theSpin, const QString& theText);
 
MODULEBASE_EXPORT void setSpinValue(ModuleBase_ParamIntSpinBox* theSpin, int theValue);
 
MODULEBASE_EXPORT void setSpinText(ModuleBase_ParamIntSpinBox* theSpin, const QString& theText);
 
MODULEBASE_EXPORT QAction* createAction(const QIcon& theIcon, const QString& theText,
                                        QObject* theParent, const QObject* theReceiver = 0,
                                        const char* theMember = "",
                                        const QString& theToolTip = QString(),
                                        const QString& theStatusTip = QString());
 
#ifdef _DEBUG
MODULEBASE_EXPORT QString objectName(const ObjectPtr& theObj);
 
MODULEBASE_EXPORT QString objectInfo(const ObjectPtr& theObj,
                                     const bool isUseAttributesInfo = false);
#endif
 
MODULEBASE_EXPORT int shapeType(const QString& theType);
 
MODULEBASE_EXPORT bool isSubResult(ObjectPtr theObject);
 
MODULEBASE_EXPORT void checkObjects(const QObjectPtrList& theObjects, bool& hasResult,
                           bool& hasFeature, bool& hasParameter, bool& hasCompositeOwner,
                           bool& hasResultInHistory, bool& hasFolder, bool &hasGroupsOnly);
 
//MODULEBASE_EXPORT void setDefaultDeviationCoefficient(
//                           const std::shared_ptr<ModelAPI_Result>& theResult,
//                           const Handle(Prs3d_Drawer)& theDrawer);
 
MODULEBASE_EXPORT void setDefaultDeviationCoefficient(const TopoDS_Shape& theShape,
                                                      const Handle(Prs3d_Drawer)& theDrawer);
 
MODULEBASE_EXPORT Quantity_Color color(const std::string& theSection,
                                       const std::string& theName);
 
MODULEBASE_EXPORT ObjectPtr getObject(const AttributePtr& theAttribute);
 
MODULEBASE_EXPORT TopAbs_ShapeEnum getCompoundSubType(const TopoDS_Shape& theShape);
 
MODULEBASE_EXPORT TopoDS_Shape getSelectedShape(
  const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
 
MODULEBASE_EXPORT void getParameters(QStringList& theParameters);
 
MODULEBASE_EXPORT std::string findGreedAttribute(ModuleBase_IWorkshop* theWorkshop,
                                                 const FeaturePtr& theFeature);
 
MODULEBASE_EXPORT bool hasObject(const AttributePtr& theAttribute, const ObjectPtr& theObject,
                                 const std::shared_ptr<GeomAPI_Shape>& theShape,
                                 ModuleBase_IWorkshop* theWorkshop,
                                 const bool theTemporarily);
 
MODULEBASE_EXPORT bool setObject(const AttributePtr& theAttribute, const ObjectPtr& theObject,
                                 const std::shared_ptr<GeomAPI_Shape>& theShape,
                                 ModuleBase_IWorkshop* theWorkshop,
                                 const bool theTemporarily,
                                 const bool theCheckIfAttributeHasObject);
 
MODULEBASE_EXPORT std::shared_ptr<GeomAPI_Shape> getShape(const AttributePtr& theAttribute,
                                                          ModuleBase_IWorkshop* theWorkshop);
 
MODULEBASE_EXPORT void flushUpdated(ObjectPtr theObject);
 
MODULEBASE_EXPORT void blockUpdateViewer(const bool theValue);
 
MODULEBASE_EXPORT QString wrapTextByWords(const QString& theValue, QWidget* theWidget,
                                             int theMaxLineInPixels = 150);
 
MODULEBASE_EXPORT QLocale doubleLocale();
 
void MODULEBASE_EXPORT refsToFeatureInFeatureDocument(const ObjectPtr& theObject,
                                                      std::set<FeaturePtr>& theRefFeatures);
 
 
//bool MODULEBASE_EXPORT isSubOfComposite(const ObjectPtr& theObject, const FeaturePtr& theFeature);
 
 
//bool MODULEBASE_EXPORT isSubOfComposite(const ObjectPtr& theObject);
 
 
std::shared_ptr<ModelAPI_Result> MODULEBASE_EXPORT firstResult(const ObjectPtr& theObject);
 
bool MODULEBASE_EXPORT hasModuleDocumentFeature(const std::set<FeaturePtr>& theFeatures);
 
bool MODULEBASE_EXPORT askToDelete(const std::set<FeaturePtr> aFeatures,
                                   const std::map<FeaturePtr,
                                   std::set<FeaturePtr> >& theReferences,
                                   QWidget* theParent,
                                   std::set<FeaturePtr>& theReferencesToDelete,
                                   const std::string& thePrefixInfo = "");
 
bool MODULEBASE_EXPORT warningAboutConflict(QWidget* theParent, const std::string& theWarningText);
 
void MODULEBASE_EXPORT convertToFeatures(const QObjectPtrList& theObjects,
                                         std::set<FeaturePtr>& theFeatures);
 
 
void MODULEBASE_EXPORT convertToFolders(const QObjectPtrList& theObjects,
                                         std::set<FolderPtr>& theFolders);
 
 
QString MODULEBASE_EXPORT translate(const Events_InfoMessage& theMessage);
 
QString MODULEBASE_EXPORT translate(const std::string& theContext, const std::string& theMessage);
 
void MODULEBASE_EXPORT setPointBallHighlighting(AIS_InteractiveObject* theAIS);
 
FeaturePtr MODULEBASE_EXPORT createParameter(const QString& theText);
 
void MODULEBASE_EXPORT editParameter(FeaturePtr theParam, const QString& theText);
 
bool MODULEBASE_EXPORT isNameExist(const QString& theName, FeaturePtr theIgnoreParameter);
 
FeaturePtr MODULEBASE_EXPORT findParameter(const QString& theName);
 
bool MODULEBASE_EXPORT isSameShape(const TopoDS_Shape& theShape1, const TopoDS_Shape& theShape2);
 
//----------- Class members -------------
std::wstring MODULEBASE_EXPORT generateName(const AttributePtr& theAttribute,
  ModuleBase_IWorkshop* theWorkshop);
 
qreal MODULEBASE_EXPORT currentPixelRatio();
 
void MODULEBASE_EXPORT setDisplaying(std::shared_ptr<ModelAPI_ResultPart> thePart,
                                     bool theDisplayFromScript = false);
}
 
#endif