--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsPySvn.SvnPropListDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsPySvn.SvnPropListDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,30 +18,38 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsPySvn.SvnPropListDialog</h1> + <p> Module implementing a dialog to show the output of the svn proplist command process. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#SvnPropListDialog">SvnPropListDialog</a></td> <td>Class implementing a dialog to show the output of the svn proplist command process.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="SvnPropListDialog" ID="SvnPropListDialog"></a> <h2>SvnPropListDialog</h2> + <p> Class implementing a dialog to show the output of the svn proplist command process. @@ -49,128 +57,173 @@ <h3>Derived from</h3> QWidget, SvnDialogMixin, Ui_SvnPropListDialog <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="#SvnPropListDialog.__init__">SvnPropListDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnPropListDialog.__finish">__finish</a></td> <td>Private slot called when the process finished or the user pressed the button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnPropListDialog.__generateItem">__generateItem</a></td> <td>Private method to generate a properties item in the properties list.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnPropListDialog.__resizeColumns">__resizeColumns</a></td> <td>Private method to resize the list columns.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnPropListDialog.__resort">__resort</a></td> <td>Private method to resort the tree.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnPropListDialog.__showError">__showError</a></td> <td>Private slot to show an error message.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnPropListDialog.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="#SvnPropListDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> <td>Private slot to refresh the status display.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SvnPropListDialog.start">start</a></td> <td>Public slot to start the svn status command.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="SvnPropListDialog.__init__" ID="SvnPropListDialog.__init__"></a> <h4>SvnPropListDialog (Constructor)</h4> <b>SvnPropListDialog</b>(<i>vcs, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>vcs</i></dt> <dd> reference to the vcs object -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> parent widget (QWidget) </dd> -</dl><a NAME="SvnPropListDialog.__finish" ID="SvnPropListDialog.__finish"></a> +</dl> +<a NAME="SvnPropListDialog.__finish" ID="SvnPropListDialog.__finish"></a> <h4>SvnPropListDialog.__finish</h4> <b>__finish</b>(<i></i>) + <p> Private slot called when the process finished or the user pressed the button. -</p><a NAME="SvnPropListDialog.__generateItem" ID="SvnPropListDialog.__generateItem"></a> +</p> +<a NAME="SvnPropListDialog.__generateItem" ID="SvnPropListDialog.__generateItem"></a> <h4>SvnPropListDialog.__generateItem</h4> <b>__generateItem</b>(<i>path, propName, propValue</i>) + <p> Private method to generate a properties item in the properties list. -</p><dl> +</p> +<dl> + <dt><i>path</i></dt> <dd> file/directory name the property applies to (string) -</dd><dt><i>propName</i></dt> +</dd> +<dt><i>propName</i></dt> <dd> name of the property (string) -</dd><dt><i>propValue</i></dt> +</dd> +<dt><i>propValue</i></dt> <dd> value of the property (string) </dd> -</dl><a NAME="SvnPropListDialog.__resizeColumns" ID="SvnPropListDialog.__resizeColumns"></a> +</dl> +<a NAME="SvnPropListDialog.__resizeColumns" ID="SvnPropListDialog.__resizeColumns"></a> <h4>SvnPropListDialog.__resizeColumns</h4> <b>__resizeColumns</b>(<i></i>) + <p> Private method to resize the list columns. -</p><a NAME="SvnPropListDialog.__resort" ID="SvnPropListDialog.__resort"></a> +</p> +<a NAME="SvnPropListDialog.__resort" ID="SvnPropListDialog.__resort"></a> <h4>SvnPropListDialog.__resort</h4> <b>__resort</b>(<i></i>) + <p> Private method to resort the tree. -</p><a NAME="SvnPropListDialog.__showError" ID="SvnPropListDialog.__showError"></a> +</p> +<a NAME="SvnPropListDialog.__showError" ID="SvnPropListDialog.__showError"></a> <h4>SvnPropListDialog.__showError</h4> <b>__showError</b>(<i>msg</i>) + <p> Private 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="SvnPropListDialog.on_buttonBox_clicked" ID="SvnPropListDialog.on_buttonBox_clicked"></a> +</dl> +<a NAME="SvnPropListDialog.on_buttonBox_clicked" ID="SvnPropListDialog.on_buttonBox_clicked"></a> <h4>SvnPropListDialog.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="SvnPropListDialog.on_refreshButton_clicked" ID="SvnPropListDialog.on_refreshButton_clicked"></a> +</dl> +<a NAME="SvnPropListDialog.on_refreshButton_clicked" ID="SvnPropListDialog.on_refreshButton_clicked"></a> <h4>SvnPropListDialog.on_refreshButton_clicked</h4> <b>on_refreshButton_clicked</b>(<i></i>) + <p> Private slot to refresh the status display. -</p><a NAME="SvnPropListDialog.start" ID="SvnPropListDialog.start"></a> +</p> +<a NAME="SvnPropListDialog.start" ID="SvnPropListDialog.start"></a> <h4>SvnPropListDialog.start</h4> <b>start</b>(<i>fn, recursive=False</i>) + <p> Public slot to start the svn status command. -</p><dl> +</p> +<dl> + <dt><i>fn</i></dt> <dd> filename(s) (string or list of strings) -</dd><dt><i>recursive</i></dt> +</dd> +<dt><i>recursive</i></dt> <dd> flag indicating a recursive list is requested </dd>