updated copyright message

[modules/shaper.git] / src / Config / Config_Common.h

diff --git a/src/Config/Config_Common.h b/src/Config/Config_Common.h
index c1379efe62a43196f39f91f581d17c6239476c72..1e547ce947d832b8734d7361171c69d1b3ed852f 100644 (file)
--- a/src/Config/Config_Common.h
+++ b/src/Config/Config_Common.h
@@ -1,11 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-/*
- * Config_Common.h
- *
- *  Created on: Apr 17, 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_COMMON_H_
 #define CONFIG_COMMON_H_
@@ -43,11 +53,24 @@ CONFIG_EXPORT bool isElementNode(xmlNodePtr theNode);
  */
 CONFIG_EXPORT bool isNode(xmlNodePtr theNode, const char* theNodeName, ...);
 
+//#define isNode(p) _isNode(p, NULL)
+
 /*!
- * Checks is the given node is attribute (widget) node.
+ * Checks if the given node is attribute node.
+ * Attribute node represents a widget, that is able to store/restore
+ * values from the model. Actually it's every widget, displayed
+ * in the XGUI_PropertyPanel, except paged containers (toolbox, switch/case).
+ */
+CONFIG_EXPORT bool isAttributeNode(xmlNodePtr theNode);
+
+/*!
+ * Checks if the given node is widget node.
+ * Widget nodes are attribute node + paged containers nodes.
  */
 CONFIG_EXPORT bool isWidgetNode(xmlNodePtr theNode);
 
+CONFIG_EXPORT bool isCaseNode(xmlNodePtr theNode);
+
 /*!
  * Every xml node has child. Even if there is no explicit
  * child nodes libxml gives the "Text node" as child.
@@ -57,6 +80,23 @@ CONFIG_EXPORT bool isWidgetNode(xmlNodePtr theNode);
  */
 CONFIG_EXPORT bool hasChild(xmlNodePtr theNode);
 
+
+/*!
+ * Checks if the given node has a valid parent.
+ */
+CONFIG_EXPORT bool hasParent(xmlNodePtr theNode);
+
+/*!
+ * Checks if the given node has a valid parent with any of the given node names.
+ */
+CONFIG_EXPORT bool hasParent(xmlNodePtr theNode, const char* theNodeName, ...);
+
+/*!
+ * Checks if the given node has any valid parent in hierarchy with any of the given node names.
+ */
+CONFIG_EXPORT xmlNodePtr hasParentRecursive(xmlNodePtr theNode, const char* theNodeName, ...);
+
+
 /*!
  * Returns named property for an id node as std::string and the parameters of the node.
  */
@@ -81,6 +121,16 @@ CONFIG_EXPORT std::string library(const std::string& theLibName);
  */
 CONFIG_EXPORT std::string getProperty(xmlNodePtr theNode, const char* thePropName);
 
+/*!
+ * Returns content of the node as std::string if it is exists.
+ */
+CONFIG_EXPORT std::string getContent(xmlNodePtr theNode);
+
+/*!
+ * Returns normalized (lower case) named property for a given node as std::string.
+ */
+std::string getNormalizedProperty(xmlNodePtr theNode, const char* thePropName);
+
 /*!
  * Checks if the given XML node has the given attribute,
  * if yes - returns it's bool value, if no, or if the value can not
@@ -98,6 +148,10 @@ CONFIG_EXPORT bool getBooleanAttribute(xmlNodePtr theNode,
  * Should be used for case insensitive string matching.
  */
 CONFIG_EXPORT std::string normalize(const char* theString);
+/*!
+ * Returns normalized (lower case) version of string.
+ * Should be used for case insensitive string matching.
+ */
 CONFIG_EXPORT std::string normalize(const std::string& theString);
 
 #endif