<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qstyleoption.cpp --> <title>QStyleOptionProgressBar Class | Qt Widgets 5.12.6</title> <link rel="stylesheet" type="text/css" href="style/offline-simple.css" /> <script type="text/javascript"> document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css"); // loading style sheet breaks anchors that were jumped to before // so force jumping to anchor again setTimeout(function() { var anchor = location.hash; // need to jump to different anchor first (e.g. none) location.hash = "#"; setTimeout(function() { location.hash = anchor; }, 0); }, 0); </script> </head> <body> <div class="header" id="qtdocheader"> <div class="main"> <div class="main-rounded"> <div class="navigationbar"> <table><tr> <td >Qt 5.12</td><td ><a href="qtwidgets-index.html">Qt Widgets</a></td><td ><a href="qtwidgets-module.html">C++ Classes</a></td><td >QStyleOptionProgressBar</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right"><a href="qtwidgets-index.html">Qt 5.12.6 Reference Documentation</a></td> </tr></table> </div> </div> <div class="content"> <div class="line"> <div class="content mainContent"> <div class="sidebar"> <div class="toc"> <h3><a name="toc">Contents</a></h3> <ul> <li class="level1"><a href="#public-types">Public Types</a></li> <li class="level1"><a href="#public-functions">Public Functions</a></li> <li class="level1"><a href="#public-variables">Public Variables</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">QStyleOptionProgressBar Class</h1> <!-- $$$QStyleOptionProgressBar-brief --> <p>The <a href="qstyleoptionprogressbar.html">QStyleOptionProgressBar</a> class is used to describe the parameters necessary for drawing a progress bar. <a href="#details">More...</a></p> <!-- @@@QStyleOptionProgressBar --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QStyleOptionProgressBar></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += widgets</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qstyleoption.html">QStyleOption</a></td></tr></table></div><ul> <li><a href="qstyleoptionprogressbar-members.html">List of all members, including inherited members</a></li> <li><a href="qstyleoptionprogressbar-obsolete.html">Obsolete members</a></li> </ul> <a name="public-types"></a> <h2 id="public-types">Public Types</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionprogressbar.html#StyleOptionType-enum">StyleOptionType</a></b> { Type }</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionprogressbar.html#StyleOptionVersion-enum">StyleOptionVersion</a></b> { Version }</td></tr> </table></div> <a name="public-functions"></a> <h2 id="public-functions">Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionprogressbar.html#QStyleOptionProgressBar">QStyleOptionProgressBar</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionprogressbar.html#QStyleOptionProgressBar-1">QStyleOptionProgressBar</a></b>(const QStyleOptionProgressBar &<i>other</i>)</td></tr> </table></div> <ul> <li class="fn">2 public functions inherited from <a href="qstyleoption.html#public-functions">QStyleOption</a></li> </ul> <a name="public-variables"></a> <h2 id="public-variables">Public Variables</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionprogressbar.html#bottomToTop-var">bottomToTop</a></b></td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionprogressbar.html#invertedAppearance-var">invertedAppearance</a></b></td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionprogressbar.html#maximum-var">maximum</a></b></td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionprogressbar.html#minimum-var">minimum</a></b></td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionprogressbar.html#progress-var">progress</a></b></td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionprogressbar.html#text-var">text</a></b></td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Qt::Alignment </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionprogressbar.html#textAlignment-var">textAlignment</a></b></td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptionprogressbar.html#textVisible-var">textVisible</a></b></td></tr> </table></div> <a name="details"></a> <!-- $$$QStyleOptionProgressBar-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qstyleoptionprogressbar.html">QStyleOptionProgressBar</a> class is used to describe the parameters necessary for drawing a progress bar.</p> <p>An instance of the <a href="qstyleoptionprogressbar.html">QStyleOptionProgressBar</a> class has type <a href="qstyleoption.html#OptionType-enum">SO_ProgressBar</a> and version 2.</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>For an example demonstrating how style options can be used, see the <a href="qtwidgets-widgets-styles-example.html">Styles</a> example.</p> </div> <p><b>See also </b><a href="qstyleoption.html">QStyleOption</a>.</p> <!-- @@@QStyleOptionProgressBar --> <div class="types"> <h2>Member Type Documentation</h2> <!-- $$$StyleOptionType$$$Type --> <h3 class="fn" id="StyleOptionType-enum"><a name="StyleOptionType-enum"></a>enum QStyleOptionProgressBar::<span class="name">StyleOptionType</span></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> <div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>QStyleOptionProgressBar::Type</code></td><td class="topAlign tblval"><code>SO_ProgressBar</code></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></div> <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> <!-- @@@StyleOptionType --> <!-- $$$StyleOptionVersion$$$Version --> <h3 class="fn" id="StyleOptionVersion-enum"><a name="StyleOptionVersion-enum"></a>enum QStyleOptionProgressBar::<span class="name">StyleOptionVersion</span></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> <div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>QStyleOptionProgressBar::Version</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">2</td></tr> </table></div> <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> <!-- @@@StyleOptionVersion --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QStyleOptionProgressBar[overload1]$$$QStyleOptionProgressBar --> <h3 class="fn" id="QStyleOptionProgressBar"><a name="QStyleOptionProgressBar"></a>QStyleOptionProgressBar::<span class="name">QStyleOptionProgressBar</span>()</h3> <p>Constructs a <a href="qstyleoptionprogressbar.html">QStyleOptionProgressBar</a>, initializing the members variables to their default values.</p> <!-- @@@QStyleOptionProgressBar --> <!-- $$$QStyleOptionProgressBar$$$QStyleOptionProgressBarconstQStyleOptionProgressBar& --> <h3 class="fn" id="QStyleOptionProgressBar-1"><a name="QStyleOptionProgressBar-1"></a>QStyleOptionProgressBar::<span class="name">QStyleOptionProgressBar</span>(const <span class="type"><a href="qstyleoptionprogressbar.html#QStyleOptionProgressBar">QStyleOptionProgressBar</a></span> &<i>other</i>)</h3> <p>Constructs a copy of the <i>other</i> style option.</p> <!-- @@@QStyleOptionProgressBar --> </div> <div class="vars"> <h2>Member Variable Documentation</h2> <!-- $$$bottomToTop --> <h3 class="fn" id="bottomToTop-var"><a name="bottomToTop-var"></a><span class="type">bool</span> QStyleOptionProgressBar::<span class="name">bottomToTop</span></h3> <p>This variable holds whether the text reads from bottom to top when the progress bar is vertical</p> <p>The default value is false.</p> <p><b>See also </b><a href="qprogressbar.html#textDirection-prop">QProgressBar::textDirection</a>.</p> <!-- @@@bottomToTop --> <!-- $$$invertedAppearance --> <h3 class="fn" id="invertedAppearance-var"><a name="invertedAppearance-var"></a><span class="type">bool</span> QStyleOptionProgressBar::<span class="name">invertedAppearance</span></h3> <p>This variable holds whether the progress bar's appearance is inverted</p> <p>The default value is false.</p> <p><b>See also </b><a href="qprogressbar.html#invertedAppearance-prop">QProgressBar::invertedAppearance</a>.</p> <!-- @@@invertedAppearance --> <!-- $$$maximum --> <h3 class="fn" id="maximum-var"><a name="maximum-var"></a><span class="type">int</span> QStyleOptionProgressBar::<span class="name">maximum</span></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> <!-- @@@maximum --> <!-- $$$minimum --> <h3 class="fn" id="minimum-var"><a name="minimum-var"></a><span class="type">int</span> QStyleOptionProgressBar::<span class="name">minimum</span></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> <!-- @@@minimum --> <!-- $$$progress --> <h3 class="fn" id="progress-var"><a name="progress-var"></a><span class="type">int</span> QStyleOptionProgressBar::<span class="name">progress</span></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> <!-- @@@progress --> <!-- $$$text --> <h3 class="fn" id="text-var"><a name="text-var"></a><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QStyleOptionProgressBar::<span class="name">text</span></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> <!-- @@@text --> <!-- $$$textAlignment --> <h3 class="fn" id="textAlignment-var"><a name="textAlignment-var"></a><span class="type"><a href="../qtcore/qt.html#AlignmentFlag-enum">Qt::Alignment</a></span> QStyleOptionProgressBar::<span class="name">textAlignment</span></h3> <p>This variable holds the text alignment for the text in the <a href="qprogressbar.html">QProgressBar</a></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="../qtcore/qt.html#AlignmentFlag-enum">Qt::AlignLeft</a>.</p> <!-- @@@textAlignment --> <!-- $$$textVisible --> <h3 class="fn" id="textVisible-var"><a name="textVisible-var"></a><span class="type">bool</span> QStyleOptionProgressBar::<span class="name">textVisible</span></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> <!-- @@@textVisible --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners. </p> </div> </body> </html>