diff -r b43e04854aba -r 2eee7a645cba src/eric7/Documentation/Source/eric7.WebBrowser.QtHelp.QtHelpDocumentationSettings.html --- a/src/eric7/Documentation/Source/eric7.WebBrowser.QtHelp.QtHelpDocumentationSettings.html Sun Jan 08 16:11:22 2023 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,325 +0,0 @@ -<!DOCTYPE html> -<html><head> -<title>eric7.WebBrowser.QtHelp.QtHelpDocumentationSettings</title> -<meta charset="UTF-8"> -<link rel="stylesheet" href="styles.css"> -</head> -<body> -<a NAME="top" ID="top"></a> -<h1>eric7.WebBrowser.QtHelp.QtHelpDocumentationSettings</h1> - -<p> -Module implementing a class to store the QtHelp documentation settings before -being applied to the help engine. -</p> -<h3>Global Attributes</h3> - -<table> -<tr><td>None</td></tr> -</table> -<h3>Classes</h3> - -<table> - -<tr> -<td><a href="#QtHelpDocumentationSettings">QtHelpDocumentationSettings</a></td> -<td>Class implementing a temporary store for QtHelp documentation settings.</td> -</tr> -</table> -<h3>Functions</h3> - -<table> -<tr><td>None</td></tr> -</table> -<hr /> -<hr /> -<a NAME="QtHelpDocumentationSettings" ID="QtHelpDocumentationSettings"></a> -<h2>QtHelpDocumentationSettings</h2> - -<p> - Class implementing a temporary store for QtHelp documentation settings. -</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="#QtHelpDocumentationSettings.__init__">QtHelpDocumentationSettings</a></td> -<td>Constructor</td> -</tr> -<tr> -<td><a href="#QtHelpDocumentationSettings.addDocumentation">addDocumentation</a></td> -<td>Public method to a add a documentation file to the list.</td> -</tr> -<tr> -<td><a href="#QtHelpDocumentationSettings.components">components</a></td> -<td>Public method to get the list of components.</td> -</tr> -<tr> -<td><a href="#QtHelpDocumentationSettings.namespace">namespace</a></td> -<td>Public method to get the namespace defined by a QtHelp file.</td> -</tr> -<tr> -<td><a href="#QtHelpDocumentationSettings.namespaceToFilename">namespaceToFilename</a></td> -<td>Public method to get the namespace to filename mapping.</td> -</tr> -<tr> -<td><a href="#QtHelpDocumentationSettings.namespaces">namespaces</a></td> -<td>Public method to get the list of namespaces.</td> -</tr> -<tr> -<td><a href="#QtHelpDocumentationSettings.removeDocumentation">removeDocumentation</a></td> -<td>Public method to remove the documentation of a given namespace.</td> -</tr> -<tr> -<td><a href="#QtHelpDocumentationSettings.versions">versions</a></td> -<td>Public method to get the list of versions.</td> -</tr> -</table> -<h3>Static Methods</h3> - -<table> - -<tr> -<td><a href="#QtHelpDocumentationSettings.applySettings">applySettings</a></td> -<td>Static method to apply the changed QtHelp documentation configuration.</td> -</tr> -<tr> -<td><a href="#QtHelpDocumentationSettings.readSettings">readSettings</a></td> -<td>Static method to read the QtHelp documentation configuration.</td> -</tr> -</table> - -<a NAME="QtHelpDocumentationSettings.__init__" ID="QtHelpDocumentationSettings.__init__"></a> -<h4>QtHelpDocumentationSettings (Constructor)</h4> -<b>QtHelpDocumentationSettings</b>(<i></i>) - -<p> - Constructor -</p> -<a NAME="QtHelpDocumentationSettings.addDocumentation" ID="QtHelpDocumentationSettings.addDocumentation"></a> -<h4>QtHelpDocumentationSettings.addDocumentation</h4> -<b>addDocumentation</b>(<i>filename</i>) - -<p> - Public method to a add a documentation file to the list. -</p> -<dl> - -<dt><i>filename</i> (str)</dt> -<dd> -name of the documentation file to add -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -flag indicating success -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> -<a NAME="QtHelpDocumentationSettings.components" ID="QtHelpDocumentationSettings.components"></a> -<h4>QtHelpDocumentationSettings.components</h4> -<b>components</b>(<i></i>) - -<p> - Public method to get the list of components. -</p> -<dl> -<dt>Return:</dt> -<dd> -list of components -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -list of str -</dd> -</dl> -<a NAME="QtHelpDocumentationSettings.namespace" ID="QtHelpDocumentationSettings.namespace"></a> -<h4>QtHelpDocumentationSettings.namespace</h4> -<b>namespace</b>(<i>filename</i>) - -<p> - Public method to get the namespace defined by a QtHelp file. -</p> -<dl> - -<dt><i>filename</i> (str)</dt> -<dd> -name of the QtHelp file -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -name of the namespace -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl> -<a NAME="QtHelpDocumentationSettings.namespaceToFilename" ID="QtHelpDocumentationSettings.namespaceToFilename"></a> -<h4>QtHelpDocumentationSettings.namespaceToFilename</h4> -<b>namespaceToFilename</b>(<i></i>) - -<p> - Public method to get the namespace to filename mapping. -</p> -<dl> -<dt>Return:</dt> -<dd> -dictionary containing the namespace to filename mapping -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -dict -</dd> -</dl> -<a NAME="QtHelpDocumentationSettings.namespaces" ID="QtHelpDocumentationSettings.namespaces"></a> -<h4>QtHelpDocumentationSettings.namespaces</h4> -<b>namespaces</b>(<i></i>) - -<p> - Public method to get the list of namespaces. -</p> -<dl> -<dt>Return:</dt> -<dd> -list of namespaces -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -list of str -</dd> -</dl> -<a NAME="QtHelpDocumentationSettings.removeDocumentation" ID="QtHelpDocumentationSettings.removeDocumentation"></a> -<h4>QtHelpDocumentationSettings.removeDocumentation</h4> -<b>removeDocumentation</b>(<i>namespace</i>) - -<p> - Public method to remove the documentation of a given namespace. -</p> -<dl> - -<dt><i>namespace</i> (str)</dt> -<dd> -name of the namespace -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -flag indicating success -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> -<a NAME="QtHelpDocumentationSettings.versions" ID="QtHelpDocumentationSettings.versions"></a> -<h4>QtHelpDocumentationSettings.versions</h4> -<b>versions</b>(<i></i>) - -<p> - Public method to get the list of versions. -</p> -<dl> -<dt>Return:</dt> -<dd> -list of versions -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -list of QVersionNumber -</dd> -</dl> -<a NAME="QtHelpDocumentationSettings.applySettings" ID="QtHelpDocumentationSettings.applySettings"></a> -<h4>QtHelpDocumentationSettings.applySettings (static)</h4> -<b>applySettings</b>(<i>settings</i>) - -<p> - Static method to apply the changed QtHelp documentation configuration. -</p> -<dl> - -<dt><i>helpEngine</i> (QHelpEngineCore)</dt> -<dd> -reference to the QtHelp engine -</dd> -<dt><i>settings</i> (QtHelpDocumentationSettings)</dt> -<dd> -reference to the created QtHelpDocumentationSettings - object -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -flag indicating success -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> -<a NAME="QtHelpDocumentationSettings.readSettings" ID="QtHelpDocumentationSettings.readSettings"></a> -<h4>QtHelpDocumentationSettings.readSettings (static)</h4> -<b>readSettings</b>(<i></i>) - -<p> - Static method to read the QtHelp documentation configuration. -</p> -<dl> - -<dt><i>helpEngine</i> (QHelpEngineCore)</dt> -<dd> -reference to the QtHelp engine -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -reference to the created QtHelpDocumentationSettings object -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -QtHelpDocumentationSettings -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -</body></html> \ No newline at end of file