--- a/Documentation/Source/eric5.VCS.StatusMonitorThread.html Thu Jan 14 17:27:31 2010 +0000 +++ b/Documentation/Source/eric5.VCS.StatusMonitorThread.html Thu Jan 14 18:35:52 2010 +0000 @@ -22,7 +22,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.VCS.StatusMonitorThread</h1> <p> -Module implementing the VCS status monitor thread base class. +Module implementing the VCS status monitor thread base class. </p> <h3>Global Attributes</h3> <table> @@ -32,7 +32,7 @@ <table> <tr> <td><a href="#VcsStatusMonitorThread">VcsStatusMonitorThread</a></td> -<td>Class implementing the VCS status monitor thread base class.</td> +<td>Class implementing the VCS status monitor thread base class.</td> </tr> </table> <h3>Functions</h3> @@ -43,16 +43,16 @@ <a NAME="VcsStatusMonitorThread" ID="VcsStatusMonitorThread"></a> <h2>VcsStatusMonitorThread</h2> <p> - Class implementing the VCS status monitor thread base class. + Class implementing the VCS status monitor thread base class. </p><h4>Signals</h4> <dl> <dt>vcsStatusMonitorData(QStringList)</dt> <dd> -emitted to update the VCS status +emitted to update the VCS status </dd><dt>vcsStatusMonitorStatus(QString, QString)</dt> <dd> -emitted to signal the status of the - monitoring thread (ok, nok, op) and a status message +emitted to signal the status of the + monitoring thread (ok, nok, op) and a status message </dd> </dl> <h3>Derived from</h3> @@ -65,144 +65,144 @@ <table> <tr> <td><a href="#VcsStatusMonitorThread.__init__">VcsStatusMonitorThread</a></td> -<td>Constructor</td> +<td>Constructor</td> </tr><tr> <td><a href="#VcsStatusMonitorThread._performMonitor">_performMonitor</a></td> -<td>Protected method implementing the real monitoring action.</td> +<td>Protected method implementing the real monitoring action.</td> </tr><tr> <td><a href="#VcsStatusMonitorThread.checkStatus">checkStatus</a></td> -<td>Public method to wake up the status monitor thread.</td> +<td>Public method to wake up the status monitor thread.</td> </tr><tr> <td><a href="#VcsStatusMonitorThread.clearCachedState">clearCachedState</a></td> -<td>Public method to clear the cached VCS state of a file/directory.</td> +<td>Public method to clear the cached VCS state of a file/directory.</td> </tr><tr> <td><a href="#VcsStatusMonitorThread.getAutoUpdate">getAutoUpdate</a></td> -<td>Public method to retrieve the status of the auto update function.</td> +<td>Public method to retrieve the status of the auto update function.</td> </tr><tr> <td><a href="#VcsStatusMonitorThread.getInterval">getInterval</a></td> -<td>Public method to get the monitor interval.</td> +<td>Public method to get the monitor interval.</td> </tr><tr> <td><a href="#VcsStatusMonitorThread.run">run</a></td> -<td>Protected method implementing the tasks action.</td> +<td>Protected method implementing the tasks action.</td> </tr><tr> <td><a href="#VcsStatusMonitorThread.setAutoUpdate">setAutoUpdate</a></td> -<td>Public method to enable the auto update function.</td> +<td>Public method to enable the auto update function.</td> </tr><tr> <td><a href="#VcsStatusMonitorThread.setInterval">setInterval</a></td> -<td>Public method to change the monitor interval.</td> +<td>Public method to change the monitor interval.</td> </tr><tr> <td><a href="#VcsStatusMonitorThread.stop">stop</a></td> -<td>Public method to stop the monitor thread.</td> +<td>Public method to stop the monitor thread.</td> </tr> </table> <a NAME="VcsStatusMonitorThread.__init__" ID="VcsStatusMonitorThread.__init__"></a> <h4>VcsStatusMonitorThread (Constructor)</h4> <b>VcsStatusMonitorThread</b>(<i>interval, projectDir, vcs, parent = None</i>) <p> - Constructor + Constructor </p><dl> <dt><i>interval</i></dt> <dd> -new interval in seconds (integer) +new interval in seconds (integer) </dd><dt><i>projectDir</i></dt> <dd> -project directory to monitor (string) +project directory to monitor (string) </dd><dt><i>vcs</i></dt> <dd> -reference to the version control object +reference to the version control object </dd><dt><i>parent</i></dt> <dd> -reference to the parent object (QObject) +reference to the parent object (QObject) </dd> </dl><a NAME="VcsStatusMonitorThread._performMonitor" ID="VcsStatusMonitorThread._performMonitor"></a> <h4>VcsStatusMonitorThread._performMonitor</h4> <b>_performMonitor</b>(<i></i>) <p> - Protected method implementing the real monitoring action. + Protected method implementing the real monitoring action. </p><p> - This method must be overridden and populate the statusList member variable - with a list of strings giving the status in the first column and the - path relative to the project directory starting with the third column. - The allowed status flags are: - <ul> - <li>"A" path was added but not yet comitted</li> - <li>"M" path has local changes</li> - <li>"R" path was deleted and then re-added</li> - <li>"U" path needs an update</li> - <li>"Z" path contains a conflict</li> - <li>" " path is back at normal</li> - </ul> + This method must be overridden and populate the statusList member variable + with a list of strings giving the status in the first column and the + path relative to the project directory starting with the third column. + The allowed status flags are: + <ul> + <li>"A" path was added but not yet comitted</li> + <li>"M" path has local changes</li> + <li>"R" path was deleted and then re-added</li> + <li>"U" path needs an update</li> + <li>"Z" path contains a conflict</li> + <li>" " path is back at normal</li> + </ul> </p><dl> <dt>Returns:</dt> <dd> -tuple of flag indicating successful operation (boolean) and - a status message in case of non successful operation (QString) +tuple of flag indicating successful operation (boolean) and + a status message in case of non successful operation (QString) </dd> </dl><a NAME="VcsStatusMonitorThread.checkStatus" ID="VcsStatusMonitorThread.checkStatus"></a> <h4>VcsStatusMonitorThread.checkStatus</h4> <b>checkStatus</b>(<i></i>) <p> - Public method to wake up the status monitor thread. + Public method to wake up the status monitor thread. </p><a NAME="VcsStatusMonitorThread.clearCachedState" ID="VcsStatusMonitorThread.clearCachedState"></a> <h4>VcsStatusMonitorThread.clearCachedState</h4> <b>clearCachedState</b>(<i>name</i>) <p> - Public method to clear the cached VCS state of a file/directory. + Public method to clear the cached VCS state of a file/directory. </p><dl> <dt><i>name</i></dt> <dd> -name of the entry to be cleared (string) +name of the entry to be cleared (string) </dd> </dl><a NAME="VcsStatusMonitorThread.getAutoUpdate" ID="VcsStatusMonitorThread.getAutoUpdate"></a> <h4>VcsStatusMonitorThread.getAutoUpdate</h4> <b>getAutoUpdate</b>(<i></i>) <p> - Public method to retrieve the status of the auto update function. + Public method to retrieve the status of the auto update function. </p><dl> <dt>Returns:</dt> <dd> -status of the auto update function (boolean) +status of the auto update function (boolean) </dd> </dl><a NAME="VcsStatusMonitorThread.getInterval" ID="VcsStatusMonitorThread.getInterval"></a> <h4>VcsStatusMonitorThread.getInterval</h4> <b>getInterval</b>(<i></i>) <p> - Public method to get the monitor interval. + Public method to get the monitor interval. </p><dl> <dt>Returns:</dt> <dd> -interval in seconds (integer) +interval in seconds (integer) </dd> </dl><a NAME="VcsStatusMonitorThread.run" ID="VcsStatusMonitorThread.run"></a> <h4>VcsStatusMonitorThread.run</h4> <b>run</b>(<i></i>) <p> - Protected method implementing the tasks action. + Protected method implementing the tasks action. </p><a NAME="VcsStatusMonitorThread.setAutoUpdate" ID="VcsStatusMonitorThread.setAutoUpdate"></a> <h4>VcsStatusMonitorThread.setAutoUpdate</h4> <b>setAutoUpdate</b>(<i>auto</i>) <p> - Public method to enable the auto update function. + Public method to enable the auto update function. </p><dl> <dt><i>auto</i></dt> <dd> -status of the auto update function (boolean) +status of the auto update function (boolean) </dd> </dl><a NAME="VcsStatusMonitorThread.setInterval" ID="VcsStatusMonitorThread.setInterval"></a> <h4>VcsStatusMonitorThread.setInterval</h4> <b>setInterval</b>(<i>interval</i>) <p> - Public method to change the monitor interval. + Public method to change the monitor interval. </p><dl> <dt><i>interval</i></dt> <dd> -new interval in seconds (integer) +new interval in seconds (integer) </dd> </dl><a NAME="VcsStatusMonitorThread.stop" ID="VcsStatusMonitorThread.stop"></a> <h4>VcsStatusMonitorThread.stop</h4> <b>stop</b>(<i></i>) <p> - Public method to stop the monitor thread. + Public method to stop the monitor thread. </p> <div align="right"><a href="#top">Up</a></div> <hr />