--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnChangeListsDialog.html Sun Jun 03 12:51:15 2012 +0200 @@ -0,0 +1,216 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>eric5.Plugins.VcsPlugins.vcsSubversion.SvnChangeListsDialog</title> +<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>eric5.Plugins.VcsPlugins.vcsSubversion.SvnChangeListsDialog</h1> +<p> +Module implementing a dialog to browse the change lists. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#SvnChangeListsDialog">SvnChangeListsDialog</a></td> +<td>Class implementing a dialog to browse the change lists.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="SvnChangeListsDialog" ID="SvnChangeListsDialog"></a> +<h2>SvnChangeListsDialog</h2> +<p> + Class implementing a dialog to browse the change lists. +</p> +<h3>Derived from</h3> +QDialog, Ui_SvnChangeListsDialog +<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="#SvnChangeListsDialog.__init__">SvnChangeListsDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#SvnChangeListsDialog.__finish">__finish</a></td> +<td>Private slot called when the process finished or the user pressed the button.</td> +</tr><tr> +<td><a href="#SvnChangeListsDialog.__procFinished">__procFinished</a></td> +<td>Private slot connected to the finished signal.</td> +</tr><tr> +<td><a href="#SvnChangeListsDialog.__readStderr">__readStderr</a></td> +<td>Private slot to handle the readyReadStandardError signal.</td> +</tr><tr> +<td><a href="#SvnChangeListsDialog.__readStdout">__readStdout</a></td> +<td>Private slot to handle the readyReadStandardOutput signal.</td> +</tr><tr> +<td><a href="#SvnChangeListsDialog.keyPressEvent">keyPressEvent</a></td> +<td>Protected slot to handle a key press event.</td> +</tr><tr> +<td><a href="#SvnChangeListsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot called by a button of the button box clicked.</td> +</tr><tr> +<td><a href="#SvnChangeListsDialog.on_changeLists_currentItemChanged">on_changeLists_currentItemChanged</a></td> +<td>Private slot to handle the selection of a new item.</td> +</tr><tr> +<td><a href="#SvnChangeListsDialog.on_input_returnPressed">on_input_returnPressed</a></td> +<td>Private slot to handle the press of the return key in the input field.</td> +</tr><tr> +<td><a href="#SvnChangeListsDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> +<td>Private slot to handle the password checkbox toggled.</td> +</tr><tr> +<td><a href="#SvnChangeListsDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> +<td>Private slot to send the input to the subversion process.</td> +</tr><tr> +<td><a href="#SvnChangeListsDialog.start">start</a></td> +<td>Public slot to populate the data.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="SvnChangeListsDialog.__init__" ID="SvnChangeListsDialog.__init__"></a> +<h4>SvnChangeListsDialog (Constructor)</h4> +<b>SvnChangeListsDialog</b>(<i>vcs, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>vcs</i></dt> +<dd> +reference to the vcs object +</dd><dt><i>parent</i></dt> +<dd> +parent widget (QWidget) +</dd> +</dl><a NAME="SvnChangeListsDialog.__finish" ID="SvnChangeListsDialog.__finish"></a> +<h4>SvnChangeListsDialog.__finish</h4> +<b>__finish</b>(<i></i>) +<p> + Private slot called when the process finished or the user pressed + the button. +</p><a NAME="SvnChangeListsDialog.__procFinished" ID="SvnChangeListsDialog.__procFinished"></a> +<h4>SvnChangeListsDialog.__procFinished</h4> +<b>__procFinished</b>(<i>exitCode, exitStatus</i>) +<p> + Private slot connected to the finished signal. +</p><dl> +<dt><i>exitCode</i></dt> +<dd> +exit code of the process (integer) +</dd><dt><i>exitStatus</i></dt> +<dd> +exit status of the process (QProcess.ExitStatus) +</dd> +</dl><a NAME="SvnChangeListsDialog.__readStderr" ID="SvnChangeListsDialog.__readStderr"></a> +<h4>SvnChangeListsDialog.__readStderr</h4> +<b>__readStderr</b>(<i></i>) +<p> + Private slot to handle the readyReadStandardError signal. +</p><p> + It reads the error output of the process and inserts it into the + error pane. +</p><a NAME="SvnChangeListsDialog.__readStdout" ID="SvnChangeListsDialog.__readStdout"></a> +<h4>SvnChangeListsDialog.__readStdout</h4> +<b>__readStdout</b>(<i></i>) +<p> + Private slot to handle the readyReadStandardOutput signal. +</p><p> + It reads the output of the process, formats it and inserts it into + the contents pane. +</p><a NAME="SvnChangeListsDialog.keyPressEvent" ID="SvnChangeListsDialog.keyPressEvent"></a> +<h4>SvnChangeListsDialog.keyPressEvent</h4> +<b>keyPressEvent</b>(<i>evt</i>) +<p> + Protected slot to handle a key press event. +</p><dl> +<dt><i>evt</i></dt> +<dd> +the key press event (QKeyEvent) +</dd> +</dl><a NAME="SvnChangeListsDialog.on_buttonBox_clicked" ID="SvnChangeListsDialog.on_buttonBox_clicked"></a> +<h4>SvnChangeListsDialog.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> +<dt><i>button</i></dt> +<dd> +button that was clicked (QAbstractButton) +</dd> +</dl><a NAME="SvnChangeListsDialog.on_changeLists_currentItemChanged" ID="SvnChangeListsDialog.on_changeLists_currentItemChanged"></a> +<h4>SvnChangeListsDialog.on_changeLists_currentItemChanged</h4> +<b>on_changeLists_currentItemChanged</b>(<i>current, previous</i>) +<p> + Private slot to handle the selection of a new item. +</p><dl> +<dt><i>current</i></dt> +<dd> +current item (QListWidgetItem) +</dd><dt><i>previous</i></dt> +<dd> +previous current item (QListWidgetItem) +</dd> +</dl><a NAME="SvnChangeListsDialog.on_input_returnPressed" ID="SvnChangeListsDialog.on_input_returnPressed"></a> +<h4>SvnChangeListsDialog.on_input_returnPressed</h4> +<b>on_input_returnPressed</b>(<i></i>) +<p> + Private slot to handle the press of the return key in the input field. +</p><a NAME="SvnChangeListsDialog.on_passwordCheckBox_toggled" ID="SvnChangeListsDialog.on_passwordCheckBox_toggled"></a> +<h4>SvnChangeListsDialog.on_passwordCheckBox_toggled</h4> +<b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) +<p> + Private slot to handle the password checkbox toggled. +</p><dl> +<dt><i>isOn</i></dt> +<dd> +flag indicating the status of the check box (boolean) +</dd> +</dl><a NAME="SvnChangeListsDialog.on_sendButton_clicked" ID="SvnChangeListsDialog.on_sendButton_clicked"></a> +<h4>SvnChangeListsDialog.on_sendButton_clicked</h4> +<b>on_sendButton_clicked</b>(<i></i>) +<p> + Private slot to send the input to the subversion process. +</p><a NAME="SvnChangeListsDialog.start" ID="SvnChangeListsDialog.start"></a> +<h4>SvnChangeListsDialog.start</h4> +<b>start</b>(<i>path</i>) +<p> + Public slot to populate the data. +</p><dl> +<dt><i>path</i></dt> +<dd> +directory name to show change lists for (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file