--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitPatchFilesDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitPatchFilesDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,107 +18,139 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.VcsPlugins.vcsGit.GitPatchFilesDialog</h1> + <p> Module implementing a dialog to select a list of patch files. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#GitPatchFilesDialog">GitPatchFilesDialog</a></td> <td>Class implementing a dialog to select a list of patch files.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="GitPatchFilesDialog" ID="GitPatchFilesDialog"></a> <h2>GitPatchFilesDialog</h2> + <p> Class implementing a dialog to select a list of patch files. </p> <h3>Derived from</h3> QDialog, Ui_GitPatchFilesDialog <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="#GitPatchFilesDialog.__init__">GitPatchFilesDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitPatchFilesDialog.__getPatchFilesList">__getPatchFilesList</a></td> <td>Private method to get the list of patch files.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitPatchFilesDialog.getData">getData</a></td> <td>Public slot to get the entered data.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitPatchFilesDialog.on_addButton_clicked">on_addButton_clicked</a></td> <td>Private slot to add patch files to the list.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitPatchFilesDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td> <td>Private slot to delete the selected patch files.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitPatchFilesDialog.on_downButton_clicked">on_downButton_clicked</a></td> <td>Private slot to move an entry down in the list.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitPatchFilesDialog.on_patchFilesList_itemSelectionChanged">on_patchFilesList_itemSelectionChanged</a></td> <td>Private slot to enable button states depending on selection.</td> -</tr><tr> +</tr> +<tr> <td><a href="#GitPatchFilesDialog.on_upButton_clicked">on_upButton_clicked</a></td> <td>Private slot to move an entry up in the list.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="GitPatchFilesDialog.__init__" ID="GitPatchFilesDialog.__init__"></a> <h4>GitPatchFilesDialog (Constructor)</h4> <b>GitPatchFilesDialog</b>(<i>rootDir, patchCheckData, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>rootDir</i></dt> <dd> root of the directory tree (string) -</dd><dt><i>patchCheckData</i></dt> +</dd> +<dt><i>patchCheckData</i></dt> <dd> tuple of data as returned by the getData() method -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="GitPatchFilesDialog.__getPatchFilesList" ID="GitPatchFilesDialog.__getPatchFilesList"></a> +</dl> +<a NAME="GitPatchFilesDialog.__getPatchFilesList" ID="GitPatchFilesDialog.__getPatchFilesList"></a> <h4>GitPatchFilesDialog.__getPatchFilesList</h4> <b>__getPatchFilesList</b>(<i></i>) + <p> Private method to get the list of patch files. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> list of patch files (list of string) </dd> -</dl><a NAME="GitPatchFilesDialog.getData" ID="GitPatchFilesDialog.getData"></a> +</dl> +<a NAME="GitPatchFilesDialog.getData" ID="GitPatchFilesDialog.getData"></a> <h4>GitPatchFilesDialog.getData</h4> <b>getData</b>(<i></i>) + <p> Public slot to get the entered data. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple of list of patch files, strip count, flag indicating @@ -126,29 +158,39 @@ indicating to not trust the line count information (list of string, integer, boolean, boolean) </dd> -</dl><a NAME="GitPatchFilesDialog.on_addButton_clicked" ID="GitPatchFilesDialog.on_addButton_clicked"></a> +</dl> +<a NAME="GitPatchFilesDialog.on_addButton_clicked" ID="GitPatchFilesDialog.on_addButton_clicked"></a> <h4>GitPatchFilesDialog.on_addButton_clicked</h4> <b>on_addButton_clicked</b>(<i></i>) + <p> Private slot to add patch files to the list. -</p><a NAME="GitPatchFilesDialog.on_deleteButton_clicked" ID="GitPatchFilesDialog.on_deleteButton_clicked"></a> +</p> +<a NAME="GitPatchFilesDialog.on_deleteButton_clicked" ID="GitPatchFilesDialog.on_deleteButton_clicked"></a> <h4>GitPatchFilesDialog.on_deleteButton_clicked</h4> <b>on_deleteButton_clicked</b>(<i></i>) + <p> Private slot to delete the selected patch files. -</p><a NAME="GitPatchFilesDialog.on_downButton_clicked" ID="GitPatchFilesDialog.on_downButton_clicked"></a> +</p> +<a NAME="GitPatchFilesDialog.on_downButton_clicked" ID="GitPatchFilesDialog.on_downButton_clicked"></a> <h4>GitPatchFilesDialog.on_downButton_clicked</h4> <b>on_downButton_clicked</b>(<i></i>) + <p> Private slot to move an entry down in the list. -</p><a NAME="GitPatchFilesDialog.on_patchFilesList_itemSelectionChanged" ID="GitPatchFilesDialog.on_patchFilesList_itemSelectionChanged"></a> +</p> +<a NAME="GitPatchFilesDialog.on_patchFilesList_itemSelectionChanged" ID="GitPatchFilesDialog.on_patchFilesList_itemSelectionChanged"></a> <h4>GitPatchFilesDialog.on_patchFilesList_itemSelectionChanged</h4> <b>on_patchFilesList_itemSelectionChanged</b>(<i></i>) + <p> Private slot to enable button states depending on selection. -</p><a NAME="GitPatchFilesDialog.on_upButton_clicked" ID="GitPatchFilesDialog.on_upButton_clicked"></a> +</p> +<a NAME="GitPatchFilesDialog.on_upButton_clicked" ID="GitPatchFilesDialog.on_upButton_clicked"></a> <h4>GitPatchFilesDialog.on_upButton_clicked</h4> <b>on_upButton_clicked</b>(<i></i>) + <p> Private slot to move an entry up in the list. </p>