SHAPER 9.16.0
Config_WidgetReader.h
1// Copyright (C) 2014-2026 CEA, EDF
2//
3// This library is free software; you can redistribute it and/or
4// modify it under the terms of the GNU Lesser General Public
5// License as published by the Free Software Foundation; either
6// version 2.1 of the License, or (at your option) any later version.
7//
8// This library is distributed in the hope that it will be useful,
9// but WITHOUT ANY WARRANTY; without even the implied warranty of
10// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11// Lesser General Public License for more details.
12//
13// You should have received a copy of the GNU Lesser General Public
14// License along with this library; if not, write to the Free Software
15// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16//
17// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18//
19
20#ifndef CONFIG_WIDGETREADER_H_
21#define CONFIG_WIDGETREADER_H_
22
23#include <Config_def.h>
24#include <Config_XMLReader.h>
25
26#include <map>
27#include <string>
28
36{
37 public:
42 CONFIG_EXPORT Config_WidgetReader(const std::string& theXmlFile);
43 CONFIG_EXPORT virtual ~Config_WidgetReader();
44
46 CONFIG_EXPORT std::string featureWidgetCfg(const std::string& theFeatureName);
48 CONFIG_EXPORT std::string featureDescription(const std::string& theFeatureName);
49
50 protected:
52 void processNode(xmlNodePtr theNode);
54 bool processChildren(xmlNodePtr theNode);
56 std::string dumpNode(xmlNodePtr theNode);
58 void resolveSourceNodes(xmlNodePtr theNode);
59
60 private:
61 std::map<std::string, std::string> myWidgetCache;
62 std::map<std::string, std::string> myDescriptionCache;
63
64};
65
66#endif /* CONFIG_WIDGETREADER_H_ */
Class that dumps xml definitions of widgets for further processing in the WidgetFactory.
Definition: Config_WidgetReader.h:36
std::string dumpNode(xmlNodePtr theNode)
Extracts xml definition of the given node and it's children.
Definition: Config_WidgetReader.cpp:102
CONFIG_EXPORT std::string featureWidgetCfg(const std::string &theFeatureName)
Extract feature's widget configuration from local cache, stored on node processing.
Definition: Config_WidgetReader.cpp:45
CONFIG_EXPORT std::string featureDescription(const std::string &theFeatureName)
Extract feature's description from local cache, stored on node processing.
Definition: Config_WidgetReader.cpp:50
bool processChildren(xmlNodePtr theNode)
Overloaded method. Defines if the given node should be parsed recursively.
Definition: Config_WidgetReader.cpp:66
CONFIG_EXPORT Config_WidgetReader(const std::string &theXmlFile)
Definition: Config_WidgetReader.cpp:35
void resolveSourceNodes(xmlNodePtr theNode)
Replace all "source" nodes with their content (used before dumping nodes)
Definition: Config_WidgetReader.cpp:73
void processNode(xmlNodePtr theNode)
Overloaded method. Defines how to process each node.
Definition: Config_WidgetReader.cpp:55
Base class for all libxml readers. Provides high-level API for all xml operations.
Definition: Config_XMLReader.h:48