Documentation/Source/eric5.E5Gui.E5ProgressDialog.html

<!DOCTYPE html>
<html><head>
<title>eric5.E5Gui.E5ProgressDialog</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>eric5.E5Gui.E5ProgressDialog</h1>
<p>
Module implementing a progress dialog allowing a customized progress bar label.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#E5ProgressDialog">E5ProgressDialog</a></td>
<td>Class implementing a progress dialog allowing a customized progress bar label.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="E5ProgressDialog" ID="E5ProgressDialog"></a>
<h2>E5ProgressDialog</h2>
<p>
    Class implementing a progress dialog allowing a customized progress bar
    label.
</p>
<h3>Derived from</h3>
QProgressDialog
<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="#E5ProgressDialog.__init__">E5ProgressDialog</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#E5ProgressDialog.format">format</a></td>
<td>Public method to get the progress bar format.</td>
</tr><tr>
<td><a href="#E5ProgressDialog.setFormat">setFormat</a></td>
<td>Public method to set the progress bar format.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="E5ProgressDialog.__init__" ID="E5ProgressDialog.__init__"></a>
<h4>E5ProgressDialog (Constructor)</h4>
<b>E5ProgressDialog</b>(<i>labelText, cancelButtonText, minimum, maximum, format=None, parent=None, flags=Qt.WindowFlags()</i>)
<p>
        Constructor
</p><dl>
<dt><i>labelText</i></dt>
<dd>
text of the dialog label (string)
</dd><dt><i>cancelButtonText</i></dt>
<dd>
text of the cancel button (string)
</dd><dt><i>minimum</i></dt>
<dd>
minimum value (integer)
</dd><dt><i>maximum</i></dt>
<dd>
maximum value (integer)
</dd><dt><i>format=</i></dt>
<dd>
label format of the progress bar (string)
</dd><dt><i>parent=</i></dt>
<dd>
reference to the parent widget (QWidget)
</dd><dt><i>flags=</i></dt>
<dd>
window flags of the dialog (Qt.WindowFlags)
</dd>
</dl><a NAME="E5ProgressDialog.format" ID="E5ProgressDialog.format"></a>
<h4>E5ProgressDialog.format</h4>
<b>format</b>(<i></i>)
<p>
        Public method to get the progress bar format.
</p><dl>
<dt>Returns:</dt>
<dd>
progress bar format (string)
</dd>
</dl><a NAME="E5ProgressDialog.setFormat" ID="E5ProgressDialog.setFormat"></a>
<h4>E5ProgressDialog.setFormat</h4>
<b>setFormat</b>(<i>format</i>)
<p>
        Public method to set the progress bar format.
</p><dl>
<dt><i>format</i></dt>
<dd>
progress bar format (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>