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