- // Copyright (C) 2014-20xx CEA/DEN, EDF R&D\r
-\r
-#ifndef ModuleBase_IModule_H\r
-#define ModuleBase_IModule_H\r
-\r
-#include "ModuleBase.h"\r
-#include "ModuleBase_IWorkshop.h"\r
-\r
-#include <ModelAPI_Feature.h>\r
-\r
-#include <QString>\r
-#include <QObject>\r
-#include <QMap>\r
-\r
-#include <string>\r
-#include <map>\r
-\r
-class QAction;\r
-class QMouseEvent;\r
-class QKeyEvent;\r
-class QMenu;\r
-class Config_WidgetAPI;\r
-class ModuleBase_ModelWidget;\r
-class ModuleBase_Operation;\r
-class ModuleBase_IWorkshop;\r
-\r
-/**\r
- * \ingroup GUI\r
- * Interface to a module\r
- */\r
-class MODULEBASE_EXPORT ModuleBase_IModule : public QObject\r
-{\r
- Q_OBJECT\r
- public:\r
-\r
- /// Constructor\r
- /// \param theParent instance of workshop interface\r
- ModuleBase_IModule(ModuleBase_IWorkshop* theParent);\r
-\r
- virtual ~ModuleBase_IModule() {}\r
-\r
- /// Add default selection filters of the module to the current viewer\r
- virtual void activateSelectionFilters() {};\r
-\r
- /// Remove default selection filters of the module from the current viewer\r
- virtual void deactivateSelectionFilters() {};\r
-\r
- /// Reads description of features from XML file \r
- virtual void createFeatures();\r
-\r
- /// Called on creation of menu item in desktop\r
- virtual void actionCreated(QAction*);\r
-\r
- /// Launching of a edit operation on the feature \r
- /// \param theFeature feature for editing\r
- virtual void editFeature(FeaturePtr theFeature);\r
-\r
- /// Creates an operation and send it to loop\r
- /// \param theCmdId the operation name\r
- virtual void launchOperation(const QString& theCmdId);\r
-\r
- /// Realizes some functionality by an operation start\r
- /// \param theOperation a started operation\r
- virtual void operationStarted(ModuleBase_Operation* theOperation) {}\r
-\r
- /// Realizes some functionality by an operation resume\r
- /// By default it emits operationResumed signal\r
- /// \param theOperation a resumed operation\r
- virtual void operationResumed(ModuleBase_Operation* theOperation);\r
-\r
- /// Realizes some functionality by an operation stop\r
- virtual void operationStopped(ModuleBase_Operation* theOperation) {}\r
-\r
- /// Realizes some functionality by an operation commit\r
- virtual void operationCommitted(ModuleBase_Operation* theOperation) {}\r
-\r
- /// Realizes some functionality by an operation abort\r
- virtual void operationAborted(ModuleBase_Operation* theOperation) {}\r
-\r
- /// Realizes some functionality by an operation start\r
- virtual ModuleBase_Operation* currentOperation() const = 0;\r
-\r
- /// Add menu items for viewer into the given menu\r
- /// \param theMenu a popup menu to be shown in the viewer\r
- /// \param theStdActions a map of standard actions\r
- /// \return true if items are added and there is no necessity to provide standard menu\r
- virtual bool addViewerMenu(QMenu* theMenu, const QMap<QString, QAction*>& theStdActions) const { return false; }\r
-\r
- /// Add menu items for object browser into the given menu\r
- /// \param theMenu a popup menu to be shown in the object browser\r
- virtual void addObjectBrowserMenu(QMenu* theMenu) const {};\r
-\r
- /// Creates custom widgets for property panel\r
- /// \param theType a type of widget\r
- /// \param theParent the parent object\r
- /// \param theWidgetApi the widget configuration. The attribute of the model widget is obtained from\r
- /// \param theParentId is Id of a parent of the current attribute\r
- virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,\r
- Config_WidgetAPI* theWidgetApi, std::string theParentId)\r
- {\r
- return 0;\r
- }\r
-\r
- /// Returns the active widget, by default it is the property panel active widget\r
- virtual ModuleBase_ModelWidget* activeWidget() const = 0;\r
-\r
- /// Returns current workshop\r
- ModuleBase_IWorkshop* workshop() const { return myWorkshop; }\r
-\r
- /// Call back forlast tuning of property panel before operation performance\r
- /// It is called as on clearing of property panel as on filling with new widgets\r
- virtual void propertyPanelDefined(ModuleBase_Operation* theOperation) {}\r
-\r
- //! Returns True if there are available Undos and there is not an active operation\r
- virtual bool canUndo() const;\r
-\r
- //! Returns True if there are available Redos and there is not an active operation\r
- virtual bool canRedo() const;\r
-\r
- /// Returns true if the action can be applyed to the object\r
- /// \param theObject a checked object\r
- /// \param theActionId an identifier of action, to be found in the menu manager like "DELETE_CMD"\r
- /// \return the a boolean result\r
- virtual bool canApplyAction(const ObjectPtr& theObject, const QString& theActionId) const = 0;\r
-\r
- /// Returns True if the current operation can be committed. By default it is true.\r
- /// \return a boolean value\r
- //virtual bool canCommitOperation() const;\r
-\r
- /// Returns whether the object can be erased. The default realization returns true.\r
- /// \param theObject a model object\r
- virtual bool canEraseObject(const ObjectPtr& theObject) const;\r
-\r
- /// Returns whether the object can be displayed. The default realization returns true.\r
- /// \param theObject a model object\r
- virtual bool canDisplayObject(const ObjectPtr& theObject) const;\r
-\r
- /// Returns true if selection for the object can be activate.\r
- /// By default a result or feature of the current operation can not be activated\r
- /// \param theObject a model object\r
- virtual bool canActivateSelection(const ObjectPtr& theObject) const;\r
-\r
- /// Reacts to the delete action in module\r
- /// \returns true if the action is processed\r
- virtual bool deleteObjects() { return false; };\r
-\r
- /// Performs functionality on closing document\r
- virtual void closeDocument() = 0;\r
-\r
- /// Clears specific presentations in the viewer\r
- virtual void clearViewer() = 0;\r
-\r
- /// Returns a list of modes, where the AIS objects should be activated\r
- /// \param theModes a list of modes\r
- virtual void activeSelectionModes(QIntList& theModes) {}\r
-\r
- /** Update the object presentable properties such as color, lines width and other\r
- * If the object is result with the color attribute value set, it is used,\r
- * otherwise the customize is applyed to the object's feature if it is a custom prs\r
- * \param theObject an object instance\r
- * \param theUpdateViewer the parameter whether the viewer should be update immediately\r
- * \returns true if the object is modified\r
- */\r
- virtual bool customizeObject(ObjectPtr theObject, const bool theUpdateViewer);\r
-\r
- /// This method is called on object browser creation for customization of module specific features\r
- /// \param theObjectBrowser a pinter on Object Browser widget\r
- virtual void customizeObjectBrowser(QWidget* theObjectBrowser) {}\r
-\r
- /// Creates a new operation\r
- /// \param theCmdId the operation name\r
- virtual ModuleBase_Operation* createOperation(const std::string& theCmdId);\r
-\r
- /// Sends the operation for launching\r
- /// \param theOperation the operation\r
- virtual void sendOperation(ModuleBase_Operation* theOperation);\r
-\r
- //! Returns data object by AIS\r
- virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const = 0;\r
-\r
- /// Update state of pop-up menu items in object browser\r
- /// \param theStdActions - a map of standard actions\r
- virtual void updateObjectBrowserMenu(const QMap<QString, QAction*>& theStdActions) {}\r
-\r
- /// Update state of pop-up menu items in viewer\r
- /// \param theStdActions - a map of standard actions\r
- virtual void updateViewerMenu(const QMap<QString, QAction*>& theStdActions) {}\r
-\r
- //! Returns the feature error if the current state of the feature in the module is not correct\r
- //! If the feature is correct, it returns an empty value\r
- //! \return string value\r
- virtual QString getFeatureError(const FeaturePtr& theFeature);\r
-\r
- //! Returns the widget error, get it from the attribute validator and state of the widget\r
- //! If the feature is correct, it returns an empty value\r
- //! \return string value\r
- virtual QString getWidgetError(ModuleBase_ModelWidget* theWidget);\r
-\r
- /// Returns list of granted operation indices\r
- virtual void grantedOperationIds(ModuleBase_Operation* theOperation, QStringList& theIds) const;\r
-\r
- /// Connects or disconnects to the value changed signal of the property panel widgets\r
- /// \param theWidget a property contol widget\r
- /// \param isToConnect a boolean value whether connect or disconnect\r
- virtual void connectToPropertyPanel(ModuleBase_ModelWidget* theWidget, const bool isToConnect) {};\r
-\r
- /// Validates the operation to change the "Apply" button state.\r
- /// \param thePreviousState the previous state of the widget\r
- virtual void widgetStateChanged(int thePreviousState) {};\r
-\r
- /// Returns true if the event is processed.\r
- /// \param thePreviousAttributeID an index of the previous active attribute\r
- virtual bool processEnter(const std::string& thePreviousAttributeID) { return false; };\r
-\r
-signals:\r
- /// Signal which is emitted when operation is launched\r
- void operationLaunched();\r
-\r
- /// Segnal emitted when an operation is resumed\r
- /// \param theOp a resumed operation\r
- void resumed(ModuleBase_Operation* theOp);\r
-\r
-public slots:\r
- /// Called on call of command corresponded to a feature\r
- virtual void onFeatureTriggered();\r
-\r
- /// Slot called on object display\r
- /// \param theObject a data object\r
- /// \param theAIS a presentation object\r
- virtual void onObjectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS) {}\r
-\r
- /// Slot called on before object erase\r
- /// \param theObject a data object\r
- /// \param theAIS a presentation object\r
- virtual void onBeforeObjectErase(ObjectPtr theObject, AISObjectPtr theAIS) {}\r
-\r
-protected slots:\r
- /// Called on selection changed event\r
- virtual void onSelectionChanged() {}\r
-\r
- protected:\r
- /// Register validators for this module\r
- virtual void registerValidators() {}\r
-\r
- /// Register selection filters for this module\r
- virtual void registerFilters() {}\r
-\r
- /// Register properties of this module\r
- virtual void registerProperties() {}\r
-\r
- /// Returns new instance of operation object (used in createOperation for customization)\r
- virtual ModuleBase_Operation* getNewOperation(const std::string& theFeatureId);\r
-\r
-protected:\r
-\r
- /// Reference to workshop\r
- ModuleBase_IWorkshop* myWorkshop;\r
-\r
- /// Map of features in XML\r
- std::map<std::string, std::string> myFeaturesInFiles;\r
-};\r
-\r
-\r
-\r
-//! This function must return a new module instance.\r
-extern "C" {\r
-typedef ModuleBase_IModule* (*CREATE_FUNC)(ModuleBase_IWorkshop*);\r
-}\r
-\r
-#define CREATE_MODULE "createModule"\r
-\r
-#endif //ModuleBase_IModule\r
+// Copyright (C) 2014-2019 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
+//
+
+#ifndef ModuleBase_IModule_H
+#define ModuleBase_IModule_H
+
+#include "ModuleBase.h"
+#include "ModuleBase_IWorkshop.h"
+
+#include <ModelAPI_Feature.h>
+#include <ModelAPI_Attribute.h>
+
+#include <GeomAPI_Shape.h>
+#include <GeomAPI_ICustomPrs.h>
+
+#include <SelectMgr_ListOfFilter.hxx>
+
+#include <QString>
+#include <QObject>
+#include <QMap>
+#include <QList>
+
+#include <string>
+#include <vector>
+#include <map>
+
+class QAction;
+class QMouseEvent;
+class QKeyEvent;
+class QMenu;
+class Config_WidgetAPI;
+
+class ModuleBase_ModelWidget;
+class ModuleBase_Operation;
+class ModuleBase_ViewerPrs;
+class ModuleBase_ITreeNode;
+class ModuleBase_IWorkshop;
+
+class ModelAPI_Result;
+class Events_Message;
+
+class AIS_InteractiveObject;
+
+/**
+ * \ingroup GUI
+ * Interface to a module
+ */
+class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
+{
+ Q_OBJECT
+ public:
+ /// enumeration to know which objects should be customized
+ enum ModuleBase_CustomizeFlag {
+ CustomizeArguments = 0, /// references of other objects referenced to the current feature
+ CustomizeResults, /// results of the current feature
+ CustomizeHighlightedObjects /// highlighted objects of the active widget
+ };
+
+ /// Constructor
+ /// \param theParent instance of workshop interface
+ ModuleBase_IModule(ModuleBase_IWorkshop* theParent);
+
+ virtual ~ModuleBase_IModule() {}
+
+ /// Stores the current selection
+ virtual void storeSelection() {}
+
+ /// Restores the current selection
+ virtual void restoreSelection() {}
+
+ /// Reads description of features from XML file
+ virtual void createFeatures();
+
+ /// Called on creation of menu item in desktop
+ virtual void actionCreated(QAction*);
+
+ /// Launching of a edit operation on the feature
+ /// \param theFeature feature for editing
+ virtual void editFeature(FeaturePtr theFeature);
+
+ /// Returns true if the operation can be committed. Result in default implementation is true.
+ /// \return boolean value
+ virtual bool canCommitOperation() const { return true; }
+
+ /// Creates an operation and send it to loop
+ /// \param theCmdId the operation name
+ /// \param isStartAfterCommitOnly operation is launched if there is no active operation or
+ /// it is committed
+ virtual void launchOperation(const QString& theCmdId,
+ const bool& isStartAfterCommitOnly);
+
+ /// Executes feature as a modal dialog box
+ /// \param theCmdId the operation name
+ virtual void launchModal(const QString& theCmdId);
+
+ /// Realizes some functionality by an operation start
+ /// \param theOperation a started operation
+ virtual void operationStarted(ModuleBase_Operation* theOperation) {}
+
+ /// Realizes some functionality by an operation resume
+ /// By default it emits operationResumed signal
+ /// \param theOperation a resumed operation
+ virtual void operationResumed(ModuleBase_Operation* theOperation);
+
+ /// Realizes some functionality by an operation stop
+ virtual void operationStopped(ModuleBase_Operation* theOperation) {}
+
+ /// Realizes some functionality by an operation commit
+ virtual void operationCommitted(ModuleBase_Operation* theOperation) {}
+
+ /// Realizes some functionality by an operation abort
+ virtual void operationAborted(ModuleBase_Operation* theOperation) {}
+
+ /// Realizes some functionality by an operation start
+ virtual ModuleBase_Operation* currentOperation() const = 0;
+
+ /// Add menu items for viewer into the actions map
+ /// \param theStdActions a map of standard actions
+ /// \param theParent a parent widget
+ /// \param theMenuActions map of action/menu for the desirable index in the viewer menu
+ /// \return true if items are added and there is no necessity to provide standard menu
+ virtual bool addViewerMenu(const QMap<QString, QAction*>& theStdActions,
+ QWidget* theParent,
+ QMap<int, QAction*>& theMenuActions) const
+ { return false; }
+
+ /// Add menu items for object browser into the given menu
+ /// \param theMenu a popup menu to be shown in the object browser
+ virtual void addObjectBrowserMenu(QMenu* theMenu) const {};
+
+ /// Creates custom widgets for property panel
+ /// \param theType a type of widget
+ /// \param theParent the parent object
+ /// \param theWidgetApi the widget configuration.
+ /// The attribute of the model widget is obtained from
+ virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType,
+ QWidget* theParent,
+ Config_WidgetAPI* theWidgetApi)
+ {
+ return 0;
+ }
+
+ /// Returns the active widget, by default it is the property panel active widget
+ virtual ModuleBase_ModelWidget* activeWidget() const = 0;
+
+ /// Returns current workshop
+ ModuleBase_IWorkshop* workshop() const { return myWorkshop; }
+
+ /// Call back forlast tuning of property panel before operation performance
+ /// It is called as on clearing of property panel as on filling with new widgets
+ virtual void propertyPanelDefined(ModuleBase_Operation* theOperation) {}
+
+ /// Have an opportunity to create widgets for the current operation
+ /// instead of standard creation in workshop
+ /// \param theOperation a started operation
+ /// \param theWidgets a list of created widgets
+ /// \return boolean result, false by default
+ virtual bool createWidgets(ModuleBase_Operation* theOperation,
+ QList<ModuleBase_ModelWidget*>& theWidgets) const { return false; }
+
+ //! Returns True if there are available Undos and there is not an active operation
+ virtual bool canUndo() const;
+
+ //! Returns True if there are available Redos and there is not an active operation
+ virtual bool canRedo() const;
+
+ /// Returns true if the action can be applyed to the object
+ /// \param theObject a checked object
+ /// \param theActionId an identifier of action, to be found in the menu manager like "DELETE_CMD"
+ /// \return the a boolean result
+ virtual bool canApplyAction(const ObjectPtr& theObject, const QString& theActionId) const = 0;
+
+ /// Returns True if the current operation can be committed. By default it is true.
+ /// \return a boolean value
+ //virtual bool canCommitOperation() const;
+
+ /// Returns whether the object can be erased. The default realization returns true.
+ /// \param theObject a model object
+ virtual bool canEraseObject(const ObjectPtr& theObject) const;
+
+ /// Returns whether the object can be displayed. The default realization returns true.
+ /// \param theObject a model object
+ virtual bool canDisplayObject(const ObjectPtr& theObject) const;
+
+ /// Returns whether the started operation may use preselection of the previous one
+ /// Cases are: previous operation is null, edit operation, previuos and started operations
+ /// kinds are the same
+ /// \param thePreviousOperationKind a kind of previous operation
+ /// \param theStartedOperationKind a kind of a started operation
+ virtual bool canUsePreselection(const QString& thePreviousOperationKind,
+ const QString& theStartedOperationKind);
+
+ /// Make some functionality after the objects are hidden in viewer
+ /// \param theObjects a list of hidden objects
+ //virtual void processHiddenObject(const std::list<ObjectPtr>& theObjects) {};
+
+ /// Returns true if selection for the object can be activate.
+ /// By default a result or feature of the current operation can not be activated
+ /// \param theObject a model object
+ virtual bool canActivateSelection(const ObjectPtr& theObject) const;
+
+ /// Reacts to the delete action in module
+ /// \returns true if the action is processed
+ virtual bool deleteObjects() { return false; };
+
+ /// Performs functionality on closing document
+ virtual void closeDocument() = 0;
+
+ /// Clears specific presentations in the viewer
+ virtual void clearViewer() = 0;
+
+ /// Returns a list of modes, where the AIS objects should be activated
+ /// \param theModes a list of modes
+ virtual void activeSelectionModes(QIntList& theModes) {}
+
+ /// Appends specific selection modes for the module to the list of types
+ /// \param theModesType combination of available selection filters
+ /// \param theModes a selection modes to be extended
+ virtual void moduleSelectionModes(int theModesType, QIntList& theModes) = 0;
+
+ /// Appends into container of filters module filters corresponded to the modes type
+ /// \param theFilterTypes container of available selection filters
+ /// \param theSelectionFilters [out] container to be extend by elements
+ virtual void moduleSelectionFilters(const QIntList& theFilterTypes,
+ SelectMgr_ListOfFilter& theSelectionFilters) = 0;
+
+ /// Returns types of registered module selection filters
+ /// \param theSelectionFilters [out] container of type value
+ virtual QIntList selectionFilters() { return QIntList(); }
+
+ /// Returns selection filter
+ /// \param theType selection filter type
+ /// \param theFilter instance of filter
+ virtual Handle(SelectMgr_Filter) selectionFilter(const int theType) = 0;
+
+ /// Return true if the custom presentation is activated
+ /// \param theFlag a flag of level of customization, which means that only part of sub-elements
+ /// \return boolean value
+ virtual bool isCustomPrsActivated(const ModuleBase_CustomizeFlag& theFlag) const
+ { return false; };
+
+ /// Activate custom presentation for the object. Default realization is empty.
+ /// \param theFeature a feature instance
+ /// \param theFlag a flag of level of customization, which means that only part of sub-elements
+ /// \param theUpdateViewer the parameter whether the viewer should be update immediately
+ virtual void activateCustomPrs(const FeaturePtr& theFeature,
+ const ModuleBase_CustomizeFlag& theFlag,
+ const bool theUpdateViewer) {}
+
+ /// Deactivate custom presentation for the object. Default realization is empty.
+ /// \param theFlag a flag of level of customization, which means that only part of sub-elements
+ /// \param theUpdateViewer the parameter whether the viewer should be update immediately
+ virtual void deactivateCustomPrs(const ModuleBase_CustomizeFlag& theFlag,
+ const bool theUpdateViewer) {}
+
+ /// Modifies the given presentation in the custom way.
+ virtual bool customisePresentation(std::shared_ptr<ModelAPI_Result> theResult,
+ AISObjectPtr thePrs,
+ GeomCustomPrsPtr theCustomPrs) { return false; };
+
+ /// Modifies the given presentation in the custom way after usual customize is performed.
+ virtual bool afterCustomisePresentation(std::shared_ptr<ModelAPI_Result> theResult,
+ AISObjectPtr thePrs,
+ GeomCustomPrsPtr theCustomPrs) { return false; };
+
+ /// Update the object presentable properties such as color, lines width and other
+ /// If the object is result with the color attribute value set, it is used,
+ /// otherwise the customize is applyed to the object's feature if it is a custom prs
+ /// \param theObject an object instance
+ /// \param theFlag a flag of level of customization, which means that only part of sub-elements
+ /// should be updated(e.g. only highlighted elements)
+ /// \param theUpdateViewer the parameter whether the viewer should be update immediately
+ /// \returns true if the object is modified
+ virtual bool customizeObject(ObjectPtr theObject, const ModuleBase_CustomizeFlag& theFlag,
+ const bool theUpdateViewer);
+
+ /// This method is called on object browser creation for customization of module specific features
+ /// \param theObjectBrowser a pinter on Object Browser widget
+ virtual void customizeObjectBrowser(QWidget* theObjectBrowser) {}
+
+ /// Creates a new operation
+ /// \param theCmdId the operation name
+ virtual ModuleBase_Operation* createOperation(const std::string& theCmdId);
+
+ /// Create specific for the module presentation
+ /// \param theResult an object for presentation
+ /// \return created presentation or NULL(default value)
+ virtual Handle(AIS_InteractiveObject) createPresentation(
+ const std::shared_ptr<ModelAPI_Result>& theResult);
+
+ //! Returns data object by AIS
+ virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const = 0;
+
+ //! Returns true if the presentation can be shown in shading mode
+ //! \param theAIS presentation to be checked
+ //! \return boolean value
+ virtual bool canBeShaded(Handle(AIS_InteractiveObject) theAIS) const;
+
+ /// Update state of pop-up menu items in object browser
+ /// \param theStdActions - a map of standard actions
+ virtual void updateObjectBrowserMenu(const QMap<QString, QAction*>& theStdActions) {}
+
+ /// Update state of pop-up menu items in viewer
+ /// \param theStdActions - a map of standard actions
+ virtual void updateViewerMenu(const QMap<QString, QAction*>& theStdActions) {}
+
+ /// Returns true if the action should be always enabled
+ /// \param theActionId an action index: Accept or Accept All
+ /// \return boolean value
+ virtual bool isActionEnableStateFixed(const int theActionId) const { return false; }
+
+ //! Returns the feature error if the current state of the feature in the module is not correct
+ //! If the feature is correct, it returns an empty value
+ //! \return string value
+ virtual QString getFeatureError(const FeaturePtr& theFeature);
+
+ /// Returns list of granted operation indices
+ virtual void grantedOperationIds(ModuleBase_Operation* theOperation, QStringList& theIds) const;
+
+ /// Connects or disconnects to the value changed signal of the property panel widgets
+ /// \param theWidget a property contol widget
+ /// \param isToConnect a boolean value whether connect or disconnect
+ virtual void connectToPropertyPanel(ModuleBase_ModelWidget* theWidget, const bool isToConnect) {};
+
+ /// Validates the operation to change the "Apply" button state.
+ /// \param thePreviousState the previous state of the widget
+ virtual void widgetStateChanged(int thePreviousState) {};
+
+ /// Returns true if the event is processed.
+ /// \param thePreviousAttributeID an index of the previous active attribute
+ virtual bool processEnter(const std::string& thePreviousAttributeID) { return false; };
+
+ /// Performs some GUI actions before an operation transaction is stopped
+ /// Default realization is empty
+ virtual void beforeOperationStopped(ModuleBase_Operation* theOperation) {};
+
+ /// Finds a shape by attribute if it is possible
+ /// \param theAttribute an attribute
+ /// \return a geom shape
+ virtual GeomShapePtr findShape(const AttributePtr& theAttribute) = 0;
+
+ /// Finds an attribute by geom shape if it is possible
+ /// \param theObject an object of the attribute
+ /// \param theGeomShape a geom shape
+ /// \return theAttribute
+ virtual AttributePtr findAttribute(const ObjectPtr& theObject,
+ const GeomShapePtr& theGeomShape) = 0;
+
+ /// Returns reentrant message if it was accepted
+ virtual std::shared_ptr<Events_Message> reentrantMessage() = 0;
+
+ /// Put current selection into reentrant message
+ /// \param theMessage a message of reentrant operation
+ virtual void setReentrantPreSelection(const std::shared_ptr<Events_Message>& theMessage) = 0;
+
+ /// Returns XML information by the feature index
+ /// \param theFeatureId a feature id
+ /// \param theXmlCfg XML configuration
+ /// \param theDescription feature description
+ void getXMLRepresentation(const std::string& theFeatureId, std::string& theXmlCfg,
+ std::string& theDescription);
+
+ /// Returns root tree node which represents a data model
+ virtual ModuleBase_ITreeNode* rootNode() const = 0;
+
+signals:
+ /// Segnal emitted when an operation is resumed
+ /// \param theOp a resumed operation
+ void resumed(ModuleBase_Operation* theOp);
+
+public slots:
+ /// Called on call of command corresponded to a feature
+ virtual void onFeatureTriggered();
+
+ /// Slot called on object display
+ /// \param theObject a data object
+ /// \param theAIS a presentation object
+ virtual void onObjectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS) {}
+
+ /// Slot called on before object erase
+ /// \param theObject a data object
+ /// \param theAIS a presentation object
+ virtual void onBeforeObjectErase(ObjectPtr theObject, AISObjectPtr theAIS) {}
+
+protected slots:
+ /// Called on selection changed event
+ virtual void onSelectionChanged() {}
+
+protected:
+ /// Register validators for this module
+ virtual void registerValidators() {}
+
+ /// Register properties of this module
+ virtual void registerProperties() {}
+
+ /// Returns new instance of operation object (used in createOperation for customization)
+ virtual ModuleBase_Operation* getNewOperation(const std::string& theFeatureId);
+
+protected:
+ /// Reference to workshop
+ ModuleBase_IWorkshop* myWorkshop;
+
+ /// Map of features in XML
+ std::map<std::string, std::string> myFeaturesInFiles;
+};
+
+
+
+//! This function must return a new module instance.
+extern "C" {
+typedef ModuleBase_IModule* (*CREATE_FUNC)(ModuleBase_IWorkshop*);
+}
+
+#define CREATE_MODULE "createModule"
+
+#endif //ModuleBase_IModule
