X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_Tools.h;h=b50ec66a1116581d3bef2dfe9b229f183da16085;hb=854902e275b0daab546cbe4517b8bb71badad4a1;hp=e2a09c54624833ac3bd0d9f17aa25e7aa0fc2222;hpb=cd9217d7e87997ec8bc150a6d8c389e742ca0f84;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_Tools.h b/src/ModuleBase/ModuleBase_Tools.h old mode 100644 new mode 100755 index e2a09c546..b50ec66a1 --- a/src/ModuleBase/ModuleBase_Tools.h +++ b/src/ModuleBase/ModuleBase_Tools.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: ModuleBase_Tools.h // Created: 11 July 2014 // Author: Vitaly Smetannikov @@ -6,22 +8,295 @@ #define ModuleBase_Tools_H #include "ModuleBase.h" +#include "ModuleBase_Definitions.h" -#include +#include #include +#include +#include +#include + +#include + +#include +#include + +#include + +class QWidget; +class QLayout; +class QDoubleSpinBox; +class QAction; +class ModuleBase_ParamIntSpinBox; +class ModuleBase_ParamSpinBox; +class ModuleBase_IWorkshop; + class GeomAPI_Shape; namespace ModuleBase_Tools { +/* + * Methods to adjust margins and spacings. + */ +MODULEBASE_EXPORT void adjustMargins(QWidget* theWidget); +MODULEBASE_EXPORT void adjustMargins(QLayout* theLayout); + +MODULEBASE_EXPORT void zeroMargins(QWidget* theWidget); +MODULEBASE_EXPORT void zeroMargins(QLayout* theLayout); + +/* + * Calls the same-named Qt method for the given widget. + * It sets the top-level widget containing this widget to be the active window. + * An active window is a visible top-level window that has the keyboard input focus. + * \param theWidget a widget to be activated + * \param theIndo a debug information + */ +MODULEBASE_EXPORT void activateWindow(QWidget* theWidget, const QString& theInfo = QString()); + +/* + * Calls the same-named Qt method for the given widget. + * Gives the keyboard input focus to this widget (or its focus proxy) if this widget or + * one of its parents is the active window. + * \param theWidget a widget to be activated + * \param theIndo a debug information + */ +MODULEBASE_EXPORT void setFocus(QWidget* theWidget, const QString& theInfo = QString()); + + +//! Sets or removes the shadow effect to the widget +//! \param theWidget a widget to be styled +//! \param isSetEffect if true, the shadow effect is set, overwise cleared +//! \return resulting pixmap +MODULEBASE_EXPORT void setShadowEffect(QWidget* theWidget, const bool isSetEffect); + /** - * Returns returns a shape if the result has a shape method. Otherwise returns NULL pointer + * \ingroup GUI + * Methods to modify a resource pixmap */ -MODULEBASE_EXPORT boost::shared_ptr shape(ResultPtr theResult); -MODULEBASE_EXPORT FeaturePtr feature(ObjectPtr theObject); +//! Create composite pixmap. +//! Pixmap \a theAdditionalIcon is drawn over pixmap \a dest with coordinates +//! specified relatively to the upper left corner of \a theIcon. + +//! \param theAdditionalIcon resource text of the additional pixmap +//! \param theIcon resource text of the background pixmap +//! \return resulting pixmap +MODULEBASE_EXPORT QPixmap composite(const QString& theAdditionalIcon, const QString& theIcon); + +//! Generates the pixmap lighter than the resources pixmap. +//! Pixmap \a theIcon is lighted according to the given value. +//! If the lighter value is greater than 100, this functions returns a lighter pixmap. +//! Setting lighter value to 150 returns a color that is 50% brighter. If the factor is less than 100, +//! the return pixmap is darker. If the factor is 0 or negative, the return pixmap is unspecified. + +//! \param resource text of the pixmap +//! \param theLighterValue a lighter factor +//! \return resulting pixmap +MODULEBASE_EXPORT QPixmap lighter(const QString& theIcon, const int theLighterValue = 200); + +/// Sets programmatically the value to the spin box without emitting any signals(e.g. valueChanged) +/// \param theSpin an X or Y coordinate widget +/// \param theValue a new value +MODULEBASE_EXPORT void setSpinValue(QDoubleSpinBox* theSpin, double theValue); + +/// Sets programmatically the value to the spin box without emitting any signals(e.g. valueChanged) +/// \param theSpin an X or Y coordinate widget +/// \param theValue a new value +MODULEBASE_EXPORT void setSpinValue(ModuleBase_ParamSpinBox* theSpin, double theValue); + +/// Sets programmatically the value to the spin box without emitting any signals(e.g. valueChanged) +/// \param theSpin an ModuleBase_ParamSpinBox that accepts text +/// \param theText a new value +MODULEBASE_EXPORT void setSpinText(ModuleBase_ParamSpinBox* theSpin, const QString& theText); + +/// Sets programmatically the value to the spin box without emitting any signals(e.g. valueChanged) +/// \param theSpin a ModuleBase_ParamIntSpinBox object +/// \param theValue a new value +MODULEBASE_EXPORT void setSpinValue(ModuleBase_ParamIntSpinBox* theSpin, int theValue); + +/// Sets programmatically the value to the spin box without emitting any signals(e.g. valueChanged) +/// \param theSpin a SpinBox that accepts text +/// \param theText a new value +MODULEBASE_EXPORT void setSpinText(ModuleBase_ParamIntSpinBox* theSpin, const QString& theText); + +/// Creates an action filled with the parameters +/// \param theIcon an action icon +/// \param theText an icon text +/// \param theParent an action object +/// \param theReceiver an object to process action triggered signal +/// \param theMember a slot to process the action triggered signal +/// \param theToolTip an action tool tip information, if empty the text is used +/// \param theStatusTip an action status tip information, if empty the text is used +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()); + +/// 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 string value (name of shape type) to shape enum value +/// \param theType - string with shape type name +/// \return TopAbs_ShapeEnum value +MODULEBASE_EXPORT TopAbs_ShapeEnum shapeType(const QString& theType); + +/// Checks whether the object is a sub result. It gets the feature of the object, +/// obtains all results of the feature and check if the object is a sub result +/// \return boolean result +MODULEBASE_EXPORT bool isSubResult(ObjectPtr theObject); + +/*! +Check types of objects which are in the given list +\param theObjects the list of objects +\param hasResult will be set to true if list contains Result objects +\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 +*/ +MODULEBASE_EXPORT void checkObjects(const QObjectPtrList& theObjects, bool& hasResult, + bool& hasFeature, bool& hasParameter, bool& hasCompositeOwner); + +/*! Sets the default coeffient into the driver calculated accordingly the shape type. +It provides 1.e-4 for a shape withe Edge shape type +\param theShape a shape to define the deviation coeffient, +\param theDrawer a drawer +*/ +MODULEBASE_EXPORT void setDefaultDeviationCoefficient(const TopoDS_Shape& theShape, + const Handle(Prs3d_Drawer)& theDrawer); + +/*! 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); + + +/// Returns the object from the attribute +/// \param theObj an object +MODULEBASE_EXPORT ObjectPtr getObject(const AttributePtr& theAttribute); + +/// Returns the object from the attribute +/// \param theObj an object +MODULEBASE_EXPORT TopAbs_ShapeEnum getCompoundSubType(const TopoDS_Shape& theShape); + +/// Returns list of parameters accessible in the active part and partset +/// \theParameters a list of parameter names +MODULEBASE_EXPORT void getParameters(QStringList& theParameters); + +/// Returns list of parameters accessible in the active part and partset +/// \theParameters a list of parameter names +MODULEBASE_EXPORT std::string findGreedAttribute(ModuleBase_IWorkshop* theWorkshop, + const FeaturePtr& theFeature); + +/// Set the object to the attribute depending on the attribute type. If it is a list, +/// the values are appended if they are not in the list yet. +/// \param theAttribute an attribute where the object and shape are set +/// \param theObject an object +/// \param theShape a shape +/// \param theWorkshop to find an attribute for the given shape for attribute reference +/// \param theTemporarily if it is true, do not store and name the added in the data framework +/// It is useful for attribute selection +MODULEBASE_EXPORT bool hasObject(const AttributePtr& theAttribute, const ObjectPtr& theObject, + const std::shared_ptr& theShape, + ModuleBase_IWorkshop* theWorkshop, + const bool theTemporarily); + +/// Set the object to the attribute depending on the attribute type. If it is a list, +/// the values are appended if they are not in the list yet. +/// \param theAttribute an attribute where the object and shape are set +/// \param theObject an object +/// \param theShape a shape +/// \param theWorkshop to find an attribute for the given shape for attribute reference +/// \param theTemporarily if it is true, do not store and name the added in the data framework +/// \param theCheckIfAttributeHasObject if it is true, the check isInList is called +/// It is useful for attribute selection +MODULEBASE_EXPORT void setObject(const AttributePtr& theAttribute, const ObjectPtr& theObject, + const std::shared_ptr& theShape, + ModuleBase_IWorkshop* theWorkshop, + const bool theTemporarily, + const bool theCheckIfAttributeHasObject); + +/// Returns the shape of the attribute. If the attribute is AttributeRefAttrPtr, the shape is found +/// using current module of the given workshop. +/// \param theAttribute an attribute where the shape is set +/// \param theWorkshop to find a shape for the given attribute +MODULEBASE_EXPORT std::shared_ptr getShape(const AttributePtr& theAttribute, + ModuleBase_IWorkshop* theWorkshop); + +/// Flush updated signal for the object. The viewer update is blocked in the process +/// \param theObject parameter of the signal +MODULEBASE_EXPORT void flushUpdated(ObjectPtr theObject); + +/// Sends a message about block/unblock viewer updating +/// \param theValue a boolean value +MODULEBASE_EXPORT void blockUpdateViewer(const bool theValue); + +/// Generates a wrapped string to be less than value with '\n' separators +/// \param theValue a boolean value +/// \param theWidget a widget to know the font +/// \param theMaxLineInPixels a maximum line width in pixels +MODULEBASE_EXPORT QString wrapTextByWords(const QString& theValue, QWidget* theWidget, + int theMaxLineInPixels = 150); + +/*! + Returns a container of referenced feature to the current object in the object document. + \param theObject an object, which will be casted to a feature type + \param theRefFeatures an output container + */ +void MODULEBASE_EXPORT refsToFeatureInFeatureDocument(const ObjectPtr& theObject, + std::set& theRefFeatures); + + +/*! + Returns true if the object if a sub child of the feature. The feature is casted to the + composite one. If it is possible, the sub object check happens. The method is applyed + recursively to the feature subs. + \param theObject a candidate to be a sub object + \param theFeature a candidate to be a composite feature + \return a boolean value + */ +bool MODULEBASE_EXPORT isSubOfComposite(const ObjectPtr& theObject, const FeaturePtr& theFeature); + + +/*! +* Returns true if the result is a sub object of some composite object +* \param theObject a result object +* \returns boolean value +*/ +bool MODULEBASE_EXPORT isSubOfComposite(const ObjectPtr& theObject); + + +/*! +* Shows a dialog box about references. Ask whether they should be also removed. +* \param theFeatures a list of features +* \param theReferences a map of all references to the features +* \param theParent a parent widget for the question message box +* \param theReferencesToDelete an out set for references features to be removed +* \return true if in message box answer is Yes +*/ +bool MODULEBASE_EXPORT askToDelete(const std::set aFeatures, + const std::map >& theReferences, + QWidget* theParent, + std::set& theReferencesToDelete); + +/*! +* Converts a list of objects to set of corresponded features. If object is result, it is ingored +* because the feauture only might be removed. But if result is in a parameter group, the feature +* of this parameter is to be removed +* \param theObjects a list of objects +* \param theFeatures an out conteiner of features +*/ +void MODULEBASE_EXPORT convertToFeatures(const QObjectPtrList& theObjects, std::set& theFeatures); } -; #endif