src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnPropListDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsSubversion.SvnPropListDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsSubversion.SvnPropListDialog</h1>
<p>
Module implementing a dialog to show the output of the svn proplist command
process.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#SvnPropListDialog">SvnPropListDialog</a></td>
<td>Class implementing a dialog to show the output of the svn proplist command process.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="SvnPropListDialog" ID="SvnPropListDialog"></a>
<h2>SvnPropListDialog</h2>
<p>
    Class implementing a dialog to show the output of the svn proplist command
    process.
</p>

<h3>Derived from</h3>
QWidget, Ui_SvnPropListDialog
<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="#SvnPropListDialog.__init__">SvnPropListDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#SvnPropListDialog.__finish">__finish</a></td>
<td>Private slot called when the process finished or the user pressed the button.</td>
</tr>
<tr>
<td><a href="#SvnPropListDialog.__generateItem">__generateItem</a></td>
<td>Private method to generate a properties item in the properties list.</td>
</tr>
<tr>
<td><a href="#SvnPropListDialog.__procFinished">__procFinished</a></td>
<td>Private slot connected to the finished signal.</td>
</tr>
<tr>
<td><a href="#SvnPropListDialog.__readStderr">__readStderr</a></td>
<td>Private slot to handle the readyReadStandardError signal.</td>
</tr>
<tr>
<td><a href="#SvnPropListDialog.__readStdout">__readStdout</a></td>
<td>Private slot to handle the readyReadStandardOutput signal.</td>
</tr>
<tr>
<td><a href="#SvnPropListDialog.__resizeColumns">__resizeColumns</a></td>
<td>Private method to resize the list columns.</td>
</tr>
<tr>
<td><a href="#SvnPropListDialog.__resort">__resort</a></td>
<td>Private method to resort the tree.</td>
</tr>
<tr>
<td><a href="#SvnPropListDialog.closeEvent">closeEvent</a></td>
<td>Protected slot implementing a close event handler.</td>
</tr>
<tr>
<td><a href="#SvnPropListDialog.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="#SvnPropListDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
<td>Private slot to refresh the status display.</td>
</tr>
<tr>
<td><a href="#SvnPropListDialog.start">start</a></td>
<td>Public slot to start the svn status command.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="SvnPropListDialog.__init__" ID="SvnPropListDialog.__init__"></a>
<h4>SvnPropListDialog (Constructor)</h4>
<b>SvnPropListDialog</b>(<i>vcs, parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>vcs</i> (Subversion)</dt>
<dd>
reference to the vcs object
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
parent widget
</dd>
</dl>
<a NAME="SvnPropListDialog.__finish" ID="SvnPropListDialog.__finish"></a>
<h4>SvnPropListDialog.__finish</h4>
<b>__finish</b>(<i></i>)
<p>
        Private slot called when the process finished or the user pressed the
        button.
</p>

<a NAME="SvnPropListDialog.__generateItem" ID="SvnPropListDialog.__generateItem"></a>
<h4>SvnPropListDialog.__generateItem</h4>
<b>__generateItem</b>(<i>path, propName, propValue</i>)
<p>
        Private method to generate a properties item in the properties list.
</p>

<dl>

<dt><i>path</i> (str)</dt>
<dd>
file/directory name the property applies to
</dd>
<dt><i>propName</i> (str)</dt>
<dd>
name of the property
</dd>
<dt><i>propValue</i> (str)</dt>
<dd>
value of the property
</dd>
</dl>
<a NAME="SvnPropListDialog.__procFinished" ID="SvnPropListDialog.__procFinished"></a>
<h4>SvnPropListDialog.__procFinished</h4>
<b>__procFinished</b>(<i>exitCode, exitStatus</i>)
<p>
        Private slot connected to the finished signal.
</p>

<dl>

<dt><i>exitCode</i> (int)</dt>
<dd>
exit code of the process
</dd>
<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
<dd>
exit status of the process
</dd>
</dl>
<a NAME="SvnPropListDialog.__readStderr" ID="SvnPropListDialog.__readStderr"></a>
<h4>SvnPropListDialog.__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="SvnPropListDialog.__readStdout" ID="SvnPropListDialog.__readStdout"></a>
<h4>SvnPropListDialog.__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="SvnPropListDialog.__resizeColumns" ID="SvnPropListDialog.__resizeColumns"></a>
<h4>SvnPropListDialog.__resizeColumns</h4>
<b>__resizeColumns</b>(<i></i>)
<p>
        Private method to resize the list columns.
</p>

<a NAME="SvnPropListDialog.__resort" ID="SvnPropListDialog.__resort"></a>
<h4>SvnPropListDialog.__resort</h4>
<b>__resort</b>(<i></i>)
<p>
        Private method to resort the tree.
</p>

<a NAME="SvnPropListDialog.closeEvent" ID="SvnPropListDialog.closeEvent"></a>
<h4>SvnPropListDialog.closeEvent</h4>
<b>closeEvent</b>(<i>e</i>)
<p>
        Protected slot implementing a close event handler.
</p>

<dl>

<dt><i>e</i> (QCloseEvent)</dt>
<dd>
close event
</dd>
</dl>
<a NAME="SvnPropListDialog.on_buttonBox_clicked" ID="SvnPropListDialog.on_buttonBox_clicked"></a>
<h4>SvnPropListDialog.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> (QAbstractButton)</dt>
<dd>
button that was clicked
</dd>
</dl>
<a NAME="SvnPropListDialog.on_refreshButton_clicked" ID="SvnPropListDialog.on_refreshButton_clicked"></a>
<h4>SvnPropListDialog.on_refreshButton_clicked</h4>
<b>on_refreshButton_clicked</b>(<i></i>)
<p>
        Private slot to refresh the status display.
</p>

<a NAME="SvnPropListDialog.start" ID="SvnPropListDialog.start"></a>
<h4>SvnPropListDialog.start</h4>
<b>start</b>(<i>fn, recursive=False</i>)
<p>
        Public slot to start the svn status command.
</p>

<dl>

<dt><i>fn</i> (str or list of str)</dt>
<dd>
filename(s)
</dd>
<dt><i>recursive</i> (bool)</dt>
<dd>
flag indicating a recursive list is requested
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>