#include <memory>
class Config_WidgetAPI;
+class ModuleBase_IWorkshop;
class QKeyEvent;
/**\class ModuleBase_ModelWidget
public:
/// Constructor
/// \param theParent the parent object
- /// \param theData the widget configuation. The attribute of the model widget is obtained from
+ /// \param theData the widget configuration. The attribute of the model widget is obtained from
/// \param theParentId is Id of a parent of the current attribute
ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData,
const std::string& theParentId);
}
/// Fills the widget with default values
- virtual void reset() {};
+ /// \return true if the widget current value is reset
+ virtual bool reset() { return false; };
/// Returns the state whether the attribute of the feature is initialized
/// \param theObject a model feature to be checked
/// \return the boolean result
std::string getDefaultValue() const { return myDefaultValue; }
+ /// Returns true, if the obligatory value of the widget is not defined in the XML or has true value
+ /// \return the boolean result
+ bool isObligatory() const { return myIsObligatory; }
+
+ /// Returns this parameter value in the xml file
+ /// \return the boolean result
+ bool isUseReset() const { return myUseReset; }
+
/// Defines if it is supposed that the widget should interact with the viewer.
virtual bool isViewerSelector() { return false; }
/// Set the given wrapped value to the current widget
/// This value should be processed in the widget according to the needs
- /// \param theValue the wrapped widget value
- virtual bool setSelection(ModuleBase_ViewerPrs theValue)
+ /// \param theValues the wrapped selection values
+ /// \param toValidate the boolean value whether the value should be checked by filters
+ virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
+ const bool theToValidate)
{
return false;
}
- /// Restore value from attribute data to the widget's control
- virtual bool restoreValue() = 0;
+ /// Restore value from attribute data to the widget's control. Emits signals before and after store
+ /// \return True in success
+ bool restoreValue();
/// Set focus to the first control of the current widget. The focus policy of the control is checked.
/// If the widget has the NonFocus focus policy, it is skipped.
/// \return the state whether the widget can accept the focus
virtual bool focusTo();
- /// The methiod called when widget is activated
+ /// The method called when widget is activated
void activate();
- /// The methiod called when widget is deactivated
+ /// The method called when widget is deactivated
virtual void deactivate() {}
/// Returns list of widget controls
/// FocusIn events processing
virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
- //! \brief Enables processing of focus event on all controls by the widget
- void enableFocusProcessing();
+ /// \brief Enables processing of focus event on all controls by the widget
+ /// if this widget is not obligatory and set no-focus policy otherwise
+ virtual void enableFocusProcessing();
//! Switch On/Off highlighting of the widget
- void setHighlighted(bool isHighlighted);
+ virtual void setHighlighted(bool isHighlighted);
/// Returns the attribute name
/// \returns the string value
/// \return Current Editing mode
bool isEditingMode() const { return myIsEditing; }
+ /// Sends Update and Redisplay for the given object
+ /// \param theObj is updating object
+ static void updateObject(ObjectPtr theObj);
+
+ /// Sends Move event for the given object
+ /// \param theObj is object for moving
+ static void moveObject(ObjectPtr theObj);
+
signals:
/// The signal about widget values are to be changed
void beforeValuesChanged();
/// The signal about widget values are to be changed
void afterValuesChanged();
+ /// The signal about widget values are to be restored
+ void beforeValuesRestored();
+ /// The signal about widget values are to be restored
+ void afterValuesRestored();
+
/// The signal about key release on the control, that corresponds to the attribute
/// \param theEvent key release event
void keyReleased(QKeyEvent* theEvent);
/// \param theWidget the model base widget
void focusOutWidget(ModuleBase_ModelWidget* theWidget);
- protected:
+protected:
+ /// Sets default value of widget. Normally, widget should fetch this value
+ /// from the xml. However, some widgets derived widgets could define it
+ void setDefaultValue(const std::string& theValue);
/// \brief Set the attribute name
/// \param theAttribute the string value with attribute name
void setAttributeID(const std::string& theAttribute)
/// \return True in success
virtual bool storeValueCustom() const = 0;
- /// The methiod called when widget is activated
- virtual void activateCustom() {};
+ /// Restore value from attribute data to the widget's control
+ virtual bool restoreValueCustom() = 0;
- /// Sends Update and Redisplay for the given object
- /// \param theObj is updating object
- void updateObject(ObjectPtr theObj) const;
+ /// The method called when widget is activated
+ virtual void activateCustom() {};
- /// Sends Move event for the given object
- /// \param theObj is object for moving
- void moveObject(ObjectPtr theObj) const;
+ /// Sends a message about block/unblock viewer updating
+ /// \param theValue a boolean value
+ static void blockUpdateViewer(const bool theValue);
protected slots:
/// Processing of values changed in model widget by store the current value to the feature
protected:
/// The attribute name of the model feature
- std::string myAttributeID;
+ std::string myAttributeID;
/// Name of parent
- std::string myParentId;
+ std::string myParentId;
/// A feature which is processing by active operation
- FeaturePtr myFeature;
+ FeaturePtr myFeature;
/// Flag which shows that current operation is in editing mode
bool myIsEditing;
+ /// Flag which shows whether current widget is obligatory
+ /// The non-obligatory widgets should not accept the focus in the property panel
+ bool myIsObligatory;
+
private:
/// Value should be computed on execute, like radius for circle's constraint (can not be zero)
- bool myIsComputedDefault;
-
+ bool myIsComputedDefault;
+
/// the default value, which is defined in the XML for this attribute
- std::string myDefaultValue;
+ std::string myDefaultValue;
+
+ /// the reset state. If it is false, the reset method of the widget is not performed
+ bool myUseReset;
};
#endif