162 lines
9.7 KiB
HTML
162 lines
9.7 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<!-- parser.cpp -->
|
|
<title>QCSParser Class | CSDataQuick Documentation 1.2</title>
|
|
<link rel="stylesheet" type="text/css" href="style/online.css" />
|
|
<script type="text/javascript">
|
|
(function (i, s, o, g, r, a, m) {
|
|
i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () {
|
|
(i[r].q = i[r].q || []).push(arguments)
|
|
}, i[r].l = 1 * new Date(); a = s.createElement(o),
|
|
m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m)
|
|
})(window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga');
|
|
|
|
ga('create', 'UA-24645639-4', 'qt.io');
|
|
ga('set', 'forceSSL', true);
|
|
ga('send', 'pageview');
|
|
</script>
|
|
</head>
|
|
<body>
|
|
<div class="header" id="header">
|
|
<header id="navbar" class="">
|
|
</header>
|
|
</div>
|
|
<div class="main">
|
|
<div class="main-rounded">
|
|
<div class="navigationbar">
|
|
<ul class="sub-navigation">
|
|
<li><a href="../../CSDataQuick.html">Home</a></li>
|
|
<li><a href="../docs.html" class="active">Documentation</a></li>
|
|
<li><a href="http://github.com/xiaoqiangwang/CSDataQuick/">Code</a></li>
|
|
<li><a href="https://github.com/xiaoqiangwang/CSDataQuick/issues/">Bug Reports</a></li>
|
|
</ul>
|
|
<div id="main_title_bar">
|
|
<h1>CSDataQuick Documentation</h1>
|
|
<div class="search_bar">
|
|
<script>
|
|
(function() {
|
|
var cx = '001693341472456439948:u9v0snkru3q';
|
|
var gcse = document.createElement('script');
|
|
gcse.type = 'text/javascript';
|
|
gcse.async = true;
|
|
gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + '//www.google.com/cse/cse.js?cx=' + cx;
|
|
var s = document.getElementsByTagName('script')[0];
|
|
s.parentNode.insertBefore(gcse, s);
|
|
})();
|
|
</script>
|
|
<gcse:searchbox-only resultsUrl="search-results.html"></gcse:searchbox-only>
|
|
</div></div>
|
|
<ul>
|
|
<li><a href="index.html">CSDataQuick Documentation</a></li>
|
|
<li><a href="csdataquick-cpp.html">C++ Classes</a></li>
|
|
<li>QCSParser</li>
|
|
</ul>
|
|
</div>
|
|
<div class="content">
|
|
<div class="line">
|
|
<div class="content mainContent">
|
|
<div class="sidebar">
|
|
<div class="toc">
|
|
<h3><a name="toc">Contents</a></h3>
|
|
<ul>
|
|
<li class="level1"><a href="qcsparser.html#properties">Properties</a></li>
|
|
<li class="level1"><a href="qcsparser.html#public-functions">Public Functions</a></li>
|
|
<li class="level1"><a href="qcsparser.html#details">Detailed Description</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sidebar-content" id="sidebar-content"></div></div>
|
|
<div class="context">
|
|
<h1 class="title">QCSParser Class</h1>
|
|
<!-- $$$QCSParser-brief -->
|
|
<p>The <a href="qcsparser.html">QCSParser</a> class defines the interface of display file parser. <a href="qcsparser.html#details">More...</a></p>
|
|
<!-- @@@QCSParser -->
|
|
<div class="table"><table class="alignedsummary">
|
|
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QCSParser></span>
|
|
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="http://doc.qt.io/qt-5/qobject.html">QObject</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="adlparser.html">ADLParser</a>, <a href="edlparser.html">EDLParser</a>, <a href="qmlparser.html">QMLParser</a>, and <a href="uiparser.html">UIParser</a></p>
|
|
</td></tr></table></div><ul>
|
|
<li><a href="qcsparser-members.html">List of all members, including inherited members</a></li>
|
|
</ul>
|
|
<a name="properties"></a>
|
|
<h2 id="properties">Properties</h2>
|
|
<ul>
|
|
<li class="fn"><b><a href="qcsparser.html#description-prop">description</a></b> : const QString</li>
|
|
<li class="fn"><b><a href="qcsparser.html#extension-prop">extension</a></b> : const QString</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="fn">1 property inherited from <a href="http://doc.qt.io/qt-5/qobject.html#properties">QObject</a></li>
|
|
</ul>
|
|
<a name="public-functions"></a>
|
|
<h2 id="public-functions">Public Functions</h2>
|
|
<div class="table"><table class="alignedsummary">
|
|
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcsparser.html#QCSParser">QCSParser</a></b>(QObject *<i>parent</i>)</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qcsparser.html#dtor.QCSParser">~QCSParser</a></b>()</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qcsparser.html#description-prop">description</a></b>() = 0</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qcsparser.html#extension-prop">extension</a></b>() = 0</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qcsparser.html#parseDisplayFile">parseDisplayFile</a></b>(QString <i>filename</i>, QMap<QString, QString> <i>macros</i>, bool <i>partial</i> = false) = 0</td></tr>
|
|
</table></div>
|
|
<ul>
|
|
<li class="fn">32 public functions inherited from <a href="http://doc.qt.io/qt-5/qobject.html#public-functions">QObject</a></li>
|
|
</ul>
|
|
<h3>Additional Inherited Members</h3>
|
|
<ul>
|
|
<li class="fn">1 public slot inherited from <a href="http://doc.qt.io/qt-5/qobject.html#public-slots">QObject</a></li>
|
|
<li class="fn">2 signals inherited from <a href="http://doc.qt.io/qt-5/qobject.html#signals">QObject</a></li>
|
|
<li class="fn">1 public variable inherited from <a href="http://doc.qt.io/qt-5/qobject.html#public-variables">QObject</a></li>
|
|
<li class="fn">10 static public members inherited from <a href="http://doc.qt.io/qt-5/qobject.html#static-public-members">QObject</a></li>
|
|
<li class="fn">9 protected functions inherited from <a href="http://doc.qt.io/qt-5/qobject.html#protected-functions">QObject</a></li>
|
|
<li class="fn">2 protected variables inherited from <a href="http://doc.qt.io/qt-5/qobject.html#protected-variables">QObject</a></li>
|
|
</ul>
|
|
<a name="details"></a>
|
|
<!-- $$$QCSParser-description -->
|
|
<div class="descr">
|
|
<h2 id="details">Detailed Description</h2>
|
|
<p>The <a href="qcsparser.html">QCSParser</a> class defines the interface of display file parser.</p>
|
|
<p>This is the base class for display file parsers, which parses various display files and output equivalent QML files.</p>
|
|
<p>Pasers are loaded as plugins on demand and parse zero, one or more types of file.</p>
|
|
</div>
|
|
<!-- @@@QCSParser -->
|
|
<div class="prop">
|
|
<h2>Property Documentation</h2>
|
|
<!-- $$$description-prop$$$description -->
|
|
<h3 class="fn" id="description-prop"><a name="description-prop"></a><span class="name">description</span> : const <span class="type"><a href="http://doc.qt.io/qt-5/qstring.html">QString</a></span></h3>
|
|
<p>Descriptive text of this file parser.</p>
|
|
<p><b>Access functions:</b></p>
|
|
<div class="table"><table class="alignedsummary">
|
|
<tr><td class="memItemLeft topAlign rightAlign"> virtual QString </td><td class="memItemRight bottomAlign"><span class="name"><b>description</b></span>() = 0</td></tr>
|
|
</table></div>
|
|
<!-- @@@description -->
|
|
<!-- $$$extension-prop$$$extension -->
|
|
<h3 class="fn" id="extension-prop"><a name="extension-prop"></a><span class="name">extension</span> : const <span class="type"><a href="http://doc.qt.io/qt-5/qstring.html">QString</a></span></h3>
|
|
<p>File extension supported by this parser.</p>
|
|
<p><b>Access functions:</b></p>
|
|
<div class="table"><table class="alignedsummary">
|
|
<tr><td class="memItemLeft topAlign rightAlign"> virtual QString </td><td class="memItemRight bottomAlign"><span class="name"><b>extension</b></span>() = 0</td></tr>
|
|
</table></div>
|
|
<!-- @@@extension -->
|
|
</div>
|
|
<div class="func">
|
|
<h2>Member Function Documentation</h2>
|
|
<!-- $$$QCSParser[overload1]$$$QCSParserQObject* -->
|
|
<h3 class="fn" id="QCSParser"><a name="QCSParser"></a>QCSParser::<span class="name">QCSParser</span>(<span class="type"><a href="http://doc.qt.io/qt-5/qobject.html#QObject">QObject</a></span> *<i>parent</i>)</h3>
|
|
<p>Default constructs an instance of QCSParser.</p><!-- @@@QCSParser -->
|
|
<!-- $$$~QCSParser[overload1]$$$~QCSParser -->
|
|
<h3 class="fn" id="dtor.QCSParser"><a name="dtor.QCSParser"></a><code>[virtual] </code>QCSParser::<span class="name">~QCSParser</span>()</h3>
|
|
<p>Destroys the instance of QCSParser. The destructor is virtual.</p><!-- @@@~QCSParser -->
|
|
<!-- $$$parseDisplayFile[overload1]$$$parseDisplayFileQStringQMap<QString,QString>bool -->
|
|
<h3 class="fn" id="parseDisplayFile"><a name="parseDisplayFile"></a><code>[pure virtual] </code><span class="type"><a href="http://doc.qt.io/qt-5/qstring.html">QString</a></span> QCSParser::<span class="name">parseDisplayFile</span>(<span class="type"><a href="http://doc.qt.io/qt-5/qstring.html">QString</a></span> <i>filename</i>, <span class="type"><a href="http://doc.qt.io/qt-5/qmap.html">QMap</a></span><<span class="type"><a href="http://doc.qt.io/qt-5/qstring.html">QString</a></span>, <span class="type"><a href="http://doc.qt.io/qt-5/qstring.html">QString</a></span>> <i>macros</i>, <span class="type">bool</span> <i>partial</i> = false)</h3>
|
|
<p>Parse the given display file.</p>
|
|
<p>The file parser must implements this to parse the given <i>filename</i> with <i>macros</i> substitution. The returned QML representation should be a standard QML source, unless <i>partial</i> is specified in which only the item definitions are returned excluding import statements and root item.</p>
|
|
<!-- @@@parseDisplayFile -->
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer">Copyright (C) 2012-2021 Xiaoqiang Wang, Paul Scherrer Institute.</div>
|
|
</body>
|
|
</html>
|