<?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>QStyleOptionToolBox 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 >QStyleOptionToolBox</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">QStyleOptionToolBox Class</h1> <!-- $$$QStyleOptionToolBox-brief --> <p>The <a href="qstyleoptiontoolbox.html">QStyleOptionToolBox</a> class is used to describe the parameters needed for drawing a tool box. <a href="#details">More...</a></p> <!-- @@@QStyleOptionToolBox --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QStyleOptionToolBox></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="qstyleoptiontoolbox-members.html">List of all members, including inherited members</a></li> <li><a href="qstyleoptiontoolbox-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="qstyleoptiontoolbox.html#SelectedPosition-enum">SelectedPosition</a></b> { NotAdjacent, NextIsSelected, PreviousIsSelected }</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbox.html#StyleOptionType-enum">StyleOptionType</a></b> { Type }</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbox.html#StyleOptionVersion-enum">StyleOptionVersion</a></b> { Version }</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbox.html#TabPosition-enum">TabPosition</a></b> { Beginning, Middle, End, OnlyOneTab }</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="qstyleoptiontoolbox.html#QStyleOptionToolBox">QStyleOptionToolBox</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbox.html#QStyleOptionToolBox-1">QStyleOptionToolBox</a></b>(const QStyleOptionToolBox &<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"> QIcon </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbox.html#icon-var">icon</a></b></td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QStyleOptionToolBox::TabPosition </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbox.html#position-var">position</a></b></td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QStyleOptionToolBox::SelectedPosition </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbox.html#selectedPosition-var">selectedPosition</a></b></td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbox.html#text-var">text</a></b></td></tr> </table></div> <a name="details"></a> <!-- $$$QStyleOptionToolBox-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qstyleoptiontoolbox.html">QStyleOptionToolBox</a> class is used to describe the parameters needed for drawing a tool box.</p> <p><a href="qstyleoptiontoolbox.html">QStyleOptionToolBox</a> contains all the information that <a href="qstyle.html">QStyle</a> functions need to draw <a href="qtoolbox.html">QToolBox</a>.</p> <p>For performance reasons, the access to the member variables is direct (i.e., using the <code>.</code> or <code>-></code> operator). This low-level feel makes the structures straightforward to use and emphasizes that these are simply parameters used by the style functions.</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> and <a href="qtoolbox.html">QToolBox</a>.</p> <!-- @@@QStyleOptionToolBox --> <div class="types"> <h2>Member Type Documentation</h2> <!-- $$$SelectedPosition$$$NotAdjacent$$$NextIsSelected$$$PreviousIsSelected --> <h3 class="fn" id="SelectedPosition-enum"><a name="SelectedPosition-enum"></a>enum QStyleOptionToolBox::<span class="name">SelectedPosition</span></h3> <p>This enum describes the position of the selected tab. Some styles need to draw a tab differently depending on whether or not it is adjacent to the selected tab.</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>QStyleOptionToolBox::NotAdjacent</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The tab is not adjacent to a selected tab (or is the selected tab).</td></tr> <tr><td class="topAlign"><code>QStyleOptionToolBox::NextIsSelected</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The next tab (typically the tab on the right) is selected.</td></tr> <tr><td class="topAlign"><code>QStyleOptionToolBox::PreviousIsSelected</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">The previous tab (typically the tab on the left) is selected.</td></tr> </table></div> <p><b>See also </b><a href="qstyleoptiontoolbox.html#selectedPosition-var">selectedPosition</a>.</p> <!-- @@@SelectedPosition --> <!-- $$$StyleOptionType$$$Type --> <h3 class="fn" id="StyleOptionType-enum"><a name="StyleOptionType-enum"></a>enum QStyleOptionToolBox::<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>QStyleOptionToolBox::Type</code></td><td class="topAlign tblval"><code>SO_ToolBox</code></td><td class="topAlign">The type of style option provided (<a href="qstyleoption.html#OptionType-enum">SO_ToolBox</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="qstyleoptiontoolbox.html#StyleOptionVersion-enum">StyleOptionVersion</a>.</p> <!-- @@@StyleOptionType --> <!-- $$$StyleOptionVersion$$$Version --> <h3 class="fn" id="StyleOptionVersion-enum"><a name="StyleOptionVersion-enum"></a>enum QStyleOptionToolBox::<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>QStyleOptionToolBox::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="qstyleoptiontoolbox.html#StyleOptionType-enum">StyleOptionType</a>.</p> <!-- @@@StyleOptionVersion --> <!-- $$$TabPosition$$$Beginning$$$Middle$$$End$$$OnlyOneTab --> <h3 class="fn" id="TabPosition-enum"><a name="TabPosition-enum"></a>enum QStyleOptionToolBox::<span class="name">TabPosition</span></h3> <p>This enum describes tab positions relative to other tabs.</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>QStyleOptionToolBox::Beginning</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The tab is the first (i.e., top-most) tab in the toolbox.</td></tr> <tr><td class="topAlign"><code>QStyleOptionToolBox::Middle</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The tab is placed in the middle of the toolbox.</td></tr> <tr><td class="topAlign"><code>QStyleOptionToolBox::End</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">The tab is placed at the bottom of the toolbox.</td></tr> <tr><td class="topAlign"><code>QStyleOptionToolBox::OnlyOneTab</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">There is only one tab in the toolbox.</td></tr> </table></div> <!-- @@@TabPosition --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QStyleOptionToolBox[overload1]$$$QStyleOptionToolBox --> <h3 class="fn" id="QStyleOptionToolBox"><a name="QStyleOptionToolBox"></a>QStyleOptionToolBox::<span class="name">QStyleOptionToolBox</span>()</h3> <p>Creates a <a href="qstyleoptiontoolbox.html">QStyleOptionToolBox</a>, initializing the members variables to their default values.</p> <!-- @@@QStyleOptionToolBox --> <!-- $$$QStyleOptionToolBox$$$QStyleOptionToolBoxconstQStyleOptionToolBox& --> <h3 class="fn" id="QStyleOptionToolBox-1"><a name="QStyleOptionToolBox-1"></a>QStyleOptionToolBox::<span class="name">QStyleOptionToolBox</span>(const <span class="type"><a href="qstyleoptiontoolbox.html#QStyleOptionToolBox">QStyleOptionToolBox</a></span> &<i>other</i>)</h3> <p>Constructs a copy of the <i>other</i> style option.</p> <!-- @@@QStyleOptionToolBox --> </div> <div class="vars"> <h2>Member Variable Documentation</h2> <!-- $$$icon --> <h3 class="fn" id="icon-var"><a name="icon-var"></a><span class="type"><a href="../qtgui/qicon.html">QIcon</a></span> QStyleOptionToolBox::<span class="name">icon</span></h3> <p>This variable holds the icon for the tool box tab</p> <p>The default value is an empty icon, i.e. an icon with neither a pixmap nor a filename.</p> <!-- @@@icon --> <!-- $$$selectedPosition --> <h3 class="fn" id="selectedPosition-var"><a name="selectedPosition-var"></a><span class="type"><a href="qstyleoptiontoolbox.html#SelectedPosition-enum">QStyleOptionToolBox::SelectedPosition</a></span> QStyleOptionToolBox::<span class="name">selectedPosition</span></h3> <p>This variable holds the position of the selected tab in relation to this tab</p> <p>The default value is <a href="qstyleoptiontoolbox.html#SelectedPosition-enum">NotAdjacent</a>, i.e. the tab is not adjacent to a selected tab nor is it the selected tab.</p> <!-- @@@selectedPosition --> <!-- $$$text --> <h3 class="fn" id="text-var"><a name="text-var"></a><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QStyleOptionToolBox::<span class="name">text</span></h3> <p>This variable holds the text for the tool box tab</p> <p>The default value is an empty string.</p> <!-- @@@text --> </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>