Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.WebBrowser.Network.ProtocolHandlerManager.html
Documentation/Source/eric6.WebBrowser.Network.ProtocolHandlerManager.html
- changeset 6695
- 0a51887c13cd
equal
deleted
inserted
replaced
| 6692:c104c120e043 | 6695:0a51887c13cd |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.WebBrowser.Network.ProtocolHandlerManager</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.WebBrowser.Network.ProtocolHandlerManager</h1> | |
| 23 <p> | |
| 24 Module implementing the protocol handler manager. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#ProtocolHandlerManager">ProtocolHandlerManager</a></td> | |
| 34 <td>Class implementing the protocol handler manager.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="ProtocolHandlerManager" ID="ProtocolHandlerManager"></a> | |
| 43 <h2>ProtocolHandlerManager</h2> | |
| 44 <p> | |
| 45 Class implementing the protocol handler manager. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QObject | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#ProtocolHandlerManager.__init__">ProtocolHandlerManager</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#ProtocolHandlerManager.__load">__load</a></td> | |
| 64 <td>Private method to load the registered protocol handlers.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#ProtocolHandlerManager.__protocolHandlersFileName">__protocolHandlersFileName</a></td> | |
| 67 <td>Private method to determine the protocol handlers file name.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#ProtocolHandlerManager.__registerHandler">__registerHandler</a></td> | |
| 70 <td>Private method to register a protocol handler for a scheme.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#ProtocolHandlerManager.__save">__save</a></td> | |
| 73 <td>Private method to save the protocol handlers.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#ProtocolHandlerManager.__unregisterHandler">__unregisterHandler</a></td> | |
| 76 <td>Private method to unregister a protocol handler for a scheme.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#ProtocolHandlerManager.addProtocolHandler">addProtocolHandler</a></td> | |
| 79 <td>Public method to add a protocol handler for a scheme.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#ProtocolHandlerManager.protocolHandler">protocolHandler</a></td> | |
| 82 <td>Public method to get the protocol handler URL for a given scheme.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#ProtocolHandlerManager.protocolHandlers">protocolHandlers</a></td> | |
| 85 <td>Public method to get the registered protocol handlers.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#ProtocolHandlerManager.removeProtocolHandler">removeProtocolHandler</a></td> | |
| 88 <td>Public method to remove the protocol handler for a given scheme.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#ProtocolHandlerManager.showProtocolHandlerManagerDialog">showProtocolHandlerManagerDialog</a></td> | |
| 91 <td>Public method to show the protocol handler manager dialog.</td> | |
| 92 </tr> | |
| 93 </table> | |
| 94 <h3>Static Methods</h3> | |
| 95 <table> | |
| 96 <tr><td>None</td></tr> | |
| 97 </table> | |
| 98 <a NAME="ProtocolHandlerManager.__init__" ID="ProtocolHandlerManager.__init__"></a> | |
| 99 <h4>ProtocolHandlerManager (Constructor)</h4> | |
| 100 <b>ProtocolHandlerManager</b>(<i>parent=None</i>) | |
| 101 <p> | |
| 102 Constructor | |
| 103 </p><dl> | |
| 104 <dt><i>parent</i> (QObject)</dt> | |
| 105 <dd> | |
| 106 reference to the parent object | |
| 107 </dd> | |
| 108 </dl><a NAME="ProtocolHandlerManager.__load" ID="ProtocolHandlerManager.__load"></a> | |
| 109 <h4>ProtocolHandlerManager.__load</h4> | |
| 110 <b>__load</b>(<i></i>) | |
| 111 <p> | |
| 112 Private method to load the registered protocol handlers. | |
| 113 </p><a NAME="ProtocolHandlerManager.__protocolHandlersFileName" ID="ProtocolHandlerManager.__protocolHandlersFileName"></a> | |
| 114 <h4>ProtocolHandlerManager.__protocolHandlersFileName</h4> | |
| 115 <b>__protocolHandlersFileName</b>(<i></i>) | |
| 116 <p> | |
| 117 Private method to determine the protocol handlers file name. | |
| 118 </p><dl> | |
| 119 <dt>Returns:</dt> | |
| 120 <dd> | |
| 121 name of the protocol handlers file | |
| 122 </dd> | |
| 123 </dl><dl> | |
| 124 <dt>Return Type:</dt> | |
| 125 <dd> | |
| 126 str | |
| 127 </dd> | |
| 128 </dl><a NAME="ProtocolHandlerManager.__registerHandler" ID="ProtocolHandlerManager.__registerHandler"></a> | |
| 129 <h4>ProtocolHandlerManager.__registerHandler</h4> | |
| 130 <b>__registerHandler</b>(<i>scheme, url</i>) | |
| 131 <p> | |
| 132 Private method to register a protocol handler for a scheme. | |
| 133 </p><dl> | |
| 134 <dt><i>scheme</i> (str)</dt> | |
| 135 <dd> | |
| 136 scheme of the protocol handler | |
| 137 </dd><dt><i>url</i> (QUrl)</dt> | |
| 138 <dd> | |
| 139 URL of the protocol handler | |
| 140 </dd> | |
| 141 </dl><a NAME="ProtocolHandlerManager.__save" ID="ProtocolHandlerManager.__save"></a> | |
| 142 <h4>ProtocolHandlerManager.__save</h4> | |
| 143 <b>__save</b>(<i></i>) | |
| 144 <p> | |
| 145 Private method to save the protocol handlers. | |
| 146 </p><a NAME="ProtocolHandlerManager.__unregisterHandler" ID="ProtocolHandlerManager.__unregisterHandler"></a> | |
| 147 <h4>ProtocolHandlerManager.__unregisterHandler</h4> | |
| 148 <b>__unregisterHandler</b>(<i>scheme, url</i>) | |
| 149 <p> | |
| 150 Private method to unregister a protocol handler for a scheme. | |
| 151 </p><dl> | |
| 152 <dt><i>scheme</i> (str)</dt> | |
| 153 <dd> | |
| 154 scheme of the protocol handler | |
| 155 </dd><dt><i>url</i> (QUrl)</dt> | |
| 156 <dd> | |
| 157 URL of the protocol handler | |
| 158 </dd> | |
| 159 </dl><a NAME="ProtocolHandlerManager.addProtocolHandler" ID="ProtocolHandlerManager.addProtocolHandler"></a> | |
| 160 <h4>ProtocolHandlerManager.addProtocolHandler</h4> | |
| 161 <b>addProtocolHandler</b>(<i>scheme, url</i>) | |
| 162 <p> | |
| 163 Public method to add a protocol handler for a scheme. | |
| 164 </p><dl> | |
| 165 <dt><i>scheme</i> (str)</dt> | |
| 166 <dd> | |
| 167 scheme of the protocol handler | |
| 168 </dd><dt><i>url</i> (QUrl)</dt> | |
| 169 <dd> | |
| 170 URL of the protocol handler | |
| 171 </dd> | |
| 172 </dl><a NAME="ProtocolHandlerManager.protocolHandler" ID="ProtocolHandlerManager.protocolHandler"></a> | |
| 173 <h4>ProtocolHandlerManager.protocolHandler</h4> | |
| 174 <b>protocolHandler</b>(<i>scheme</i>) | |
| 175 <p> | |
| 176 Public method to get the protocol handler URL for a given scheme. | |
| 177 </p><dl> | |
| 178 <dt><i>scheme</i> (str)</dt> | |
| 179 <dd> | |
| 180 scheme to look for | |
| 181 </dd> | |
| 182 </dl><dl> | |
| 183 <dt>Returns:</dt> | |
| 184 <dd> | |
| 185 protocol handler URL | |
| 186 </dd> | |
| 187 </dl><dl> | |
| 188 <dt>Return Type:</dt> | |
| 189 <dd> | |
| 190 QUrl | |
| 191 </dd> | |
| 192 </dl><a NAME="ProtocolHandlerManager.protocolHandlers" ID="ProtocolHandlerManager.protocolHandlers"></a> | |
| 193 <h4>ProtocolHandlerManager.protocolHandlers</h4> | |
| 194 <b>protocolHandlers</b>(<i></i>) | |
| 195 <p> | |
| 196 Public method to get the registered protocol handlers. | |
| 197 </p><dl> | |
| 198 <dt>Returns:</dt> | |
| 199 <dd> | |
| 200 dictionary containing the registered protocol handlers | |
| 201 </dd> | |
| 202 </dl><dl> | |
| 203 <dt>Return Type:</dt> | |
| 204 <dd> | |
| 205 dict | |
| 206 </dd> | |
| 207 </dl><a NAME="ProtocolHandlerManager.removeProtocolHandler" ID="ProtocolHandlerManager.removeProtocolHandler"></a> | |
| 208 <h4>ProtocolHandlerManager.removeProtocolHandler</h4> | |
| 209 <b>removeProtocolHandler</b>(<i>scheme</i>) | |
| 210 <p> | |
| 211 Public method to remove the protocol handler for a given scheme. | |
| 212 </p><dl> | |
| 213 <dt><i>scheme</i> (str)</dt> | |
| 214 <dd> | |
| 215 scheme to remove | |
| 216 </dd> | |
| 217 </dl><a NAME="ProtocolHandlerManager.showProtocolHandlerManagerDialog" ID="ProtocolHandlerManager.showProtocolHandlerManagerDialog"></a> | |
| 218 <h4>ProtocolHandlerManager.showProtocolHandlerManagerDialog</h4> | |
| 219 <b>showProtocolHandlerManagerDialog</b>(<i></i>) | |
| 220 <p> | |
| 221 Public method to show the protocol handler manager dialog. | |
| 222 </p> | |
| 223 <div align="right"><a href="#top">Up</a></div> | |
| 224 <hr /> | |
| 225 </body></html> |
