src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitPatchFilesDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10438
4cd7e5a8b3cf
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitPatchFilesDialog.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,185 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Plugins.VcsPlugins.vcsGit.GitPatchFilesDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.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 />
+<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>
+<td><a href="#GitPatchFilesDialog.__getPatchFilesList">__getPatchFilesList</a></td>
+<td>Private method to get the list of patch files.</td>
+</tr>
+<tr>
+<td><a href="#GitPatchFilesDialog.getData">getData</a></td>
+<td>Public slot to get the entered data.</td>
+</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>
+<td><a href="#GitPatchFilesDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
+<td>Private slot to delete the selected patch files.</td>
+</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>
+<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>
+<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>
+
+<dt><i>rootDir</i></dt>
+<dd>
+root of the directory tree (string)
+</dd>
+<dt><i>patchCheckData</i></dt>
+<dd>
+tuple of data as returned by the
+            getData() method
+</dd>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</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>
+<dt>Return:</dt>
+<dd>
+list of patch files (list of string)
+</dd>
+</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>
+<dt>Return:</dt>
+<dd>
+tuple of list of patch files, strip count, flag indicating
+            that the patch has inaccurate end-of-file marker and a flag
+            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>
+<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>
+<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>
+<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>
+<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>
+<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>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial