Documentation/Source/eric5.Cooperation.CooperationClient.html

changeset 155
375e3c884874
parent 149
a134031209be
child 162
28f235c426c4
--- a/Documentation/Source/eric5.Cooperation.CooperationClient.html	Thu Mar 25 18:29:33 2010 +0000
+++ b/Documentation/Source/eric5.Cooperation.CooperationClient.html	Fri Mar 26 15:43:36 2010 +0000
@@ -52,6 +52,10 @@
 </dd><dt>connectionError(message)</dt>
 <dd>
 emitted when a connection error occurs (string)
+</dd><dt>editorCommand(hash, filename, message)</dt>
+<dd>
+emitted when an editor command
+            has been received (string, string, string)
 </dd><dt>newMessage(user, message)</dt>
 <dd>
 emitted after a new message has
@@ -68,7 +72,7 @@
 QObject
 <h3>Class Attributes</h3>
 <table>
-<tr><td>cannotConnect</td></tr><tr><td>connectionError</td></tr><tr><td>newMessage</td></tr><tr><td>newParticipant</td></tr><tr><td>participantLeft</td></tr>
+<tr><td>cannotConnect</td></tr><tr><td>connectionError</td></tr><tr><td>editorCommand</td></tr><tr><td>newMessage</td></tr><tr><td>newParticipant</td></tr><tr><td>participantLeft</td></tr>
 </table>
 <h3>Methods</h3>
 <table>
@@ -112,6 +116,9 @@
 <td><a href="#CooperationClient.nickName">nickName</a></td>
 <td>Public method to get the nick name.</td>
 </tr><tr>
+<td><a href="#CooperationClient.sendEditorCommand">sendEditorCommand</a></td>
+<td>Public method to send an editor command.</td>
+</tr><tr>
 <td><a href="#CooperationClient.sendMessage">sendMessage</a></td>
 <td>Public method to send a message.</td>
 </tr><tr>
@@ -235,6 +242,23 @@
 <dd>
 nick name (string)
 </dd>
+</dl><a NAME="CooperationClient.sendEditorCommand" ID="CooperationClient.sendEditorCommand"></a>
+<h4>CooperationClient.sendEditorCommand</h4>
+<b>sendEditorCommand</b>(<i>projectHash, filename, message</i>)
+<p>
+        Public method to send an editor command.
+</p><dl>
+<dt><i>projectHash</i></dt>
+<dd>
+hash of the project (string)
+</dd><dt><i>filename</i></dt>
+<dd>
+project relative universal file name of
+            the sending editor (string)
+</dd><dt><i>message</i></dt>
+<dd>
+editor command to be sent (string)
+</dd>
 </dl><a NAME="CooperationClient.sendMessage" ID="CooperationClient.sendMessage"></a>
 <h4>CooperationClient.sendMessage</h4>
 <b>sendMessage</b>(<i>message</i>)

eric ide

mercurial