+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
/*
* Config_WidgetAPI.h
*
struct _xmlDoc;
//<<
-
+/*!
+ * \class Config_WidgetAPI
+ * \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();
-
std::string widgetType() const;
bool isContainerWidget() const;
bool isPagedWidget() const;
std::string getProperty(const char* thePropName) const;
-private:
+ /// 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;
+
+ bool isComputedDefault() const;
+
+ protected:
+ /// These fields are accessible for ModuleBase_WidgetFactory only
+ Config_WidgetAPI(std::string theRawXml);
+ bool toNextWidget();
+ bool toChildWidget();
+ bool toParentWidget();
+
+ private:
xmlDocPtr myDoc;
xmlNodePtr myCurrentNode;
+ friend class ModuleBase_WidgetFactory;
};
#endif /* CONFIG_WIDGETAPI_H_ */