-/*
- * Config_WidgetAPI.h
- *
- * Created on: Apr 1, 2014
- * Author: sbh
- */
+// Copyright (C) 2014-2023 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_
struct _xmlDoc;
//<<
-class CONFIG_EXPORT Config_WidgetAPI
+/*!
+ * \class Config_WidgetAPI
+ * \ingroup Config
+ * \brief Provides low-level API for WidgetFactory for reading xml definitions of widgets
+ */
+class Config_WidgetAPI
{
public:
- virtual ~Config_WidgetAPI();
-
- 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;
+ CONFIG_EXPORT virtual ~Config_WidgetAPI();
- std::string getProperty(const char* thePropName) const;
+ //! Returns name of widget's node (attribute)
+ CONFIG_EXPORT std::string widgetType() const;
+ //! Returns true if widget has container type, which means it able to contain other widgets
+ CONFIG_EXPORT bool isGroupBoxWidget() const;
+ //! Returns true if widget has page type;
+ //! Page is container widget with combo box control to switch between pages
+ CONFIG_EXPORT bool isPagedWidget() 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;
+ //! Returns id of current feature
+ CONFIG_EXPORT std::string featureId() const;
+ //! Returns id of current widget
+ CONFIG_EXPORT std::string widgetId() const;
+ //! Returns icon of current widget
+ CONFIG_EXPORT std::string widgetIcon() const;
+ //! Returns text for label of current widget
+ CONFIG_EXPORT std::string widgetLabel() const;
+ //! Returns text for tooltip of current widget
+ CONFIG_EXPORT std::string widgetTooltip() const;
+ //! Returns a custom property of current widget
+ CONFIG_EXPORT std::string getProperty(const char* thePropName) const;
- bool isComputedDefault() 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
+ */
+ CONFIG_EXPORT bool getBooleanAttribute(const char* theAttributeName, bool theDefault) const;
- protected:
/// These fields are accessible for ModuleBase_WidgetFactory only
- Config_WidgetAPI(std::string theRawXml);
- bool toNextWidget();
- bool toChildWidget();
- bool toParentWidget();
+ CONFIG_EXPORT Config_WidgetAPI(std::string theRawXml, const std::string theAttributePrefix = "");
+ //! Pass to the next (sibling) node of widget's xml definition. If impossible, returns false
+ CONFIG_EXPORT bool toNextWidget();
+ //! Pass into the child node of widget's xml definition. If impossible, returns false
+ CONFIG_EXPORT bool toChildWidget();
+ //! Pass into the parent node of widget's xml definition. If impossible, returns false
+ CONFIG_EXPORT bool toParentWidget();
private:
- xmlDocPtr myDoc;
- xmlNodePtr myCurrentNode;
+ xmlDocPtr myDoc; //!< Pointer to the root of widget's xml definition
+ xmlNodePtr myCurrentNode; //!< Pointer to the current node in the widget's xml definition
+ std::string myFeatureId;
+ std::string myAttributePrefix; //!< prefix that must be added to the attribute name
friend class ModuleBase_WidgetFactory;
};
