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

Sat, 22 Oct 2016 17:09:08 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 22 Oct 2016 17:09:08 +0200
changeset 5264
8bc23ecb4ea3
parent 5262
235d6a030128
child 5292
ac8b476ba122
permissions
-rw-r--r--

Finished the refactoring of the Mercurial user config management code.

<!DOCTYPE html>
<html><head>
<title>eric6.Plugins.VcsPlugins.vcsMercurial.HgUserConfigDialog</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgUserConfigDialog</h1>
<p>
Module implementing a dialog to enter some user data.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#HgUserConfigDialog">HgUserConfigDialog</a></td>
<td>Class implementing a dialog to enter some user data.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<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_HgUserConfigDialog
<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="#HgUserConfigDialog.__init__">HgUserConfigDialog</a></td>
<td>Constructor</td>
</tr><tr>
<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="HgUserConfigDialog.__init__" ID="HgUserConfigDialog.__init__"></a>
<h4>HgUserConfigDialog (Constructor)</h4>
<b>HgUserConfigDialog</b>(<i>version=(0, 0), parent=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>version</i></dt>
<dd>
Mercurial version info (tuple of two integers)
</dd><dt><i>parent</i></dt>
<dd>
reference to the parent widget (QWidget)
</dd>
</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>
        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>
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><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>

eric ide

mercurial