#define MODULEBASE_MODELWIDGET_H
#include <ModuleBase.h>
-#include <ModuleBase_ViewerPrs.h>
#include <ModuleBase_OperationFeature.h>
#include <ModelAPI_Feature.h>
class Config_WidgetAPI;
class ModuleBase_IWorkshop;
+class ModuleBase_ViewerPrs;
+class ModuleBase_WidgetValidator;
class QKeyEvent;
/**\class ModuleBase_ModelWidget
/// Constructor
/// \param theParent the parent object
/// \param theData the widget configuration. The attribute of the model widget is obtained from
- /// \param theData a low-level API for reading xml definitions of widgets
+ /// a low-level API for reading xml definitions of widgets
ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData);
/// Destructor
virtual ~ModuleBase_ModelWidget()
/// \return the enumeration result
ValueState getValueState() const { return myState; }
+ /// Stores the widget value if it is modified
+ void processValueState();
+
/// Returns an attribute error according to the value state
/// It exists in all cases excepring the "Store" case
QString getValueStateError() const;
/// Defines if it is supported to set the value in this widget
/// By default it returns true
- virtual bool canSetValue() const { return true; };
+ virtual bool canAcceptFocus() const { return true; };
//! Returns the widget error, get it from the attribute validator and state of the widget
//! If the feature is correct, it returns an empty value
+ //! \param theValueStateChecked the boolean flag if the state of the widget should be checked
//! \return string value
- QString getError() const;
+ QString getError(const bool theValueStateChecked = true) const;
/// Set the given wrapped value to the current widget
/// This value should be processed in the widget according to the needs
/// \param theValues the wrapped selection values
/// \param theToValidate the boolean value whether the value should be checked by filters
- virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
+ virtual bool setSelection(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues,
const bool theToValidate)
{
return false;
/// Returns values which should be highlighted when the whidget is active
/// \param theValues a list of presentations
- virtual void getHighlighted(QList<ModuleBase_ViewerPrs>& theValues) {};
+ virtual void getHighlighted(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues) {};
+
+ /// Checks if the selection presentation is valid in widget
+ /// \param theValue a selected presentation in the view
+ /// \return a boolean value
+ virtual bool isValidSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& theValue) { return true; }
+
+ /// Returns widget validator, by default it is NULL. To be created in a child if necessary
+ ModuleBase_WidgetValidator* widgetValidator() { return myWidgetValidator; }
/// Restore value from attribute data to the widget's control. Emits signals before and after store
/// \return True in success
bool restoreValue();
+ /// Saves the internal parameters to the given feature. Emits signals before and after store
+ /// \return True in success
+ bool storeValue();
+
/// 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
/// Set feature which is processing by active operation
/// \param theFeature a feature object
/// \param theToStoreValue a value about necessity to store the widget value to the feature
- void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false);
+ /// \param isUpdateFlushed a flag if update should be flushed on store value
+ void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false,
+ const bool isUpdateFlushed = true);
/// Editing mode depends on mode of current operation. This value is defined by it.
- void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
+ virtual void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
/// \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);
+ void updateObject(ObjectPtr theObj);
/// Sends Move event for the given object
/// \param theObj is object for moving
static void moveObject(ObjectPtr theObj);
- /// Sends a message about block/unblock viewer updating
- /// \param theValue a boolean value
- static void blockUpdateViewer(const bool theValue);
-
signals:
/// The signal about widget values are to be changed
void beforeValuesChanged();
/// The signal about value state modification
void valueStateChanged(int theState);
+ /// The signal is emitted after flush of updates singal for the widget
+ void objectUpdated();
+
protected:
/// Sets default value of widget. Normally, widget should fetch this value
/// from the xml. However, some widgets derived widgets could define it
/// or store the control value to the feature
virtual void initializeValueByActivate();
- /// Saves the internal parameters to the given feature. Emits signals before and after store
- /// \return True in success
- bool storeValue();
-
/// Saves the internal parameters to the given feature
/// \return True in success
- virtual bool storeValueCustom() const = 0;
+ virtual bool storeValueCustom() = 0;
/// Restore value from attribute data to the widget's control
virtual bool restoreValueCustom() = 0;
void onWidgetValuesModified();
protected:
+ /// own validator, by default it is zero
+ ModuleBase_WidgetValidator* myWidgetValidator;
/// The attribute name of the model feature
std::string myAttributeID;
bool myUseReset;
/// blocked flag of modification of the value state
bool myIsValueStateBlocked;
-
- friend class ModuleBase_OperationFeature; // to call storeValue() by commit if value state is ModifiedInPP
+ /// do not flush updated signal
+ bool myFlushUpdateBlocked;
};
#endif
