Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnLogDialog.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnLogDialog.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnLogDialog.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Plugins.VcsPlugins.vcsSubversion.SvnLogDialog</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#111;&#102; &#116;&#104;&#101; &#115;v&#110; &#108;&#111;&#103; &#99;&#111;&#109;&#109;&#97;&#110;&#100; &#112;&#114;&#111;&#99;&#101;&#115;&#115;.
+Module implementing a dialog to show the output of the svn log command process.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#SvnLogDialog">SvnLogDialog</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#111;&#102; &#116;&#104;&#101; &#115;v&#110; &#108;&#111;&#103; &#99;&#111;&#109;&#109;&#97;&#110;&#100; &#112;&#114;&#111;&#99;&#101;&#115;&#115;.</td>
+<td>Class implementing a dialog to show the output of the svn log command process.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,10 +43,10 @@
 <a NAME="SvnLogDialog" ID="SvnLogDialog"></a>
 <h2>SvnLogDialog</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#111;&#102; &#116;&#104;&#101; &#115;v&#110; &#108;&#111;&#103; &#99;&#111;&#109;&#109;&#97;&#110;&#100; &#112;&#114;&#111;&#99;&#101;&#115;&#115;.
+    Class implementing a dialog to show the output of the svn log command process.
 </p><p>
-    &#84;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103; &#105;&#115; &#110;&#111;&#110;&#109;&#111;&#100;&#97;&#108;. &#67;&#108;&#105;&#99;&#107;&#105;&#110;&#103; &#97; &#108;&#105;&#110;&#107; &#105;&#110; &#116;&#104;&#101; &#117;&#112;&#112;&#101;&#114; &#116;&#101;x&#116; &#112;&#97;&#110;&#101; &#115;&#104;&#111;w&#115; 
-    &#97; &#100;&#105;&#102;&#102; &#111;&#102; &#116;&#104;&#101; v&#101;&#114;&#115;&#105;&#111;&#110;&#115;.
+    The dialog is nonmodal. Clicking a link in the upper text pane shows 
+    a diff of the versions.
 </p>
 <h3>Derived from</h3>
 QWidget, Ui_SvnLogDialog
@@ -58,142 +58,142 @@
 <table>
 <tr>
 <td><a href="#SvnLogDialog.__init__">SvnLogDialog</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#SvnLogDialog.__procFinished">__procFinished</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#111;&#110;&#110;&#101;&#99;&#116;&#101;&#100; &#116;&#111; &#116;&#104;&#101; &#102;&#105;&#110;&#105;&#115;&#104;&#101;&#100; &#115;&#105;&#103;&#110;&#97;&#108;.</td>
+<td>Private slot connected to the finished signal.</td>
 </tr><tr>
 <td><a href="#SvnLogDialog.__readStderr">__readStderr</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#114;&#101;&#97;&#100;y&#82;&#101;&#97;&#100;&#83;&#116;&#97;&#110;&#100;&#97;&#114;&#100;&#69;&#114;&#114;&#111;&#114; &#115;&#105;&#103;&#110;&#97;&#108;.</td>
+<td>Private slot to handle the readyReadStandardError signal.</td>
 </tr><tr>
 <td><a href="#SvnLogDialog.__readStdout">__readStdout</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#114;&#101;&#97;&#100;y&#82;&#101;&#97;&#100;&#83;&#116;&#97;&#110;&#100;&#97;&#114;&#100;&#79;&#117;&#116;&#112;&#117;&#116; &#115;&#105;&#103;&#110;&#97;&#108;.</td>
+<td>Private slot to handle the readyReadStandardOutput signal.</td>
 </tr><tr>
 <td><a href="#SvnLogDialog.__sourceChanged">__sourceChanged</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101;&#67;&#104;&#97;&#110;&#103;&#101;&#100; &#115;&#105;&#103;&#110;&#97;&#108; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115; &#112;&#97;&#110;&#101;.</td>
+<td>Private slot to handle the sourceChanged signal of the contents pane.</td>
 </tr><tr>
 <td><a href="#SvnLogDialog.closeEvent">closeEvent</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#99;&#108;&#111;&#115;&#101; &#101;v&#101;&#110;&#116; &#104;&#97;&#110;&#100;&#108;&#101;&#114;.</td>
+<td>Private slot implementing a close event handler.</td>
 </tr><tr>
 <td><a href="#SvnLogDialog.keyPressEvent">keyPressEvent</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#97; &#107;&#101;y &#112;&#114;&#101;&#115;&#115; &#101;v&#101;&#110;&#116;.</td>
+<td>Protected slot to handle a key press event.</td>
 </tr><tr>
 <td><a href="#SvnLogDialog.on_input_returnPressed">on_input_returnPressed</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#112;&#114;&#101;&#115;&#115; &#111;&#102; &#116;&#104;&#101; &#114;&#101;&#116;&#117;&#114;&#110; &#107;&#101;y &#105;&#110; &#116;&#104;&#101; &#105;&#110;&#112;&#117;&#116; &#102;&#105;&#101;&#108;&#100;.</td>
+<td>Private slot to handle the press of the return key in the input field.</td>
 </tr><tr>
 <td><a href="#SvnLogDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#112;&#97;&#115;&#115;w&#111;&#114;&#100; &#99;&#104;&#101;&#99;&#107;&#98;&#111;x &#116;&#111;&#103;&#103;&#108;&#101;&#100;.</td>
+<td>Private slot to handle the password checkbox toggled.</td>
 </tr><tr>
 <td><a href="#SvnLogDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#110;&#100; &#116;&#104;&#101; &#105;&#110;&#112;&#117;&#116; &#116;&#111; &#116;&#104;&#101; &#115;&#117;&#98;v&#101;&#114;&#115;&#105;&#111;&#110; &#112;&#114;&#111;&#99;&#101;&#115;&#115;.</td>
+<td>Private slot to send the input to the subversion process.</td>
 </tr><tr>
 <td><a href="#SvnLogDialog.start">start</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#116;&#97;&#114;&#116; &#116;&#104;&#101; &#99;v&#115; &#108;&#111;&#103; &#99;&#111;&#109;&#109;&#97;&#110;&#100;.</td>
+<td>Public slot to start the cvs log command.</td>
 </tr>
 </table>
 <a NAME="SvnLogDialog.__init__" ID="SvnLogDialog.__init__"></a>
 <h4>SvnLogDialog (Constructor)</h4>
 <b>SvnLogDialog</b>(<i>vcs, parent = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>vcs</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; v&#99;&#115; &#111;&#98;&#106;&#101;&#99;&#116;
+reference to the vcs object
 </dd><dt><i>parent</i></dt>
 <dd>
-&#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+parent widget (QWidget)
 </dd>
 </dl><a NAME="SvnLogDialog.__procFinished" ID="SvnLogDialog.__procFinished"></a>
 <h4>SvnLogDialog.__procFinished</h4>
 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#111;&#110;&#110;&#101;&#99;&#116;&#101;&#100; &#116;&#111; &#116;&#104;&#101; &#102;&#105;&#110;&#105;&#115;&#104;&#101;&#100; &#115;&#105;&#103;&#110;&#97;&#108;.
+        Private slot connected to the finished signal.
 </p><dl>
 <dt><i>exitCode</i></dt>
 <dd>
-&#101;x&#105;&#116; &#99;&#111;&#100;&#101; &#111;&#102; &#116;&#104;&#101; &#112;&#114;&#111;&#99;&#101;&#115;&#115; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+exit code of the process (integer)
 </dd><dt><i>exitStatus</i></dt>
 <dd>
-&#101;x&#105;&#116; &#115;&#116;&#97;&#116;&#117;&#115; &#111;&#102; &#116;&#104;&#101; &#112;&#114;&#111;&#99;&#101;&#115;&#115; (&#81;&#80;&#114;&#111;&#99;&#101;&#115;&#115;.&#69;x&#105;&#116;&#83;&#116;&#97;&#116;&#117;&#115;)
+exit status of the process (QProcess.ExitStatus)
 </dd>
 </dl><a NAME="SvnLogDialog.__readStderr" ID="SvnLogDialog.__readStderr"></a>
 <h4>SvnLogDialog.__readStderr</h4>
 <b>__readStderr</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#114;&#101;&#97;&#100;y&#82;&#101;&#97;&#100;&#83;&#116;&#97;&#110;&#100;&#97;&#114;&#100;&#69;&#114;&#114;&#111;&#114; &#115;&#105;&#103;&#110;&#97;&#108;.
+        Private slot to handle the readyReadStandardError signal.
 </p><p>
-        &#73;&#116; &#114;&#101;&#97;&#100;&#115; &#116;&#104;&#101; &#101;&#114;&#114;&#111;&#114; &#111;&#117;&#116;&#112;&#117;&#116; &#111;&#102; &#116;&#104;&#101; &#112;&#114;&#111;&#99;&#101;&#115;&#115; &#97;&#110;&#100; &#105;&#110;&#115;&#101;&#114;&#116;&#115; &#105;&#116; &#105;&#110;&#116;&#111; &#116;&#104;&#101;
-        &#101;&#114;&#114;&#111;&#114; &#112;&#97;&#110;&#101;.
+        It reads the error output of the process and inserts it into the
+        error pane.
 </p><a NAME="SvnLogDialog.__readStdout" ID="SvnLogDialog.__readStdout"></a>
 <h4>SvnLogDialog.__readStdout</h4>
 <b>__readStdout</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#114;&#101;&#97;&#100;y&#82;&#101;&#97;&#100;&#83;&#116;&#97;&#110;&#100;&#97;&#114;&#100;&#79;&#117;&#116;&#112;&#117;&#116; &#115;&#105;&#103;&#110;&#97;&#108;. 
+        Private slot to handle the readyReadStandardOutput signal. 
 </p><p>
-        &#73;&#116; &#114;&#101;&#97;&#100;&#115; &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#111;&#102; &#116;&#104;&#101; &#112;&#114;&#111;&#99;&#101;&#115;&#115; &#97;&#110;&#100; &#105;&#110;&#115;&#101;&#114;&#116;&#115; &#105;&#116; &#105;&#110;&#116;&#111; &#97; &#98;&#117;&#102;&#102;&#101;&#114;.
+        It reads the output of the process and inserts it into a buffer.
 </p><a NAME="SvnLogDialog.__sourceChanged" ID="SvnLogDialog.__sourceChanged"></a>
 <h4>SvnLogDialog.__sourceChanged</h4>
 <b>__sourceChanged</b>(<i>url</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101;&#67;&#104;&#97;&#110;&#103;&#101;&#100; &#115;&#105;&#103;&#110;&#97;&#108; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115; &#112;&#97;&#110;&#101;.
+        Private slot to handle the sourceChanged signal of the contents pane.
 </p><dl>
 <dt><i>url</i></dt>
 <dd>
-&#116;&#104;&#101; &#117;&#114;&#108; &#116;&#104;&#97;&#116; w&#97;&#115; &#99;&#108;&#105;&#99;&#107;&#101;&#100; (&#81;&#85;&#114;&#108;)
+the url that was clicked (QUrl)
 </dd>
 </dl><a NAME="SvnLogDialog.closeEvent" ID="SvnLogDialog.closeEvent"></a>
 <h4>SvnLogDialog.closeEvent</h4>
 <b>closeEvent</b>(<i>e</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#99;&#108;&#111;&#115;&#101; &#101;v&#101;&#110;&#116; &#104;&#97;&#110;&#100;&#108;&#101;&#114;.
+        Private slot implementing a close event handler.
 </p><dl>
 <dt><i>e</i></dt>
 <dd>
-&#99;&#108;&#111;&#115;&#101; &#101;v&#101;&#110;&#116; (&#81;&#67;&#108;&#111;&#115;&#101;&#69;v&#101;&#110;&#116;)
+close event (QCloseEvent)
 </dd>
 </dl><a NAME="SvnLogDialog.keyPressEvent" ID="SvnLogDialog.keyPressEvent"></a>
 <h4>SvnLogDialog.keyPressEvent</h4>
 <b>keyPressEvent</b>(<i>evt</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#97; &#107;&#101;y &#112;&#114;&#101;&#115;&#115; &#101;v&#101;&#110;&#116;.
+        Protected slot to handle a key press event.
 </p><dl>
 <dt><i>evt</i></dt>
 <dd>
-&#116;&#104;&#101; &#107;&#101;y &#112;&#114;&#101;&#115;&#115; &#101;v&#101;&#110;&#116; (&#81;&#75;&#101;y&#69;v&#101;&#110;&#116;)
+the key press event (QKeyEvent)
 </dd>
 </dl><a NAME="SvnLogDialog.on_input_returnPressed" ID="SvnLogDialog.on_input_returnPressed"></a>
 <h4>SvnLogDialog.on_input_returnPressed</h4>
 <b>on_input_returnPressed</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#112;&#114;&#101;&#115;&#115; &#111;&#102; &#116;&#104;&#101; &#114;&#101;&#116;&#117;&#114;&#110; &#107;&#101;y &#105;&#110; &#116;&#104;&#101; &#105;&#110;&#112;&#117;&#116; &#102;&#105;&#101;&#108;&#100;.
+        Private slot to handle the press of the return key in the input field.
 </p><a NAME="SvnLogDialog.on_passwordCheckBox_toggled" ID="SvnLogDialog.on_passwordCheckBox_toggled"></a>
 <h4>SvnLogDialog.on_passwordCheckBox_toggled</h4>
 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#112;&#97;&#115;&#115;w&#111;&#114;&#100; &#99;&#104;&#101;&#99;&#107;&#98;&#111;x &#116;&#111;&#103;&#103;&#108;&#101;&#100;.
+        Private slot to handle the password checkbox toggled.
 </p><dl>
 <dt><i>isOn</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#117;&#115; &#111;&#102; &#116;&#104;&#101; &#99;&#104;&#101;&#99;&#107; &#98;&#111;x (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating the status of the check box (boolean)
 </dd>
 </dl><a NAME="SvnLogDialog.on_sendButton_clicked" ID="SvnLogDialog.on_sendButton_clicked"></a>
 <h4>SvnLogDialog.on_sendButton_clicked</h4>
 <b>on_sendButton_clicked</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#110;&#100; &#116;&#104;&#101; &#105;&#110;&#112;&#117;&#116; &#116;&#111; &#116;&#104;&#101; &#115;&#117;&#98;v&#101;&#114;&#115;&#105;&#111;&#110; &#112;&#114;&#111;&#99;&#101;&#115;&#115;.
+        Private slot to send the input to the subversion process.
 </p><a NAME="SvnLogDialog.start" ID="SvnLogDialog.start"></a>
 <h4>SvnLogDialog.start</h4>
 <b>start</b>(<i>fn, noEntries = 0</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#116;&#97;&#114;&#116; &#116;&#104;&#101; &#99;v&#115; &#108;&#111;&#103; &#99;&#111;&#109;&#109;&#97;&#110;&#100;.
+        Public slot to start the cvs log command.
 </p><dl>
 <dt><i>fn</i></dt>
 <dd>
-&#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#108;&#111;&#103; &#102;&#111;&#114; (&#115;&#116;&#114;&#105;&#110;&#103;)
+filename to show the log for (string)
 </dd><dt><i>noEntries</i></dt>
 <dd>
-&#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#101;&#110;&#116;&#114;&#105;&#101;&#115; &#116;&#111; &#115;&#104;&#111;w (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+number of entries to show (integer)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial