src/eric7/Documentation/Source/eric7.EricWidgets.EricProgressDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.EricWidgets.EricProgressDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricWidgets.EricProgressDialog</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="#EricProgressDialog">EricProgressDialog</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="EricProgressDialog" ID="EricProgressDialog"></a>
<h2>EricProgressDialog</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="#EricProgressDialog.__init__">EricProgressDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricProgressDialog.format">format</a></td>
<td>Public method to get the progress bar format.</td>
</tr>
<tr>
<td><a href="#EricProgressDialog.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="EricProgressDialog.__init__" ID="EricProgressDialog.__init__"></a>
<h4>EricProgressDialog (Constructor)</h4>
<b>EricProgressDialog</b>(<i>labelText, cancelButtonText, minimum, maximum, labelFormat=None, parent=None, flags=None, </i>)
<p>
        Constructor
</p>

<dl>

<dt><i>labelText</i> (str)</dt>
<dd>
text of the dialog label
</dd>
<dt><i>cancelButtonText</i> (str)</dt>
<dd>
text of the cancel button
</dd>
<dt><i>minimum</i> (int)</dt>
<dd>
minimum value
</dd>
<dt><i>maximum</i> (int)</dt>
<dd>
maximum value
</dd>
<dt><i>labelFormat</i> (str)</dt>
<dd>
label format of the progress bar
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
<dt><i>flags</i> (Qt.WindowFlags)</dt>
<dd>
window flags of the dialog
</dd>
</dl>
<a NAME="EricProgressDialog.format" ID="EricProgressDialog.format"></a>
<h4>EricProgressDialog.format</h4>
<b>format</b>(<i></i>)
<p>
        Public method to get the progress bar format.
</p>

<dl>
<dt>Return:</dt>
<dd>
progress bar format
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="EricProgressDialog.setFormat" ID="EricProgressDialog.setFormat"></a>
<h4>EricProgressDialog.setFormat</h4>
<b>setFormat</b>(<i>labelFormat</i>)
<p>
        Public method to set the progress bar format.
</p>

<dl>

<dt><i>labelFormat</i> (str)</dt>
<dd>
progress bar format
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>