diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsPySvn.SvnDialog.html --- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsPySvn.SvnDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsPySvn.SvnDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,146 +18,194 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsPySvn.SvnDialog</h1> + <p> Module implementing a dialog to show the output of a pysvn action. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#SvnDialog">SvnDialog</a></td> <td>Class implementing a dialog to show the output of a pysvn action.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="SvnDialog" ID="SvnDialog"></a> <h2>SvnDialog</h2> + <p> Class implementing a dialog to show the output of a pysvn action. </p> <h3>Derived from</h3> QDialog, SvnDialogMixin, Ui_SvnDialog <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#SvnDialog.__init__">SvnDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnDialog._clientNotifyCallback">_clientNotifyCallback</a></td> <td>Protected method called by the client to send events.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnDialog.finish">finish</a></td> <td>Public slot called when the process finished or the user pressed the button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnDialog.hasAddOrDelete">hasAddOrDelete</a></td> <td>Public method to check, if the last action contained an add or delete.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> <td>Private slot called by a button of the button box clicked.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnDialog.showError">showError</a></td> <td>Public slot to show an error message.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnDialog.showMessage">showMessage</a></td> <td>Public slot to show a message.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="SvnDialog.__init__" ID="SvnDialog.__init__"></a> <h4>SvnDialog (Constructor)</h4> <b>SvnDialog</b>(<i>text, command, pysvnClient, parent=None, log=""</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>text</i></dt> <dd> text to be shown by the label (string) -</dd><dt><i>command</i></dt> +</dd> +<dt><i>command</i></dt> <dd> svn command to be executed (display purposes only) (string) -</dd><dt><i>pysvnClient</i></dt> +</dd> +<dt><i>pysvnClient</i></dt> <dd> reference to the pysvn client object (pysvn.Client) -</dd><dt><i>parent=</i></dt> +</dd> +<dt><i>parent=</i></dt> <dd> parent widget (QWidget) -</dd><dt><i>log=</i></dt> +</dd> +<dt><i>log=</i></dt> <dd> optional log message (string) </dd> -</dl><a NAME="SvnDialog._clientNotifyCallback" ID="SvnDialog._clientNotifyCallback"></a> +</dl> +<a NAME="SvnDialog._clientNotifyCallback" ID="SvnDialog._clientNotifyCallback"></a> <h4>SvnDialog._clientNotifyCallback</h4> <b>_clientNotifyCallback</b>(<i>eventDict</i>) + <p> Protected method called by the client to send events. -</p><dl> +</p> +<dl> + <dt><i>eventDict</i></dt> <dd> dictionary containing the notification event </dd> -</dl><a NAME="SvnDialog.finish" ID="SvnDialog.finish"></a> +</dl> +<a NAME="SvnDialog.finish" ID="SvnDialog.finish"></a> <h4>SvnDialog.finish</h4> <b>finish</b>(<i></i>) + <p> Public slot called when the process finished or the user pressed the button. -</p><a NAME="SvnDialog.hasAddOrDelete" ID="SvnDialog.hasAddOrDelete"></a> +</p> +<a NAME="SvnDialog.hasAddOrDelete" ID="SvnDialog.hasAddOrDelete"></a> <h4>SvnDialog.hasAddOrDelete</h4> <b>hasAddOrDelete</b>(<i></i>) + <p> Public method to check, if the last action contained an add or delete. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> flag indicating the presence of an add or delete (boolean) </dd> -</dl><a NAME="SvnDialog.on_buttonBox_clicked" ID="SvnDialog.on_buttonBox_clicked"></a> +</dl> +<a NAME="SvnDialog.on_buttonBox_clicked" ID="SvnDialog.on_buttonBox_clicked"></a> <h4>SvnDialog.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> +</p> +<dl> + <dt><i>button</i></dt> <dd> button that was clicked (QAbstractButton) </dd> -</dl><a NAME="SvnDialog.showError" ID="SvnDialog.showError"></a> +</dl> +<a NAME="SvnDialog.showError" ID="SvnDialog.showError"></a> <h4>SvnDialog.showError</h4> <b>showError</b>(<i>msg</i>) + <p> Public slot to show an error message. -</p><dl> +</p> +<dl> + <dt><i>msg</i></dt> <dd> error message to show (string) </dd> -</dl><a NAME="SvnDialog.showMessage" ID="SvnDialog.showMessage"></a> +</dl> +<a NAME="SvnDialog.showMessage" ID="SvnDialog.showMessage"></a> <h4>SvnDialog.showMessage</h4> <b>showMessage</b>(<i>msg</i>) + <p> Public slot to show a message. -</p><dl> +</p> +<dl> + <dt><i>msg</i></dt> <dd> message to show (string)