X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FConfig%2FConfig_WidgetAPI.h;h=2c2cd9c7165015879a397dc73dceac73e74aa717;hb=60e95a5502a6940c6c27ce5d561b3c684b0b0a4f;hp=ad084049f76e147a9b0e468684e9a7694fceccaf;hpb=853952fd4ddc93c0cd6a7122d37b618199864396;p=modules%2Fshaper.git diff --git a/src/Config/Config_WidgetAPI.h b/src/Config/Config_WidgetAPI.h index ad084049f..2c2cd9c71 100644 --- 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,17 +27,15 @@ typedef xmlDoc *xmlDocPtr; 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); virtual ~Config_WidgetAPI(); - //TODO(sbh): Make these fields protected, accessible only for WidgetFactory - bool toNextWidget(); - bool toChildWidget(); - bool toParentWidget(); - std::string widgetType() const; bool isContainerWidget() const; bool isPagedWidget() const; @@ -47,10 +47,28 @@ class CONFIG_EXPORT Config_WidgetAPI std::string getProperty(const char* thePropName) const; + /// 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_ */