Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockManager.html
Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockManager.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Helpviewer.AdBlock.AdBlockManager</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.Helpviewer.AdBlock.AdBlockManager</h1> | |
| 12 <p> | |
| 13 Module implementing the AdBlock manager. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#AdBlockManager">AdBlockManager</a></td> | |
| 23 <td>Class implementing the AdBlock manager.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <hr /><hr /> | |
| 31 <a NAME="AdBlockManager" ID="AdBlockManager"></a> | |
| 32 <h2>AdBlockManager</h2> | |
| 33 <p> | |
| 34 Class implementing the AdBlock manager. | |
| 35 </p><h4>Signals</h4> | |
| 36 <dl> | |
| 37 <dt>rulesChanged()</dt> | |
| 38 <dd> | |
| 39 emitted after some rule has changed | |
| 40 </dd> | |
| 41 </dl> | |
| 42 <h3>Derived from</h3> | |
| 43 QObject | |
| 44 <h3>Class Attributes</h3> | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Methods</h3> | |
| 49 <table> | |
| 50 <tr> | |
| 51 <td><a href="#AdBlockManager.__init__">AdBlockManager</a></td> | |
| 52 <td>Constructor</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#AdBlockManager.__customSubscriptionLocation">__customSubscriptionLocation</a></td> | |
| 55 <td>Private method to generate the path for custom subscriptions.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#AdBlockManager.__customSubscriptionUrl">__customSubscriptionUrl</a></td> | |
| 58 <td>Private method to generate the URL for custom subscriptions.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#AdBlockManager.addSubscription">addSubscription</a></td> | |
| 61 <td>Public method to add an AdBlock subscription.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#AdBlockManager.close">close</a></td> | |
| 64 <td>Public method to close the open search engines manager.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#AdBlockManager.customRules">customRules</a></td> | |
| 67 <td>Public method to get a subscription for custom rules.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#AdBlockManager.isEnabled">isEnabled</a></td> | |
| 70 <td>Public method to check, if blocking ads is enabled.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#AdBlockManager.load">load</a></td> | |
| 73 <td>Public method to load the AdBlock subscriptions.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#AdBlockManager.network">network</a></td> | |
| 76 <td>Public method to get a reference to the network block object.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#AdBlockManager.page">page</a></td> | |
| 79 <td>Public method to get a reference to the page block object.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#AdBlockManager.removeSubscription">removeSubscription</a></td> | |
| 82 <td>Public method to remove an AdBlock subscription.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#AdBlockManager.save">save</a></td> | |
| 85 <td>Public method to save the AdBlock subscriptions.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#AdBlockManager.setEnabled">setEnabled</a></td> | |
| 88 <td>Public slot to set the enabled state.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#AdBlockManager.showDialog">showDialog</a></td> | |
| 91 <td>Public slot to show the AdBlock subscription management dialog.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#AdBlockManager.subscriptions">subscriptions</a></td> | |
| 94 <td>Public method to get all subscriptions.</td> | |
| 95 </tr> | |
| 96 </table> | |
| 97 <a NAME="AdBlockManager.__init__" ID="AdBlockManager.__init__"></a> | |
| 98 <h4>AdBlockManager (Constructor)</h4> | |
| 99 <b>AdBlockManager</b>(<i>parent = None</i>) | |
| 100 <p> | |
| 101 Constructor | |
| 102 </p><dl> | |
| 103 <dt><i>parent</i></dt> | |
| 104 <dd> | |
| 105 reference to the parent object (QObject) | |
| 106 </dd> | |
| 107 </dl><a NAME="AdBlockManager.__customSubscriptionLocation" ID="AdBlockManager.__customSubscriptionLocation"></a> | |
| 108 <h4>AdBlockManager.__customSubscriptionLocation</h4> | |
| 109 <b>__customSubscriptionLocation</b>(<i></i>) | |
| 110 <p> | |
| 111 Private method to generate the path for custom subscriptions. | |
| 112 </p><dl> | |
| 113 <dt>Returns:</dt> | |
| 114 <dd> | |
| 115 URL for custom subscriptions (QUrl) | |
| 116 </dd> | |
| 117 </dl><a NAME="AdBlockManager.__customSubscriptionUrl" ID="AdBlockManager.__customSubscriptionUrl"></a> | |
| 118 <h4>AdBlockManager.__customSubscriptionUrl</h4> | |
| 119 <b>__customSubscriptionUrl</b>(<i></i>) | |
| 120 <p> | |
| 121 Private method to generate the URL for custom subscriptions. | |
| 122 </p><dl> | |
| 123 <dt>Returns:</dt> | |
| 124 <dd> | |
| 125 URL for custom subscriptions (QUrl) | |
| 126 </dd> | |
| 127 </dl><a NAME="AdBlockManager.addSubscription" ID="AdBlockManager.addSubscription"></a> | |
| 128 <h4>AdBlockManager.addSubscription</h4> | |
| 129 <b>addSubscription</b>(<i>subscription</i>) | |
| 130 <p> | |
| 131 Public method to add an AdBlock subscription. | |
| 132 </p><dl> | |
| 133 <dt><i>subscription</i></dt> | |
| 134 <dd> | |
| 135 AdBlock subscription to be added (AdBlockSubscription) | |
| 136 </dd> | |
| 137 </dl><a NAME="AdBlockManager.close" ID="AdBlockManager.close"></a> | |
| 138 <h4>AdBlockManager.close</h4> | |
| 139 <b>close</b>(<i></i>) | |
| 140 <p> | |
| 141 Public method to close the open search engines manager. | |
| 142 </p><a NAME="AdBlockManager.customRules" ID="AdBlockManager.customRules"></a> | |
| 143 <h4>AdBlockManager.customRules</h4> | |
| 144 <b>customRules</b>(<i></i>) | |
| 145 <p> | |
| 146 Public method to get a subscription for custom rules. | |
| 147 </p><dl> | |
| 148 <dt>Returns:</dt> | |
| 149 <dd> | |
| 150 subscription object for custom rules (AdBlockSubscription) | |
| 151 </dd> | |
| 152 </dl><a NAME="AdBlockManager.isEnabled" ID="AdBlockManager.isEnabled"></a> | |
| 153 <h4>AdBlockManager.isEnabled</h4> | |
| 154 <b>isEnabled</b>(<i></i>) | |
| 155 <p> | |
| 156 Public method to check, if blocking ads is enabled. | |
| 157 </p><dl> | |
| 158 <dt>Returns:</dt> | |
| 159 <dd> | |
| 160 flag indicating the enabled state (boolean) | |
| 161 </dd> | |
| 162 </dl><a NAME="AdBlockManager.load" ID="AdBlockManager.load"></a> | |
| 163 <h4>AdBlockManager.load</h4> | |
| 164 <b>load</b>(<i></i>) | |
| 165 <p> | |
| 166 Public method to load the AdBlock subscriptions. | |
| 167 </p><a NAME="AdBlockManager.network" ID="AdBlockManager.network"></a> | |
| 168 <h4>AdBlockManager.network</h4> | |
| 169 <b>network</b>(<i></i>) | |
| 170 <p> | |
| 171 Public method to get a reference to the network block object. | |
| 172 </p><dl> | |
| 173 <dt>Returns:</dt> | |
| 174 <dd> | |
| 175 reference to the network block object (AdBlockNetwork) | |
| 176 </dd> | |
| 177 </dl><a NAME="AdBlockManager.page" ID="AdBlockManager.page"></a> | |
| 178 <h4>AdBlockManager.page</h4> | |
| 179 <b>page</b>(<i></i>) | |
| 180 <p> | |
| 181 Public method to get a reference to the page block object. | |
| 182 </p><dl> | |
| 183 <dt>Returns:</dt> | |
| 184 <dd> | |
| 185 reference to the page block object (AdBlockPage) | |
| 186 </dd> | |
| 187 </dl><a NAME="AdBlockManager.removeSubscription" ID="AdBlockManager.removeSubscription"></a> | |
| 188 <h4>AdBlockManager.removeSubscription</h4> | |
| 189 <b>removeSubscription</b>(<i>subscription</i>) | |
| 190 <p> | |
| 191 Public method to remove an AdBlock subscription. | |
| 192 </p><dl> | |
| 193 <dt><i>subscription</i></dt> | |
| 194 <dd> | |
| 195 AdBlock subscription to be removed (AdBlockSubscription) | |
| 196 </dd> | |
| 197 </dl><a NAME="AdBlockManager.save" ID="AdBlockManager.save"></a> | |
| 198 <h4>AdBlockManager.save</h4> | |
| 199 <b>save</b>(<i></i>) | |
| 200 <p> | |
| 201 Public method to save the AdBlock subscriptions. | |
| 202 </p><a NAME="AdBlockManager.setEnabled" ID="AdBlockManager.setEnabled"></a> | |
| 203 <h4>AdBlockManager.setEnabled</h4> | |
| 204 <b>setEnabled</b>(<i>enabled</i>) | |
| 205 <p> | |
| 206 Public slot to set the enabled state. | |
| 207 </p><dl> | |
| 208 <dt><i>enabled</i></dt> | |
| 209 <dd> | |
| 210 flag indicating the enabled state (boolean) | |
| 211 </dd> | |
| 212 </dl><a NAME="AdBlockManager.showDialog" ID="AdBlockManager.showDialog"></a> | |
| 213 <h4>AdBlockManager.showDialog</h4> | |
| 214 <b>showDialog</b>(<i></i>) | |
| 215 <p> | |
| 216 Public slot to show the AdBlock subscription management dialog. | |
| 217 </p><a NAME="AdBlockManager.subscriptions" ID="AdBlockManager.subscriptions"></a> | |
| 218 <h4>AdBlockManager.subscriptions</h4> | |
| 219 <b>subscriptions</b>(<i></i>) | |
| 220 <p> | |
| 221 Public method to get all subscriptions. | |
| 222 </p><dl> | |
| 223 <dt>Returns:</dt> | |
| 224 <dd> | |
| 225 list of subscriptions (list of AdBlockSubscription) | |
| 226 </dd> | |
| 227 </dl> | |
| 228 <div align="right"><a href="#top">Up</a></div> | |
| 229 <hr /> | |
| 230 </body></html> |
