Update classes documentation

[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetFactory.h

diff --git a/src/ModuleBase/ModuleBase_WidgetFactory.h b/src/ModuleBase/ModuleBase_WidgetFactory.h
index 1e1f29fa76e8dfc54e6de9b682f1efc2881cc0f5..ffc14fe30302c6db69f393b0fe75ecbf862a436a 100644 (file)
--- a/src/ModuleBase/ModuleBase_WidgetFactory.h
+++ b/src/ModuleBase/ModuleBase_WidgetFactory.h
@@ -38,9 +38,20 @@ class MODULEBASE_EXPORT ModuleBase_WidgetFactory
   virtual ~ModuleBase_WidgetFactory();
 
   /// Creates content widget for property panel
-  /// \param theParent a parent widget
-  void createWidget(ModuleBase_PageBase* theParent);
+  /// \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
+  /// \param thePage a parent page
+  /// \param theFeature a feature to fill the panel
+  void createPanel(ModuleBase_PageBase* thePage, const FeaturePtr& theFeature);
 
+  /// Creates one widget for property panel for the widget with given index
+  /// \param thePage a parent widget
+  /// \param theWidgetId a widget index
+  void createWidget(ModuleBase_PageBase* thePage,
+                    const std::string& theWidgetId);
 
   /// Returns list of model widgets
   QList<ModuleBase_ModelWidget*> getModelWidgets() const
@@ -48,12 +59,32 @@ class MODULEBASE_EXPORT ModuleBase_WidgetFactory
     return myModelWidgets;
   }
 
- protected:
+  /// Returns the value of the title key from XML definition of the attribute in the feature
+  /// \param theAttributeId a value of a kind of the attribute under the feature
+  /// \param theTitle the result title
+  void getAttributeTitle(const std::string& theAttributeId,
+                         std::string& theTitle);
+
+  /// Returns the identifier of the first found attribute where greed field value is set and true
+  /// \param theAttributeId an outpup parameter with  attribute
+  void getGreedAttribute(std::string& theAttributeId);
+
+  /// Returns widget API from XML
+  const Config_WidgetAPI* widgetAPI() const { return myWidgetApi; }
+
+protected:
   /// check if ModuleBase_Widget has expandable widgets in getControls
   bool hasExpandingControls(QWidget* theParent);
-   /// Create widget by its type
-   /// \param theType a type
-   /// \param theParent a parent widget
+
+  /// Create page by its type
+  /// \param theType a type
+  /// \param theParent a parent widget
+  ModuleBase_PageBase* createPageByType(const std::string& theType,
+                                        QWidget* theParent);
+
+  /// Create widget by its type
+  /// \param theType a type
+  /// \param theParent a parent widget
   ModuleBase_ModelWidget* createWidgetByType(const std::string& theType,
                                              QWidget* theParent = NULL);
 
@@ -61,6 +92,12 @@ class MODULEBASE_EXPORT ModuleBase_WidgetFactory
   /// \param theStdString is STD string
   static QString qs(const std::string& theStdString);
 
+  /// It updates internal config api to point in the structure to given id of widget
+  /// The method is recusive and it stops when the found flag is true
+  /// \param theWidgetId a widget id key value
+  /// \param theFound a flag about found windget and recursive search should be stopped
+  void moveToWidgetId(const std::string& theWidgetId, bool& theFound);
+
  private:
    /// API object for XML reading
   Config_WidgetAPI* myWidgetApi;
@@ -70,9 +107,6 @@ class MODULEBASE_EXPORT ModuleBase_WidgetFactory
 
   /// List of created model widgets
   QList<ModuleBase_ModelWidget*> myModelWidgets;
-
-  /// Id of current parent
-  std::string myParentId;
 };
 
 #endif /* ModuleBase_WidgetFactory_H_ */