Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.WebBrowser.GreaseMonkey.GreaseMonkeyJsObject.html
eric7/Documentation/Source/eric7.WebBrowser.GreaseMonkey.GreaseMonkeyJsObject.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.WebBrowser.GreaseMonkey.GreaseMonkeyJsObject</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> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.WebBrowser.GreaseMonkey.GreaseMonkeyJsObject</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing the Python side for GreaseMonkey scripts. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 | |
| 37 <tr> | |
| 38 <td><a href="#GreaseMonkeyJsObject">GreaseMonkeyJsObject</a></td> | |
| 39 <td>Class implementing the Python side for GreaseMonkey scripts.</td> | |
| 40 </tr> | |
| 41 </table> | |
| 42 <h3>Functions</h3> | |
| 43 | |
| 44 <table> | |
| 45 <tr><td>None</td></tr> | |
| 46 </table> | |
| 47 <hr /> | |
| 48 <hr /> | |
| 49 <a NAME="GreaseMonkeyJsObject" ID="GreaseMonkeyJsObject"></a> | |
| 50 <h2>GreaseMonkeyJsObject</h2> | |
| 51 | |
| 52 <p> | |
| 53 Class implementing the Python side for GreaseMonkey scripts. | |
| 54 </p> | |
| 55 <h3>Derived from</h3> | |
| 56 QObject | |
| 57 <h3>Class Attributes</h3> | |
| 58 | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Class Methods</h3> | |
| 63 | |
| 64 <table> | |
| 65 <tr><td>None</td></tr> | |
| 66 </table> | |
| 67 <h3>Methods</h3> | |
| 68 | |
| 69 <table> | |
| 70 | |
| 71 <tr> | |
| 72 <td><a href="#GreaseMonkeyJsObject.__init__">GreaseMonkeyJsObject</a></td> | |
| 73 <td>Constructor</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#GreaseMonkeyJsObject.deleteValue">deleteValue</a></td> | |
| 77 <td>Public slot to set delete the named variable for the identified script.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#GreaseMonkeyJsObject.getValue">getValue</a></td> | |
| 81 <td>Public slot to get the value for the named variable for the identified script.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#GreaseMonkeyJsObject.listValues">listValues</a></td> | |
| 85 <td>Public slot to list the stored variables for the identified script.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#GreaseMonkeyJsObject.setClipboard">setClipboard</a></td> | |
| 89 <td>Public slot to set some clipboard text.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#GreaseMonkeyJsObject.setSettingsFile">setSettingsFile</a></td> | |
| 93 <td>Public method to set the settings file for the GreaseMonkey parameters.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#GreaseMonkeyJsObject.setValue">setValue</a></td> | |
| 97 <td>Public slot to set the value for the named variable for the identified script.</td> | |
| 98 </tr> | |
| 99 </table> | |
| 100 <h3>Static Methods</h3> | |
| 101 | |
| 102 <table> | |
| 103 <tr><td>None</td></tr> | |
| 104 </table> | |
| 105 | |
| 106 <a NAME="GreaseMonkeyJsObject.__init__" ID="GreaseMonkeyJsObject.__init__"></a> | |
| 107 <h4>GreaseMonkeyJsObject (Constructor)</h4> | |
| 108 <b>GreaseMonkeyJsObject</b>(<i>parent=None</i>) | |
| 109 | |
| 110 <p> | |
| 111 Constructor | |
| 112 </p> | |
| 113 <dl> | |
| 114 | |
| 115 <dt><i>parent</i> (QObject)</dt> | |
| 116 <dd> | |
| 117 reference to the parent object | |
| 118 </dd> | |
| 119 </dl> | |
| 120 <a NAME="GreaseMonkeyJsObject.deleteValue" ID="GreaseMonkeyJsObject.deleteValue"></a> | |
| 121 <h4>GreaseMonkeyJsObject.deleteValue</h4> | |
| 122 <b>deleteValue</b>(<i>nspace, name</i>) | |
| 123 | |
| 124 <p> | |
| 125 Public slot to set delete the named variable for the identified script. | |
| 126 </p> | |
| 127 <dl> | |
| 128 | |
| 129 <dt><i>nspace</i> (str)</dt> | |
| 130 <dd> | |
| 131 unique script id | |
| 132 </dd> | |
| 133 <dt><i>name</i> (str)</dt> | |
| 134 <dd> | |
| 135 name of the variable | |
| 136 </dd> | |
| 137 </dl> | |
| 138 <dl> | |
| 139 <dt>Return:</dt> | |
| 140 <dd> | |
| 141 flag indicating success | |
| 142 </dd> | |
| 143 </dl> | |
| 144 <dl> | |
| 145 <dt>Return Type:</dt> | |
| 146 <dd> | |
| 147 bool | |
| 148 </dd> | |
| 149 </dl> | |
| 150 <a NAME="GreaseMonkeyJsObject.getValue" ID="GreaseMonkeyJsObject.getValue"></a> | |
| 151 <h4>GreaseMonkeyJsObject.getValue</h4> | |
| 152 <b>getValue</b>(<i>nspace, name, dValue</i>) | |
| 153 | |
| 154 <p> | |
| 155 Public slot to get the value for the named variable for the identified | |
| 156 script. | |
| 157 </p> | |
| 158 <dl> | |
| 159 | |
| 160 <dt><i>nspace</i> (str)</dt> | |
| 161 <dd> | |
| 162 unique script id | |
| 163 </dd> | |
| 164 <dt><i>name</i> (str)</dt> | |
| 165 <dd> | |
| 166 name of the variable | |
| 167 </dd> | |
| 168 <dt><i>dValue</i> (str)</dt> | |
| 169 <dd> | |
| 170 default value | |
| 171 </dd> | |
| 172 </dl> | |
| 173 <dl> | |
| 174 <dt>Return:</dt> | |
| 175 <dd> | |
| 176 value for the named variable | |
| 177 </dd> | |
| 178 </dl> | |
| 179 <dl> | |
| 180 <dt>Return Type:</dt> | |
| 181 <dd> | |
| 182 str | |
| 183 </dd> | |
| 184 </dl> | |
| 185 <a NAME="GreaseMonkeyJsObject.listValues" ID="GreaseMonkeyJsObject.listValues"></a> | |
| 186 <h4>GreaseMonkeyJsObject.listValues</h4> | |
| 187 <b>listValues</b>(<i>nspace</i>) | |
| 188 | |
| 189 <p> | |
| 190 Public slot to list the stored variables for the identified script. | |
| 191 </p> | |
| 192 <dl> | |
| 193 | |
| 194 <dt><i>nspace</i> (str)</dt> | |
| 195 <dd> | |
| 196 unique script id | |
| 197 </dd> | |
| 198 </dl> | |
| 199 <dl> | |
| 200 <dt>Return:</dt> | |
| 201 <dd> | |
| 202 list of stored variables | |
| 203 </dd> | |
| 204 </dl> | |
| 205 <dl> | |
| 206 <dt>Return Type:</dt> | |
| 207 <dd> | |
| 208 list of str | |
| 209 </dd> | |
| 210 </dl> | |
| 211 <a NAME="GreaseMonkeyJsObject.setClipboard" ID="GreaseMonkeyJsObject.setClipboard"></a> | |
| 212 <h4>GreaseMonkeyJsObject.setClipboard</h4> | |
| 213 <b>setClipboard</b>(<i>text</i>) | |
| 214 | |
| 215 <p> | |
| 216 Public slot to set some clipboard text. | |
| 217 </p> | |
| 218 <dl> | |
| 219 | |
| 220 <dt><i>text</i> (str)</dt> | |
| 221 <dd> | |
| 222 text to be copied to the clipboard | |
| 223 </dd> | |
| 224 </dl> | |
| 225 <a NAME="GreaseMonkeyJsObject.setSettingsFile" ID="GreaseMonkeyJsObject.setSettingsFile"></a> | |
| 226 <h4>GreaseMonkeyJsObject.setSettingsFile</h4> | |
| 227 <b>setSettingsFile</b>(<i>name</i>) | |
| 228 | |
| 229 <p> | |
| 230 Public method to set the settings file for the GreaseMonkey parameters. | |
| 231 </p> | |
| 232 <dl> | |
| 233 | |
| 234 <dt><i>name</i> (str)</dt> | |
| 235 <dd> | |
| 236 name of the settings file | |
| 237 </dd> | |
| 238 </dl> | |
| 239 <a NAME="GreaseMonkeyJsObject.setValue" ID="GreaseMonkeyJsObject.setValue"></a> | |
| 240 <h4>GreaseMonkeyJsObject.setValue</h4> | |
| 241 <b>setValue</b>(<i>nspace, name, value</i>) | |
| 242 | |
| 243 <p> | |
| 244 Public slot to set the value for the named variable for the identified | |
| 245 script. | |
| 246 </p> | |
| 247 <dl> | |
| 248 | |
| 249 <dt><i>nspace</i> (str)</dt> | |
| 250 <dd> | |
| 251 unique script id | |
| 252 </dd> | |
| 253 <dt><i>name</i> (str)</dt> | |
| 254 <dd> | |
| 255 name of the variable | |
| 256 </dd> | |
| 257 <dt><i>value</i> (str)</dt> | |
| 258 <dd> | |
| 259 value to be set | |
| 260 </dd> | |
| 261 </dl> | |
| 262 <dl> | |
| 263 <dt>Return:</dt> | |
| 264 <dd> | |
| 265 flag indicating success | |
| 266 </dd> | |
| 267 </dl> | |
| 268 <dl> | |
| 269 <dt>Return Type:</dt> | |
| 270 <dd> | |
| 271 bool | |
| 272 </dd> | |
| 273 </dl> | |
| 274 <div align="right"><a href="#top">Up</a></div> | |
| 275 <hr /> | |
| 276 </body></html> |
