Documentation/Source/eric5.DocumentationTools.QtHelpGenerator.html

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.DocumentationTools.QtHelpGenerator</title>
<style>
body {
    background:white;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #4FA4FF; }
h2 { color: white; background: #4FA4FF; }
h3 { color: white; background: #00557F; }
h4 { color: white; background: #00557F; }
    
a { color: #AA5500; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.DocumentationTools.QtHelpGenerator</h1>
<p>
&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114; &#102;&#111;&#114; &#116;&#104;&#101; &#98;&#117;&#105;&#108;&#116;&#105;&#110; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>HelpCollection</td></tr><tr><td>HelpCollectionFile</td></tr><tr><td>HelpCollectionProjectFile</td></tr><tr><td>HelpHelpFile</td></tr><tr><td>HelpProject</td></tr><tr><td>HelpProjectFile</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#QtHelpGenerator">QtHelpGenerator</a></td>
<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114; &#102;&#111;&#114; &#116;&#104;&#101; &#98;&#117;&#105;&#108;&#116;&#105;&#110; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="QtHelpGenerator" ID="QtHelpGenerator"></a>
<h2>QtHelpGenerator</h2>
<p>
    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114; &#102;&#111;&#114; &#116;&#104;&#101; &#98;&#117;&#105;&#108;&#116;&#105;&#110; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;.
</p>
<h3>Derived from</h3>
object
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#QtHelpGenerator.__init__">QtHelpGenerator</a></td>
<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
</tr><tr>
<td><a href="#QtHelpGenerator.__generateKeywords">__generateKeywords</a></td>
<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#107;&#101;yw&#111;&#114;&#100;&#115; &#115;&#101;&#99;&#116;&#105;&#111;&#110;.</td>
</tr><tr>
<td><a href="#QtHelpGenerator.__generateSections">__generateSections</a></td>
<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#101;&#99;&#116;&#105;&#111;&#110;&#115; &#112;&#97;&#114;&#116;.</td>
</tr><tr>
<td><a href="#QtHelpGenerator.generateFiles">generateFiles</a></td>
<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97;&#108;&#108; &#105;&#110;&#100;&#101;x &#102;&#105;&#108;&#101;&#115;.</td>
</tr><tr>
<td><a href="#QtHelpGenerator.remember">remember</a></td>
<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#109;&#101;&#109;&#98;&#101;&#114; &#97; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#102;&#105;&#108;&#101;.</td>
</tr>
</table>
<a NAME="QtHelpGenerator.__init__" ID="QtHelpGenerator.__init__"></a>
<h4>QtHelpGenerator (Constructor)</h4>
<b>QtHelpGenerator</b>(<i>htmlDir, outputDir, namespace, virtualFolder, filterName, filterAttributes, title, createCollection</i>)
<p>
        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
</p><dl>
<dt><i>htmlDir</i></dt>
<dd>
&#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#72;&#84;&#77;&#76; &#102;&#105;&#108;&#101;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd><dt><i>outputDir</i></dt>
<dd>
&#111;&#117;&#116;&#112;&#117;&#116; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#102;&#111;&#114; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd><dt><i>namespace</i></dt>
<dd>
&#110;&#97;&#109;&#101;&#115;&#112;&#97;&#99;&#101; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd><dt><i>virtualFolder</i></dt>
<dd>
v&#105;&#114;&#116;&#117;&#97;&#108; &#102;&#111;&#108;&#100;&#101;&#114; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd><dt><i>filterName</i></dt>
<dd>
&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#117;&#115;&#116;&#111;&#109; &#102;&#105;&#108;&#116;&#101;&#114; (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd><dt><i>filterAttributes</i></dt>
<dd>
'&#58;' &#115;&#101;&#112;&#97;&#114;&#97;&#116;&#101;&#100; &#108;&#105;&#115;&#116; &#111;&#102; &#102;&#105;&#108;&#116;&#101;&#114; &#97;&#116;&#116;&#114;&#105;&#98;&#117;&#116;&#101;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd><dt><i>title</i></dt>
<dd>
&#116;&#105;&#116;&#108;&#101; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; &#102;&#111;&#114; &#116;&#104;&#101; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101;&#100; &#104;&#101;&#108;&#112; (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd><dt><i>createCollection</i></dt>
<dd>
&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#108;&#108;&#101;&#99;&#116;&#105;&#111;&#110;
            &#102;&#105;&#108;&#101;&#115; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
</dd>
</dl><a NAME="QtHelpGenerator.__generateKeywords" ID="QtHelpGenerator.__generateKeywords"></a>
<h4>QtHelpGenerator.__generateKeywords</h4>
<b>__generateKeywords</b>(<i></i>)
<p>
        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#107;&#101;yw&#111;&#114;&#100;&#115; &#115;&#101;&#99;&#116;&#105;&#111;&#110;.
</p><dl>
<dt>Returns:</dt>
<dd>
&#107;&#101;yw&#111;&#114;&#100;&#115; &#115;&#101;&#99;&#116;&#105;&#111;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd>
</dl><a NAME="QtHelpGenerator.__generateSections" ID="QtHelpGenerator.__generateSections"></a>
<h4>QtHelpGenerator.__generateSections</h4>
<b>__generateSections</b>(<i>package, level</i>)
<p>
        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#101;&#99;&#116;&#105;&#111;&#110;&#115; &#112;&#97;&#114;&#116;.
</p><dl>
<dt><i>package</i></dt>
<dd>
&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#112;&#97;&#99;&#107;&#97;&#103;&#101; &#116;&#111; &#112;&#114;&#111;&#99;&#101;&#115;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd><dt><i>level</i></dt>
<dd>
&#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
&#115;&#101;&#99;&#116;&#105;&#111;&#110;&#115; &#112;&#97;&#114;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd>
</dl><a NAME="QtHelpGenerator.generateFiles" ID="QtHelpGenerator.generateFiles"></a>
<h4>QtHelpGenerator.generateFiles</h4>
<b>generateFiles</b>(<i>basename = ""</i>)
<p>
        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97;&#108;&#108; &#105;&#110;&#100;&#101;x &#102;&#105;&#108;&#101;&#115;.
</p><dl>
<dt><i>basename</i></dt>
<dd>
&#84;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#104;&#105;&#101;&#114;&#97;&#114;&#99;&#104;y &#116;&#111; &#98;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#101;&#100;.
            &#84;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101; &#105;&#115; &#115;&#116;&#114;&#105;&#112;&#112;&#101;&#100; &#111;&#102;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#105;&#102; &#105;&#116; &#115;&#116;&#97;&#114;&#116;&#115; w&#105;&#116;&#104;
            &#116;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101;.
</dd>
</dl><a NAME="QtHelpGenerator.remember" ID="QtHelpGenerator.remember"></a>
<h4>QtHelpGenerator.remember</h4>
<b>remember</b>(<i>file, moduleDocument, basename=""</i>)
<p>
        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#109;&#101;&#109;&#98;&#101;&#114; &#97; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#102;&#105;&#108;&#101;.
</p><dl>
<dt><i>file</i></dt>
<dd>
&#84;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#116;&#111; &#98;&#101; &#114;&#101;&#109;&#101;&#109;&#98;&#101;&#114;&#101;&#100;. (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd><dt><i>moduleDocument</i></dt>
<dd>
&#84;&#104;&#101; &#77;&#111;&#100;&#117;&#108;&#101;&#68;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#111;&#98;&#106;&#101;&#99;&#116; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101;
            &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110; &#102;&#111;&#114; &#116;&#104;&#101; &#102;&#105;&#108;&#101;.
</dd><dt><i>basename</i></dt>
<dd>
&#84;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#104;&#105;&#101;&#114;&#97;&#114;&#99;&#104;y &#116;&#111; &#98;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#101;&#100;.
            &#84;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101; &#105;&#115; &#115;&#116;&#114;&#105;&#112;&#112;&#101;&#100; &#111;&#102;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#105;&#102; &#105;&#116; &#115;&#116;&#97;&#114;&#116;&#115; w&#105;&#116;&#104;
            &#116;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101;.
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>