+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
/*
* Config_WidgetAPI.h
*
#ifndef CONFIG_WIDGETAPI_H_
#define CONFIG_WIDGETAPI_H_
-#include <Config.h>
+#include <Config_def.h>
#include <cstdarg>
#include <string>
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();
- void reset();
- bool nextWidget();
+ std::string widgetType() const;
+ bool isContainerWidget() const;
+ bool isPagedWidget() const;
+
+ std::string widgetId() const;
+ std::string widgetIcon() const;
+ std::string widgetLabel() const;
+ std::string widgetTooltip() const;
- std::string widgetType();
+ std::string getProperty(const char* thePropName) const;
- std::string widgetIcon();
- std::string widgetLabel();
- std::string widgetTooltip();
+ /// 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;
- std::string getProperty(const char* thePropName);
+ bool isComputedDefault() const;
-protected:
- bool isNode(xmlNodePtr theNode, const char* name, ...);
+ protected:
+ /// These fields are accessible for ModuleBase_WidgetFactory only
+ Config_WidgetAPI(std::string theRawXml);
+ bool toNextWidget();
+ bool toChildWidget();
+ bool toParentWidget();
-private:
+ private:
xmlDocPtr myDoc;
xmlNodePtr myCurrentNode;
+ friend class ModuleBase_WidgetFactory;
};
#endif /* CONFIG_WIDGETAPI_H_ */