--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.WebBrowser.Network.ProtocolHandlerManager.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,291 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.WebBrowser.Network.ProtocolHandlerManager</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>eric7.WebBrowser.Network.ProtocolHandlerManager</h1> + +<p> +Module implementing the protocol handler manager. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#ProtocolHandlerManager">ProtocolHandlerManager</a></td> +<td>Class implementing the protocol handler manager.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="ProtocolHandlerManager" ID="ProtocolHandlerManager"></a> +<h2>ProtocolHandlerManager</h2> + +<p> + Class implementing the protocol handler manager. +</p> +<h3>Derived from</h3> +QObject +<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="#ProtocolHandlerManager.__init__">ProtocolHandlerManager</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#ProtocolHandlerManager.__load">__load</a></td> +<td>Private method to load the registered protocol handlers.</td> +</tr> +<tr> +<td><a href="#ProtocolHandlerManager.__protocolHandlersFileName">__protocolHandlersFileName</a></td> +<td>Private method to determine the protocol handlers file name.</td> +</tr> +<tr> +<td><a href="#ProtocolHandlerManager.__registerHandler">__registerHandler</a></td> +<td>Private method to register a protocol handler for a scheme.</td> +</tr> +<tr> +<td><a href="#ProtocolHandlerManager.__save">__save</a></td> +<td>Private method to save the protocol handlers.</td> +</tr> +<tr> +<td><a href="#ProtocolHandlerManager.__unregisterHandler">__unregisterHandler</a></td> +<td>Private method to unregister a protocol handler for a scheme.</td> +</tr> +<tr> +<td><a href="#ProtocolHandlerManager.addProtocolHandler">addProtocolHandler</a></td> +<td>Public method to add a protocol handler for a scheme.</td> +</tr> +<tr> +<td><a href="#ProtocolHandlerManager.protocolHandler">protocolHandler</a></td> +<td>Public method to get the protocol handler URL for a given scheme.</td> +</tr> +<tr> +<td><a href="#ProtocolHandlerManager.protocolHandlers">protocolHandlers</a></td> +<td>Public method to get the registered protocol handlers.</td> +</tr> +<tr> +<td><a href="#ProtocolHandlerManager.removeProtocolHandler">removeProtocolHandler</a></td> +<td>Public method to remove the protocol handler for a given scheme.</td> +</tr> +<tr> +<td><a href="#ProtocolHandlerManager.showProtocolHandlerManagerDialog">showProtocolHandlerManagerDialog</a></td> +<td>Public method to show the protocol handler manager dialog.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="ProtocolHandlerManager.__init__" ID="ProtocolHandlerManager.__init__"></a> +<h4>ProtocolHandlerManager (Constructor)</h4> +<b>ProtocolHandlerManager</b>(<i>parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>parent</i> (QObject)</dt> +<dd> +reference to the parent object +</dd> +</dl> +<a NAME="ProtocolHandlerManager.__load" ID="ProtocolHandlerManager.__load"></a> +<h4>ProtocolHandlerManager.__load</h4> +<b>__load</b>(<i></i>) + +<p> + Private method to load the registered protocol handlers. +</p> +<a NAME="ProtocolHandlerManager.__protocolHandlersFileName" ID="ProtocolHandlerManager.__protocolHandlersFileName"></a> +<h4>ProtocolHandlerManager.__protocolHandlersFileName</h4> +<b>__protocolHandlersFileName</b>(<i></i>) + +<p> + Private method to determine the protocol handlers file name. +</p> +<dl> +<dt>Return:</dt> +<dd> +name of the protocol handlers file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="ProtocolHandlerManager.__registerHandler" ID="ProtocolHandlerManager.__registerHandler"></a> +<h4>ProtocolHandlerManager.__registerHandler</h4> +<b>__registerHandler</b>(<i>scheme, url</i>) + +<p> + Private method to register a protocol handler for a scheme. +</p> +<dl> + +<dt><i>scheme</i> (str)</dt> +<dd> +scheme of the protocol handler +</dd> +<dt><i>url</i> (QUrl)</dt> +<dd> +URL of the protocol handler +</dd> +</dl> +<a NAME="ProtocolHandlerManager.__save" ID="ProtocolHandlerManager.__save"></a> +<h4>ProtocolHandlerManager.__save</h4> +<b>__save</b>(<i></i>) + +<p> + Private method to save the protocol handlers. +</p> +<a NAME="ProtocolHandlerManager.__unregisterHandler" ID="ProtocolHandlerManager.__unregisterHandler"></a> +<h4>ProtocolHandlerManager.__unregisterHandler</h4> +<b>__unregisterHandler</b>(<i>scheme, url</i>) + +<p> + Private method to unregister a protocol handler for a scheme. +</p> +<dl> + +<dt><i>scheme</i> (str)</dt> +<dd> +scheme of the protocol handler +</dd> +<dt><i>url</i> (QUrl)</dt> +<dd> +URL of the protocol handler +</dd> +</dl> +<a NAME="ProtocolHandlerManager.addProtocolHandler" ID="ProtocolHandlerManager.addProtocolHandler"></a> +<h4>ProtocolHandlerManager.addProtocolHandler</h4> +<b>addProtocolHandler</b>(<i>scheme, url</i>) + +<p> + Public method to add a protocol handler for a scheme. +</p> +<dl> + +<dt><i>scheme</i> (str)</dt> +<dd> +scheme of the protocol handler +</dd> +<dt><i>url</i> (QUrl)</dt> +<dd> +URL of the protocol handler +</dd> +</dl> +<a NAME="ProtocolHandlerManager.protocolHandler" ID="ProtocolHandlerManager.protocolHandler"></a> +<h4>ProtocolHandlerManager.protocolHandler</h4> +<b>protocolHandler</b>(<i>scheme</i>) + +<p> + Public method to get the protocol handler URL for a given scheme. +</p> +<dl> + +<dt><i>scheme</i> (str)</dt> +<dd> +scheme to look for +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +protocol handler URL +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QUrl +</dd> +</dl> +<a NAME="ProtocolHandlerManager.protocolHandlers" ID="ProtocolHandlerManager.protocolHandlers"></a> +<h4>ProtocolHandlerManager.protocolHandlers</h4> +<b>protocolHandlers</b>(<i></i>) + +<p> + Public method to get the registered protocol handlers. +</p> +<dl> +<dt>Return:</dt> +<dd> +dictionary containing the registered protocol handlers +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<a NAME="ProtocolHandlerManager.removeProtocolHandler" ID="ProtocolHandlerManager.removeProtocolHandler"></a> +<h4>ProtocolHandlerManager.removeProtocolHandler</h4> +<b>removeProtocolHandler</b>(<i>scheme</i>) + +<p> + Public method to remove the protocol handler for a given scheme. +</p> +<dl> + +<dt><i>scheme</i> (str)</dt> +<dd> +scheme to remove +</dd> +</dl> +<a NAME="ProtocolHandlerManager.showProtocolHandlerManagerDialog" ID="ProtocolHandlerManager.showProtocolHandlerManagerDialog"></a> +<h4>ProtocolHandlerManager.showProtocolHandlerManagerDialog</h4> +<b>showProtocolHandlerManagerDialog</b>(<i></i>) + +<p> + Public method to show the protocol handler manager dialog. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file