<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- /tmp/qt-4.2.1-harald-1161357942206/qt-x11-opensource-src-4.2.1/src/gui/styles/qstyleoption.cpp -->
<head>
<title>Qt 4.2: QStyleOptionProgressBar Class Reference</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://www.trolltech.com/products/qt"><img src="images/qt-logo.png" align="left" width="32" height="32" border="0" /></a></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="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"><a href="http://www.trolltech.com"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></a></td></tr></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>
<pre> #include <QStyleOptionProgressBar></pre><p>Inherits <a href="qstyleoption.html">QStyleOption</a>.</p>
<p>Inherited by <a href="qstyleoptionprogressbarv2.html">QStyleOptionProgressBarV2</a>.</p>
<ul>
<li><a href="qstyleoptionprogressbar-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h3>Public 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>
<a name="public-functions"></a>
<h3>Public Functions</h3>
<ul>
<li><div class="fn"/><b><a href="qstyleoptionprogressbar.html#QStyleOptionProgressBar">QStyleOptionProgressBar</a></b> ()</li>
<li><div class="fn"/><b><a href="qstyleoptionprogressbar.html#QStyleOptionProgressBar-2">QStyleOptionProgressBar</a></b> ( const QStyleOptionProgressBar & <i>other</i> )</li>
</ul>
<ul>
<li><div class="fn"/>2 public functions inherited from <a href="qstyleoption.html#public-functions">QStyleOption</a></li>
</ul>
<a name="public-variables"></a>
<h3>Public Variables</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>
<ul>
<li><div class="fn"/>7 public variables inherited from <a href="qstyleoption.html#public-variables">QStyleOption</a></li>
</ul>
<a name="details"></a>
<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 don't 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>
<p>See also <a href="qstyleoptionprogressbarv2.html">QStyleOptionProgressBarV2</a> and <a href="qstyleoption.html">QStyleOption</a>.</p>
<hr />
<h2>Member Type Documentation</h2>
<h3 class="fn"><a name="StyleOptionType-enum"></a>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>
<p><table border="1" cellpadding="2" cellspacing="1" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QStyleOptionProgressBar::Type</tt></td><td align="center" valign="top"><tt>SO_ProgressBar</tt></td><td valign="top">The type of style option provided (<a href="qstyleoption.html#OptionType-enum">SO_ProgressBar</a> for this class).</td></tr>
</table></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.</p>
<p>See also <a href="qstyleoptionprogressbar.html#StyleOptionVersion-enum">StyleOptionVersion</a>.</p>
<h3 class="fn"><a name="StyleOptionVersion-enum"></a>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>
<p><table border="1" cellpadding="2" cellspacing="1" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QStyleOptionProgressBar::Version</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">1</td></tr>
</table></p>
<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 don't need to check it.</p>
<p>See also <a href="qstyleoptionprogressbar.html#StyleOptionType-enum">StyleOptionType</a>.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QStyleOptionProgressBar"></a>QStyleOptionProgressBar::QStyleOptionProgressBar ()</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"></a>QStyleOptionProgressBar::QStyleOptionProgressBar ( const QStyleOptionProgressBar & <i>other</i> )</h3>
<p>Constructs a copy of the <i>other</i> style option.</p>
<hr />
<h2>Member Variable Documentation</h2>
<h3 class="fn"><a name="maximum-var"></a>int QStyleOptionProgressBar::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>See also <a href="qprogressbar.html#maximum-prop">QProgressBar::maximum</a>.</p>
<h3 class="fn"><a name="minimum-var"></a>int QStyleOptionProgressBar::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>See also <a href="qprogressbar.html#minimum-prop">QProgressBar::minimum</a>.</p>
<h3 class="fn"><a name="progress-var"></a>int QStyleOptionProgressBar::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>See also <a href="qprogressbar.html#value-prop">QProgressBar::value</a>.</p>
<h3 class="fn"><a name="text-var"></a><a href="qstring.html">QString</a> QStyleOptionProgressBar::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>See also <a href="qprogressbar.html#text-prop">QProgressBar::text</a>.</p>
<h3 class="fn"><a name="textAlignment-var"></a><a href="qt.html#AlignmentFlag-enum">Qt::Alignment</a> QStyleOptionProgressBar::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 progressbar. The default value is <a href="qt.html#AlignmentFlag-enum">Qt::AlignLeft</a>.</p>
<h3 class="fn"><a name="textVisible-var"></a>bool QStyleOptionProgressBar::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>See also <a href="qprogressbar.html#textVisible-prop">QProgressBar::textVisible</a>.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%">Copyright © 2006 <a href="trolltech.html">Trolltech</a></td>
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt 4.2.1</div></td>
</tr></table></div></address></body>
</html>
