Mercurial Repositories > eric / file comparison

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

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

changeset 6153
0b18c86c03a1
equal deleted inserted replaced
6152:a98925d5a214 6153:0b18c86c03a1
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.GreaseMonkey.GreaseMonkeyJsObject</h1>
23 <p>
24 Module implementing the Python side for GreaseMonkey scripts.
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="#GreaseMonkeyJsObject">GreaseMonkeyJsObject</a></td>
34 <td>Class implementing the Python side for GreaseMonkey scripts.</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="GreaseMonkeyJsObject" ID="GreaseMonkeyJsObject"></a>
43 <h2>GreaseMonkeyJsObject</h2>
44 <p>
45 Class implementing the Python side for GreaseMonkey scripts.
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="#GreaseMonkeyJsObject.__init__">GreaseMonkeyJsObject</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#GreaseMonkeyJsObject.deleteValue">deleteValue</a></td>
64 <td>Public slot to set delete the named variable for the identified script.</td>
65 </tr><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><tr>
69 <td><a href="#GreaseMonkeyJsObject.listValues">listValues</a></td>
70 <td>Public slot to list the stored variables for the identified script.</td>
71 </tr><tr>
72 <td><a href="#GreaseMonkeyJsObject.setClipboard">setClipboard</a></td>
73 <td>Public slot to set some clipboard text.</td>
74 </tr><tr>
75 <td><a href="#GreaseMonkeyJsObject.setSettingsFile">setSettingsFile</a></td>
76 <td>Public method to set the settings file for the GreaseMonkey parameters.</td>
77 </tr><tr>
78 <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>
80 </tr>
81 </table>
82 <h3>Static Methods</h3>
83 <table>
84 <tr><td>None</td></tr>
85 </table>
86 <a NAME="GreaseMonkeyJsObject.__init__" ID="GreaseMonkeyJsObject.__init__"></a>
87 <h4>GreaseMonkeyJsObject (Constructor)</h4>
88 <b>GreaseMonkeyJsObject</b>(<i>parent=None</i>)
89 <p>
90 Constructor
91 </p><dl>
92 <dt><i>parent</i> (QObject)</dt>
93 <dd>
94 reference to the parent object
95 </dd>
96 </dl><a NAME="GreaseMonkeyJsObject.deleteValue" ID="GreaseMonkeyJsObject.deleteValue"></a>
97 <h4>GreaseMonkeyJsObject.deleteValue</h4>
98 <b>deleteValue</b>(<i>nspace, name</i>)
99 <p>
100 Public slot to set delete the named variable for the identified script.
101 </p><dl>
102 <dt><i>nspace</i> (str)</dt>
103 <dd>
104 unique script id
105 </dd><dt><i>name</i> (str)</dt>
106 <dd>
107 name of the variable
108 </dd>
109 </dl><dl>
110 <dt>Returns:</dt>
111 <dd>
112 flag indicating success
113 </dd>
114 </dl><dl>
115 <dt>Return Type:</dt>
116 <dd>
117 bool
118 </dd>
119 </dl><a NAME="GreaseMonkeyJsObject.getValue" ID="GreaseMonkeyJsObject.getValue"></a>
120 <h4>GreaseMonkeyJsObject.getValue</h4>
121 <b>getValue</b>(<i>nspace, name, dValue</i>)
122 <p>
123 Public slot to get the value for the named variable for the identified
124 script.
125 </p><dl>
126 <dt><i>nspace</i> (str)</dt>
127 <dd>
128 unique script id
129 </dd><dt><i>name</i> (str)</dt>
130 <dd>
131 name of the variable
132 </dd><dt><i>dValue</i> (str)</dt>
133 <dd>
134 default value
135 </dd>
136 </dl><dl>
137 <dt>Returns:</dt>
138 <dd>
139 value for the named variable
140 </dd>
141 </dl><dl>
142 <dt>Return Type:</dt>
143 <dd>
144 str
145 </dd>
146 </dl><a NAME="GreaseMonkeyJsObject.listValues" ID="GreaseMonkeyJsObject.listValues"></a>
147 <h4>GreaseMonkeyJsObject.listValues</h4>
148 <b>listValues</b>(<i>nspace</i>)
149 <p>
150 Public slot to list the stored variables for the identified script.
151 </p><dl>
152 <dt><i>nspace</i> (str)</dt>
153 <dd>
154 unique script id
155 </dd>
156 </dl><dl>
157 <dt>Returns:</dt>
158 <dd>
159 list of stored variables
160 </dd>
161 </dl><dl>
162 <dt>Return Type:</dt>
163 <dd>
164 list of str
165 </dd>
166 </dl><a NAME="GreaseMonkeyJsObject.setClipboard" ID="GreaseMonkeyJsObject.setClipboard"></a>
167 <h4>GreaseMonkeyJsObject.setClipboard</h4>
168 <b>setClipboard</b>(<i>text</i>)
169 <p>
170 Public slot to set some clipboard text.
171 </p><dl>
172 <dt><i>text</i> (str)</dt>
173 <dd>
174 text to be copied to the clipboard
175 </dd>
176 </dl><a NAME="GreaseMonkeyJsObject.setSettingsFile" ID="GreaseMonkeyJsObject.setSettingsFile"></a>
177 <h4>GreaseMonkeyJsObject.setSettingsFile</h4>
178 <b>setSettingsFile</b>(<i>name</i>)
179 <p>
180 Public method to set the settings file for the GreaseMonkey parameters.
181 </p><dl>
182 <dt><i>name</i> (str)</dt>
183 <dd>
184 name of the settings file
185 </dd>
186 </dl><a NAME="GreaseMonkeyJsObject.setValue" ID="GreaseMonkeyJsObject.setValue"></a>
187 <h4>GreaseMonkeyJsObject.setValue</h4>
188 <b>setValue</b>(<i>nspace, name, value</i>)
189 <p>
190 Public slot to set the value for the named variable for the identified
191 script.
192 </p><dl>
193 <dt><i>nspace</i> (str)</dt>
194 <dd>
195 unique script id
196 </dd><dt><i>name</i> (str)</dt>
197 <dd>
198 name of the variable
199 </dd><dt><i>value</i> (str)</dt>
200 <dd>
201 value to be set
202 </dd>
203 </dl><dl>
204 <dt>Returns:</dt>
205 <dd>
206 flag indicating success
207 </dd>
208 </dl><dl>
209 <dt>Return Type:</dt>
210 <dd>
211 bool
212 </dd>
213 </dl>
214 <div align="right"><a href="#top">Up</a></div>
215 <hr />
216 </body></html>

Mercurial Repository: eric

eric ide

mercurial