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

changeset 5715
cbcca230679f
parent 4918
71caf42a13d8
child 5727
c8842a8d1167
--- a/Documentation/Source/eric6.WebBrowser.GreaseMonkey.GreaseMonkeyScript.html	Tue Apr 25 18:40:46 2017 +0200
+++ b/Documentation/Source/eric6.WebBrowser.GreaseMonkey.GreaseMonkeyScript.html	Tue Apr 25 19:20:18 2017 +0200
@@ -60,9 +60,27 @@
 <td><a href="#GreaseMonkeyScript.__init__">GreaseMonkeyScript</a></td>
 <td>Constructor</td>
 </tr><tr>
+<td><a href="#GreaseMonkeyScript.__downloadRequires">__downloadRequires</a></td>
+<td>Private method to download the required scripts.</td>
+</tr><tr>
+<td><a href="#GreaseMonkeyScript.__downloaderError">__downloaderError</a></td>
+<td>Private slot to handle a downloader error.</td>
+</tr><tr>
+<td><a href="#GreaseMonkeyScript.__downloaderFinished">__downloaderFinished</a></td>
+<td>Private slot to handle a finished download.</td>
+</tr><tr>
 <td><a href="#GreaseMonkeyScript.__parseScript">__parseScript</a></td>
 <td>Private method to parse the given script and populate the data structure.</td>
 </tr><tr>
+<td><a href="#GreaseMonkeyScript.__reloadScript">__reloadScript</a></td>
+<td>Private method to reload the script.</td>
+</tr><tr>
+<td><a href="#GreaseMonkeyScript.__requireDownloadError">__requireDownloadError</a></td>
+<td>Private slot to handle a downloader error.</td>
+</tr><tr>
+<td><a href="#GreaseMonkeyScript.__requireDownloaded">__requireDownloaded</a></td>
+<td>Private slot to handle a finished download of a required script.</td>
+</tr><tr>
 <td><a href="#GreaseMonkeyScript.__toJavaScriptList">__toJavaScriptList</a></td>
 <td>Private method to convert a list of str to a string containing a valid JavaScript list definition.</td>
 </tr><tr>
@@ -90,6 +108,9 @@
 <td><a href="#GreaseMonkeyScript.isEnabled">isEnabled</a></td>
 <td>Public method to check, if the script is enabled.</td>
 </tr><tr>
+<td><a href="#GreaseMonkeyScript.isUpdating">isUpdating</a></td>
+<td>Public method to get the updating flag.</td>
+</tr><tr>
 <td><a href="#GreaseMonkeyScript.isValid">isValid</a></td>
 <td>Public method to check the validity of the script.</td>
 </tr><tr>
@@ -102,8 +123,8 @@
 <td><a href="#GreaseMonkeyScript.noFrames">noFrames</a></td>
 <td>Public method to get the noFrames flag.</td>
 </tr><tr>
-<td><a href="#GreaseMonkeyScript.script">script</a></td>
-<td>Public method to get the Javascript source.</td>
+<td><a href="#GreaseMonkeyScript.require">require</a></td>
+<td>Public method to get the list of required scripts.</td>
 </tr><tr>
 <td><a href="#GreaseMonkeyScript.setEnabled">setEnabled</a></td>
 <td>Public method to enable a script.</td>
@@ -111,6 +132,9 @@
 <td><a href="#GreaseMonkeyScript.startAt">startAt</a></td>
 <td>Public method to get the start point of the script.</td>
 </tr><tr>
+<td><a href="#GreaseMonkeyScript.updateScript">updateScript</a></td>
+<td>Public method to updated the script.</td>
+</tr><tr>
 <td><a href="#GreaseMonkeyScript.updateUrl">updateUrl</a></td>
 <td>Public method to get the update URL of the script.</td>
 </tr><tr>
@@ -138,12 +162,42 @@
 <dd>
 path of the Javascript file (string)
 </dd>
-</dl><a NAME="GreaseMonkeyScript.__parseScript" ID="GreaseMonkeyScript.__parseScript"></a>
+</dl><a NAME="GreaseMonkeyScript.__downloadRequires" ID="GreaseMonkeyScript.__downloadRequires"></a>
+<h4>GreaseMonkeyScript.__downloadRequires</h4>
+<b>__downloadRequires</b>(<i></i>)
+<p>
+        Private method to download the required scripts.
+</p><a NAME="GreaseMonkeyScript.__downloaderError" ID="GreaseMonkeyScript.__downloaderError"></a>
+<h4>GreaseMonkeyScript.__downloaderError</h4>
+<b>__downloaderError</b>(<i></i>)
+<p>
+        Private slot to handle a downloader error.
+</p><a NAME="GreaseMonkeyScript.__downloaderFinished" ID="GreaseMonkeyScript.__downloaderFinished"></a>
+<h4>GreaseMonkeyScript.__downloaderFinished</h4>
+<b>__downloaderFinished</b>(<i></i>)
+<p>
+        Private slot to handle a finished download.
+</p><a NAME="GreaseMonkeyScript.__parseScript" ID="GreaseMonkeyScript.__parseScript"></a>
 <h4>GreaseMonkeyScript.__parseScript</h4>
 <b>__parseScript</b>(<i></i>)
 <p>
         Private method to parse the given script and populate the data
         structure.
+</p><a NAME="GreaseMonkeyScript.__reloadScript" ID="GreaseMonkeyScript.__reloadScript"></a>
+<h4>GreaseMonkeyScript.__reloadScript</h4>
+<b>__reloadScript</b>(<i></i>)
+<p>
+        Private method to reload the script.
+</p><a NAME="GreaseMonkeyScript.__requireDownloadError" ID="GreaseMonkeyScript.__requireDownloadError"></a>
+<h4>GreaseMonkeyScript.__requireDownloadError</h4>
+<b>__requireDownloadError</b>(<i></i>)
+<p>
+        Private slot to handle a downloader error.
+</p><a NAME="GreaseMonkeyScript.__requireDownloaded" ID="GreaseMonkeyScript.__requireDownloaded"></a>
+<h4>GreaseMonkeyScript.__requireDownloaded</h4>
+<b>__requireDownloaded</b>(<i></i>)
+<p>
+        Private slot to handle a finished download of a required script.
 </p><a NAME="GreaseMonkeyScript.__toJavaScriptList" ID="GreaseMonkeyScript.__toJavaScriptList"></a>
 <h4>GreaseMonkeyScript.__toJavaScriptList</h4>
 <b>__toJavaScriptList</b>(<i>patterns</i>)
@@ -213,7 +267,7 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-path path of the Javascript file (string)
+path of the Javascript file (string)
 </dd>
 </dl><a NAME="GreaseMonkeyScript.fullName" ID="GreaseMonkeyScript.fullName"></a>
 <h4>GreaseMonkeyScript.fullName</h4>
@@ -245,6 +299,21 @@
 <dd>
 flag indicating an enabled state (boolean)
 </dd>
+</dl><a NAME="GreaseMonkeyScript.isUpdating" ID="GreaseMonkeyScript.isUpdating"></a>
+<h4>GreaseMonkeyScript.isUpdating</h4>
+<b>isUpdating</b>(<i></i>)
+<p>
+        Public method to get the updating flag.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+updating flag
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
 </dl><a NAME="GreaseMonkeyScript.isValid" ID="GreaseMonkeyScript.isValid"></a>
 <h4>GreaseMonkeyScript.isValid</h4>
 <b>isValid</b>(<i></i>)
@@ -290,15 +359,15 @@
 <dd>
 bool
 </dd>
-</dl><a NAME="GreaseMonkeyScript.script" ID="GreaseMonkeyScript.script"></a>
-<h4>GreaseMonkeyScript.script</h4>
-<b>script</b>(<i></i>)
+</dl><a NAME="GreaseMonkeyScript.require" ID="GreaseMonkeyScript.require"></a>
+<h4>GreaseMonkeyScript.require</h4>
+<b>require</b>(<i></i>)
 <p>
-        Public method to get the Javascript source.
+        Public method to get the list of required scripts.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-Javascript source (string)
+list of required scripts (list of strings)
 </dd>
 </dl><a NAME="GreaseMonkeyScript.setEnabled" ID="GreaseMonkeyScript.setEnabled"></a>
 <h4>GreaseMonkeyScript.setEnabled</h4>
@@ -320,7 +389,12 @@
 <dd>
 start point of the script (DocumentStart or DocumentEnd)
 </dd>
-</dl><a NAME="GreaseMonkeyScript.updateUrl" ID="GreaseMonkeyScript.updateUrl"></a>
+</dl><a NAME="GreaseMonkeyScript.updateScript" ID="GreaseMonkeyScript.updateScript"></a>
+<h4>GreaseMonkeyScript.updateScript</h4>
+<b>updateScript</b>(<i></i>)
+<p>
+        Public method to updated the script.
+</p><a NAME="GreaseMonkeyScript.updateUrl" ID="GreaseMonkeyScript.updateUrl"></a>
 <h4>GreaseMonkeyScript.updateUrl</h4>
 <b>updateUrl</b>(<i></i>)
 <p>

eric ide

mercurial