X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2FConfig%2FConfig_Common.h;h=1850f8a7bd642373ed74ebdc4d262b443403410a;hb=1eb338bda4fd99a4db24005f62a073a2866c9689;hp=a2cc7884378b87a13006242531dc20f146aa88fb;hpb=841933dc4a26f84ee2f9ce32b27c8c8e5327faf1;p=modules%2Fshaper.git diff --git a/src/Config/Config_Common.h b/src/Config/Config_Common.h index a2cc78843..1850f8a7b 100644 --- a/src/Config/Config_Common.h +++ b/src/Config/Config_Common.h @@ -28,12 +28,12 @@ typedef xmlDoc *xmlDocPtr; struct _xmlDoc; //<< -/* +/*! * Returns true if theNode is XML ELEMENT node (not a "text" node ie). */ CONFIG_EXPORT bool isElementNode(xmlNodePtr theNode); -/* +/*! * Returns true if theNode is XML node with a given name. * Please note that this function should be called with NULL last argument. @@ -43,12 +43,25 @@ CONFIG_EXPORT bool isElementNode(xmlNodePtr theNode); */ CONFIG_EXPORT bool isNode(xmlNodePtr theNode, const char* theNodeName, ...); -/* - * Checks is the given node is attribute (widget) node. +//#define isNode(p) _isNode(p, NULL) + +/*! + * 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,7 +70,18 @@ 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, ...); + +/*! * Returns named property for an id node as std::string and the parameters of the node. */ CONFIG_EXPORT bool getParametersInfo(xmlNodePtr theNode, std::string& outPropertyId, @@ -76,12 +100,17 @@ CONFIG_EXPORT bool getParametersInfo(xmlNodePtr theNode, std::string& outPropert */ CONFIG_EXPORT std::string library(const std::string& theLibName); -/* +/*! * Returns named property for a given node as std::string. */ CONFIG_EXPORT std::string getProperty(xmlNodePtr theNode, const char* thePropName); -/* +/*! + * 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 * be converted to bool - returns theDefault value. @@ -93,11 +122,15 @@ CONFIG_EXPORT bool getBooleanAttribute(xmlNodePtr theNode, const char* theAttributeName, bool theDefault); -/* +/*! * Returns normalized (lower case) version of string. * 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