Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgUserConfigDialog.html

changeset 5264
8bc23ecb4ea3
parent 5262
235d6a030128
child 5292
ac8b476ba122
diff -r 50a03ff54b15 -r 8bc23ecb4ea3 Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgUserConfigDialog.html
--- a/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgUserConfigDialog.html	Fri Oct 21 23:14:16 2016 +0200
+++ b/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgUserConfigDialog.html	Sat Oct 22 17:09:08 2016 +0200
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 <html><head>
-<title>eric6.Plugins.VcsPlugins.vcsMercurial.HgUserConfigDataDialog</title>
+<title>eric6.Plugins.VcsPlugins.vcsMercurial.HgUserConfigDialog</title>
 <meta charset="UTF-8">
 <style>
 body {
@@ -19,7 +19,7 @@
 </style>
 </head>
 <body><a NAME="top" ID="top"></a>
-<h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgUserConfigDataDialog</h1>
+<h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgUserConfigDialog</h1>
 <p>
 Module implementing a dialog to enter some user data.
 </p>
@@ -30,7 +30,7 @@
 <h3>Classes</h3>
 <table>
 <tr>
-<td><a href="#HgUserConfigDataDialog">HgUserConfigDataDialog</a></td>
+<td><a href="#HgUserConfigDialog">HgUserConfigDialog</a></td>
 <td>Class implementing a dialog to enter some user data.</td>
 </tr>
 </table>
@@ -39,13 +39,13 @@
 <tr><td>None</td></tr>
 </table>
 <hr /><hr />
-<a NAME="HgUserConfigDataDialog" ID="HgUserConfigDataDialog"></a>
-<h2>HgUserConfigDataDialog</h2>
+<a NAME="HgUserConfigDialog" ID="HgUserConfigDialog"></a>
+<h2>HgUserConfigDialog</h2>
 <p>
     Class implementing a dialog to enter some user data.
 </p>
 <h3>Derived from</h3>
-QDialog, Ui_HgUserConfigDataDialog
+QDialog, Ui_HgUserConfigDialog
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
@@ -57,20 +57,53 @@
 <h3>Methods</h3>
 <table>
 <tr>
-<td><a href="#HgUserConfigDataDialog.__init__">HgUserConfigDataDialog</a></td>
+<td><a href="#HgUserConfigDialog.__init__">HgUserConfigDialog</a></td>
 <td>Constructor</td>
 </tr><tr>
-<td><a href="#HgUserConfigDataDialog.getData">getData</a></td>
-<td>Public method to retrieve the entered data.</td>
+<td><a href="#HgUserConfigDialog.__clearDialog">__clearDialog</a></td>
+<td>Private method to clear the data of the dialog.</td>
+</tr><tr>
+<td><a href="#HgUserConfigDialog.__finalizeFingerprintsColumns">__finalizeFingerprintsColumns</a></td>
+<td>Private method to resize and sort the host fingerprints columns.</td>
+</tr><tr>
+<td><a href="#HgUserConfigDialog.__updateFingerprintsButtons">__updateFingerprintsButtons</a></td>
+<td>Private slot to update the host fingerprints edit buttons.</td>
+</tr><tr>
+<td><a href="#HgUserConfigDialog.accept">accept</a></td>
+<td>Public slot to accept the dialog.</td>
+</tr><tr>
+<td><a href="#HgUserConfigDialog.eventFilter">eventFilter</a></td>
+<td>Public method called to filter the event queue.</td>
+</tr><tr>
+<td><a href="#HgUserConfigDialog.on_editorButton_clicked">on_editorButton_clicked</a></td>
+<td>Private slot to open the user configuration file in a text editor.</td>
+</tr><tr>
+<td><a href="#HgUserConfigDialog.on_fingerprintsList_currentItemChanged">on_fingerprintsList_currentItemChanged</a></td>
+<td>Private slot handling a change of the current fingerprints item.</td>
+</tr><tr>
+<td><a href="#HgUserConfigDialog.on_fpAddButton_clicked">on_fpAddButton_clicked</a></td>
+<td>Private slot to add a fingerprints entry.</td>
+</tr><tr>
+<td><a href="#HgUserConfigDialog.on_fpDeleteButton_clicked">on_fpDeleteButton_clicked</a></td>
+<td>Private slot to delete the current fingerprints item.</td>
+</tr><tr>
+<td><a href="#HgUserConfigDialog.on_fpEditButton_clicked">on_fpEditButton_clicked</a></td>
+<td>Private slot to edit the current fingerprints item.</td>
+</tr><tr>
+<td><a href="#HgUserConfigDialog.readUserConfig">readUserConfig</a></td>
+<td>Public method to read the user configuration file.</td>
+</tr><tr>
+<td><a href="#HgUserConfigDialog.writeUserConfig">writeUserConfig</a></td>
+<td>Public method to write the user configuration file.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
-<a NAME="HgUserConfigDataDialog.__init__" ID="HgUserConfigDataDialog.__init__"></a>
-<h4>HgUserConfigDataDialog (Constructor)</h4>
-<b>HgUserConfigDataDialog</b>(<i>version=(0, 0), parent=None</i>)
+<a NAME="HgUserConfigDialog.__init__" ID="HgUserConfigDialog.__init__"></a>
+<h4>HgUserConfigDialog (Constructor)</h4>
+<b>HgUserConfigDialog</b>(<i>version=(0, 0), parent=None</i>)
 <p>
         Constructor
 </p><dl>
@@ -81,20 +114,93 @@
 <dd>
 reference to the parent widget (QWidget)
 </dd>
-</dl><a NAME="HgUserConfigDataDialog.getData" ID="HgUserConfigDataDialog.getData"></a>
-<h4>HgUserConfigDataDialog.getData</h4>
-<b>getData</b>(<i></i>)
+</dl><a NAME="HgUserConfigDialog.__clearDialog" ID="HgUserConfigDialog.__clearDialog"></a>
+<h4>HgUserConfigDialog.__clearDialog</h4>
+<b>__clearDialog</b>(<i></i>)
+<p>
+        Private method to clear the data of the dialog.
+</p><a NAME="HgUserConfigDialog.__finalizeFingerprintsColumns" ID="HgUserConfigDialog.__finalizeFingerprintsColumns"></a>
+<h4>HgUserConfigDialog.__finalizeFingerprintsColumns</h4>
+<b>__finalizeFingerprintsColumns</b>(<i></i>)
+<p>
+        Private method to resize and sort the host fingerprints columns.
+</p><a NAME="HgUserConfigDialog.__updateFingerprintsButtons" ID="HgUserConfigDialog.__updateFingerprintsButtons"></a>
+<h4>HgUserConfigDialog.__updateFingerprintsButtons</h4>
+<b>__updateFingerprintsButtons</b>(<i></i>)
 <p>
-        Public method to retrieve the entered data.
+        Private slot to update the host fingerprints edit buttons.
+</p><a NAME="HgUserConfigDialog.accept" ID="HgUserConfigDialog.accept"></a>
+<h4>HgUserConfigDialog.accept</h4>
+<b>accept</b>(<i></i>)
+<p>
+        Public slot to accept the dialog.
+</p><a NAME="HgUserConfigDialog.eventFilter" ID="HgUserConfigDialog.eventFilter"></a>
+<h4>HgUserConfigDialog.eventFilter</h4>
+<b>eventFilter</b>(<i>watched, event</i>)
+<p>
+        Public method called to filter the event queue.
 </p><dl>
+<dt><i>watched</i> (QObject)</dt>
+<dd>
+reference to the object being watched
+</dd><dt><i>event</i> (QEvent)</dt>
+<dd>
+event to be handled
+</dd>
+</dl><dl>
 <dt>Returns:</dt>
 <dd>
-tuple with user's first name, last name, email address,
-            list of activated extensions and dictionary with extension data
-            (tuple of three strings, a list of strings and a dictionary with
-             extension name as key)
+flag indicating, if we handled the event
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl><a NAME="HgUserConfigDialog.on_editorButton_clicked" ID="HgUserConfigDialog.on_editorButton_clicked"></a>
+<h4>HgUserConfigDialog.on_editorButton_clicked</h4>
+<b>on_editorButton_clicked</b>(<i></i>)
+<p>
+        Private slot to open the user configuration file in a text editor.
+</p><a NAME="HgUserConfigDialog.on_fingerprintsList_currentItemChanged" ID="HgUserConfigDialog.on_fingerprintsList_currentItemChanged"></a>
+<h4>HgUserConfigDialog.on_fingerprintsList_currentItemChanged</h4>
+<b>on_fingerprintsList_currentItemChanged</b>(<i>current, previous</i>)
+<p>
+        Private slot handling a change of the current fingerprints item.
+</p><dl>
+<dt><i>current</i> (QTreeWidgetItem)</dt>
+<dd>
+reference to the current item
+</dd><dt><i>previous</i> (QTreeWidgetItem)</dt>
+<dd>
+reference to the previous current item
 </dd>
-</dl>
+</dl><a NAME="HgUserConfigDialog.on_fpAddButton_clicked" ID="HgUserConfigDialog.on_fpAddButton_clicked"></a>
+<h4>HgUserConfigDialog.on_fpAddButton_clicked</h4>
+<b>on_fpAddButton_clicked</b>(<i></i>)
+<p>
+        Private slot to add a fingerprints entry.
+</p><a NAME="HgUserConfigDialog.on_fpDeleteButton_clicked" ID="HgUserConfigDialog.on_fpDeleteButton_clicked"></a>
+<h4>HgUserConfigDialog.on_fpDeleteButton_clicked</h4>
+<b>on_fpDeleteButton_clicked</b>(<i></i>)
+<p>
+        Private slot to delete the current fingerprints item.
+</p><a NAME="HgUserConfigDialog.on_fpEditButton_clicked" ID="HgUserConfigDialog.on_fpEditButton_clicked"></a>
+<h4>HgUserConfigDialog.on_fpEditButton_clicked</h4>
+<b>on_fpEditButton_clicked</b>(<i></i>)
+<p>
+        Private slot to edit the current fingerprints item.
+</p><a NAME="HgUserConfigDialog.readUserConfig" ID="HgUserConfigDialog.readUserConfig"></a>
+<h4>HgUserConfigDialog.readUserConfig</h4>
+<b>readUserConfig</b>(<i></i>)
+<p>
+        Public method to read the user configuration file.
+</p><a NAME="HgUserConfigDialog.writeUserConfig" ID="HgUserConfigDialog.writeUserConfig"></a>
+<h4>HgUserConfigDialog.writeUserConfig</h4>
+<b>writeUserConfig</b>(<i></i>)
+<p>
+        Public method to write the user configuration file.
+</p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file

eric ide

mercurial