diff -r eaf2cf171f3a -r 5cf645f6daab eric6/Documentation/Source/eric6.Helpviewer.GreaseMonkey.GreaseMonkeyManager.html --- a/eric6/Documentation/Source/eric6.Helpviewer.GreaseMonkey.GreaseMonkeyManager.html Sat Sep 07 14:45:27 2019 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,344 +0,0 @@ -<!DOCTYPE html> -<html><head> -<title>eric6.Helpviewer.GreaseMonkey.GreaseMonkeyManager</title> -<meta charset="UTF-8"> -<style> -body { - background: #EDECE6; - margin: 0em 1em 10em 1em; - color: black; -} - -h1 { color: white; background: #85774A; } -h2 { color: white; background: #85774A; } -h3 { color: white; background: #9D936E; } -h4 { color: white; background: #9D936E; } - -a { color: #BA6D36; } - -</style> -</head> -<body><a NAME="top" ID="top"></a> -<h1>eric6.Helpviewer.GreaseMonkey.GreaseMonkeyManager</h1> -<p> -Module implementing the manager for GreaseMonkey scripts. -</p> -<h3>Global Attributes</h3> -<table> -<tr><td>None</td></tr> -</table> -<h3>Classes</h3> -<table> -<tr> -<td><a href="#GreaseMonkeyManager">GreaseMonkeyManager</a></td> -<td>Class implementing the manager for GreaseMonkey scripts.</td> -</tr> -</table> -<h3>Functions</h3> -<table> -<tr><td>None</td></tr> -</table> -<hr /><hr /> -<a NAME="GreaseMonkeyManager" ID="GreaseMonkeyManager"></a> -<h2>GreaseMonkeyManager</h2> -<p> - Class implementing the manager for GreaseMonkey scripts. -</p><h3>Signals</h3> -<dl> -<dt>scriptsChanged()</dt> -<dd> -emitted to indicate a change of scripts -</dd> -</dl> -<h3>Derived from</h3> -QObject -<h3>Class Attributes</h3> -<table> -<tr><td>None</td></tr> -</table> -<h3>Class Methods</h3> -<table> -<tr><td>None</td></tr> -</table> -<h3>Methods</h3> -<table> -<tr> -<td><a href="#GreaseMonkeyManager.__init__">GreaseMonkeyManager</a></td> -<td>Constructor</td> -</tr><tr> -<td><a href="#GreaseMonkeyManager.__downloaderFinished">__downloaderFinished</a></td> -<td>Private slot to handle the completion of a script download.</td> -</tr><tr> -<td><a href="#GreaseMonkeyManager.__load">__load</a></td> -<td>Private slot to load the available scripts into the manager.</td> -</tr><tr> -<td><a href="#GreaseMonkeyManager.addScript">addScript</a></td> -<td>Public method to add a script.</td> -</tr><tr> -<td><a href="#GreaseMonkeyManager.allScripts">allScripts</a></td> -<td>Public method to get a list of all scripts.</td> -</tr><tr> -<td><a href="#GreaseMonkeyManager.canRunOnScheme">canRunOnScheme</a></td> -<td>Public method to check, if scripts can be run on a scheme.</td> -</tr><tr> -<td><a href="#GreaseMonkeyManager.connectPage">connectPage</a></td> -<td>Public method to allow the GreaseMonkey manager to connect to the page.</td> -</tr><tr> -<td><a href="#GreaseMonkeyManager.containsScript">containsScript</a></td> -<td>Public method to check, if the given script exists.</td> -</tr><tr> -<td><a href="#GreaseMonkeyManager.createRequest">createRequest</a></td> -<td>Public method to create a request.</td> -</tr><tr> -<td><a href="#GreaseMonkeyManager.disableScript">disableScript</a></td> -<td>Public method to disable the given script.</td> -</tr><tr> -<td><a href="#GreaseMonkeyManager.downloadScript">downloadScript</a></td> -<td>Public method to download a GreaseMonkey script.</td> -</tr><tr> -<td><a href="#GreaseMonkeyManager.enableScript">enableScript</a></td> -<td>Public method to enable the given script.</td> -</tr><tr> -<td><a href="#GreaseMonkeyManager.pageLoadStarted">pageLoadStarted</a></td> -<td>Public slot to handle the start of loading a page.</td> -</tr><tr> -<td><a href="#GreaseMonkeyManager.removeScript">removeScript</a></td> -<td>Public method to remove a script.</td> -</tr><tr> -<td><a href="#GreaseMonkeyManager.requireScripts">requireScripts</a></td> -<td>Public method to get the sources of all required scripts.</td> -</tr><tr> -<td><a href="#GreaseMonkeyManager.requireScriptsDirectory">requireScriptsDirectory</a></td> -<td>Public method to get the path of the scripts directory.</td> -</tr><tr> -<td><a href="#GreaseMonkeyManager.saveConfiguration">saveConfiguration</a></td> -<td>Public method to save the configuration.</td> -</tr><tr> -<td><a href="#GreaseMonkeyManager.scriptsDirectory">scriptsDirectory</a></td> -<td>Public method to get the path of the scripts directory.</td> -</tr><tr> -<td><a href="#GreaseMonkeyManager.showConfigurationDialog">showConfigurationDialog</a></td> -<td>Public method to show the configuration dialog.</td> -</tr> -</table> -<h3>Static Methods</h3> -<table> -<tr><td>None</td></tr> -</table> -<a NAME="GreaseMonkeyManager.__init__" ID="GreaseMonkeyManager.__init__"></a> -<h4>GreaseMonkeyManager (Constructor)</h4> -<b>GreaseMonkeyManager</b>(<i>parent=None</i>) -<p> - Constructor -</p><dl> -<dt><i>parent</i></dt> -<dd> -reference to the parent object (QObject) -</dd> -</dl><a NAME="GreaseMonkeyManager.__downloaderFinished" ID="GreaseMonkeyManager.__downloaderFinished"></a> -<h4>GreaseMonkeyManager.__downloaderFinished</h4> -<b>__downloaderFinished</b>(<i>downloader</i>) -<p> - Private slot to handle the completion of a script download. -</p><dl> -<dt><i>downloader</i> (GreaseMonkeyDownloader)</dt> -<dd> -reference to the downloader object -</dd> -</dl><a NAME="GreaseMonkeyManager.__load" ID="GreaseMonkeyManager.__load"></a> -<h4>GreaseMonkeyManager.__load</h4> -<b>__load</b>(<i></i>) -<p> - Private slot to load the available scripts into the manager. -</p><a NAME="GreaseMonkeyManager.addScript" ID="GreaseMonkeyManager.addScript"></a> -<h4>GreaseMonkeyManager.addScript</h4> -<b>addScript</b>(<i>script</i>) -<p> - Public method to add a script. -</p><dl> -<dt><i>script</i></dt> -<dd> -script to be added (GreaseMonkeyScript) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -flag indicating success (boolean) -</dd> -</dl><a NAME="GreaseMonkeyManager.allScripts" ID="GreaseMonkeyManager.allScripts"></a> -<h4>GreaseMonkeyManager.allScripts</h4> -<b>allScripts</b>(<i></i>) -<p> - Public method to get a list of all scripts. -</p><dl> -<dt>Returns:</dt> -<dd> -list of all scripts (list of GreaseMonkeyScript) -</dd> -</dl><a NAME="GreaseMonkeyManager.canRunOnScheme" ID="GreaseMonkeyManager.canRunOnScheme"></a> -<h4>GreaseMonkeyManager.canRunOnScheme</h4> -<b>canRunOnScheme</b>(<i>scheme</i>) -<p> - Public method to check, if scripts can be run on a scheme. -</p><dl> -<dt><i>scheme</i></dt> -<dd> -scheme to check (string) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -flag indicating, that scripts can be run (boolean) -</dd> -</dl><a NAME="GreaseMonkeyManager.connectPage" ID="GreaseMonkeyManager.connectPage"></a> -<h4>GreaseMonkeyManager.connectPage</h4> -<b>connectPage</b>(<i>page</i>) -<p> - Public method to allow the GreaseMonkey manager to connect to the page. -</p><dl> -<dt><i>page</i></dt> -<dd> -reference to the web page (HelpWebPage) -</dd> -</dl><a NAME="GreaseMonkeyManager.containsScript" ID="GreaseMonkeyManager.containsScript"></a> -<h4>GreaseMonkeyManager.containsScript</h4> -<b>containsScript</b>(<i>fullName</i>) -<p> - Public method to check, if the given script exists. -</p><dl> -<dt><i>fullName</i></dt> -<dd> -full name of the script (string) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -flag indicating the existence (boolean) -</dd> -</dl><a NAME="GreaseMonkeyManager.createRequest" ID="GreaseMonkeyManager.createRequest"></a> -<h4>GreaseMonkeyManager.createRequest</h4> -<b>createRequest</b>(<i>op, request, outgoingData=None</i>) -<p> - Public method to create a request. -</p><dl> -<dt><i>op</i></dt> -<dd> -the operation to be performed - (QNetworkAccessManager.Operation) -</dd><dt><i>request</i></dt> -<dd> -reference to the request object (QNetworkRequest) -</dd><dt><i>outgoingData</i></dt> -<dd> -reference to an IODevice containing data to be sent - (QIODevice) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -reference to the created reply object (QNetworkReply) -</dd> -</dl><a NAME="GreaseMonkeyManager.disableScript" ID="GreaseMonkeyManager.disableScript"></a> -<h4>GreaseMonkeyManager.disableScript</h4> -<b>disableScript</b>(<i>script</i>) -<p> - Public method to disable the given script. -</p><dl> -<dt><i>script</i></dt> -<dd> -script to be disabled (GreaseMonkeyScript) -</dd> -</dl><a NAME="GreaseMonkeyManager.downloadScript" ID="GreaseMonkeyManager.downloadScript"></a> -<h4>GreaseMonkeyManager.downloadScript</h4> -<b>downloadScript</b>(<i>request</i>) -<p> - Public method to download a GreaseMonkey script. -</p><dl> -<dt><i>request</i></dt> -<dd> -reference to the request (QNetworkRequest) -</dd> -</dl><a NAME="GreaseMonkeyManager.enableScript" ID="GreaseMonkeyManager.enableScript"></a> -<h4>GreaseMonkeyManager.enableScript</h4> -<b>enableScript</b>(<i>script</i>) -<p> - Public method to enable the given script. -</p><dl> -<dt><i>script</i></dt> -<dd> -script to be enabled (GreaseMonkeyScript) -</dd> -</dl><a NAME="GreaseMonkeyManager.pageLoadStarted" ID="GreaseMonkeyManager.pageLoadStarted"></a> -<h4>GreaseMonkeyManager.pageLoadStarted</h4> -<b>pageLoadStarted</b>(<i></i>) -<p> - Public slot to handle the start of loading a page. -</p><a NAME="GreaseMonkeyManager.removeScript" ID="GreaseMonkeyManager.removeScript"></a> -<h4>GreaseMonkeyManager.removeScript</h4> -<b>removeScript</b>(<i>script</i>) -<p> - Public method to remove a script. -</p><dl> -<dt><i>script</i></dt> -<dd> -script to be removed (GreaseMonkeyScript) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -flag indicating success (boolean) -</dd> -</dl><a NAME="GreaseMonkeyManager.requireScripts" ID="GreaseMonkeyManager.requireScripts"></a> -<h4>GreaseMonkeyManager.requireScripts</h4> -<b>requireScripts</b>(<i>urlList</i>) -<p> - Public method to get the sources of all required scripts. -</p><dl> -<dt><i>urlList</i></dt> -<dd> -list of URLs (list of string) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -sources of all required scripts (string) -</dd> -</dl><a NAME="GreaseMonkeyManager.requireScriptsDirectory" ID="GreaseMonkeyManager.requireScriptsDirectory"></a> -<h4>GreaseMonkeyManager.requireScriptsDirectory</h4> -<b>requireScriptsDirectory</b>(<i></i>) -<p> - Public method to get the path of the scripts directory. -</p><dl> -<dt>Returns:</dt> -<dd> -path of the scripts directory (string) -</dd> -</dl><a NAME="GreaseMonkeyManager.saveConfiguration" ID="GreaseMonkeyManager.saveConfiguration"></a> -<h4>GreaseMonkeyManager.saveConfiguration</h4> -<b>saveConfiguration</b>(<i></i>) -<p> - Public method to save the configuration. -</p><a NAME="GreaseMonkeyManager.scriptsDirectory" ID="GreaseMonkeyManager.scriptsDirectory"></a> -<h4>GreaseMonkeyManager.scriptsDirectory</h4> -<b>scriptsDirectory</b>(<i></i>) -<p> - Public method to get the path of the scripts directory. -</p><dl> -<dt>Returns:</dt> -<dd> -path of the scripts directory (string) -</dd> -</dl><a NAME="GreaseMonkeyManager.showConfigurationDialog" ID="GreaseMonkeyManager.showConfigurationDialog"></a> -<h4>GreaseMonkeyManager.showConfigurationDialog</h4> -<b>showConfigurationDialog</b>(<i>parent=None</i>) -<p> - Public method to show the configuration dialog. -</p><dl> -<dt><i>parent</i></dt> -<dd> -reference to the parent widget (QWidget) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -</body></html> \ No newline at end of file