eric: diff Documentation/Source/eric5.VCS.StatusMonitorLed.html

diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.VCS.StatusMonitorLed.html
--- a/Documentation/Source/eric5.VCS.StatusMonitorLed.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.VCS.StatusMonitorLed.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.VCS.StatusMonitorLed</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#76;&#69;&#68; &#116;&#111; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#117;&#115; &#111;&#102; &#116;&#104;&#101; &#86;&#67;&#83; &#115;&#116;&#97;&#116;&#117;&#115; &#109;&#111;&#110;&#105;&#116;&#111;&#114; &#116;&#104;&#114;&#101;&#97;&#100;.
+Module implementing a LED to indicate the status of the VCS status monitor thread.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#StatusMonitorLed">StatusMonitorLed</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#76;&#69;&#68; &#116;&#111; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#117;&#115; &#111;&#102; &#116;&#104;&#101; &#86;&#67;&#83; &#115;&#116;&#97;&#116;&#117;&#115; &#109;&#111;&#110;&#105;&#116;&#111;&#114; &#116;&#104;&#114;&#101;&#97;&#100;.</td>
+<td>Class implementing a LED to indicate the status of the VCS status monitor thread.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,7 +43,7 @@
 <a NAME="StatusMonitorLed" ID="StatusMonitorLed"></a>
 <h2>StatusMonitorLed</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#76;&#69;&#68; &#116;&#111; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#117;&#115; &#111;&#102; &#116;&#104;&#101; &#86;&#67;&#83; &#115;&#116;&#97;&#116;&#117;&#115; &#109;&#111;&#110;&#105;&#116;&#111;&#114; &#116;&#104;&#114;&#101;&#97;&#100;.
+    Class implementing a LED to indicate the status of the VCS status monitor thread.
 </p>
 <h3>Derived from</h3>
 E5Led
@@ -55,90 +55,90 @@
 <table>
 <tr>
 <td><a href="#StatusMonitorLed.__init__">StatusMonitorLed</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#StatusMonitorLed.__checkActions">__checkActions</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#101;&#110;&#97;&#98;&#108;&#101;&#100; &#115;&#116;&#97;&#116;&#117;&#115; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117; &#97;&#99;&#116;&#105;&#111;&#110;&#115;.</td>
+<td>Private method to set the enabled status of the context menu actions.</td>
 </tr><tr>
 <td><a href="#StatusMonitorLed.__checkStatus">__checkStatus</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#105;&#110;&#105;&#116;&#105;&#97;&#116;&#101; &#97; &#110;&#101;w &#115;&#116;&#97;&#116;&#117;&#115; &#99;&#104;&#101;&#99;&#107;.</td>
+<td>Private slot to initiate a new status check.</td>
 </tr><tr>
 <td><a href="#StatusMonitorLed.__projectVcsMonitorStatus">__projectVcsMonitorStatus</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#99;&#101;&#105;v&#101; &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#117;&#115; &#109;&#111;&#110;&#105;&#116;&#111;&#114; &#115;&#116;&#97;&#116;&#117;&#115;.</td>
+<td>Private method to receive the status monitor status.</td>
 </tr><tr>
 <td><a href="#StatusMonitorLed.__setInterval">__setInterval</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#99;&#104;&#97;&#110;&#103;&#101; &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#117;&#115; &#99;&#104;&#101;&#99;&#107; &#105;&#110;&#116;&#101;&#114;v&#97;&#108;.</td>
+<td>Private slot to change the status check interval.</td>
 </tr><tr>
 <td><a href="#StatusMonitorLed.__switchOff">__switchOff</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;w&#105;&#116;&#99;&#104; &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#117;&#115; &#109;&#111;&#110;&#105;&#116;&#111;&#114; &#116;&#104;&#114;&#101;&#97;&#100; &#116;&#111; &#79;&#102;&#102;.</td>
+<td>Private slot to switch the status monitor thread to Off.</td>
 </tr><tr>
 <td><a href="#StatusMonitorLed.__switchOn">__switchOn</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;w&#105;&#116;&#99;&#104; &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#117;&#115; &#109;&#111;&#110;&#105;&#116;&#111;&#114; &#116;&#104;&#114;&#101;&#97;&#100; &#116;&#111; &#79;&#110;.</td>
+<td>Private slot to switch the status monitor thread to On.</td>
 </tr><tr>
 <td><a href="#StatusMonitorLed._showContextMenu">_showContextMenu</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117;.</td>
+<td>Protected slot to show the context menu.</td>
 </tr>
 </table>
 <a NAME="StatusMonitorLed.__init__" ID="StatusMonitorLed.__init__"></a>
 <h4>StatusMonitorLed (Constructor)</h4>
 <b>StatusMonitorLed</b>(<i>project, parent</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>project</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#111;&#98;&#106;&#101;&#99;&#116; (&#80;&#114;&#111;&#106;&#101;&#99;&#116;.&#80;&#114;&#111;&#106;&#101;&#99;&#116;)
+reference to the project object (Project.Project)
 </dd><dt><i>parent</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+reference to the parent object (QWidget)
 </dd>
 </dl><a NAME="StatusMonitorLed.__checkActions" ID="StatusMonitorLed.__checkActions"></a>
 <h4>StatusMonitorLed.__checkActions</h4>
 <b>__checkActions</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#101;&#110;&#97;&#98;&#108;&#101;&#100; &#115;&#116;&#97;&#116;&#117;&#115; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117; &#97;&#99;&#116;&#105;&#111;&#110;&#115;.
+        Private method to set the enabled status of the context menu actions.
 </p><a NAME="StatusMonitorLed.__checkStatus" ID="StatusMonitorLed.__checkStatus"></a>
 <h4>StatusMonitorLed.__checkStatus</h4>
 <b>__checkStatus</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#105;&#110;&#105;&#116;&#105;&#97;&#116;&#101; &#97; &#110;&#101;w &#115;&#116;&#97;&#116;&#117;&#115; &#99;&#104;&#101;&#99;&#107;.
+        Private slot to initiate a new status check.
 </p><a NAME="StatusMonitorLed.__projectVcsMonitorStatus" ID="StatusMonitorLed.__projectVcsMonitorStatus"></a>
 <h4>StatusMonitorLed.__projectVcsMonitorStatus</h4>
 <b>__projectVcsMonitorStatus</b>(<i>status, statusMsg</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#99;&#101;&#105;v&#101; &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#117;&#115; &#109;&#111;&#110;&#105;&#116;&#111;&#114; &#115;&#116;&#97;&#116;&#117;&#115;.
+        Private method to receive the status monitor status.
 </p><dl>
 <dt><i>status</i></dt>
 <dd>
-&#115;&#116;&#97;&#116;&#117;&#115; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#110;&#105;&#116;&#111;&#114;&#105;&#110;&#103; &#116;&#104;&#114;&#101;&#97;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;, &#111;&#107;, &#110;&#111;&#107; &#111;&#114; &#111;&#102;&#102;)
+status of the monitoring thread (string, ok, nok or off)
 </dd><dt><i>statusMsg</i></dt>
 <dd>
-&#101;x&#112;&#108;&#97;&#110;&#111;&#116;&#111;&#114;y &#116;&#101;x&#116; &#102;&#111;&#114; &#116;&#104;&#101; &#115;&#105;&#103;&#110;&#97;&#108;&#101;&#100; &#115;&#116;&#97;&#116;&#117;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;)
+explanotory text for the signaled status (string)
 </dd>
 </dl><a NAME="StatusMonitorLed.__setInterval" ID="StatusMonitorLed.__setInterval"></a>
 <h4>StatusMonitorLed.__setInterval</h4>
 <b>__setInterval</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#99;&#104;&#97;&#110;&#103;&#101; &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#117;&#115; &#99;&#104;&#101;&#99;&#107; &#105;&#110;&#116;&#101;&#114;v&#97;&#108;.
+        Private slot to change the status check interval.
 </p><a NAME="StatusMonitorLed.__switchOff" ID="StatusMonitorLed.__switchOff"></a>
 <h4>StatusMonitorLed.__switchOff</h4>
 <b>__switchOff</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;w&#105;&#116;&#99;&#104; &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#117;&#115; &#109;&#111;&#110;&#105;&#116;&#111;&#114; &#116;&#104;&#114;&#101;&#97;&#100; &#116;&#111; &#79;&#102;&#102;.
+        Private slot to switch the status monitor thread to Off.
 </p><a NAME="StatusMonitorLed.__switchOn" ID="StatusMonitorLed.__switchOn"></a>
 <h4>StatusMonitorLed.__switchOn</h4>
 <b>__switchOn</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;w&#105;&#116;&#99;&#104; &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#117;&#115; &#109;&#111;&#110;&#105;&#116;&#111;&#114; &#116;&#104;&#114;&#101;&#97;&#100; &#116;&#111; &#79;&#110;.
+        Private slot to switch the status monitor thread to On.
 </p><a NAME="StatusMonitorLed._showContextMenu" ID="StatusMonitorLed._showContextMenu"></a>
 <h4>StatusMonitorLed._showContextMenu</h4>
 <b>_showContextMenu</b>(<i>coord</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117;.
+        Protected slot to show the context menu.
 </p><dl>
 <dt><i>coord</i></dt>
 <dd>
-&#116;&#104;&#101; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#117;&#115;&#101; &#112;&#111;&#105;&#110;&#116;&#101;&#114; (&#81;&#80;&#111;&#105;&#110;&#116;)
+the position of the mouse pointer (QPoint)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>