LMU/musrfit
5
1
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases 4 Activity
Files
b6fac619f95a6dd7b99e4eed6682d83ef18405b9
musrfit/mupp/html/classPmuppAdminXMLParser.html
T
Gitea Actions b6fac619f9 Deploy site
2026-05-28 07:32:41 +00:00

686 lines
37 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mupp: PmuppAdminXMLParser Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">mupp<span id="projectnumber">&#160;1.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classPmuppAdminXMLParser-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">PmuppAdminXMLParser Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>XML parser for mupp configuration files.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PmuppAdmin_8h_source.html">PmuppAdmin.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for PmuppAdminXMLParser:</div>
<div class="dyncontent">
<div class="center"><img src="classPmuppAdminXMLParser__coll__graph.png" border="0" usemap="#aPmuppAdminXMLParser_coll__map" alt="Collaboration graph"/></div>
<map name="aPmuppAdminXMLParser_coll__map" id="aPmuppAdminXMLParser_coll__map">
<area shape="rect" title="XML parser for mupp configuration files." alt="" coords="5,175,173,203"/>
<area shape="rect" href="classPmuppAdmin.html" title="Main administration class for mupp configuration management." alt="" coords="37,82,141,110"/>
<area shape="poly" title=" " alt="" coords="92,125,92,175,86,175,86,125"/>
<area shape="rect" title=" " alt="" coords="54,5,124,33"/>
<area shape="poly" title=" " alt="" coords="92,48,92,82,86,82,86,48"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7be68122fce37ab677aebbaeb922e633" id="r_a7be68122fce37ab677aebbaeb922e633"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7be68122fce37ab677aebbaeb922e633">PmuppAdminXMLParser</a> (const QString &amp;fln, <a class="el" href="classPmuppAdmin.html">PmuppAdmin</a> *)</td></tr>
<tr class="memdesc:a7be68122fce37ab677aebbaeb922e633"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that parses the XML configuration file. <br /></td></tr>
<tr class="separator:a7be68122fce37ab677aebbaeb922e633"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29258588eaf25a71588c213c8d9b25e3" id="r_a29258588eaf25a71588c213c8d9b25e3"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a29258588eaf25a71588c213c8d9b25e3">~PmuppAdminXMLParser</a> ()</td></tr>
<tr class="memdesc:a29258588eaf25a71588c213c8d9b25e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a29258588eaf25a71588c213c8d9b25e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6cd573284d12d01774ca602a1f579473" id="r_a6cd573284d12d01774ca602a1f579473"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6cd573284d12d01774ca602a1f579473">isValid</a> ()</td></tr>
<tr class="memdesc:a6cd573284d12d01774ca602a1f579473"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the XML parsing was successful. <br /></td></tr>
<tr class="separator:a6cd573284d12d01774ca602a1f579473"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-types" name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:ae28333b802ebf95d6c0905060b905087" id="r_ae28333b802ebf95d6c0905060b905087"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae28333b802ebf95d6c0905060b905087">EAdminKeyWords</a> { <br />
&#160;&#160;<a class="el" href="#ae28333b802ebf95d6c0905060b905087a2ceb298abb6ad78a648e5b0658282cda">eEmpty</a>
, <a class="el" href="#ae28333b802ebf95d6c0905060b905087a9a07fb8caf04c79bde9a3cfb5b53868d">eRecentFile</a>
, <a class="el" href="#ae28333b802ebf95d6c0905060b905087a0fbbf8994a26e63d42633f6e0c663d20">eIgnoreThemeAutoDetection</a>
, <a class="el" href="#ae28333b802ebf95d6c0905060b905087a80bf1e8a6dd2c490932a886ae568a3ce">eDarkThemeIconsMenu</a>
, <br />
&#160;&#160;<a class="el" href="#ae28333b802ebf95d6c0905060b905087a881e0aad1ef1a10aaa192df3438d31a0">eDarkThemeIconsToolbar</a>
, <a class="el" href="#ae28333b802ebf95d6c0905060b905087ab3e7b7803dcaca2fd26b7d7eaf29c510">eMarker</a>
, <a class="el" href="#ae28333b802ebf95d6c0905060b905087aef92283b4ae76b0fb4643236d5aa030d">eColor</a>
<br />
}</td></tr>
<tr class="memdesc:ae28333b802ebf95d6c0905060b905087"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration of recognized XML element types. <a href="#ae28333b802ebf95d6c0905060b905087">More...</a><br /></td></tr>
<tr class="separator:ae28333b802ebf95d6c0905060b905087"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a0d7b610e1c21999f13ff4d210cc8a678" id="r_a0d7b610e1c21999f13ff4d210cc8a678"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0d7b610e1c21999f13ff4d210cc8a678">parse</a> (QIODevice *device)</td></tr>
<tr class="memdesc:a0d7b610e1c21999f13ff4d210cc8a678"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main parsing method that processes the XML document. <br /></td></tr>
<tr class="separator:a0d7b610e1c21999f13ff4d210cc8a678"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0858a71022aff09077c03306302ca01a" id="r_a0858a71022aff09077c03306302ca01a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0858a71022aff09077c03306302ca01a">startDocument</a> ()</td></tr>
<tr class="memdesc:a0858a71022aff09077c03306302ca01a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler for XML document start. <br /></td></tr>
<tr class="separator:a0858a71022aff09077c03306302ca01a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9c2f3670b5a848ad1d3ff1451733015" id="r_ad9c2f3670b5a848ad1d3ff1451733015"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad9c2f3670b5a848ad1d3ff1451733015">startElement</a> ()</td></tr>
<tr class="memdesc:ad9c2f3670b5a848ad1d3ff1451733015"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler for XML element opening tags. <br /></td></tr>
<tr class="separator:ad9c2f3670b5a848ad1d3ff1451733015"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aecd6aa3e7ef8f6530ad6968ce7f6429c" id="r_aecd6aa3e7ef8f6530ad6968ce7f6429c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aecd6aa3e7ef8f6530ad6968ce7f6429c">endElement</a> ()</td></tr>
<tr class="memdesc:aecd6aa3e7ef8f6530ad6968ce7f6429c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler for XML element closing tags. <br /></td></tr>
<tr class="separator:aecd6aa3e7ef8f6530ad6968ce7f6429c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97345c22d3dd25eae18f62220885eb83" id="r_a97345c22d3dd25eae18f62220885eb83"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a97345c22d3dd25eae18f62220885eb83">characters</a> ()</td></tr>
<tr class="memdesc:a97345c22d3dd25eae18f62220885eb83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler for XML element text content. <br /></td></tr>
<tr class="separator:a97345c22d3dd25eae18f62220885eb83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af13b9336227317637fc5ca3b53d7be73" id="r_af13b9336227317637fc5ca3b53d7be73"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af13b9336227317637fc5ca3b53d7be73">endDocument</a> ()</td></tr>
<tr class="memdesc:af13b9336227317637fc5ca3b53d7be73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler for XML document end. <br /></td></tr>
<tr class="separator:af13b9336227317637fc5ca3b53d7be73"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a666b09fb1bd535acf0eaa27d3eeb66c6" id="r_a666b09fb1bd535acf0eaa27d3eeb66c6"><td class="memItemLeft" align="right" valign="top">QXmlStreamReader&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a666b09fb1bd535acf0eaa27d3eeb66c6">fXml</a></td></tr>
<tr class="memdesc:a666b09fb1bd535acf0eaa27d3eeb66c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Qt XML stream reader object for parsing. <br /></td></tr>
<tr class="separator:a666b09fb1bd535acf0eaa27d3eeb66c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a934c52009b8a870d9aaf0980b73c22a2" id="r_a934c52009b8a870d9aaf0980b73c22a2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a934c52009b8a870d9aaf0980b73c22a2">fValid</a></td></tr>
<tr class="memdesc:a934c52009b8a870d9aaf0980b73c22a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">flag indicating successful XML parsing <br /></td></tr>
<tr class="separator:a934c52009b8a870d9aaf0980b73c22a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51bd2ee93a40cd6b82d915083d742509" id="r_a51bd2ee93a40cd6b82d915083d742509"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ae28333b802ebf95d6c0905060b905087">EAdminKeyWords</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a51bd2ee93a40cd6b82d915083d742509">fKeyWord</a></td></tr>
<tr class="memdesc:a51bd2ee93a40cd6b82d915083d742509"><td class="mdescLeft">&#160;</td><td class="mdescRight">current element type being processed <br /></td></tr>
<tr class="separator:a51bd2ee93a40cd6b82d915083d742509"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0adc8581b463dc6b35677c6aec2ae4a8" id="r_a0adc8581b463dc6b35677c6aec2ae4a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPmuppAdmin.html">PmuppAdmin</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0adc8581b463dc6b35677c6aec2ae4a8">fAdmin</a></td></tr>
<tr class="memdesc:a0adc8581b463dc6b35677c6aec2ae4a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">pointer to the admin object being populated <br /></td></tr>
<tr class="separator:a0adc8581b463dc6b35677c6aec2ae4a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>XML parser for mupp configuration files. </p>
<p><a class="el" href="classPmuppAdminXMLParser.html" title="XML parser for mupp configuration files.">PmuppAdminXMLParser</a> is responsible for reading and parsing the mupp startup XML file (mupp_startup.xml). This configuration file contains:</p><ul>
<li>Recent file history</li>
<li>Theme preferences (light/dark mode icons)</li>
<li>Plot marker styles and sizes</li>
<li>Plot color definitions</li>
</ul>
<p>The parser uses Qt's QXmlStreamReader for efficient XML processing and populates a <a class="el" href="classPmuppAdmin.html" title="Main administration class for mupp configuration management.">PmuppAdmin</a> object with the configuration data.</p>
<p>XML structure handled:</p><ul>
<li>&lt;recent_files&gt;: List of recently opened files</li>
<li>&lt;ignore_theme_auto_detection&gt;: Theme detection override</li>
<li>&lt;dark_theme_icon_menu&gt;: Menu icon theme preference</li>
<li>&lt;dark_theme_icon_toolbar&gt;: Toolbar icon theme preference</li>
<li>&lt;marker&gt;: Plot marker definitions</li>
<li>&lt;color&gt;: RGB color definitions </li>
</ul>
<p class="definition">Definition at line <a class="el" href="PmuppAdmin_8h_source.html#l00223">223</a> of file <a class="el" href="PmuppAdmin_8h_source.html">PmuppAdmin.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="ae28333b802ebf95d6c0905060b905087" name="ae28333b802ebf95d6c0905060b905087"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae28333b802ebf95d6c0905060b905087">&#9670;&#160;</a></span>EAdminKeyWords</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="#ae28333b802ebf95d6c0905060b905087">PmuppAdminXMLParser::EAdminKeyWords</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Enumeration of recognized XML element types. </p>
<p>These keywords determine how to process the content of each XML element. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ae28333b802ebf95d6c0905060b905087a2ceb298abb6ad78a648e5b0658282cda" name="ae28333b802ebf95d6c0905060b905087a2ceb298abb6ad78a648e5b0658282cda"></a>eEmpty&#160;</td><td class="fielddoc"><p>no specific element being processed </p>
</td></tr>
<tr><td class="fieldname"><a id="ae28333b802ebf95d6c0905060b905087a9a07fb8caf04c79bde9a3cfb5b53868d" name="ae28333b802ebf95d6c0905060b905087a9a07fb8caf04c79bde9a3cfb5b53868d"></a>eRecentFile&#160;</td><td class="fielddoc"><p>recent file path element </p>
</td></tr>
<tr><td class="fieldname"><a id="ae28333b802ebf95d6c0905060b905087a0fbbf8994a26e63d42633f6e0c663d20" name="ae28333b802ebf95d6c0905060b905087a0fbbf8994a26e63d42633f6e0c663d20"></a>eIgnoreThemeAutoDetection&#160;</td><td class="fielddoc"><p>theme auto-detection override </p>
</td></tr>
<tr><td class="fieldname"><a id="ae28333b802ebf95d6c0905060b905087a80bf1e8a6dd2c490932a886ae568a3ce" name="ae28333b802ebf95d6c0905060b905087a80bf1e8a6dd2c490932a886ae568a3ce"></a>eDarkThemeIconsMenu&#160;</td><td class="fielddoc"><p>menu icon theme setting </p>
</td></tr>
<tr><td class="fieldname"><a id="ae28333b802ebf95d6c0905060b905087a881e0aad1ef1a10aaa192df3438d31a0" name="ae28333b802ebf95d6c0905060b905087a881e0aad1ef1a10aaa192df3438d31a0"></a>eDarkThemeIconsToolbar&#160;</td><td class="fielddoc"><p>toolbar icon theme setting </p>
</td></tr>
<tr><td class="fieldname"><a id="ae28333b802ebf95d6c0905060b905087ab3e7b7803dcaca2fd26b7d7eaf29c510" name="ae28333b802ebf95d6c0905060b905087ab3e7b7803dcaca2fd26b7d7eaf29c510"></a>eMarker&#160;</td><td class="fielddoc"><p>marker definition element </p>
</td></tr>
<tr><td class="fieldname"><a id="ae28333b802ebf95d6c0905060b905087aef92283b4ae76b0fb4643236d5aa030d" name="ae28333b802ebf95d6c0905060b905087aef92283b4ae76b0fb4643236d5aa030d"></a>eColor&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="PmuppAdmin_8h_source.html#l00250">250</a> of file <a class="el" href="PmuppAdmin_8h_source.html">PmuppAdmin.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7be68122fce37ab677aebbaeb922e633" name="a7be68122fce37ab677aebbaeb922e633"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7be68122fce37ab677aebbaeb922e633">&#9670;&#160;</a></span>PmuppAdminXMLParser()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PmuppAdminXMLParser::PmuppAdminXMLParser </td>
<td>(</td>
<td class="paramtype">const QString &amp;</td> <td class="paramname"><span class="paramname"><em>fln</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPmuppAdmin.html">PmuppAdmin</a> *</td> <td class="paramname"><span class="paramname"><em>admin</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor that parses the XML configuration file. </p>
<p>Constructor for XML parser.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fln</td><td>path to the mupp_startup.xml file </td></tr>
<tr><td class="paramname">admin</td><td>pointer to <a class="el" href="classPmuppAdmin.html" title="Main administration class for mupp configuration management.">PmuppAdmin</a> object to populate with parsed data</td></tr>
</table>
</dd>
</dl>
<p>Initializes the XML parser and attempts to open and parse the specified configuration file. The parsed data is stored in the provided <a class="el" href="classPmuppAdmin.html" title="Main administration class for mupp configuration management.">PmuppAdmin</a> object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fln</td><td>path to the mupp_startup.xml configuration file </td></tr>
<tr><td class="paramname">admin</td><td>pointer to the <a class="el" href="classPmuppAdmin.html" title="Main administration class for mupp configuration management.">PmuppAdmin</a> instance to populate with parsed data </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PmuppAdmin_8cpp_source.html#l00123">123</a> of file <a class="el" href="PmuppAdmin_8cpp_source.html">PmuppAdmin.cpp</a>.</p>
</div>
</div>
<a id="a29258588eaf25a71588c213c8d9b25e3" name="a29258588eaf25a71588c213c8d9b25e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29258588eaf25a71588c213c8d9b25e3">&#9670;&#160;</a></span>~PmuppAdminXMLParser()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual PmuppAdminXMLParser::~PmuppAdminXMLParser </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p class="definition">Definition at line <a class="el" href="PmuppAdmin_8h_source.html#l00236">236</a> of file <a class="el" href="PmuppAdmin_8h_source.html">PmuppAdmin.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a97345c22d3dd25eae18f62220885eb83" name="a97345c22d3dd25eae18f62220885eb83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97345c22d3dd25eae18f62220885eb83">&#9670;&#160;</a></span>characters()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PmuppAdminXMLParser::characters </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Handler for XML element text content. </p>
<p>Handler called to process XML element content.</p>
<dl class="section return"><dt>Returns</dt><dd>true if content is valid, false on error</dd></dl>
<p>This method processes the text content between XML opening and closing tags. The content interpretation depends on the current fKeyWord state (set by startElement).</p>
<p>Content processing by element type:</p><ul>
<li>eRecentFile: Adds file path to recent files list</li>
<li>eIgnoreThemeAutoDetection: Sets theme auto-detection flag (yes/no/true/false)</li>
<li>eDarkThemeIconsMenu: Sets menu icon theme preference</li>
<li>eDarkThemeIconsToolbar: Sets toolbar icon theme preference</li>
<li>eMarker: Parses marker definition (code[,size])</li>
<li>eColor: Parses RGB color definition (r,g,b[,name])</li>
</ul>
<dl class="section return"><dt>Returns</dt><dd>true if content is valid, false on parsing errors </dd></dl>
<p class="definition">Definition at line <a class="el" href="PmuppAdmin_8cpp_source.html#l00272">272</a> of file <a class="el" href="PmuppAdmin_8cpp_source.html">PmuppAdmin.cpp</a>.</p>
</div>
</div>
<a id="af13b9336227317637fc5ca3b53d7be73" name="af13b9336227317637fc5ca3b53d7be73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af13b9336227317637fc5ca3b53d7be73">&#9670;&#160;</a></span>endDocument()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PmuppAdminXMLParser::endDocument </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Handler for XML document end. </p>
<p>Handler called at the end of XML document parsing.</p>
<dl class="section return"><dt>Returns</dt><dd>true if successful</dd></dl>
<p>This is invoked when the parser reaches the end of the XML document. Currently performs no post-processing but provides a hook for future finalization tasks such as path expansion or validation.</p>
<dl class="section return"><dt>Returns</dt><dd>always returns true </dd></dl>
<p class="definition">Definition at line <a class="el" href="PmuppAdmin_8cpp_source.html#l00364">364</a> of file <a class="el" href="PmuppAdmin_8cpp_source.html">PmuppAdmin.cpp</a>.</p>
</div>
</div>
<a id="aecd6aa3e7ef8f6530ad6968ce7f6429c" name="aecd6aa3e7ef8f6530ad6968ce7f6429c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aecd6aa3e7ef8f6530ad6968ce7f6429c">&#9670;&#160;</a></span>endElement()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PmuppAdminXMLParser::endElement </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Handler for XML element closing tags. </p>
<p>Handler called when an XML closing tag is encountered.</p>
<dl class="section return"><dt>Returns</dt><dd>true if successful</dd></dl>
<p>This method is invoked when the parser encounters a closing XML tag. It resets the fKeyWord state to eEmpty, ending the current element's context for content processing.</p>
<dl class="section return"><dt>Returns</dt><dd>always returns true </dd></dl>
<p class="definition">Definition at line <a class="el" href="PmuppAdmin_8cpp_source.html#l00247">247</a> of file <a class="el" href="PmuppAdmin_8cpp_source.html">PmuppAdmin.cpp</a>.</p>
</div>
</div>
<a id="a6cd573284d12d01774ca602a1f579473" name="a6cd573284d12d01774ca602a1f579473"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cd573284d12d01774ca602a1f579473">&#9670;&#160;</a></span>isValid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool PmuppAdminXMLParser::isValid </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if the XML parsing was successful. </p>
<dl class="section return"><dt>Returns</dt><dd>true if parsing succeeded, false otherwise </dd></dl>
<p class="definition">Definition at line <a class="el" href="PmuppAdmin_8h_source.html#l00242">242</a> of file <a class="el" href="PmuppAdmin_8h_source.html">PmuppAdmin.h</a>.</p>
</div>
</div>
<a id="a0d7b610e1c21999f13ff4d210cc8a678" name="a0d7b610e1c21999f13ff4d210cc8a678"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d7b610e1c21999f13ff4d210cc8a678">&#9670;&#160;</a></span>parse()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PmuppAdminXMLParser::parse </td>
<td>(</td>
<td class="paramtype">QIODevice *</td> <td class="paramname"><span class="paramname"><em>device</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Main parsing method that processes the XML document. </p>
<p>Parses the mupp startup XML file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">device</td><td>QIODevice containing the XML data to parse </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if parsing succeeds, false on error</dd></dl>
<p>This method uses Qt's QXmlStreamReader to parse the configuration file. It processes each XML element sequentially, calling appropriate handler methods (startElement, characters, endElement) based on the element type.</p>
<p>The parser is event-driven and maintains state through the fKeyWord enumeration to determine how to process element content.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">device</td><td>QIODevice (typically QFile) containing the XML data</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if parsing succeeds without errors, false otherwise </dd></dl>
<p class="definition">Definition at line <a class="el" href="PmuppAdmin_8cpp_source.html#l00151">151</a> of file <a class="el" href="PmuppAdmin_8cpp_source.html">PmuppAdmin.cpp</a>.</p>
</div>
</div>
<a id="a0858a71022aff09077c03306302ca01a" name="a0858a71022aff09077c03306302ca01a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0858a71022aff09077c03306302ca01a">&#9670;&#160;</a></span>startDocument()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PmuppAdminXMLParser::startDocument </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Handler for XML document start. </p>
<p>Handler called at the start of XML document parsing.</p>
<dl class="section return"><dt>Returns</dt><dd>true if successful</dd></dl>
<p>This is invoked when the XML parser encounters the document start. Currently performs no actions but provides a hook for future initialization.</p>
<dl class="section return"><dt>Returns</dt><dd>always returns true </dd></dl>
<p class="definition">Definition at line <a class="el" href="PmuppAdmin_8cpp_source.html#l00191">191</a> of file <a class="el" href="PmuppAdmin_8cpp_source.html">PmuppAdmin.cpp</a>.</p>
</div>
</div>
<a id="ad9c2f3670b5a848ad1d3ff1451733015" name="ad9c2f3670b5a848ad1d3ff1451733015"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9c2f3670b5a848ad1d3ff1451733015">&#9670;&#160;</a></span>startElement()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PmuppAdminXMLParser::startElement </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Handler for XML element opening tags. </p>
<p>Handler called when a new XML element is encountered.</p>
<dl class="section return"><dt>Returns</dt><dd>true if successful</dd></dl>
<p>This method is invoked when the parser encounters an opening XML tag. It identifies the element type and sets the fKeyWord state accordingly, which determines how the element's content will be processed in the <a class="el" href="#a97345c22d3dd25eae18f62220885eb83" title="Handler for XML element text content.">characters()</a> method.</p>
<p>Recognized elements:</p><ul>
<li>path_file_name: Recent file entry</li>
<li>ignore_theme_auto_detection: Theme detection override</li>
<li>dark_theme_icon_menu: Menu icon theme</li>
<li>dark_theme_icon_toolbar: Toolbar icon theme</li>
<li>marker: Plot marker definition</li>
<li>color: RGB color definition</li>
</ul>
<dl class="section return"><dt>Returns</dt><dd>always returns true </dd></dl>
<p class="definition">Definition at line <a class="el" href="PmuppAdmin_8cpp_source.html#l00216">216</a> of file <a class="el" href="PmuppAdmin_8cpp_source.html">PmuppAdmin.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a0adc8581b463dc6b35677c6aec2ae4a8" name="a0adc8581b463dc6b35677c6aec2ae4a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0adc8581b463dc6b35677c6aec2ae4a8">&#9670;&#160;</a></span>fAdmin</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classPmuppAdmin.html">PmuppAdmin</a>* PmuppAdminXMLParser::fAdmin</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>pointer to the admin object being populated </p>
<p class="definition">Definition at line <a class="el" href="PmuppAdmin_8h_source.html#l00298">298</a> of file <a class="el" href="PmuppAdmin_8h_source.html">PmuppAdmin.h</a>.</p>
</div>
</div>
<a id="a51bd2ee93a40cd6b82d915083d742509" name="a51bd2ee93a40cd6b82d915083d742509"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51bd2ee93a40cd6b82d915083d742509">&#9670;&#160;</a></span>fKeyWord</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#ae28333b802ebf95d6c0905060b905087">EAdminKeyWords</a> PmuppAdminXMLParser::fKeyWord</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>current element type being processed </p>
<p class="definition">Definition at line <a class="el" href="PmuppAdmin_8h_source.html#l00297">297</a> of file <a class="el" href="PmuppAdmin_8h_source.html">PmuppAdmin.h</a>.</p>
</div>
</div>
<a id="a934c52009b8a870d9aaf0980b73c22a2" name="a934c52009b8a870d9aaf0980b73c22a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a934c52009b8a870d9aaf0980b73c22a2">&#9670;&#160;</a></span>fValid</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PmuppAdminXMLParser::fValid</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>flag indicating successful XML parsing </p>
<p class="definition">Definition at line <a class="el" href="PmuppAdmin_8h_source.html#l00296">296</a> of file <a class="el" href="PmuppAdmin_8h_source.html">PmuppAdmin.h</a>.</p>
</div>
</div>
<a id="a666b09fb1bd535acf0eaa27d3eeb66c6" name="a666b09fb1bd535acf0eaa27d3eeb66c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a666b09fb1bd535acf0eaa27d3eeb66c6">&#9670;&#160;</a></span>fXml</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QXmlStreamReader PmuppAdminXMLParser::fXml</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Qt XML stream reader object for parsing. </p>
<p class="definition">Definition at line <a class="el" href="PmuppAdmin_8h_source.html#l00295">295</a> of file <a class="el" href="PmuppAdmin_8h_source.html">PmuppAdmin.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/workspace/LMU/musrfit/src/musredit_qt6/mupp/<a class="el" href="PmuppAdmin_8h_source.html">PmuppAdmin.h</a></li>
<li>/workspace/LMU/musrfit/src/musredit_qt6/mupp/<a class="el" href="PmuppAdmin_8cpp_source.html">PmuppAdmin.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2
</small></address>
</div><!-- doc-content -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink