X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_IModule.h;h=ac70964372e9bc16625a6602e8d3bb868a4fcbbf;hb=3205d0f18200948632155bbe7b640bc1e482243d;hp=d6bd6e9afdc878e024ee5f469294abbabafb5c0b;hpb=6184808bb36e2b78623c300b30306ebb697f4ebb;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_IModule.h b/src/ModuleBase/ModuleBase_IModule.h old mode 100644 new mode 100755 index d6bd6e9af..ac7096437 --- a/src/ModuleBase/ModuleBase_IModule.h +++ b/src/ModuleBase/ModuleBase_IModule.h @@ -23,7 +23,6 @@ class Config_WidgetAPI; class ModuleBase_ModelWidget; class ModuleBase_Operation; class ModuleBase_IWorkshop; -class ModuleBase_IDocumentDataModel; /** * \ingroup GUI @@ -35,15 +34,15 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject public: /// Constructor - /// \param theParent instance of workshop intrface + /// \param theParent instance of workshop interface ModuleBase_IModule(ModuleBase_IWorkshop* theParent); virtual ~ModuleBase_IModule() {} - // Add default selection filters of the module to the current viewer + /// Add default selection filters of the module to the current viewer virtual void activateSelectionFilters() {}; - // Remove default selection filters of the module from the current viewer + /// Remove default selection filters of the module from the current viewer virtual void deactivateSelectionFilters() {}; /// Reads description of features from XML file @@ -62,51 +61,49 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject /// Realizes some functionality by an operation start /// \param theOperation a started operation - virtual void onOperationStarted(ModuleBase_Operation* theOperation) {} + 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 onOperationResumed(ModuleBase_Operation* theOperation); + virtual void operationResumed(ModuleBase_Operation* theOperation); /// Realizes some functionality by an operation stop - virtual void onOperationStopped(ModuleBase_Operation* theOperation) {} + virtual void operationStopped(ModuleBase_Operation* theOperation) {} /// Realizes some functionality by an operation commit - virtual void onOperationCommitted(ModuleBase_Operation* theOperation) {} + virtual void operationCommitted(ModuleBase_Operation* theOperation) {} /// Realizes some functionality by an operation abort - virtual void onOperationAborted(ModuleBase_Operation* theOperation) {} + virtual void operationAborted(ModuleBase_Operation* theOperation) {} /// Realizes some functionality by an operation start - /// \param theOperation a started operation virtual ModuleBase_Operation* currentOperation() const = 0; - /// Add menu atems for viewer into the given menu + /// Add menu items for viewer into the given menu /// \param theMenu a popup menu to be shown in the viewer /// \param theStdActions a map of standard actions /// \return true if items are added and there is no necessity to provide standard menu virtual bool addViewerMenu(QMenu* theMenu, const QMap& theStdActions) const { return false; } - /// Add menu atems for object browser into the given menu + /// 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 {}; - /// Called when it is necessary to update a command state (enable or disable it) - //virtual bool isFeatureEnabled(const QString& theCmdId) const = 0; - /// Creates custom widgets for property panel /// \param theType a type of widget /// \param theParent the parent object - /// \param theWidgetApi the widget configuation. The attribute of the model widget is obtained from + /// \param theWidgetApi the widget configuration. The attribute of the model widget is obtained from /// \param theParentId is Id of a parent of the current attribute - /// \param theModelWidgets list of widget objects virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent, Config_WidgetAPI* theWidgetApi, std::string theParentId) { 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; } @@ -120,9 +117,19 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject //! 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; + //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 @@ -137,8 +144,11 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject /// \returns true if the action is processed virtual bool deleteObjects() { return false; }; - /// Returns data model object for representation of data tree in Object browser - virtual ModuleBase_IDocumentDataModel* dataModel() const = 0; + /// 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 @@ -148,10 +158,12 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject * 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 theUpdateViewer the parameter whether the viewer should be update immediately + * \returns true if the object is modified */ - virtual void customizeObject(ObjectPtr theObject) {} + virtual bool customizeObject(ObjectPtr theObject, const bool theUpdateViewer); - /// This method is called on object browser creation for customisation of module specific features + /// 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) {} @@ -174,16 +186,48 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject /// \param theStdActions - a map of standard actions virtual void updateViewerMenu(const QMap& theStdActions) {} + //! 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 after an operation transaction is opened + /// Default realization is empty + virtual void beforeOperationStarted(ModuleBase_Operation* theOperation) {}; + + /// Performs some GUI actions before an operation transaction is stopped + /// Default realization is empty + virtual void beforeOperationStopped(ModuleBase_Operation* theOperation) {}; + signals: + /// Signal which is emitted when operation is launched void operationLaunched(); - void operationResumed(ModuleBase_Operation* theOp); + /// 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(); - /// Slolt called on object display + /// Slot called on object display /// \param theObject a data object /// \param theAIS a presentation object virtual void onObjectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS) {}