From: vsv Date: Thu, 5 May 2016 14:23:00 +0000 (+0300) Subject: Update classes documentation X-Git-Tag: V_2.3.0~15 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=49d5a27258260087aad5e7ca30d6863e08a186d1;p=modules%2Fshaper.git Update classes documentation --- diff --git a/src/ModuleBase/ModuleBase_Dialog.h b/src/ModuleBase/ModuleBase_Dialog.h index 6b3074de5..bb58343f6 100644 --- a/src/ModuleBase/ModuleBase_Dialog.h +++ b/src/ModuleBase/ModuleBase_Dialog.h @@ -21,23 +21,41 @@ class ModuleBase_Dialog : public QDialog { Q_OBJECT public: + /// Constructor + /// \param theParent a workshop object instance + /// \param theId an Id of a feature + /// \param theDescription an XML description of the feature ModuleBase_Dialog(ModuleBase_IWorkshop* theParent, const QString& theId, const std::string& theDescription); + /// Redefinition of virtual method virtual void accept(); protected: + /// Redefinition of virtual method virtual void showEvent(QShowEvent* theEvent); private: + /// Initialising of the widget void initializeWidget(ModuleBase_ModelWidget* theWidget); + /// Id of the feature QString myId; + + /// XML description of the feature std::string myDescription; + + /// An instance of workshop object ModuleBase_IWorkshop* myWorkshop; + + /// The feature instance FeaturePtr myFeature; + + /// List of created widgets QList myWidgets; + + /// Pointer on active widget ModuleBase_ModelWidget* myActiveWidget; }; diff --git a/src/ModuleBase/ModuleBase_DoubleSpinBox.h b/src/ModuleBase/ModuleBase_DoubleSpinBox.h index 4fbdbccb2..8c60c6d2d 100644 --- a/src/ModuleBase/ModuleBase_DoubleSpinBox.h +++ b/src/ModuleBase/ModuleBase_DoubleSpinBox.h @@ -56,7 +56,6 @@ Q_OBJECT signals: /// The signal about key release on the control, that corresponds to the attribute - /// \param theEvent key release event void enterReleased(); protected slots: diff --git a/src/ModuleBase/ModuleBase_IModule.h b/src/ModuleBase/ModuleBase_IModule.h index 0ba438d20..769af80dc 100755 --- a/src/ModuleBase/ModuleBase_IModule.h +++ b/src/ModuleBase/ModuleBase_IModule.h @@ -60,10 +60,10 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject /// Remove default selection filters of the module from the current viewer virtual void deactivateSelectionFilters() {}; - // Stores the current selection + /// Stores the current selection virtual void storeSelection() {}; - // Restores the current selection + /// Restores the current selection virtual void restoreSelection() {}; /// Reads description of features from XML file @@ -111,6 +111,7 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject /// Add menu items for viewer into the actions map /// \param theStdActions a map of standard actions + /// \param theParent a parent widget /// \param theMenuActions map of action/menu for the desirable index in the viewer menu /// \return true if items are added and there is no necessity to provide standard menu virtual bool addViewerMenu(const QMap& theStdActions, @@ -197,7 +198,7 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject virtual void activeSelectionModes(QIntList& theModes) {} /// Activate custom presentation for the object. Default realization is empty. - /// \param theObject an object instance + /// \param theFeature a feature instance /// \param theFlag a flag of level of customization, which means that only part of sub-elements /// \param theUpdateViewer the parameter whether the viewer should be update immediately virtual void activateCustomPrs(const FeaturePtr& theFeature, diff --git a/src/ModuleBase/ModuleBase_IViewer.h b/src/ModuleBase/ModuleBase_IViewer.h index 51dc03dae..374e526bd 100644 --- a/src/ModuleBase/ModuleBase_IViewer.h +++ b/src/ModuleBase/ModuleBase_IViewer.h @@ -40,6 +40,7 @@ Q_OBJECT //! Returns Vsd_View object from currently active view window virtual Handle(V3d_View) activeView() const = 0; + //! Returns currently active view port widget virtual QWidget* activeViewPort() const = 0; //! Enable or disable selection in the viewer diff --git a/src/ModuleBase/ModuleBase_IWidgetCreator.h b/src/ModuleBase/ModuleBase_IWidgetCreator.h index eac988263..b3018f044 100755 --- a/src/ModuleBase/ModuleBase_IWidgetCreator.h +++ b/src/ModuleBase/ModuleBase_IWidgetCreator.h @@ -39,11 +39,11 @@ public: /// Returns a container of possible page types, which this creator can process /// The default implementation is empty - /// \param a list of type names + /// \param theTypes a list of type names virtual void pageTypes(std::set& theTypes) {} /// Returns a container of possible widget types, which this creator can process - /// \param a list of type names + /// \param theTypes a list of type names virtual void widgetTypes(std::set& theTypes) {} /// Create panel control by its type. @@ -60,7 +60,7 @@ public: /// The default implementation is empty /// \param theType a type /// \param theParent a parent widget - /// \param theData a low-level API for reading xml definitions of widgets + /// \param theWidgetApi a low-level API for reading xml definitions of widgets virtual ModuleBase_PageBase* createPageByType(const std::string& theType, QWidget* theParent, Config_WidgetAPI* theWidgetApi); @@ -69,7 +69,8 @@ public: /// The default implementation is empty /// \param theType a type /// \param theParent a parent widget - /// \param theData a low-level API for reading xml definitions of widgets + /// \param theWidgetApi a low-level API for reading xml definitions of widgets + /// \param theWorkshop a workshop class instance virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent, Config_WidgetAPI* theWidgetApi, diff --git a/src/ModuleBase/ModuleBase_IWorkshop.h b/src/ModuleBase/ModuleBase_IWorkshop.h index 3d9585930..70c4ae827 100644 --- a/src/ModuleBase/ModuleBase_IWorkshop.h +++ b/src/ModuleBase/ModuleBase_IWorkshop.h @@ -106,8 +106,11 @@ Q_OBJECT /// Update of commands status virtual void updateCommandStatus() = 0; + /// Returns feature info according to given feature ID + /// \param theId a feature Id virtual std::shared_ptr featureInfo(const QString& theId) const = 0; + /// Returns main window of the application virtual QMainWindow* desktop() const = 0; diff --git a/src/ModuleBase/ModuleBase_IntSpinBox.h b/src/ModuleBase/ModuleBase_IntSpinBox.h index 551e5f0b8..31e7836c2 100755 --- a/src/ModuleBase/ModuleBase_IntSpinBox.h +++ b/src/ModuleBase/ModuleBase_IntSpinBox.h @@ -23,6 +23,8 @@ class MODULEBASE_EXPORT ModuleBase_IntSpinBox : public QSpinBox Q_OBJECT public: + /// Constructor + /// \param theParent a parent widget explicit ModuleBase_IntSpinBox(QWidget* theParent = 0); virtual ~ModuleBase_IntSpinBox() {}; diff --git a/src/ModuleBase/ModuleBase_ModelWidget.h b/src/ModuleBase/ModuleBase_ModelWidget.h index 9fe99e4f2..97e388511 100644 --- a/src/ModuleBase/ModuleBase_ModelWidget.h +++ b/src/ModuleBase/ModuleBase_ModelWidget.h @@ -43,7 +43,7 @@ Q_OBJECT /// 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() @@ -291,7 +291,8 @@ protected slots: void onWidgetValuesModified(); protected: - ModuleBase_WidgetValidator* myWidgetValidator; /// own validator, by default it is zero + /// own validator, by default it is zero + ModuleBase_WidgetValidator* myWidgetValidator; /// The attribute name of the model feature std::string myAttributeID; diff --git a/src/ModuleBase/ModuleBase_OperationFeature.h b/src/ModuleBase/ModuleBase_OperationFeature.h index 6bc625b3e..268b1d759 100755 --- a/src/ModuleBase/ModuleBase_OperationFeature.h +++ b/src/ModuleBase/ModuleBase_OperationFeature.h @@ -106,11 +106,11 @@ Q_OBJECT /// \param theProp a property panel instance virtual void setPropertyPanel(ModuleBase_IPropertyPanel* theProp); - /// \return Currently installed property panel + // \return Currently installed property panel //ModuleBase_IPropertyPanel* propertyPanel() const { return myPropertyPanel; } /// Activates widgets by preselection if it is accepted. - /// \param theGreeAttributeId a greed attribute id if there is in the current feature + /// \param theGreedAttributeId a greed attribute id if there is in the current feature /// \return last filled widget virtual ModuleBase_ModelWidget* activateByPreselection(const std::string& theGreedAttributeId); diff --git a/src/ModuleBase/ModuleBase_ParamIntSpinBox.h b/src/ModuleBase/ModuleBase_ParamIntSpinBox.h index d72895301..62f8fd679 100644 --- a/src/ModuleBase/ModuleBase_ParamIntSpinBox.h +++ b/src/ModuleBase/ModuleBase_ParamIntSpinBox.h @@ -27,20 +27,25 @@ public: The value is initially set to 0.00. \param theParent a parent object - \param thePrecision a precision of values display */ explicit ModuleBase_ParamIntSpinBox(QWidget* theParent = 0); virtual ~ModuleBase_ParamIntSpinBox(); virtual void stepBy(int); + /// Convert Int value from text string virtual int valueFromText(const QString&) const; - virtual QString textFromValue(int value) const; + /// Convert text string from int value + virtual QString textFromValue(int) const; + + /// Validate the value virtual QValidator::State validate(QString&, int&) const; + /// Set current int value virtual void setValue(int); + /// Set current text value virtual void setText(const QString&); /// Set a flag about accepted variable diff --git a/src/ModuleBase/ModuleBase_ResultPrs.h b/src/ModuleBase/ModuleBase_ResultPrs.h index 165406ec2..7ed3db9cc 100644 --- a/src/ModuleBase/ModuleBase_ResultPrs.h +++ b/src/ModuleBase/ModuleBase_ResultPrs.h @@ -25,11 +25,19 @@ DEFINE_STANDARD_HANDLE(ModuleBase_BRepOwner, StdSelect_BRepOwner) class ModuleBase_BRepOwner: public StdSelect_BRepOwner { public: + /// Constructor + /// \param aShape an owner shape + /// \param aPriority drawig priority + /// \param ComesFromDecomposition decomposition flag ModuleBase_BRepOwner(const TopoDS_Shape& aShape, const Standard_Integer aPriority = 0, const Standard_Boolean ComesFromDecomposition = Standard_False) : StdSelect_BRepOwner(aShape, aPriority, ComesFromDecomposition) {} + /// Highlight the presentation with the given color + /// \param aPM a presentations manager + /// \param aCol a color + /// \param aMode a drawing mode virtual void HilightWithColor (const Handle(PrsMgr_PresentationManager3d)& aPM, const Quantity_NameOfColor aCol, const Standard_Integer aMode = 0) { Selectable()->HilightOwnerWithColor(aPM, aCol, this); } diff --git a/src/ModuleBase/ModuleBase_WidgetCheckGroupBox.h b/src/ModuleBase/ModuleBase_WidgetCheckGroupBox.h index d9d9f533c..7bc9b041d 100755 --- a/src/ModuleBase/ModuleBase_WidgetCheckGroupBox.h +++ b/src/ModuleBase/ModuleBase_WidgetCheckGroupBox.h @@ -29,6 +29,8 @@ public: ModuleBase_WidgetCheckGroupBox(QWidget* theParent, const Config_WidgetAPI* theData); virtual ~ModuleBase_WidgetCheckGroupBox(); + /// Set the title of the group box + /// \param theTitle the text of the title void setTitle(const QString& theTitle); /// Methods to be redefined from ModuleBase_PageBase: start diff --git a/src/ModuleBase/ModuleBase_WidgetChoice.h b/src/ModuleBase/ModuleBase_WidgetChoice.h index e5c66a9cc..f88a56e7f 100644 --- a/src/ModuleBase/ModuleBase_WidgetChoice.h +++ b/src/ModuleBase/ModuleBase_WidgetChoice.h @@ -60,6 +60,9 @@ Q_OBJECT QString getPropertyPanelTitle(int theIndex); signals: + /// Segnal about selected item + /// \param theWidget selected widget + /// \param theIndex selected index void itemSelected(ModuleBase_ModelWidget* theWidget, int theIndex); protected: diff --git a/src/ModuleBase/ModuleBase_WidgetCreatorFactory.h b/src/ModuleBase/ModuleBase_WidgetCreatorFactory.h index 5cbc34c06..e5ffb3369 100755 --- a/src/ModuleBase/ModuleBase_WidgetCreatorFactory.h +++ b/src/ModuleBase/ModuleBase_WidgetCreatorFactory.h @@ -32,7 +32,7 @@ class QWidget; class MODULEBASE_EXPORT ModuleBase_WidgetCreatorFactory { public: - // Returns an singular instance of the class if it exists or create it + /// Returns an singular instance of the class if it exists or create it static std::shared_ptr get(); /// Destructor @@ -63,6 +63,7 @@ class MODULEBASE_EXPORT ModuleBase_WidgetCreatorFactory /// Create page by its type /// \param theType a type /// \param theParent a parent widget + /// \param theWidgetApi the widget configuration. The attribute of the model widget is obtained from XML /// \return a created page or null ModuleBase_PageBase* createPageByType(const std::string& theType, QWidget* theParent, @@ -71,6 +72,8 @@ class MODULEBASE_EXPORT ModuleBase_WidgetCreatorFactory /// Create widget by its type /// \param theType a type /// \param theParent a parent widget + /// \param theWidgetApi the widget configuration. The attribute of the model widget is obtained from XML + /// \param theWorkshop a workshop object instance /// \return a created widget or null ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent, diff --git a/src/ModuleBase/ModuleBase_WidgetEditor.h b/src/ModuleBase/ModuleBase_WidgetEditor.h index 049188026..d9c0671f7 100644 --- a/src/ModuleBase/ModuleBase_WidgetEditor.h +++ b/src/ModuleBase/ModuleBase_WidgetEditor.h @@ -47,6 +47,9 @@ Q_OBJECT /// \return true if the editor value is accepted bool showPopupEditor(const bool theSendSignals = true); + /// Set current cursor position + /// \param theX the X coordinate + /// \param theY the Y coordinate void setCursorPosition(const int theX, const int theY); private: diff --git a/src/ModuleBase/ModuleBase_WidgetExprEditor.h b/src/ModuleBase/ModuleBase_WidgetExprEditor.h index ef04f2386..b542808f4 100644 --- a/src/ModuleBase/ModuleBase_WidgetExprEditor.h +++ b/src/ModuleBase/ModuleBase_WidgetExprEditor.h @@ -100,7 +100,6 @@ class MODULEBASE_EXPORT ModuleBase_WidgetExprEditor : public ModuleBase_ModelWid /// Constructor /// \param theParent the parent object /// \param theData the widget configuration. - /// \param theParentId is Id of a parent of the current attribute /// \param thePlaceHolder a placeholder string ModuleBase_WidgetExprEditor( QWidget* theParent, const Config_WidgetAPI* theData, diff --git a/src/ModuleBase/ModuleBase_WidgetFactory.h b/src/ModuleBase/ModuleBase_WidgetFactory.h index 8fddaa4dd..ffc14fe30 100644 --- a/src/ModuleBase/ModuleBase_WidgetFactory.h +++ b/src/ModuleBase/ModuleBase_WidgetFactory.h @@ -39,6 +39,7 @@ class MODULEBASE_EXPORT ModuleBase_WidgetFactory /// Creates content widget for property panel /// \param thePage a parent page + /// \param alignToTop align to top flag (true by default) void createWidget(ModuleBase_PageBase* thePage, bool alignToTop = true); /// Creates property panel content for the feature @@ -47,7 +48,7 @@ class MODULEBASE_EXPORT ModuleBase_WidgetFactory void createPanel(ModuleBase_PageBase* thePage, const FeaturePtr& theFeature); /// Creates one widget for property panel for the widget with given index - /// \param theParent a parent widget + /// \param thePage a parent widget /// \param theWidgetId a widget index void createWidget(ModuleBase_PageBase* thePage, const std::string& theWidgetId); diff --git a/src/ModuleBase/ModuleBase_WidgetMultiSelector.h b/src/ModuleBase/ModuleBase_WidgetMultiSelector.h index 56aa91a23..946007d61 100755 --- a/src/ModuleBase/ModuleBase_WidgetMultiSelector.h +++ b/src/ModuleBase/ModuleBase_WidgetMultiSelector.h @@ -180,8 +180,10 @@ protected: /// Provides correspondance between Result object and its shape typedef QPair GeomSelection; - /// An action for pop-up menu in a list control + /// A copy action for pop-up menu in a list control QAction* myCopyAction; + + /// A delete action for pop-up menu in a list control QAction* myDeleteAction; /// A flag to store use_choice parameter state diff --git a/src/ModuleBase/ModuleBase_WidgetSelector.h b/src/ModuleBase/ModuleBase_WidgetSelector.h index b6af3a3f9..f39b74717 100755 --- a/src/ModuleBase/ModuleBase_WidgetSelector.h +++ b/src/ModuleBase/ModuleBase_WidgetSelector.h @@ -109,8 +109,9 @@ protected: //----------- Class members ------------- /// Returns a name in the next form: attribute_feature_name/attribute_id /// \param theAttribute a model attribute + /// \param theWorkshop a workshop class instance /// \return string value - static std::string generateName(const AttributePtr& theAttribite, + static std::string generateName(const AttributePtr& theAttribute, ModuleBase_IWorkshop* theWorkshop); }; diff --git a/src/ModuleBase/ModuleBase_WidgetValidated.h b/src/ModuleBase/ModuleBase_WidgetValidated.h index 87432cb72..f20a298c4 100644 --- a/src/ModuleBase/ModuleBase_WidgetValidated.h +++ b/src/ModuleBase/ModuleBase_WidgetValidated.h @@ -74,6 +74,7 @@ protected: /// to current attribute by setting the value inside and calling validators. After this, /// the previous attribute value is restored.The valid/invalid value is cashed. /// \param theValue a selected presentation in the view + /// \param theAttribute the attribute /// \return a boolean value bool isValidSelectionForAttribute(const std::shared_ptr& theValue, const AttributePtr& theAttribute); @@ -118,7 +119,7 @@ protected: /// Block the model flush of update and intialization of attribute /// \param theAttribute an attribute of blocking /// \param theToBlock flag whether the model is blocked or unblocked - /// \param isActive out value if model is blocked, in value if model is unblocked + /// \param isFlushesActived out value if model is blocked, in value if model is unblocked /// to be used to restore flush state when unblocked /// \param isAttributeSetInitializedBlocked out value if model is blocked /// in value if model is unblocked to be used to restore previous state when unblocked diff --git a/src/ModuleBase/ModuleBase_WidgetValidator.h b/src/ModuleBase/ModuleBase_WidgetValidator.h index ead80e794..db9719b80 100755 --- a/src/ModuleBase/ModuleBase_WidgetValidator.h +++ b/src/ModuleBase/ModuleBase_WidgetValidator.h @@ -67,8 +67,8 @@ protected: ModuleBase_ModelWidget* myModelWidget; ///< the current widget to be validated ModuleBase_IWorkshop* myWorkshop; ///< the active workshop - QList> myValidPrs; /// cash of valid selection presentations - QList> myInvalidPrs; /// cash of invalid selection presentations + QList> myValidPrs; ///< cash of valid selection presentations + QList> myInvalidPrs; ///< cash of invalid selection presentations }; #endif /* ModuleBase_WidgetValidator_H_ */ diff --git a/src/ParametersPlugin/ParametersPlugin_WidgetCreator.h b/src/ParametersPlugin/ParametersPlugin_WidgetCreator.h index 872fd5511..d6878a68e 100644 --- a/src/ParametersPlugin/ParametersPlugin_WidgetCreator.h +++ b/src/ParametersPlugin/ParametersPlugin_WidgetCreator.h @@ -25,20 +25,20 @@ public: ParametersPlugin_WidgetCreator(); /// Returns a container of possible widget types, which this creator can process - /// \param a list of type names + /// \param theTypes a list of type names virtual void widgetTypes(std::set& theTypes); /// Create widget by its type /// The default implementation is empty /// \param theType a type /// \param theParent a parent widget - /// \param theData a low-level API for reading xml definitions of widgets + /// \param theWidgetApi a low-level API for reading xml definitions of widgets /// \param theWorkshop a current workshop /// \return a created model widget or null virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent, Config_WidgetAPI* theWidgetApi, - ModuleBase_IWorkshop* /*theWorkshop*/); + ModuleBase_IWorkshop* theWorkshop); }; #endif diff --git a/src/ParametersPlugin/ParametersPlugin_WidgetParamsMgr.cpp b/src/ParametersPlugin/ParametersPlugin_WidgetParamsMgr.cpp index 4978f2a9b..679d42896 100644 --- a/src/ParametersPlugin/ParametersPlugin_WidgetParamsMgr.cpp +++ b/src/ParametersPlugin/ParametersPlugin_WidgetParamsMgr.cpp @@ -41,22 +41,39 @@ const char* NoName = ""; const char* NoValue = ""; const char* NotValid = ""; +/*! + * \ingroup GUI + * ItemDelegate object in order to redefine items behavior + */ class ParametersPlugin_ItemDelegate : public QStyledItemDelegate { public: + /// Constructor + /// \param thaParent a parent ParametersPlugin_ItemDelegate(QObject* thaParent) : QStyledItemDelegate(thaParent) {} + /// Redefinition of virtual method + /// \param painter a painter object + /// \param option the item options + /// \param index the current index virtual void paint(QPainter* painter, const QStyleOptionViewItem& option, const QModelIndex& index ) const; + /// Redefinition of virtual method + /// \param parent a parent widget + /// \param option the item options + /// \param index the current index virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, const QModelIndex& index) const; + /// Returns True if the given index is editable item + /// \param theIndex an item index bool isEditable(const QModelIndex& theIndex) const; + /// Returns currently editing index QModelIndex editIndex() const { return myEditingIdx; } private: diff --git a/src/ParametersPlugin/ParametersPlugin_WidgetParamsMgr.h b/src/ParametersPlugin/ParametersPlugin_WidgetParamsMgr.h index 976238576..4fe132ed7 100644 --- a/src/ParametersPlugin/ParametersPlugin_WidgetParamsMgr.h +++ b/src/ParametersPlugin/ParametersPlugin_WidgetParamsMgr.h @@ -18,13 +18,22 @@ class QPushButton; class QToolButton; +/*! + * \ingroup GUI + * Redefinition of QTreeWidget for processing of closeEditor event + */ class ParametersPlugin_TreeWidget: public QTreeWidget { Q_OBJECT public: + /// Constructor + /// \param theParent a parent widget ParametersPlugin_TreeWidget(QWidget* theParent = 0) : QTreeWidget(theParent) {} protected slots: + /// Redefinition of virtual method + /// \param theEditor a editor widget + /// \param theHint end of editing hint virtual void closeEditor(QWidget* theEditor, QAbstractItemDelegate::EndEditHint theHint); }; diff --git a/src/PartSet/PartSet_MenuMgr.h b/src/PartSet/PartSet_MenuMgr.h index c75493a10..661226ef6 100644 --- a/src/PartSet/PartSet_MenuMgr.h +++ b/src/PartSet/PartSet_MenuMgr.h @@ -84,7 +84,10 @@ private slots: void onEdit(bool); protected: - bool eventFilter(QObject* theObj, QEvent* theEvent); + /// Redefinition of virtual method + /// \param theObj an object + /// \param theEvent an event + virtual bool eventFilter(QObject* theObj, QEvent* theEvent); private: /// Returns true if the current operation is sketch entity create operation diff --git a/src/PartSet/PartSet_Module.h b/src/PartSet/PartSet_Module.h index 925dc1760..eb5e317c2 100755 --- a/src/PartSet/PartSet_Module.h +++ b/src/PartSet/PartSet_Module.h @@ -178,6 +178,7 @@ public: /// Add menu items for viewer into the actions map /// \param theStdActions a map of standard actions + /// \param theParent a parent widget /// \param theMenuActions map of action/menu for the desirable index in the viewer menu /// \return true if items are added and there is no necessity to provide standard menu virtual bool addViewerMenu(const QMap& theStdActions, diff --git a/src/PartSet/PartSet_OverconstraintListener.h b/src/PartSet/PartSet_OverconstraintListener.h index 3e8e5616e..c636920af 100755 --- a/src/PartSet/PartSet_OverconstraintListener.h +++ b/src/PartSet/PartSet_OverconstraintListener.h @@ -33,9 +33,9 @@ public: virtual ~PartSet_OverconstraintListener() {}; - /// Set erroneous color for the presentation of object if the object is in the conflicting list - /// \param theObject an object to be settled - /// \param theUpdateViewer a boolean state whether the current viewer should be updated + // Set erroneous color for the presentation of object if the object is in the conflicting list + // \param theObject an object to be settled + // \param theUpdateViewer a boolean state whether the current viewer should be updated //bool customizeObject(ObjectPtr theObject, const bool theUpdateViewer); /// Returns true if the object belongs to internal container of conflicting objects diff --git a/src/PartSet/PartSet_PreviewPlanes.h b/src/PartSet/PartSet_PreviewPlanes.h index ac94dc350..6ea902663 100755 --- a/src/PartSet/PartSet_PreviewPlanes.h +++ b/src/PartSet/PartSet_PreviewPlanes.h @@ -44,7 +44,6 @@ public: static bool hasVisualizedSketch(ModuleBase_IWorkshop* theWorkshop); /// Returns if the preview was displayed - /// \param theWorkshop the application workshop /// \return boolean value bool isPreviewDisplayed() const { return myPreviewDisplayed; } diff --git a/src/PartSet/PartSet_SketcherReetntrantMgr.h b/src/PartSet/PartSet_SketcherReetntrantMgr.h index 5f68d34ea..2c9a8a431 100755 --- a/src/PartSet/PartSet_SketcherReetntrantMgr.h +++ b/src/PartSet/PartSet_SketcherReetntrantMgr.h @@ -42,7 +42,7 @@ enum RestartingMode { public: /// Constructor - /// \param theParent a parent object + /// \param theWorkshop a workshop instance PartSet_SketcherReetntrantMgr(ModuleBase_IWorkshop* theWorkshop); virtual ~PartSet_SketcherReetntrantMgr(); diff --git a/src/PartSet/PartSet_Tools.h b/src/PartSet/PartSet_Tools.h index bd68e4fb6..3bbebc781 100755 --- a/src/PartSet/PartSet_Tools.h +++ b/src/PartSet/PartSet_Tools.h @@ -239,8 +239,8 @@ public: * Gets all references to the feature, take coincidence constraint features, get point 2d attributes * and compare the point value to be equal with the given. Returns the first feature, which has * equal points. - * \param theSearchInResults a flag whether the conicidence feature shoudl be searched in - * references of the feature results. + * \param theFeature the coincidence feature + * \param thePoint a 2d point * \return the coincidence feature or null */ static FeaturePtr findFirstCoincidence(const FeaturePtr& theFeature, @@ -250,6 +250,7 @@ public: * Returns list of features connected in a councedence feature point * \param theStartCoin the coincidence feature * \param theList a list which collects lines features + * \param theCoincidencies a list of coincidence features * \param theAttr the attribute name */ static void findCoincidences(FeaturePtr theStartCoin, QList& theList, diff --git a/src/PartSet/PartSet_WidgetMultiSelector.h b/src/PartSet/PartSet_WidgetMultiSelector.h index b079c7530..4ec5e1350 100644 --- a/src/PartSet/PartSet_WidgetMultiSelector.h +++ b/src/PartSet/PartSet_WidgetMultiSelector.h @@ -54,6 +54,7 @@ protected: /// Creates a backup of the current values of the attribute /// It should be realized in the specific widget because of different /// parameters of the current attribute + /// \param theAttribute an attribute /// \param theValid a boolean flag, if restore happens for valid parameters virtual void restoreAttributeValue(const AttributePtr& theAttribute, const bool theValid); diff --git a/src/PartSet/PartSet_WidgetPoint2dDistance.h b/src/PartSet/PartSet_WidgetPoint2dDistance.h index 55825c4b6..1c4e05b2a 100644 --- a/src/PartSet/PartSet_WidgetPoint2dDistance.h +++ b/src/PartSet/PartSet_WidgetPoint2dDistance.h @@ -111,9 +111,9 @@ protected: /// Reference to sketch CompositeFeaturePtr mySketch; - bool myValueIsCashed; /// boolean state if the value is cashed during value state change - bool myIsFeatureVisibleInCash; /// boolean value if the feature was visible when cash if filled - double myValueInCash; /// the cashed X value during value state change + bool myValueIsCashed; ///< boolean state if the value is cashed during value state change + bool myIsFeatureVisibleInCash; ///< boolean value if the feature was visible when cash if filled + double myValueInCash; ///< the cashed X value during value state change }; #endif diff --git a/src/PartSet/PartSet_WidgetShapeSelector.h b/src/PartSet/PartSet_WidgetShapeSelector.h index 9f8c44da6..8a0ee84de 100644 --- a/src/PartSet/PartSet_WidgetShapeSelector.h +++ b/src/PartSet/PartSet_WidgetShapeSelector.h @@ -62,6 +62,7 @@ protected: /// Creates a backup of the current values of the attribute /// It should be realized in the specific widget because of different /// parameters of the current attribute + /// \param theAttribute an attribute /// \param theValid a boolean flag, if restore happens for valid parameters void restoreAttributeValue(const AttributePtr& theAttribute, const bool theValid); @@ -72,7 +73,7 @@ protected: /// Pointer to a sketch CompositeFeaturePtr mySketch; - bool myUseSketchPlane; /// state whether the sketch plane filter should be switched on + bool myUseSketchPlane; ///< state whether the sketch plane filter should be switched on }; #endif \ No newline at end of file diff --git a/src/PartSet/PartSet_WidgetSketchLabel.h b/src/PartSet/PartSet_WidgetSketchLabel.h index dc391906f..526207a8a 100644 --- a/src/PartSet/PartSet_WidgetSketchLabel.h +++ b/src/PartSet/PartSet_WidgetSketchLabel.h @@ -73,8 +73,13 @@ public: virtual void setHighlighted(bool) { /*do nothing*/ }; virtual void enableFocusProcessing(); + /// Returns True if the selected presentation can be used for plane definition + /// \param thePrs a presentation static bool canFillSketch(const std::shared_ptr& thePrs); + /// Set sketch plane from selected object + /// \param theFeature a feature of sketch + /// \param thePrs a presentation static bool fillSketchPlaneBySelection(const FeaturePtr& theFeature, const std::shared_ptr& thePrs); @@ -124,8 +129,9 @@ protected: /// Block the model flush of update and intialization of attribute /// In additional to curstom realization it blocks initialization for all feature attributes /// as the current attribute is selection but its modification leads to other attributes change + /// \param theAttribute an attribute /// \param theToBlock flag whether the model is blocked or unblocked - /// \param isActive out value if model is blocked, in value if model is unblocked + /// \param isFlushesActived out value if model is blocked, in value if model is unblocked /// to be used to restore flush state when unblocked /// \param isAttributeSetInitializedBlocked out value if model is blocked /// in value if model is unblocked to be used to restore previous state when unblocked diff --git a/src/XGUI/XGUI_CustomPrs.h b/src/XGUI/XGUI_CustomPrs.h index d8b7147a2..c7fe0bc0b 100644 --- a/src/XGUI/XGUI_CustomPrs.h +++ b/src/XGUI/XGUI_CustomPrs.h @@ -47,7 +47,7 @@ public: protected: - XGUI_Workshop* myWorkshop; /// the current workshop + XGUI_Workshop* myWorkshop; ///< the current workshop }; #endif diff --git a/src/XGUI/XGUI_DataModel.h b/src/XGUI/XGUI_DataModel.h index b43edd8a8..24bcf9cc7 100644 --- a/src/XGUI/XGUI_DataModel.h +++ b/src/XGUI/XGUI_DataModel.h @@ -124,6 +124,7 @@ public: void setXMLReader(Config_DataModelReader* theReader) { myXMLReader = theReader; } signals: + /// Signal about tree had been rebuilt void treeRebuilt(); private: diff --git a/src/XGUI/XGUI_Displayer.h b/src/XGUI/XGUI_Displayer.h index a7b72d22e..b80165b69 100644 --- a/src/XGUI/XGUI_Displayer.h +++ b/src/XGUI/XGUI_Displayer.h @@ -257,7 +257,7 @@ class XGUI_EXPORT XGUI_Displayer: public QObject /// \param theDisplayer a displayer /// \param theObject an object /// \return a boolean value - static bool isVisible(XGUI_Displayer* theDislayer, const ObjectPtr& theObject); + static bool isVisible(XGUI_Displayer* theDisplayer, const ObjectPtr& theObject); signals: /// Signal on object display @@ -353,7 +353,7 @@ private: /// Number of blocking of the viewer update. The viewer is updated only if it equals zero int myViewerBlockedRecursiveCount; - // Flag: use trihedgon for selection or not + /// Flag: use trihedgon for selection or not bool myIsTrihedronActive; /// A flag that update was requested but not done diff --git a/src/XGUI/XGUI_MenuMgr.h b/src/XGUI/XGUI_MenuMgr.h index ac25c80ec..cef7810a1 100755 --- a/src/XGUI/XGUI_MenuMgr.h +++ b/src/XGUI/XGUI_MenuMgr.h @@ -31,13 +31,15 @@ class XGUI_MenuMgr : public Events_Listener { public: /// Constructor - /// \param the current workshop + /// \param theWorkshop the current workshop XGUI_EXPORT XGUI_MenuMgr(XGUI_Workshop* theWorkshop); XGUI_EXPORT virtual ~XGUI_MenuMgr() {} + /// Creates feature actions XGUI_EXPORT void createFeatureActions(); /// Redefinition of Events_Listener method + /// \param theMessage a message XGUI_EXPORT virtual void processEvent(const std::shared_ptr& theMessage); protected: @@ -58,8 +60,8 @@ protected: const std::string& theWchName, const bool aUseSeparator) const; private: - XGUI_Workshop* myWorkshop; /// the current workshop - std::list< std::shared_ptr > myWorkbenches; /// container of existing workbenchs + XGUI_Workshop* myWorkshop; ///< the current workshop + std::list< std::shared_ptr > myWorkbenches; ///< container of existing workbenchs }; #endif /* XGUI_MENUMGR_H_ */ diff --git a/src/XGUI/XGUI_ObjectsBrowser.h b/src/XGUI/XGUI_ObjectsBrowser.h index eff2ffc10..2b9ab1803 100644 --- a/src/XGUI/XGUI_ObjectsBrowser.h +++ b/src/XGUI/XGUI_ObjectsBrowser.h @@ -181,6 +181,8 @@ Q_OBJECT /// Resets the object browser into initial state void clearContent(); + /// Set XML reader object for data model + /// \param theReader the reader object void setXMLReader(Config_DataModelReader* theReader); public slots: diff --git a/src/XGUI/XGUI_OperationMgr.h b/src/XGUI/XGUI_OperationMgr.h index 1d94f4acf..2b3e31069 100755 --- a/src/XGUI/XGUI_OperationMgr.h +++ b/src/XGUI/XGUI_OperationMgr.h @@ -90,6 +90,7 @@ Q_OBJECT /// Redefinition of virtual function /// \param theObject a sender of the event + /// \param theEvent the event virtual bool eventFilter(QObject *theObject, QEvent *theEvent); /// Start the operation and append it to the stack of operations diff --git a/src/XGUI/XGUI_PropertyPanel.h b/src/XGUI/XGUI_PropertyPanel.h index a360a449d..7743a0ffc 100644 --- a/src/XGUI/XGUI_PropertyPanel.h +++ b/src/XGUI/XGUI_PropertyPanel.h @@ -137,6 +137,9 @@ public slots: /// \param theWidget a widget where focus in event happened void onFocusInWidget(ModuleBase_ModelWidget* theWidget); + + /// Activate next widget + /// \param theWidget the current widget void onActivateNextWidget(ModuleBase_ModelWidget* theWidget); signals: diff --git a/src/XGUI/XGUI_SelectionMgr.h b/src/XGUI/XGUI_SelectionMgr.h index 441b52d64..0ca09a167 100644 --- a/src/XGUI/XGUI_SelectionMgr.h +++ b/src/XGUI/XGUI_SelectionMgr.h @@ -55,7 +55,7 @@ Q_OBJECT void clearSelection(); /// Updates selection, which are depend on the selection in the given place - /// \thePlace a widget where selection has happened. + /// \param thePlace a widget where selection has happened. void updateSelectionBy(const ModuleBase_ISelection::SelectionPlace& thePlace); signals: diff --git a/src/XGUI/XGUI_Workshop.h b/src/XGUI/XGUI_Workshop.h index d28b37867..74269e898 100755 --- a/src/XGUI/XGUI_Workshop.h +++ b/src/XGUI/XGUI_Workshop.h @@ -248,7 +248,7 @@ Q_OBJECT //! Delete features. Delete the referenced features. There can be a question with a list of //! referenced objects. - //! \param theList an objects to be deleted + //! \param theFeatures a list of objects to be deleted //! \param theIgnoredFeatures a list of features to be ignored during delete bool deleteFeatures(const QObjectPtrList& theFeatures, const std::set& theIgnoredFeatures = std::set()); diff --git a/src/XGUI/XGUI_WorkshopListener.h b/src/XGUI/XGUI_WorkshopListener.h index 9601486f8..5358253b5 100755 --- a/src/XGUI/XGUI_WorkshopListener.h +++ b/src/XGUI/XGUI_WorkshopListener.h @@ -59,7 +59,10 @@ protected: /// \param theMsg a message with a container of objects void onFeatureRedisplayMsg(const std::shared_ptr& theMsg); + /// Process clearing of presentation + /// \param theMsg an event message void onFeatureEmptyPresentationMsg(const std::shared_ptr& theMsg); + /// Displaus object and fit all viewer if the object is first (update viewer will not be called) /// Asks the module whether the object can be displayed /// \param theObj an object