Mercurial Repositories > eric / file diff

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

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

changeset 4918
71caf42a13d8
child 6123
39cd368143db
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.WebBrowser.Network.QtHelpSchemeHandler.html	Sun Apr 03 17:10:43 2016 +0200
@@ -0,0 +1,240 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.WebBrowser.Network.QtHelpSchemeHandler</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<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>
+<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 />
+<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>
+<td><a href="#QtHelpSchemeHandler.__replyClosed">__replyClosed</a></td>
+<td>Private slot handling the closed signal of a reply.</td>
+</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>
+<dt><i>engine</i> (QHelpEngine)</dt>
+<dd>
+reference to the help engine
+</dd><dt><i>parent</i> (QObject)</dt>
+<dd>
+reference to the parent object
+</dd>
+</dl><a NAME="QtHelpSchemeHandler.__replyClosed" ID="QtHelpSchemeHandler.__replyClosed"></a>
+<h4>QtHelpSchemeHandler.__replyClosed</h4>
+<b>__replyClosed</b>(<i></i>)
+<p>
+        Private slot handling the closed signal of a reply.
+</p><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>
+<dt><i>job</i> (QWebEngineUrlRequestJob)</dt>
+<dd>
+URL request job
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<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>
+<dl>
+<dt>closed</dt>
+<dd>
+emitted to signal that the web engine has read
+        the data
+</dd>
+</dl>
+<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>
+<td><a href="#QtHelpSchemeReply.__mimeFromUrl">__mimeFromUrl</a></td>
+<td>Private method to guess the mime type given an URL.</td>
+</tr><tr>
+<td><a href="#QtHelpSchemeReply.bytesAvailable">bytesAvailable</a></td>
+<td>Public method to get the number of available bytes.</td>
+</tr><tr>
+<td><a href="#QtHelpSchemeReply.close">close</a></td>
+<td>Public method used to cloase the reply.</td>
+</tr><tr>
+<td><a href="#QtHelpSchemeReply.mimeType">mimeType</a></td>
+<td>Public method to get the reply mime type.</td>
+</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>
+<dt><i>job</i> (QWebEngineUrlRequestJob)</dt>
+<dd>
+reference to the URL request
+</dd><dt><i>engine</i> (QHelpEngine)</dt>
+<dd>
+reference to the help engine
+</dd><dt><i>parent</i> (QObject)</dt>
+<dd>
+reference to the parent object
+</dd>
+</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>
+<dt><i>url</i></dt>
+<dd>
+URL to guess the mime type from (QUrl)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+mime type for the given URL (string)
+</dd>
+</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>
+<dt>Returns:</dt>
+<dd>
+number of available bytes
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+int
+</dd>
+</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>
+<h4>QtHelpSchemeReply.mimeType</h4>
+<b>mimeType</b>(<i></i>)
+<p>
+        Public method to get the reply mime type.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+mime type of the reply
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bytes
+</dd>
+</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>
+<dt><i>maxlen</i></dt>
+<dd>
+maximum number of bytes to read (integer)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+string containing the data (bytes)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

Mercurial Repository: eric

eric ide

mercurial