src/eric7/Documentation/Source/eric7.DocumentationTools.QtHelpGenerator.html

<!DOCTYPE html>
<html><head>
<title>eric7.DocumentationTools.QtHelpGenerator</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.DocumentationTools.QtHelpGenerator</h1>
<p>
Module implementing the QtHelp generator for the builtin documentation
generator.
</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>Class implementing the QtHelp generator for the builtin documentation generator.</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>
    Class implementing the QtHelp generator for the builtin documentation
    generator.
</p>

<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Methods</h3>
<table>
<tr>
<td><a href="#QtHelpGenerator.__init__">QtHelpGenerator</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#QtHelpGenerator.__convertEol">__convertEol</a></td>
<td>Private method to convert the newline characters.</td>
</tr>
<tr>
<td><a href="#QtHelpGenerator.__generateSections">__generateSections</a></td>
<td>Private method to generate the sections part.</td>
</tr>
<tr>
<td><a href="#QtHelpGenerator.generateFiles">generateFiles</a></td>
<td>Public method to generate all index files.</td>
</tr>
<tr>
<td><a href="#QtHelpGenerator.remember">remember</a></td>
<td>Public method to remember a documentation file.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</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>
        Constructor
</p>

<dl>

<dt><i>htmlDir</i> (str)</dt>
<dd>
directory containing the HTML files
</dd>
<dt><i>outputDir</i> (str)</dt>
<dd>
output directory for the files
</dd>
<dt><i>namespace</i> (str)</dt>
<dd>
namespace to be used
</dd>
<dt><i>virtualFolder</i> (str)</dt>
<dd>
virtual folder to be used
</dd>
<dt><i>filterName</i> (str)</dt>
<dd>
name of the custom filter
</dd>
<dt><i>filterAttributes</i> (str)</dt>
<dd>
':' separated list of filter attributes
</dd>
<dt><i>title</i> (str)</dt>
<dd>
title to be used for the generated help
</dd>
<dt><i>createCollection</i> (bool)</dt>
<dd>
flag indicating the generation of the
            collection files
</dd>
</dl>
<a NAME="QtHelpGenerator.__convertEol" ID="QtHelpGenerator.__convertEol"></a>
<h4>QtHelpGenerator.__convertEol</h4>
<b>__convertEol</b>(<i>txt, newline</i>)
<p>
        Private method to convert the newline characters.
</p>

<dl>

<dt><i>txt</i> (str)</dt>
<dd>
text to be converted
</dd>
<dt><i>newline</i> (str)</dt>
<dd>
newline character to be used
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
converted text
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="QtHelpGenerator.__generateSections" ID="QtHelpGenerator.__generateSections"></a>
<h4>QtHelpGenerator.__generateSections</h4>
<b>__generateSections</b>(<i>package, level</i>)
<p>
        Private method to generate the sections part.
</p>

<dl>

<dt><i>package</i> (str)</dt>
<dd>
name of the package to process
</dd>
<dt><i>level</i> (int)</dt>
<dd>
indentation level
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
sections part
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="QtHelpGenerator.generateFiles" ID="QtHelpGenerator.generateFiles"></a>
<h4>QtHelpGenerator.generateFiles</h4>
<b>generateFiles</b>(<i>basename="", newline=None</i>)
<p>
        Public method to generate all index files.
</p>

<dl>

<dt><i>basename</i> (str)</dt>
<dd>
base name of the file hierarchy to be documented.
            The base name is stripped off the filename if it starts with
            the base name.
</dd>
<dt><i>newline</i> (str)</dt>
<dd>
newline character to be used
</dd>
</dl>
<a NAME="QtHelpGenerator.remember" ID="QtHelpGenerator.remember"></a>
<h4>QtHelpGenerator.remember</h4>
<b>remember</b>(<i>file, moduleDocument, basename=""</i>)
<p>
        Public method to remember a documentation file.
</p>

<dl>

<dt><i>file</i> (str)</dt>
<dd>
The filename to be remembered.
</dd>
<dt><i>moduleDocument</i> (ModuleDocument)</dt>
<dd>
module documentation object containing the
            information for the file.
</dd>
<dt><i>basename</i> (str)</dt>
<dd>
base name of the file hierarchy to be documented.
            The base name is stripped off the filename if it starts with
            the base name.
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>