<?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd"> <html><head><title>QStyleOptionProgressBar Class Reference</title><style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm } a:link { color: #004faf; text-decoration: none } a:visited { color: #672967; text-decoration: none } td.postheader { font-family: sans-serif } tr.address { font-family: sans-serif } body { background: #ffffff; color: black; } </style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr /><td align="left" valign="top" width="32"><img align="left" border="0" height="32" src="images/rb-logo.png" width="32" /></td><td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a></td></table><h1 align="center">QStyleOptionProgressBar Class Reference<br /><sup><sup>[<a href="qtgui.html">QtGui</a> module]</sup></sup></h1><p>The QStyleOptionProgressBar class is used to describe the parameters necessary for drawing a progress bar. <a href="#details">More...</a></p> <p>Inherits <a href="qstyleoption.html">QStyleOption</a>.</p><p>Inherited by <a href="qstyleoptionprogressbarv2.html">QStyleOptionProgressBarV2</a>.</p><h3>Types</h3><ul><li><div class="fn" />enum <b><a href="qstyleoptionprogressbar.html#StyleOptionType-enum">StyleOptionType</a></b> { Type }</li><li><div class="fn" />enum <b><a href="qstyleoptionprogressbar.html#StyleOptionVersion-enum">StyleOptionVersion</a></b> { Version }</li></ul><h3>Methods</h3><ul><li><div class="fn" /><b><a href="qstyleoptionprogressbar.html#QStyleOptionProgressBar">__init__</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qstyleoptionprogressbar.html#QStyleOptionProgressBar-2">__init__</a></b> (<i>self</i>, QStyleOptionProgressBar <i>other</i>)</li></ul><h3>Members</h3><ul><li><div class="fn" />int <b><a href="qstyleoptionprogressbar.html#maximum-var">maximum</a></b></li><li><div class="fn" />int <b><a href="qstyleoptionprogressbar.html#minimum-var">minimum</a></b></li><li><div class="fn" />int <b><a href="qstyleoptionprogressbar.html#progress-var">progress</a></b></li><li><div class="fn" />QString <b><a href="qstyleoptionprogressbar.html#text-var">text</a></b></li><li><div class="fn" />Qt.Alignment <b><a href="qstyleoptionprogressbar.html#textAlignment-var">textAlignment</a></b></li><li><div class="fn" />bool <b><a href="qstyleoptionprogressbar.html#textVisible-var">textVisible</a></b></li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QStyleOptionProgressBar class is used to describe the parameters necessary for drawing a progress bar.</p> <p>Since Qt 4.1, Qt uses the <a href="qstyleoptionprogressbarv2.html">QStyleOptionProgressBarV2</a> subclass for drawing <a href="qprogressbar.html">QProgressBar</a>.</p> <p>An instance of the QStyleOptionProgressBar class has type <a href="qstyleoption.html#OptionType-enum">SO_ProgressBar</a> and version 1.</p> <p>The type is used internally by <a href="qstyleoption.html">QStyleOption</a>, its subclasses, and <a href="qstyleoption.html#qstyleoption_cast">qstyleoption_cast</a>() to determine the type of style option. In general you do not need to worry about this unless you want to create your own <a href="qstyleoption.html">QStyleOption</a> subclass and your own styles. The version is used by <a href="qstyleoption.html">QStyleOption</a> subclasses to implement extensions without breaking compatibility. If you use <a href="qstyleoption.html#qstyleoption_cast">qstyleoption_cast</a>(), you normally do not need to check it.</p> <p>If you create your own <a href="qstyle.html">QStyle</a> subclass, you should handle both QStyleOptionProgressBar and <a href="qstyleoptionprogressbarv2.html">QStyleOptionProgressBarV2</a>.</p> <p>For an example demonstrating how style options can be used, see the <a href="widgets-styles.html">Styles</a> example.</p> <hr /><h2>Type Documentation</h2><h3 class="fn"><a name="StyleOptionType-enum" />QStyleOptionProgressBar.StyleOptionType</h3><p>This enum is used to hold information about the type of the style option, and is defined for each <a href="qstyleoption.html">QStyleOption</a> subclass.</p> <table class="valuelist"> <tr class="odd" valign="top"> <th class="tblConst">Constant</th> <th class="tblval">Value</th> <th class="tbldscr">Description</th> </tr> <tr> <td class="topAlign"><tt>QStyleOptionProgressBar.Type</tt></td> <td class="topAlign"><tt>SO_ProgressBar</tt></td> <td class="topAlign">The type of style option provided (<a href="qstyleoption.html#OptionType-enum">SO_ProgressBar</a> for this class).</td> </tr> </table> <p>The type is used internally by <a href="qstyleoption.html">QStyleOption</a>, its subclasses, and <a href="qstyleoption.html#qstyleoption_cast">qstyleoption_cast</a>() to determine the type of style option. In general you do not need to worry about this unless you want to create your own <a href="qstyleoption.html">QStyleOption</a> subclass and your own styles.</p> <p><b>See also</b> <a href="qstyleoptionprogressbar.html#StyleOptionVersion-enum">StyleOptionVersion</a>.</p> <h3 class="fn"><a name="StyleOptionVersion-enum" />QStyleOptionProgressBar.StyleOptionVersion</h3><p>This enum is used to hold information about the version of the style option, and is defined for each <a href="qstyleoption.html">QStyleOption</a> subclass.</p> <table class="valuelist"> <tr class="odd" valign="top"> <th class="tblConst">Constant</th> <th class="tblval">Value</th> <th class="tbldscr">Description</th> </tr> <tr> <td class="topAlign"><tt>QStyleOptionProgressBar.Version</tt></td> <td class="topAlign"><tt>1</tt></td> <td class="topAlign">1</td> </tr> </table> <p>The version is used by <a href="qstyleoption.html">QStyleOption</a> subclasses to implement extensions without breaking compatibility. If you use <a href="qstyleoption.html#qstyleoption_cast">qstyleoption_cast</a>(), you normally do not need to check it.</p> <p><b>See also</b> <a href="qstyleoptionprogressbar.html#StyleOptionType-enum">StyleOptionType</a>.</p> <hr /><h2>Method Documentation</h2><h3 class="fn"><a name="QStyleOptionProgressBar" />QStyleOptionProgressBar.__init__ (<i>self</i>)</h3><p>Constructs a <a href="qstyleoptionprogressbar.html">QStyleOptionProgressBar</a>, initializing the members variables to their default values.</p> <h3 class="fn"><a name="QStyleOptionProgressBar-2" />QStyleOptionProgressBar.__init__ (<i>self</i>, <a href="qstyleoptionprogressbar.html">QStyleOptionProgressBar</a> <i>other</i>)</h3><p>Constructs a copy of the <i>other</i> style option.</p> <hr /><h2>Member Documentation</h2><h3 class="fn"><a name="maximum-var" />int maximum</h3><p>This variable holds the maximum value for the progress bar.</p> <p>This is the maximum value in the progress bar. The default value is 0.</p> <p><b>See also</b> <a href="qprogressbar.html#maximum-prop">QProgressBar.maximum</a>.</p> <h3 class="fn"><a name="minimum-var" />int minimum</h3><p>This variable holds the minimum value for the progress bar.</p> <p>This is the minimum value in the progress bar. The default value is 0.</p> <p><b>See also</b> <a href="qprogressbar.html#minimum-prop">QProgressBar.minimum</a>.</p> <h3 class="fn"><a name="progress-var" />int progress</h3><p>This variable holds the current progress for the progress bar.</p> <p>The current progress. A value of <a href="qstyleoptionprogressbar.html#minimum-var">QStyleOptionProgressBar.minimum</a> - 1 indicates that the progress hasn't started yet. The default value is 0.</p> <p><b>See also</b> <a href="qprogressbar.html#value-prop">QProgressBar.value</a>.</p> <h3 class="fn"><a name="text-var" />QString text</h3><p>This variable holds the text for the progress bar.</p> <p>The progress bar text is usually just the progress expressed as a string. An empty string indicates that the progress bar has not started yet. The default value is an empty string.</p> <p><b>See also</b> <a href="qprogressbar.html#text-prop">QProgressBar.text</a>.</p> <h3 class="fn"><a name="textAlignment-var" /><a href="qt-alignment.html">Qt.Alignment</a> textAlignment</h3><p>This variable holds the text alignment for the text in the QProgressBar.</p> <p>This can be used as a guide on where the text should be in the progress bar. The default value is <a href="qt.html#AlignmentFlag-enum">Qt.AlignLeft</a>.</p> <h3 class="fn"><a name="textVisible-var" />bool textVisible</h3><p>This variable holds a flag indicating whether or not text is visible.</p> <p>If this flag is true then the text is visible. Otherwise, the text is not visible. The default value is false.</p> <p><b>See also</b> <a href="qprogressbar.html#textVisible-prop">QProgressBar.textVisible</a>.</p> <address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td align="left" width="25%">PyQt 4.10.3 for X11</td><td align="center" width="50%">Copyright © <a href="http://www.riverbankcomputing.com">Riverbank Computing Ltd</a> and <a href="http://www.qtsoftware.com">Nokia</a> 2012</td><td align="right" width="25%">Qt 4.8.5</td></tr></table></div></address></body></html>