+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
// File: ModuleBase_ModelWidget.h
// Created: 25 Apr 2014
// Author: Natalia ERMOLAEVA
-#ifndef ModuleBase_ModelWidget_H
-#define ModuleBase_ModelWidget_H
+#ifndef MODULEBASE_MODELWIDGET_H
+#define MODULEBASE_MODELWIDGET_H
#include <ModuleBase.h>
+#include <ModuleBase_ViewerPrs.h>
#include <ModelAPI_Feature.h>
-#include <QObject>
+#include <QWidget>
-#include <boost/shared_ptr.hpp>
+#include <memory>
class Config_WidgetAPI;
-class ModelAPI_Feature;
class QKeyEvent;
/**\class ModuleBase_ModelWidget
+ * \ingroup GUI
* \brief An abstract custom widget class. This class realization is assumed to create some controls.
* The controls values modification should send signal about values change.
*
* Every widget are able to save/restore data from the model and/or to contain other widgets.
*
*/
-class MODULEBASE_EXPORT ModuleBase_ModelWidget : public QObject
+class MODULEBASE_EXPORT ModuleBase_ModelWidget : public QWidget
{
- Q_OBJECT
-public:
+Q_OBJECT
+ public:
/// Constructor
- /// \theParent the parent object
- /// \theData the widget configuation. The attribute of the model widget is obtained from
- ModuleBase_ModelWidget(QObject* theParent, const Config_WidgetAPI* theData);
+ /// \param theParent the parent object
+ /// \param theData the widget configuation. 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);
/// Destructor
- virtual ~ModuleBase_ModelWidget() {};
-
- /// Saves the internal parameters to the given feature
- /// \param theFeature a model feature to be changed
- virtual bool storeValue(FeaturePtr theFeature) const = 0;
-
- virtual bool restoreValue(FeaturePtr theFeature) = 0;
-
- /// Returns whether the widget can accept focus, or if it corresponds to the given attribute
- /// \param theAttribute name
- bool canFocusTo(const std::string& theAttributeName) const;
+ virtual ~ModuleBase_ModelWidget()
+ {
+ }
+
+ /// Fills the widget with default values
+ virtual void reset() {};
+
+ /// Returns the state whether the attribute of the feature is initialized
+ /// \param theObject a model feature to be checked
+ /// \return the boolean result
+ bool isInitialized(ObjectPtr theObject) const;
+
+ /// Returns true, if default value of the widget should be computed
+ /// on operation's execute, like radius for circle's constraint (can not be zero)
+ bool isComputedDefault() const { return myIsComputedDefault; }
+
+ /// Returns true, if default value of the widget is defined in the XML and it is not the
+ /// computed value
+ /// \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; }
+
+ /// Defines if it is supposed that the widget should interact with the viewer.
+ virtual bool isViewerSelector() { return false; }
+
+ /// Defines if it is supported to set the value in this widget
+ /// By default it returns true
+ virtual bool canSetValue() const { return true; };
+
+ /// 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 thePosition an index in the list of values, the values should be get from the index
+ virtual bool setSelection(const QList<ModuleBase_ViewerPrs>& theValues, int& thePosition)
+ {
+ return false;
+ }
+
+ /// Restore value from attribute data to the widget's control
+ virtual bool restoreValue() = 0;
/// 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.
- virtual void focusTo();
+ /// \return the state whether the widget can accept the focus
+ virtual bool focusTo();
+
+ /// The methiod called when widget is activated
+ void activate();
+
+ /// The methiod called when widget is deactivated
+ virtual void deactivate() {}
/// Returns list of widget controls
/// \return a control list
virtual QList<QWidget*> getControls() const = 0;
- /// Returns whether the control has a default value
- /// \return a boolean value
- bool hasDefaultValue() const { return myHasDefaultValue; }
+ /// FocusIn events processing
+ virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
+
+ /// \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
+ virtual void setHighlighted(bool isHighlighted);
/// Returns the attribute name
/// \returns the string value
- std::string attributeID() const;
+ std::string attributeID() const
+ {
+ return myAttributeID;
+ }
+
+ /// Returns the parent of the attribute
+ /// \returns the string value
+ std::string parentID() const
+ {
+ return myParentId;
+ }
+
+ /// \return Current feature
+ FeaturePtr feature() const
+ {
+ return myFeature;
+ }
+
+ /// Set feature which is processing by active operation
+ /// \param theToStoreValue a value about necessity to store the widget value to the feature
+ void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false);
+
+ /// Editing mode depends on mode of current operation. This value is defined by it.
+ void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
+
+ /// \return Current Editing mode
+ bool isEditingMode() const { return myIsEditing; }
signals:
+ /// The signal about widget values are to be changed
+ void beforeValuesChanged();
/// The signal about widget values changed
void valuesChanged();
+ /// The signal about widget values are to be changed
+ void afterValuesChanged();
+
/// The signal about key release on the control, that corresponds to the attribute
- /// \param theAttributeName a name of the attribute
/// \param theEvent key release event
- void keyReleased(const std::string& theAttributeName, QKeyEvent* theEvent);
+ void keyReleased(QKeyEvent* theEvent);
+
+ /// The signal about the widget is get focus
+ /// \param theWidget the model base widget
+ void focusInWidget(ModuleBase_ModelWidget* theWidget);
+
/// The signal about the widget is lost focus
/// \param theWidget the model base widget
void focusOutWidget(ModuleBase_ModelWidget* theWidget);
-protected:
- bool myHasDefaultValue; /// the boolean state whether the control has a default value
+ protected:
+ /// Sets default value of widget. Nornaly, 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)
+ {
+ myAttributeID = theAttribute;
+ }
+
+ /// 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;
+
+ /// The methiod called when widget is activated
+ virtual void activateCustom() {};
+
+ /// Sends Update and Redisplay for the given object
+ /// \param theObj is updating object
+ void updateObject(ObjectPtr theObj) const;
+
+ /// Sends Move event for the given object
+ /// \param theObj is object for moving
+ void moveObject(ObjectPtr theObj) const;
+
+protected slots:
+ /// Processing of values changed in model widget by store the current value to the feature
+ void onWidgetValuesChanged();
+
+ protected:
+
+ /// The attribute name of the model feature
+ std::string myAttributeID;
+
+ /// Name of parent
+ std::string myParentId;
+
+ /// A feature which is processing by active operation
+ 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:
- std::string myAttributeID; /// the attribute name of the model feature
+ /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
+ bool myIsComputedDefault;
+
+ /// the default value, which is defined in the XML for this attribute
+ std::string myDefaultValue;
};
#endif
