diff -r 892c1787d666 -r edde1fe80b3e Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnStatusDialog.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnStatusDialog.html Sat Jan 02 18:19:35 2010 +0000
@@ -0,0 +1,418 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric5.Plugins.VcsPlugins.vcsSubversion.SvnStatusDialog</title>
+<style>
+b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n'
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric5.Plugins.VcsPlugins.vcsSubversion.SvnStatusDialog</h1>
+<p>
+Module implementing a dialog to show the output of the svn status command process.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#SvnStatusDialog">SvnStatusDialog</a></td>
+<td>Class implementing a dialog to show the output of the svn status command process.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="SvnStatusDialog" ID="SvnStatusDialog"></a>
+<h2>SvnStatusDialog</h2>
+<p>
+ Class implementing a dialog to show the output of the svn status command process.
+</p>
+<h3>Derived from</h3>
+QWidget, Ui_SvnStatusDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#SvnStatusDialog.__init__">SvnStatusDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__add">__add</a></td>
+<td>Private slot to handle the Add context menu entry.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__addToChangelist">__addToChangelist</a></td>
+<td>Private slot to add entries to a changelist.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__breakLock">__breakLock</a></td>
+<td>Private slot to handle the Break Lock context menu entry.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__commit">__commit</a></td>
+<td>Private slot to handle the Commit context menu entry.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__committed">__committed</a></td>
+<td>Private slot called after the commit has finished.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__finish">__finish</a></td>
+<td>Private slot called when the process finished or the user pressed the button.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__generateItem">__generateItem</a></td>
+<td>Private method to generate a status item in the status list.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__getChangelistItems">__getChangelistItems</a></td>
+<td>Private method to retrieve all entries, that are members of a changelist.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__getLockActionItems">__getLockActionItems</a></td>
+<td>Private method to retrieve all emtries, that have a locked status.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__getModifiedItems">__getModifiedItems</a></td>
+<td>Private method to retrieve all entries, that have a modified status.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__getNonChangelistItems">__getNonChangelistItems</a></td>
+<td>Private method to retrieve all entries, that are not members of a changelist.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__getUnversionedItems">__getUnversionedItems</a></td>
+<td>Private method to retrieve all entries, that have an unversioned status.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__lock">__lock</a></td>
+<td>Private slot to handle the Lock context menu entry.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__procFinished">__procFinished</a></td>
+<td>Private slot connected to the finished signal.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__readStderr">__readStderr</a></td>
+<td>Private slot to handle the readyReadStandardError signal.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__readStdout">__readStdout</a></td>
+<td>Private slot to handle the readyReadStandardOutput signal.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__removeFromChangelist">__removeFromChangelist</a></td>
+<td>Private slot to remove entries from their changelists.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__resizeColumns">__resizeColumns</a></td>
+<td>Private method to resize the list columns.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__resort">__resort</a></td>
+<td>Private method to resort the tree.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__revert">__revert</a></td>
+<td>Private slot to handle the Revert context menu entry.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__showContextMenu">__showContextMenu</a></td>
+<td>Protected slot to show the context menu of the status list.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__stealLock">__stealLock</a></td>
+<td>Private slot to handle the Break Lock context menu entry.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.__unlock">__unlock</a></td>
+<td>Private slot to handle the Unlock context menu entry.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.closeEvent">closeEvent</a></td>
+<td>Private slot implementing a close event handler.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.keyPressEvent">keyPressEvent</a></td>
+<td>Protected slot to handle a key press event.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
+<td>Private slot called by a button of the button box clicked.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.on_input_returnPressed">on_input_returnPressed</a></td>
+<td>Private slot to handle the press of the return key in the input field.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
+<td>Private slot to handle the password checkbox toggled.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
+<td>Private slot to refresh the status display.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
+<td>Private slot to send the input to the subversion process.</td>
+</tr><tr>
+<td><a href="#SvnStatusDialog.start">start</a></td>
+<td>Public slot to start the svn status command.</td>
+</tr>
+</table>
+<a NAME="SvnStatusDialog.__init__" ID="SvnStatusDialog.__init__"></a>
+<h4>SvnStatusDialog (Constructor)</h4>
+<b>SvnStatusDialog</b>(<i>vcs, parent = None</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>vcs</i></dt>
+<dd>
+reference to the vcs object
+</dd><dt><i>parent</i></dt>
+<dd>
+parent widget (QWidget)
+</dd>
+</dl><a NAME="SvnStatusDialog.__add" ID="SvnStatusDialog.__add"></a>
+<h4>SvnStatusDialog.__add</h4>
+<b>__add</b>(<i></i>)
+<p>
+ Private slot to handle the Add context menu entry.
+</p><a NAME="SvnStatusDialog.__addToChangelist" ID="SvnStatusDialog.__addToChangelist"></a>
+<h4>SvnStatusDialog.__addToChangelist</h4>
+<b>__addToChangelist</b>(<i></i>)
+<p>
+ Private slot to add entries to a changelist.
+</p><a NAME="SvnStatusDialog.__breakLock" ID="SvnStatusDialog.__breakLock"></a>
+<h4>SvnStatusDialog.__breakLock</h4>
+<b>__breakLock</b>(<i></i>)
+<p>
+ Private slot to handle the Break Lock context menu entry.
+</p><a NAME="SvnStatusDialog.__commit" ID="SvnStatusDialog.__commit"></a>
+<h4>SvnStatusDialog.__commit</h4>
+<b>__commit</b>(<i></i>)
+<p>
+ Private slot to handle the Commit context menu entry.
+</p><a NAME="SvnStatusDialog.__committed" ID="SvnStatusDialog.__committed"></a>
+<h4>SvnStatusDialog.__committed</h4>
+<b>__committed</b>(<i></i>)
+<p>
+ Private slot called after the commit has finished.
+</p><a NAME="SvnStatusDialog.__finish" ID="SvnStatusDialog.__finish"></a>
+<h4>SvnStatusDialog.__finish</h4>
+<b>__finish</b>(<i></i>)
+<p>
+ Private slot called when the process finished or the user pressed the button.
+</p><a NAME="SvnStatusDialog.__generateItem" ID="SvnStatusDialog.__generateItem"></a>
+<h4>SvnStatusDialog.__generateItem</h4>
+<b>__generateItem</b>(<i>status, propStatus, locked, history, switched, lockinfo, uptodate, revision, change, author, path</i>)
+<p>
+ Private method to generate a status item in the status list.
+</p><dl>
+<dt><i>status</i></dt>
+<dd>
+status indicator (string)
+</dd><dt><i>propStatus</i></dt>
+<dd>
+property status indicator (string)
+</dd><dt><i>locked</i></dt>
+<dd>
+locked indicator (string)
+</dd><dt><i>history</i></dt>
+<dd>
+history indicator (string)
+</dd><dt><i>switched</i></dt>
+<dd>
+switched indicator (string)
+</dd><dt><i>lockinfo</i></dt>
+<dd>
+lock indicator (string)
+</dd><dt><i>uptodate</i></dt>
+<dd>
+up to date indicator (string)
+</dd><dt><i>revision</i></dt>
+<dd>
+revision string (string)
+</dd><dt><i>change</i></dt>
+<dd>
+revision of last change (string)
+</dd><dt><i>author</i></dt>
+<dd>
+author of the last change (string)
+</dd><dt><i>path</i></dt>
+<dd>
+path of the file or directory (string)
+</dd>
+</dl><a NAME="SvnStatusDialog.__getChangelistItems" ID="SvnStatusDialog.__getChangelistItems"></a>
+<h4>SvnStatusDialog.__getChangelistItems</h4>
+<b>__getChangelistItems</b>(<i></i>)
+<p>
+ Private method to retrieve all entries, that are members of a changelist.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of all items belonging to a changelist
+</dd>
+</dl><a NAME="SvnStatusDialog.__getLockActionItems" ID="SvnStatusDialog.__getLockActionItems"></a>
+<h4>SvnStatusDialog.__getLockActionItems</h4>
+<b>__getLockActionItems</b>(<i>indicators</i>)
+<p>
+ Private method to retrieve all emtries, that have a locked status.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of all items with a locked status
+</dd>
+</dl><a NAME="SvnStatusDialog.__getModifiedItems" ID="SvnStatusDialog.__getModifiedItems"></a>
+<h4>SvnStatusDialog.__getModifiedItems</h4>
+<b>__getModifiedItems</b>(<i></i>)
+<p>
+ Private method to retrieve all entries, that have a modified status.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of all items with a modified status
+</dd>
+</dl><a NAME="SvnStatusDialog.__getNonChangelistItems" ID="SvnStatusDialog.__getNonChangelistItems"></a>
+<h4>SvnStatusDialog.__getNonChangelistItems</h4>
+<b>__getNonChangelistItems</b>(<i></i>)
+<p>
+ Private method to retrieve all entries, that are not members of a changelist.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of all items not belonging to a changelist
+</dd>
+</dl><a NAME="SvnStatusDialog.__getUnversionedItems" ID="SvnStatusDialog.__getUnversionedItems"></a>
+<h4>SvnStatusDialog.__getUnversionedItems</h4>
+<b>__getUnversionedItems</b>(<i></i>)
+<p>
+ Private method to retrieve all entries, that have an unversioned status.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of all items with an unversioned status
+</dd>
+</dl><a NAME="SvnStatusDialog.__lock" ID="SvnStatusDialog.__lock"></a>
+<h4>SvnStatusDialog.__lock</h4>
+<b>__lock</b>(<i></i>)
+<p>
+ Private slot to handle the Lock context menu entry.
+</p><a NAME="SvnStatusDialog.__procFinished" ID="SvnStatusDialog.__procFinished"></a>
+<h4>SvnStatusDialog.__procFinished</h4>
+<b>__procFinished</b>(<i>exitCode, exitStatus</i>)
+<p>
+ Private slot connected to the finished signal.
+</p><dl>
+<dt><i>exitCode</i></dt>
+<dd>
+exit code of the process (integer)
+</dd><dt><i>exitStatus</i></dt>
+<dd>
+exit status of the process (QProcess.ExitStatus)
+</dd>
+</dl><a NAME="SvnStatusDialog.__readStderr" ID="SvnStatusDialog.__readStderr"></a>
+<h4>SvnStatusDialog.__readStderr</h4>
+<b>__readStderr</b>(<i></i>)
+<p>
+ Private slot to handle the readyReadStandardError signal.
+</p><p>
+ It reads the error output of the process and inserts it into the
+ error pane.
+</p><a NAME="SvnStatusDialog.__readStdout" ID="SvnStatusDialog.__readStdout"></a>
+<h4>SvnStatusDialog.__readStdout</h4>
+<b>__readStdout</b>(<i></i>)
+<p>
+ Private slot to handle the readyReadStandardOutput signal.
+</p><p>
+ It reads the output of the process, formats it and inserts it into
+ the contents pane.
+</p><a NAME="SvnStatusDialog.__removeFromChangelist" ID="SvnStatusDialog.__removeFromChangelist"></a>
+<h4>SvnStatusDialog.__removeFromChangelist</h4>
+<b>__removeFromChangelist</b>(<i></i>)
+<p>
+ Private slot to remove entries from their changelists.
+</p><a NAME="SvnStatusDialog.__resizeColumns" ID="SvnStatusDialog.__resizeColumns"></a>
+<h4>SvnStatusDialog.__resizeColumns</h4>
+<b>__resizeColumns</b>(<i></i>)
+<p>
+ Private method to resize the list columns.
+</p><a NAME="SvnStatusDialog.__resort" ID="SvnStatusDialog.__resort"></a>
+<h4>SvnStatusDialog.__resort</h4>
+<b>__resort</b>(<i></i>)
+<p>
+ Private method to resort the tree.
+</p><a NAME="SvnStatusDialog.__revert" ID="SvnStatusDialog.__revert"></a>
+<h4>SvnStatusDialog.__revert</h4>
+<b>__revert</b>(<i></i>)
+<p>
+ Private slot to handle the Revert context menu entry.
+</p><a NAME="SvnStatusDialog.__showContextMenu" ID="SvnStatusDialog.__showContextMenu"></a>
+<h4>SvnStatusDialog.__showContextMenu</h4>
+<b>__showContextMenu</b>(<i>coord</i>)
+<p>
+ Protected slot to show the context menu of the status list.
+</p><dl>
+<dt><i>coord</i></dt>
+<dd>
+the position of the mouse pointer (QPoint)
+</dd>
+</dl><a NAME="SvnStatusDialog.__stealLock" ID="SvnStatusDialog.__stealLock"></a>
+<h4>SvnStatusDialog.__stealLock</h4>
+<b>__stealLock</b>(<i></i>)
+<p>
+ Private slot to handle the Break Lock context menu entry.
+</p><a NAME="SvnStatusDialog.__unlock" ID="SvnStatusDialog.__unlock"></a>
+<h4>SvnStatusDialog.__unlock</h4>
+<b>__unlock</b>(<i></i>)
+<p>
+ Private slot to handle the Unlock context menu entry.
+</p><a NAME="SvnStatusDialog.closeEvent" ID="SvnStatusDialog.closeEvent"></a>
+<h4>SvnStatusDialog.closeEvent</h4>
+<b>closeEvent</b>(<i>e</i>)
+<p>
+ Private slot implementing a close event handler.
+</p><dl>
+<dt><i>e</i></dt>
+<dd>
+close event (QCloseEvent)
+</dd>
+</dl><a NAME="SvnStatusDialog.keyPressEvent" ID="SvnStatusDialog.keyPressEvent"></a>
+<h4>SvnStatusDialog.keyPressEvent</h4>
+<b>keyPressEvent</b>(<i>evt</i>)
+<p>
+ Protected slot to handle a key press event.
+</p><dl>
+<dt><i>evt</i></dt>
+<dd>
+the key press event (QKeyEvent)
+</dd>
+</dl><a NAME="SvnStatusDialog.on_buttonBox_clicked" ID="SvnStatusDialog.on_buttonBox_clicked"></a>
+<h4>SvnStatusDialog.on_buttonBox_clicked</h4>
+<b>on_buttonBox_clicked</b>(<i>button</i>)
+<p>
+ Private slot called by a button of the button box clicked.
+</p><dl>
+<dt><i>button</i></dt>
+<dd>
+button that was clicked (QAbstractButton)
+</dd>
+</dl><a NAME="SvnStatusDialog.on_input_returnPressed" ID="SvnStatusDialog.on_input_returnPressed"></a>
+<h4>SvnStatusDialog.on_input_returnPressed</h4>
+<b>on_input_returnPressed</b>(<i></i>)
+<p>
+ Private slot to handle the press of the return key in the input field.
+</p><a NAME="SvnStatusDialog.on_passwordCheckBox_toggled" ID="SvnStatusDialog.on_passwordCheckBox_toggled"></a>
+<h4>SvnStatusDialog.on_passwordCheckBox_toggled</h4>
+<b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
+<p>
+ Private slot to handle the password checkbox toggled.
+</p><dl>
+<dt><i>isOn</i></dt>
+<dd>
+flag indicating the status of the check box (boolean)
+</dd>
+</dl><a NAME="SvnStatusDialog.on_refreshButton_clicked" ID="SvnStatusDialog.on_refreshButton_clicked"></a>
+<h4>SvnStatusDialog.on_refreshButton_clicked</h4>
+<b>on_refreshButton_clicked</b>(<i></i>)
+<p>
+ Private slot to refresh the status display.
+</p><a NAME="SvnStatusDialog.on_sendButton_clicked" ID="SvnStatusDialog.on_sendButton_clicked"></a>
+<h4>SvnStatusDialog.on_sendButton_clicked</h4>
+<b>on_sendButton_clicked</b>(<i></i>)
+<p>
+ Private slot to send the input to the subversion process.
+</p><a NAME="SvnStatusDialog.start" ID="SvnStatusDialog.start"></a>
+<h4>SvnStatusDialog.start</h4>
+<b>start</b>(<i>fn</i>)
+<p>
+ Public slot to start the svn status command.
+</p><dl>
+<dt><i>fn</i></dt>
+<dd>
+filename(s)/directoryname(s) to show the status of
+ (string or list of strings)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
