Config_WidgetAPI.h

// Copyright (C) 2014-2026  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef CONFIG_WIDGETAPI_H_
#define CONFIG_WIDGETAPI_H_
 
#include <Config_def.h>
 
#include <cstdarg>
#include <string>
 
//>> Forward declaration of xmlNodePtr.
typedef struct _xmlNode xmlNode;
typedef xmlNode *xmlNodePtr;
struct _xmlNode;
//<<
 
//>> Forward declaration of xmlDocPtr.
typedef struct _xmlDoc xmlDoc;
typedef xmlDoc *xmlDocPtr;
struct _xmlDoc;
//<<
 
class Config_WidgetAPI
{
 public:
  CONFIG_EXPORT virtual ~Config_WidgetAPI();
 
  CONFIG_EXPORT std::string widgetType() const;
  CONFIG_EXPORT bool isGroupBoxWidget() const;
  CONFIG_EXPORT bool isPagedWidget() const;
 
  CONFIG_EXPORT std::string featureId() const;
  CONFIG_EXPORT std::string widgetId() const;
  CONFIG_EXPORT std::string widgetIcon() const;
  CONFIG_EXPORT std::string widgetLabel() const;
  CONFIG_EXPORT std::string widgetTooltip() const;
  CONFIG_EXPORT std::string getProperty(const char* thePropName) const;
 
  CONFIG_EXPORT bool getBooleanAttribute(const char* theAttributeName, bool theDefault) const;
 
  CONFIG_EXPORT Config_WidgetAPI(std::string theRawXml, const std::string theAttributePrefix = "");
  CONFIG_EXPORT bool toNextWidget();
  CONFIG_EXPORT bool toChildWidget();
  CONFIG_EXPORT bool toParentWidget();
 
 private:
  xmlDocPtr myDoc; 
  xmlNodePtr myCurrentNode; 
  std::string myFeatureId;
  std::string myAttributePrefix; 
 
  friend class ModuleBase_WidgetFactory;
};
 
#endif /* CONFIG_WIDGETAPI_H_ */