src/Config/Config_WidgetAPI.h

   1 /*
   2  * Config_WidgetAPI.h
   3  *
   4  *  Created on: Apr 1, 2014
   5  *      Author: sbh
   6  */
   7
   8 #ifndef CONFIG_WIDGETAPI_H_
   9 #define CONFIG_WIDGETAPI_H_
  10
  11 #include <Config_def.h>
  12
  13 #include <cstdarg>
  14 #include <string>
  15
  16 //>> Forward declaration of xmlNodePtr.
  17 typedef struct _xmlNode xmlNode;
  18 typedef xmlNode *xmlNodePtr;
  19 struct _xmlNode;
  20 //<<
  21
  22 //>> Forward declaration of xmlDocPtr.
  23 typedef struct _xmlDoc xmlDoc;
  24 typedef xmlDoc *xmlDocPtr;
  25 struct _xmlDoc;
  26 //<<
  27
  28 class CONFIG_EXPORT Config_WidgetAPI
  29 {
  30  public:
  31   virtual ~Config_WidgetAPI();
  32
  33   std::string widgetType() const;
  34   bool isContainerWidget() const;
  35   bool isPagedWidget() const;
  36
  37   std::string widgetId() const;
  38   std::string widgetIcon() const;
  39   std::string widgetLabel() const;
  40   std::string widgetTooltip() const;
  41
  42   std::string getProperty(const char* thePropName) const;
  43
  44   bool isComputedDefault() const;
  45
  46  protected:
  47   /// These fields are accessible for ModuleBase_WidgetFactory only
  48   Config_WidgetAPI(std::string theRawXml);
  49   bool toNextWidget();
  50   bool toChildWidget();
  51   bool toParentWidget();
  52
  53  private:
  54   xmlDocPtr myDoc;
  55   xmlNodePtr myCurrentNode;
  56
  57   friend class ModuleBase_WidgetFactory;
  58 };
  59
  60 #endif /* CONFIG_WIDGETAPI_H_ */