Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.WebBrowser.GreaseMonkey.GreaseMonkeyJsObject.html

eric6/Documentation/Source/eric6.WebBrowser.GreaseMonkey.GreaseMonkeyJsObject.html

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

Mercurial Repository: eric

eric ide

mercurial