Sat, 18 Apr 2015 19:14:57 +0200
Regenerated source docu.
--- a/APIs/Python3/eric6.api Sat Apr 18 19:14:15 2015 +0200 +++ b/APIs/Python3/eric6.api Sat Apr 18 19:14:57 2015 +0200 @@ -3797,7 +3797,7 @@ eric6.Plugins.AboutPlugin.AboutDialog.titleText?7 eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.CodeStyleCheckerReport.error_args?4(line_number, offset, code, check, *args) eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.CodeStyleCheckerReport?1(options) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.codeStyleBatchCheck?4(argumentsList, send, fx) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.codeStyleBatchCheck?4(argumentsList, send, fx, cancelled) eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.codeStyleCheck?4(filename, source, args) eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.extractLineFlags?4(line, startComment=") eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.initBatchService?4() @@ -4089,6 +4089,7 @@ eric6.Plugins.PluginCodeStyleChecker.CodeStyleCheckerPlugin.activate?4() eric6.Plugins.PluginCodeStyleChecker.CodeStyleCheckerPlugin.batchFinished?7 eric6.Plugins.PluginCodeStyleChecker.CodeStyleCheckerPlugin.batchJobDone?4(fx, lang) +eric6.Plugins.PluginCodeStyleChecker.CodeStyleCheckerPlugin.cancelStyleBatchCheck?4() eric6.Plugins.PluginCodeStyleChecker.CodeStyleCheckerPlugin.deactivate?4() eric6.Plugins.PluginCodeStyleChecker.CodeStyleCheckerPlugin.serviceErrorPy2?4(fx, lang, fn, msg) eric6.Plugins.PluginCodeStyleChecker.CodeStyleCheckerPlugin.serviceErrorPy3?4(fx, lang, fn, msg) @@ -8447,6 +8448,7 @@ eric6.Utilities.BackgroundService.BackgroundService.on_disconnectSocket?4(lang) eric6.Utilities.BackgroundService.BackgroundService.on_newConnection?4() eric6.Utilities.BackgroundService.BackgroundService.preferencesOrProjectChanged?4() +eric6.Utilities.BackgroundService.BackgroundService.requestCancel?4(lang) eric6.Utilities.BackgroundService.BackgroundService.restartService?4(language, forceKill=False) eric6.Utilities.BackgroundService.BackgroundService.serviceConnect?4(fx, lang, modulepath, module, callback, onErrorCallback=None, onBatchDone=None) eric6.Utilities.BackgroundService.BackgroundService.serviceDisconnect?4(fx, lang)
--- a/Documentation/Help/source.qhp Sat Apr 18 19:14:15 2015 +0200 +++ b/Documentation/Help/source.qhp Sat Apr 18 19:14:57 2015 +0200 @@ -1493,7 +1493,9 @@ <keyword name="BackgroundClient" id="BackgroundClient" ref="eric6.Utilities.BackgroundClient.html#BackgroundClient" /> <keyword name="BackgroundClient (Constructor)" id="BackgroundClient (Constructor)" ref="eric6.Utilities.BackgroundClient.html#BackgroundClient.__init__" /> <keyword name="BackgroundClient (Module)" id="BackgroundClient (Module)" ref="eric6.Utilities.BackgroundClient.html" /> + <keyword name="BackgroundClient.__cancelled" id="BackgroundClient.__cancelled" ref="eric6.Utilities.BackgroundClient.html#BackgroundClient.__cancelled" /> <keyword name="BackgroundClient.__initClientService" id="BackgroundClient.__initClientService" ref="eric6.Utilities.BackgroundClient.html#BackgroundClient.__initClientService" /> + <keyword name="BackgroundClient.__peek" id="BackgroundClient.__peek" ref="eric6.Utilities.BackgroundClient.html#BackgroundClient.__peek" /> <keyword name="BackgroundClient.__receive" id="BackgroundClient.__receive" ref="eric6.Utilities.BackgroundClient.html#BackgroundClient.__receive" /> <keyword name="BackgroundClient.__send" id="BackgroundClient.__send" ref="eric6.Utilities.BackgroundClient.html#BackgroundClient.__send" /> <keyword name="BackgroundClient.run" id="BackgroundClient.run" ref="eric6.Utilities.BackgroundClient.html#BackgroundClient.run" /> @@ -1508,6 +1510,7 @@ <keyword name="BackgroundService.on_disconnectSocket" id="BackgroundService.on_disconnectSocket" ref="eric6.Utilities.BackgroundService.html#BackgroundService.on_disconnectSocket" /> <keyword name="BackgroundService.on_newConnection" id="BackgroundService.on_newConnection" ref="eric6.Utilities.BackgroundService.html#BackgroundService.on_newConnection" /> <keyword name="BackgroundService.preferencesOrProjectChanged" id="BackgroundService.preferencesOrProjectChanged" ref="eric6.Utilities.BackgroundService.html#BackgroundService.preferencesOrProjectChanged" /> + <keyword name="BackgroundService.requestCancel" id="BackgroundService.requestCancel" ref="eric6.Utilities.BackgroundService.html#BackgroundService.requestCancel" /> <keyword name="BackgroundService.restartService" id="BackgroundService.restartService" ref="eric6.Utilities.BackgroundService.html#BackgroundService.restartService" /> <keyword name="BackgroundService.serviceConnect" id="BackgroundService.serviceConnect" ref="eric6.Utilities.BackgroundService.html#BackgroundService.serviceConnect" /> <keyword name="BackgroundService.serviceDisconnect" id="BackgroundService.serviceDisconnect" ref="eric6.Utilities.BackgroundService.html#BackgroundService.serviceDisconnect" /> @@ -2187,6 +2190,7 @@ <keyword name="CodeStyleCheckerPlugin.__translateStyleCheck" id="CodeStyleCheckerPlugin.__translateStyleCheck" ref="eric6.Plugins.PluginCodeStyleChecker.html#CodeStyleCheckerPlugin.__translateStyleCheck" /> <keyword name="CodeStyleCheckerPlugin.activate" id="CodeStyleCheckerPlugin.activate" ref="eric6.Plugins.PluginCodeStyleChecker.html#CodeStyleCheckerPlugin.activate" /> <keyword name="CodeStyleCheckerPlugin.batchJobDone" id="CodeStyleCheckerPlugin.batchJobDone" ref="eric6.Plugins.PluginCodeStyleChecker.html#CodeStyleCheckerPlugin.batchJobDone" /> + <keyword name="CodeStyleCheckerPlugin.cancelStyleBatchCheck" id="CodeStyleCheckerPlugin.cancelStyleBatchCheck" ref="eric6.Plugins.PluginCodeStyleChecker.html#CodeStyleCheckerPlugin.cancelStyleBatchCheck" /> <keyword name="CodeStyleCheckerPlugin.deactivate" id="CodeStyleCheckerPlugin.deactivate" ref="eric6.Plugins.PluginCodeStyleChecker.html#CodeStyleCheckerPlugin.deactivate" /> <keyword name="CodeStyleCheckerPlugin.serviceErrorPy2" id="CodeStyleCheckerPlugin.serviceErrorPy2" ref="eric6.Plugins.PluginCodeStyleChecker.html#CodeStyleCheckerPlugin.serviceErrorPy2" /> <keyword name="CodeStyleCheckerPlugin.serviceErrorPy3" id="CodeStyleCheckerPlugin.serviceErrorPy3" ref="eric6.Plugins.PluginCodeStyleChecker.html#CodeStyleCheckerPlugin.serviceErrorPy3" />
--- a/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html Sat Apr 18 19:14:15 2015 +0200 +++ b/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html Sat Apr 18 19:14:57 2015 +0200 @@ -162,7 +162,7 @@ <hr /><hr /> <a NAME="codeStyleBatchCheck" ID="codeStyleBatchCheck"></a> <h2>codeStyleBatchCheck</h2> -<b>codeStyleBatchCheck</b>(<i>argumentsList, send, fx</i>) +<b>codeStyleBatchCheck</b>(<i>argumentsList, send, fx, cancelled</i>) <p> Module function to check code style for a batch of files. </p><dl> @@ -171,10 +171,14 @@ list of arguments tuples as given for codeStyleCheck </dd><dt><i>send</i></dt> <dd> -reference to send method +reference to send function (function) </dd><dt><i>fx</i></dt> <dd> registered service name (string) +</dd><dt><i>cancelled</i></dt> +<dd> +reference to function checking for a cancellation + (function) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/eric6.Plugins.PluginCodeStyleChecker.html Sat Apr 18 19:14:15 2015 +0200 +++ b/Documentation/Source/eric6.Plugins.PluginCodeStyleChecker.html Sat Apr 18 19:14:57 2015 +0200 @@ -109,6 +109,9 @@ <td><a href="#CodeStyleCheckerPlugin.batchJobDone">batchJobDone</a></td> <td>Public slot handling the completion of a batch job.</td> </tr><tr> +<td><a href="#CodeStyleCheckerPlugin.cancelStyleBatchCheck">cancelStyleBatchCheck</a></td> +<td>Public method to cancel all batch jobs.</td> +</tr><tr> <td><a href="#CodeStyleCheckerPlugin.deactivate">deactivate</a></td> <td>Public method to deactivate this plugin.</td> </tr><tr> @@ -280,7 +283,12 @@ <dd> language (string) </dd> -</dl><a NAME="CodeStyleCheckerPlugin.deactivate" ID="CodeStyleCheckerPlugin.deactivate"></a> +</dl><a NAME="CodeStyleCheckerPlugin.cancelStyleBatchCheck" ID="CodeStyleCheckerPlugin.cancelStyleBatchCheck"></a> +<h4>CodeStyleCheckerPlugin.cancelStyleBatchCheck</h4> +<b>cancelStyleBatchCheck</b>(<i></i>) +<p> + Public method to cancel all batch jobs. +</p><a NAME="CodeStyleCheckerPlugin.deactivate" ID="CodeStyleCheckerPlugin.deactivate"></a> <h4>CodeStyleCheckerPlugin.deactivate</h4> <b>deactivate</b>(<i></i>) <p>
--- a/Documentation/Source/eric6.Utilities.BackgroundClient.html Sat Apr 18 19:14:15 2015 +0200 +++ b/Documentation/Source/eric6.Utilities.BackgroundClient.html Sat Apr 18 19:14:57 2015 +0200 @@ -61,9 +61,15 @@ <td><a href="#BackgroundClient.__init__">BackgroundClient</a></td> <td>Constructor of the BackgroundClient class.</td> </tr><tr> +<td><a href="#BackgroundClient.__cancelled">__cancelled</a></td> +<td>Private method to check for a job cancellation.</td> +</tr><tr> <td><a href="#BackgroundClient.__initClientService">__initClientService</a></td> <td>Private method to import the given module and register it as service.</td> </tr><tr> +<td><a href="#BackgroundClient.__peek">__peek</a></td> +<td>Private methode to peek the given length of bytes.</td> +</tr><tr> <td><a href="#BackgroundClient.__receive">__receive</a></td> <td>Private methode to receive the given length of bytes.</td> </tr><tr> @@ -91,6 +97,16 @@ <dd> port of the background service </dd> +</dl><a NAME="BackgroundClient.__cancelled" ID="BackgroundClient.__cancelled"></a> +<h4>BackgroundClient.__cancelled</h4> +<b>__cancelled</b>(<i></i>) +<p> + Private method to check for a job cancellation. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating a cancellation (boolean) +</dd> </dl><a NAME="BackgroundClient.__initClientService" ID="BackgroundClient.__initClientService"></a> <h4>BackgroundClient.__initClientService</h4> <b>__initClientService</b>(<i>fn, path, module</i>) @@ -112,6 +128,21 @@ <dd> text result of the import action (str) </dd> +</dl><a NAME="BackgroundClient.__peek" ID="BackgroundClient.__peek"></a> +<h4>BackgroundClient.__peek</h4> +<b>__peek</b>(<i>length</i>) +<p> + Private methode to peek the given length of bytes. +</p><dl> +<dt><i>length</i></dt> +<dd> +bytes to receive (int) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +received bytes (bytes) +</dd> </dl><a NAME="BackgroundClient.__receive" ID="BackgroundClient.__receive"></a> <h4>BackgroundClient.__receive</h4> <b>__receive</b>(<i>length</i>) @@ -125,7 +156,7 @@ </dl><dl> <dt>Returns:</dt> <dd> -received bytes or None if connection closed (str) +received bytes or None if connection closed (bytes) </dd> </dl><a NAME="BackgroundClient.__send" ID="BackgroundClient.__send"></a> <h4>BackgroundClient.__send</h4>
--- a/Documentation/Source/eric6.Utilities.BackgroundService.html Sat Apr 18 19:14:15 2015 +0200 +++ b/Documentation/Source/eric6.Utilities.BackgroundService.html Sat Apr 18 19:14:57 2015 +0200 @@ -85,6 +85,9 @@ <td><a href="#BackgroundService.preferencesOrProjectChanged">preferencesOrProjectChanged</a></td> <td>Public slot to restart the built in languages.</td> </tr><tr> +<td><a href="#BackgroundService.requestCancel">requestCancel</a></td> +<td>Public method to ask a batch job to terminate.</td> +</tr><tr> <td><a href="#BackgroundService.restartService">restartService</a></td> <td>Public method to restart a given lanuage.</td> </tr><tr> @@ -202,7 +205,17 @@ <b>preferencesOrProjectChanged</b>(<i></i>) <p> Public slot to restart the built in languages. -</p><a NAME="BackgroundService.restartService" ID="BackgroundService.restartService"></a> +</p><a NAME="BackgroundService.requestCancel" ID="BackgroundService.requestCancel"></a> +<h4>BackgroundService.requestCancel</h4> +<b>requestCancel</b>(<i>lang</i>) +<p> + Public method to ask a batch job to terminate. +</p><dl> +<dt><i>lang</i></dt> +<dd> +language to connect to (str) +</dd> +</dl><a NAME="BackgroundService.restartService" ID="BackgroundService.restartService"></a> <h4>BackgroundService.restartService</h4> <b>restartService</b>(<i>language, forceKill=False</i>) <p>