eric6/Documentation/Source/eric6.WebBrowser.Network.QtHelpSchemeHandler.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
--- a/eric6/Documentation/Source/eric6.WebBrowser.Network.QtHelpSchemeHandler.html	Wed Sep 25 19:40:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.WebBrowser.Network.QtHelpSchemeHandler.html	Wed Sep 25 19:42:44 2019 +0200
@@ -18,104 +18,137 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
 <h1>eric6.WebBrowser.Network.QtHelpSchemeHandler</h1>
+
 <p>
 Module implementing a scheme access handler for QtHelp.
 </p>
 <h3>Global Attributes</h3>
+
 <table>
 <tr><td>ExtensionMap</td></tr><tr><td>QtDocPath</td></tr>
 </table>
 <h3>Classes</h3>
+
 <table>
+
 <tr>
 <td><a href="#QtHelpSchemeHandler">QtHelpSchemeHandler</a></td>
 <td>Class implementing a scheme handler for the qthelp: scheme.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#QtHelpSchemeReply">QtHelpSchemeReply</a></td>
 <td>Class implementing a reply for a requested qthelp: page.</td>
 </tr>
 </table>
 <h3>Functions</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="QtHelpSchemeHandler" ID="QtHelpSchemeHandler"></a>
 <h2>QtHelpSchemeHandler</h2>
+
 <p>
     Class implementing a scheme handler for the qthelp: scheme.
 </p>
 <h3>Derived from</h3>
 QWebEngineUrlSchemeHandler
 <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="#QtHelpSchemeHandler.__init__">QtHelpSchemeHandler</a></td>
 <td>Constructor</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#QtHelpSchemeHandler.__replyClosed">__replyClosed</a></td>
 <td>Private slot handling the closed signal of a reply.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#QtHelpSchemeHandler.requestStarted">requestStarted</a></td>
 <td>Public method handling the URL request.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
+
 <a NAME="QtHelpSchemeHandler.__init__" ID="QtHelpSchemeHandler.__init__"></a>
 <h4>QtHelpSchemeHandler (Constructor)</h4>
 <b>QtHelpSchemeHandler</b>(<i>engine, parent=None</i>)
+
 <p>
         Constructor
-</p><dl>
+</p>
+<dl>
+
 <dt><i>engine</i> (QHelpEngine)</dt>
 <dd>
 reference to the help engine
-</dd><dt><i>parent</i> (QObject)</dt>
+</dd>
+<dt><i>parent</i> (QObject)</dt>
 <dd>
 reference to the parent object
 </dd>
-</dl><a NAME="QtHelpSchemeHandler.__replyClosed" ID="QtHelpSchemeHandler.__replyClosed"></a>
+</dl>
+<a NAME="QtHelpSchemeHandler.__replyClosed" ID="QtHelpSchemeHandler.__replyClosed"></a>
 <h4>QtHelpSchemeHandler.__replyClosed</h4>
 <b>__replyClosed</b>(<i>reply</i>)
+
 <p>
         Private slot handling the closed signal of a reply.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>reply</i> (QtHelpSchemeReply)</dt>
 <dd>
 reference to the network reply
 </dd>
-</dl><a NAME="QtHelpSchemeHandler.requestStarted" ID="QtHelpSchemeHandler.requestStarted"></a>
+</dl>
+<a NAME="QtHelpSchemeHandler.requestStarted" ID="QtHelpSchemeHandler.requestStarted"></a>
 <h4>QtHelpSchemeHandler.requestStarted</h4>
 <b>requestStarted</b>(<i>job</i>)
+
 <p>
         Public method handling the URL request.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>job</i> (QWebEngineUrlRequestJob)</dt>
 <dd>
 URL request job
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="QtHelpSchemeReply" ID="QtHelpSchemeReply"></a>
 <h2>QtHelpSchemeReply</h2>
+
 <p>
     Class implementing a reply for a requested qthelp: page.
-</p><h3>Signals</h3>
+</p>
+<h3>Signals</h3>
 <dl>
+
 <dt>closed</dt>
 <dd>
 emitted to signal that the web engine has read
@@ -125,129 +158,170 @@
 <h3>Derived from</h3>
 QIODevice
 <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="#QtHelpSchemeReply.__init__">QtHelpSchemeReply</a></td>
 <td>Constructor</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#QtHelpSchemeReply.__loadQtHelpPage">__loadQtHelpPage</a></td>
 <td>Private method to load the requested QtHelp page.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#QtHelpSchemeReply.__mimeFromUrl">__mimeFromUrl</a></td>
 <td>Private method to guess the mime type given an URL.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#QtHelpSchemeReply.bytesAvailable">bytesAvailable</a></td>
 <td>Public method to get the number of available bytes.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#QtHelpSchemeReply.close">close</a></td>
 <td>Public method used to cloase the reply.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#QtHelpSchemeReply.mimeType">mimeType</a></td>
 <td>Public method to get the reply mime type.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#QtHelpSchemeReply.readData">readData</a></td>
 <td>Public method to retrieve data from the reply object.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
+
 <a NAME="QtHelpSchemeReply.__init__" ID="QtHelpSchemeReply.__init__"></a>
 <h4>QtHelpSchemeReply (Constructor)</h4>
 <b>QtHelpSchemeReply</b>(<i>job, engine, parent=None</i>)
+
 <p>
         Constructor
-</p><dl>
+</p>
+<dl>
+
 <dt><i>job</i> (QWebEngineUrlRequestJob)</dt>
 <dd>
 reference to the URL request
-</dd><dt><i>engine</i> (QHelpEngine)</dt>
+</dd>
+<dt><i>engine</i> (QHelpEngine)</dt>
 <dd>
 reference to the help engine
-</dd><dt><i>parent</i> (QObject)</dt>
+</dd>
+<dt><i>parent</i> (QObject)</dt>
 <dd>
 reference to the parent object
 </dd>
-</dl><a NAME="QtHelpSchemeReply.__loadQtHelpPage" ID="QtHelpSchemeReply.__loadQtHelpPage"></a>
+</dl>
+<a NAME="QtHelpSchemeReply.__loadQtHelpPage" ID="QtHelpSchemeReply.__loadQtHelpPage"></a>
 <h4>QtHelpSchemeReply.__loadQtHelpPage</h4>
 <b>__loadQtHelpPage</b>(<i>url</i>)
+
 <p>
         Private method to load the requested QtHelp page.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>url</i> (QUrl)</dt>
 <dd>
 URL of the requested page
 </dd>
-</dl><a NAME="QtHelpSchemeReply.__mimeFromUrl" ID="QtHelpSchemeReply.__mimeFromUrl"></a>
+</dl>
+<a NAME="QtHelpSchemeReply.__mimeFromUrl" ID="QtHelpSchemeReply.__mimeFromUrl"></a>
 <h4>QtHelpSchemeReply.__mimeFromUrl</h4>
 <b>__mimeFromUrl</b>(<i>url</i>)
+
 <p>
         Private method to guess the mime type given an URL.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>url</i></dt>
 <dd>
 URL to guess the mime type from (QUrl)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 mime type for the given URL (string)
 </dd>
-</dl><a NAME="QtHelpSchemeReply.bytesAvailable" ID="QtHelpSchemeReply.bytesAvailable"></a>
+</dl>
+<a NAME="QtHelpSchemeReply.bytesAvailable" ID="QtHelpSchemeReply.bytesAvailable"></a>
 <h4>QtHelpSchemeReply.bytesAvailable</h4>
 <b>bytesAvailable</b>(<i></i>)
+
 <p>
         Public method to get the number of available bytes.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 number of available bytes
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Return Type:</dt>
 <dd>
 int
 </dd>
-</dl><a NAME="QtHelpSchemeReply.close" ID="QtHelpSchemeReply.close"></a>
+</dl>
+<a NAME="QtHelpSchemeReply.close" ID="QtHelpSchemeReply.close"></a>
 <h4>QtHelpSchemeReply.close</h4>
 <b>close</b>(<i></i>)
+
 <p>
         Public method used to cloase the reply.
-</p><a NAME="QtHelpSchemeReply.mimeType" ID="QtHelpSchemeReply.mimeType"></a>
+</p>
+<a NAME="QtHelpSchemeReply.mimeType" ID="QtHelpSchemeReply.mimeType"></a>
 <h4>QtHelpSchemeReply.mimeType</h4>
 <b>mimeType</b>(<i></i>)
+
 <p>
         Public method to get the reply mime type.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 mime type of the reply
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Return Type:</dt>
 <dd>
 bytes
 </dd>
-</dl><a NAME="QtHelpSchemeReply.readData" ID="QtHelpSchemeReply.readData"></a>
+</dl>
+<a NAME="QtHelpSchemeReply.readData" ID="QtHelpSchemeReply.readData"></a>
 <h4>QtHelpSchemeReply.readData</h4>
 <b>readData</b>(<i>maxlen</i>)
+
 <p>
         Public method to retrieve data from the reply object.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>maxlen</i></dt>
 <dd>
 maximum number of bytes to read (integer)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 string containing the data (bytes)

eric ide

mercurial