X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_IPropertyPanel.h;h=fe8a110e00e3577fa5c3fdd5a9be7cd909dfe74d;hb=cdc2caa21375bc96aaad9bb7c3ee1140dac1d738;hp=1419a715e6c8ef4418ee948b0a87695939fe0230;hpb=1c2db2a9ea5f192e2bde3c81e19a9915e2f89d53;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_IPropertyPanel.h b/src/ModuleBase/ModuleBase_IPropertyPanel.h index 1419a715e..fe8a110e0 100644 --- a/src/ModuleBase/ModuleBase_IPropertyPanel.h +++ b/src/ModuleBase/ModuleBase_IPropertyPanel.h @@ -17,10 +17,16 @@ class ModuleBase_ModelWidget; +/** +* \ingroup GUI +* A class for Property panel object definition +*/ class MODULEBASE_EXPORT ModuleBase_IPropertyPanel : public QDockWidget { Q_OBJECT public: + /// Constructor + /// \param theParent is a parent of the property panel ModuleBase_IPropertyPanel(QWidget* theParent) : QDockWidget(theParent), myIsEditing(false) {} /// Returns currently active widget @@ -30,19 +36,17 @@ public: virtual const QList& modelWidgets() const = 0; /// Editing mode depends on mode of current operation. This value is defined by it. + /// \param isEditing state of editing mode flag virtual void setEditingMode(bool isEditing) { myIsEditing = isEditing; } - bool isEditingMode() const { return myIsEditing; } - - /// Set Enable/Disable state of Ok button - virtual void setOkEnabled(bool theEnabled) = 0; - /// Returns state of Ok button - virtual bool isOkEnabled() const = 0; + /// \return State of editing mode flag + bool isEditingMode() const { return myIsEditing; } - /// Set Enable/Disable state of Ok button + /// Set Enable/Disable state of Cancel button + /// \param theEnabled Enable/Disable state of Cancel button virtual void setCancelEnabled(bool theEnabled) = 0; - /// Returns state of Ok button + /// \return Enable/Disable state of Cancel button virtual bool isCancelEnabled() const = 0; signals: @@ -69,12 +73,17 @@ public slots: /// Activate the next from current widget in the property panel virtual void activateNextWidget() = 0; - // Makes the given widget active, highlights it and removes - // highlighting from the previous active widget - // emits widgetActivated(theWidget) signal + /** + * Makes the given widget active, highlights it and removes + * highlighting from the previous active widget + * emits widgetActivated(theWidget) signal + * \param theWidget which has to be activated + */ virtual void activateWidget(ModuleBase_ModelWidget* theWidget) = 0; protected: + + /// Flag which shows that current operation is in editing mode bool myIsEditing; };