Process validators on the first feature's creation using the Config_ValidatorReader

[modules/shaper.git] / src / Config / Config_WidgetAPI.h

diff --git a/src/Config/Config_WidgetAPI.h b/src/Config/Config_WidgetAPI.h
index 190ccfc7fafd450dcd7ea1ea931414cf43b35455..a44ce55a42cae5ab7ee18d7469b7d7e6fdcb258e 100644 (file)
--- a/src/Config/Config_WidgetAPI.h
+++ b/src/Config/Config_WidgetAPI.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 /*
  * Config_WidgetAPI.h
  *
@@ -25,32 +27,59 @@ typedef xmlDoc *xmlDocPtr;
 struct _xmlDoc;
 //<<
 
-
+/*!
+ * \class Config_WidgetAPI
+ * \ingroup Config
+ * \brief Provides low-level API for WidgetFactory for reading xml definitions of widgets
+ */
 class CONFIG_EXPORT Config_WidgetAPI
 {
-public:
-  Config_WidgetAPI(std::string theRawXml);
+ public:
   virtual ~Config_WidgetAPI();
 
-  bool toNextWidget();
-  bool toChildWidget();
-  bool toParentWidget();
-
+  //! Returns name of widget's node (attribute)
   std::string widgetType() const;
+  //! Returns true if widget has container type, which means it able to contain other widgets
   bool isContainerWidget() const;
+  //! Returns true if widget has page type;
+  //! Page is container widget with combo box control to switch between pages
   bool isPagedWidget() const;
 
+  //! Returns id of current widget
   std::string widgetId() const;
+  //! Returns icon of current widget
   std::string widgetIcon() const;
+  //! Returns text for label of current widget
   std::string widgetLabel() const;
+  //! Returns text for tooltip of current widget
   std::string widgetTooltip() const;
-
+  //! Returns a custom property of current widget
   std::string getProperty(const char* thePropName) const;
 
-private:
-  xmlDocPtr myDoc;
-  xmlNodePtr myCurrentNode;
+  /*! Checks if the XML representation of widget has given attribute,
+   *  if yes - returns it's bool value, if no, or if the value can not
+   *  be converted to bool - returns theDefault.
+   *  \param theAttributeName attribute to check
+   *  \param theDefault default value on bad data
+   *  \return the boolean result
+   */
+  bool getBooleanAttribute(const char* theAttributeName, bool theDefault) const;
+
+ protected:
+  /// These fields are accessible for ModuleBase_WidgetFactory only
+  Config_WidgetAPI(std::string theRawXml);
+  //! Pass to the next (sibling) node of widget's xml definition. If impossible, returns false
+  bool toNextWidget();
+  //! Pass into the child node of widget's xml definition. If impossible, returns false
+  bool toChildWidget();
+  //! Pass into the parent node of widget's xml definition. If impossible, returns false
+  bool toParentWidget();
+
+ private:
+  xmlDocPtr myDoc; //!< Pointer to the root of widget's xml definition
+  xmlNodePtr myCurrentNode; //!< Pointer to the current node in the widget's xml definition
 
+  friend class ModuleBase_WidgetFactory;
 };
 
 #endif /* CONFIG_WIDGETAPI_H_ */