Sophie

Sophie

distrib > Mageia > 6 > armv5tl > media > core-updates > by-pkgid > 768f7d9f703884aa2562bf0a651086df > files > 3567

qtbase5-doc-5.9.4-1.1.mga6.noarch.rpm

<?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>QStyleOptionToolBar Class | Qt Widgets 5.9</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.9</td><td ><a href="qtwidgets-index.html">Qt Widgets</a></td><td ><a href="qtwidgets-module.html">C++ Classes</a></td><td >QStyleOptionToolBar</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</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">QStyleOptionToolBar Class</h1>
<!-- $$$QStyleOptionToolBar-brief -->
<p>The <a href="qstyleoptiontoolbar.html">QStyleOptionToolBar</a> class is used to describe the parameters for drawing a toolbar. <a href="#details">More...</a></p>
<!-- @@@QStyleOptionToolBar -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QStyleOptionToolBar&gt;</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"> Since:</td><td class="memItemRight bottomAlign">  Qt 4.1</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="qstyleoptiontoolbar-members.html">List of all members, including inherited 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="qstyleoptiontoolbar.html#StyleOptionType-enum">StyleOptionType</a></b> { Type }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#StyleOptionVersion-enum">StyleOptionVersion</a></b> { Version }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#ToolBarFeature-enum">ToolBarFeature</a></b> { None, Movable }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> flags </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#ToolBarFeature-enum">ToolBarFeatures</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#ToolBarPosition-enum">ToolBarPosition</a></b> { Beginning, Middle, End, OnlyOne }</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="qstyleoptiontoolbar.html#QStyleOptionToolBar">QStyleOptionToolBar</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#QStyleOptionToolBar-1">QStyleOptionToolBar</a></b>(const QStyleOptionToolBar &amp;<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"> ToolBarFeatures </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#features-var">features</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#lineWidth-var">lineWidth</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#midLineWidth-var">midLineWidth</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> ToolBarPosition </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#positionOfLine-var">positionOfLine</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> ToolBarPosition </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#positionWithinLine-var">positionWithinLine</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::ToolBarArea </td><td class="memItemRight bottomAlign"><b><a href="qstyleoptiontoolbar.html#toolBarArea-var">toolBarArea</a></b></td></tr>
</table></div>
<ul>
<li class="fn">8 public variables inherited from <a href="qstyleoption.html#public-variables">QStyleOption</a></li>
</ul>
<a name="details"></a>
<!-- $$$QStyleOptionToolBar-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qstyleoptiontoolbar.html">QStyleOptionToolBar</a> class is used to describe the parameters for drawing a toolbar.</p>
<p><a href="qstyleoptiontoolbar.html">QStyleOptionToolBar</a> contains all the information that <a href="qstyle.html">QStyle</a> functions need to draw <a href="qtoolbar.html">QToolBar</a>.</p>
<p>For performance reasons, the access to the member variables is direct (i.e&#x2e;, using the <code>.</code> or <code>-&gt;</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>The <a href="qstyleoptiontoolbar.html">QStyleOptionToolBar</a> class holds the <a href="qstyleoptiontoolbar.html#lineWidth-var">lineWidth</a> and the <a href="qstyleoptiontoolbar.html#midLineWidth-var">midLineWidth</a> for drawing the widget. It also stores information about which <a href="qstyleoptiontoolbar.html#toolBarArea-var">area</a> the toolbar should be located in, whether it is movable or not, which position the toolbar line should have (<a href="qstyleoptiontoolbar.html#positionOfLine-var">positionOfLine</a>), and the toolbar's position within the line (<a href="qstyleoptiontoolbar.html#positionWithinLine-var">positionWithinLine</a>).</p>
<p>In addition, the class provides a couple of enums: The <a href="qstyleoptiontoolbar.html#ToolBarFeature-enum">ToolBarFeature</a> enum is used to describe whether a toolbar is movable or not, and the <a href="qstyleoptiontoolbar.html#ToolBarPosition-enum">ToolBarPosition</a> enum is used to describe the position of a toolbar line, as well as the toolbar's position within the line.</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>
<!-- @@@QStyleOptionToolBar -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$StyleOptionType$$$Type -->
<h3 class="fn" id="StyleOptionType-enum"><a name="StyleOptionType-enum"></a>enum QStyleOptionToolBar::<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>QStyleOptionToolBar::Type</code></td><td class="topAlign tblval"><code>SO_ToolBar</code></td><td class="topAlign">The type of style option provided (<a href="qstyleoption.html#OptionType-enum">SO_ToolBar</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="qstyleoptiontoolbar.html#StyleOptionVersion-enum">StyleOptionVersion</a>.</p>
<!-- @@@StyleOptionType -->
<!-- $$$StyleOptionVersion$$$Version -->
<h3 class="fn" id="StyleOptionVersion-enum"><a name="StyleOptionVersion-enum"></a>enum QStyleOptionToolBar::<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>QStyleOptionToolBar::Version</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">1</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="qstyleoptiontoolbar.html#StyleOptionType-enum">StyleOptionType</a>.</p>
<!-- @@@StyleOptionVersion -->
<!-- $$$ToolBarFeature$$$None$$$Movable -->
<h3 class="flags" id="ToolBarFeature-enum"><a name="ToolBarFeature-enum"></a>enum QStyleOptionToolBar::<span class="name">ToolBarFeature</span><br/>flags QStyleOptionToolBar::<span class="name">ToolBarFeatures</span></h3>
<p>This enum is used to describe whether a toolbar is movable or not.</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>QStyleOptionToolBar::None</code></td><td class="topAlign tblval"><code>0x0</code></td><td class="topAlign">The toolbar cannot be moved. The default value.</td></tr>
<tr><td class="topAlign"><code>QStyleOptionToolBar::Movable</code></td><td class="topAlign tblval"><code>0x1</code></td><td class="topAlign">The toolbar is movable, and a handle will appear when holding the cursor over the toolbar's boundary.</td></tr>
</table></div>
<p>The ToolBarFeatures type is a typedef for <a href="../qtcore/qflags.html">QFlags</a>&lt;ToolBarFeature&gt;. It stores an OR combination of ToolBarFeature values.</p>
<p><b>See also </b><a href="qstyleoptiontoolbar.html#features-var">features</a> and <a href="qtoolbar.html#movable-prop">QToolBar::isMovable</a>().</p>
<!-- @@@ToolBarFeature -->
<!-- $$$ToolBarPosition$$$Beginning$$$Middle$$$End$$$OnlyOne -->
<h3 class="fn" id="ToolBarPosition-enum"><a name="ToolBarPosition-enum"></a>enum QStyleOptionToolBar::<span class="name">ToolBarPosition</span></h3>
<p class="centerAlign"><img src="images/qstyleoptiontoolbar-position.png" alt="" /></p><p>This enum is used to describe the position of a toolbar line, as well as the toolbar's position within the line.</p>
<p>The order of the positions within a line starts at the top of a vertical line, and from the left within a horizontal line. The order of the positions for the lines is always from the parent widget's boundary edges.</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>QStyleOptionToolBar::Beginning</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The toolbar is located at the beginning of the line, or the toolbar line is the first of several lines. There can only be one toolbar (and only one line) with this position.</td></tr>
<tr><td class="topAlign"><code>QStyleOptionToolBar::Middle</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The toolbar is located in the middle of the line, or the toolbar line is in the middle of several lines. There can several toolbars (and lines) with this position.</td></tr>
<tr><td class="topAlign"><code>QStyleOptionToolBar::End</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">The toolbar is located at the end of the line, or the toolbar line is the last of several lines. There can only be one toolbar (and only one line) with this position.</td></tr>
<tr><td class="topAlign"><code>QStyleOptionToolBar::OnlyOne</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">There is only one toolbar or line. This is the default value of the <a href="qstyleoptiontoolbar.html#positionOfLine-var">positionOfLine</a> and <a href="qstyleoptiontoolbar.html#positionWithinLine-var">positionWithinLine</a> variables.</td></tr>
</table></div>
<p><b>See also </b><a href="qstyleoptiontoolbar.html#positionWithinLine-var">positionWithinLine</a> and <a href="qstyleoptiontoolbar.html#positionOfLine-var">positionOfLine</a>.</p>
<!-- @@@ToolBarPosition -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QStyleOptionToolBar[overload1]$$$QStyleOptionToolBar -->
<h3 class="fn" id="QStyleOptionToolBar"><a name="QStyleOptionToolBar"></a>QStyleOptionToolBar::<span class="name">QStyleOptionToolBar</span>()</h3>
<p>Constructs a <a href="qstyleoptiontoolbar.html">QStyleOptionToolBar</a>, initializing the members variables to their default values.</p>
<!-- @@@QStyleOptionToolBar -->
<!-- $$$QStyleOptionToolBar$$$QStyleOptionToolBarconstQStyleOptionToolBar& -->
<h3 class="fn" id="QStyleOptionToolBar-1"><a name="QStyleOptionToolBar-1"></a>QStyleOptionToolBar::<span class="name">QStyleOptionToolBar</span>(const <span class="type"><a href="qstyleoptiontoolbar.html#QStyleOptionToolBar">QStyleOptionToolBar</a></span> &amp;<i>other</i>)</h3>
<p>Constructs a copy of the <i>other</i> style option.</p>
<!-- @@@QStyleOptionToolBar -->
</div>
<div class="vars">
<h2>Member Variable Documentation</h2>
<!-- $$$features -->
<h3 class="fn" id="features-var"><a name="features-var"></a><span class="type"><a href="qstyleoptiontoolbar.html#ToolBarFeature-enum">ToolBarFeatures</a></span> QStyleOptionToolBar::<span class="name">features</span></h3>
<p>This variable holds whether the toolbar is movable or not.</p>
<p>The default value is <a href="qstyleoptiontoolbar.html#ToolBarFeature-enum">None</a>.</p>
<!-- @@@features -->
<!-- $$$lineWidth -->
<h3 class="fn" id="lineWidth-var"><a name="lineWidth-var"></a><span class="type">int</span> QStyleOptionToolBar::<span class="name">lineWidth</span></h3>
<p>This variable holds the line width for drawing the toolbar.</p>
<p>The default value is 0.</p>
<!-- @@@lineWidth -->
<!-- $$$midLineWidth -->
<h3 class="fn" id="midLineWidth-var"><a name="midLineWidth-var"></a><span class="type">int</span> QStyleOptionToolBar::<span class="name">midLineWidth</span></h3>
<p>This variable holds the mid-line width for drawing the toolbar.</p>
<p>The default value is 0.</p>
<!-- @@@midLineWidth -->
<!-- $$$positionOfLine -->
<h3 class="fn" id="positionOfLine-var"><a name="positionOfLine-var"></a><span class="type"><a href="qstyleoptiontoolbar.html#ToolBarPosition-enum">ToolBarPosition</a></span> QStyleOptionToolBar::<span class="name">positionOfLine</span></h3>
<p>This variable holds the position of the toolbar line.</p>
<p>The default value is <a href="qstyleoptiontoolbar.html#ToolBarPosition-enum">QStyleOptionToolBar::OnlyOne</a>.</p>
<!-- @@@positionOfLine -->
<!-- $$$positionWithinLine -->
<h3 class="fn" id="positionWithinLine-var"><a name="positionWithinLine-var"></a><span class="type"><a href="qstyleoptiontoolbar.html#ToolBarPosition-enum">ToolBarPosition</a></span> QStyleOptionToolBar::<span class="name">positionWithinLine</span></h3>
<p>This variable holds the position of the toolbar within a line.</p>
<p>The default value is <a href="qstyleoptiontoolbar.html#ToolBarPosition-enum">QStyleOptionToolBar::OnlyOne</a>.</p>
<!-- @@@positionWithinLine -->
<!-- $$$toolBarArea -->
<h3 class="fn" id="toolBarArea-var"><a name="toolBarArea-var"></a><span class="type"><a href="../qtcore/qt.html#ToolBarArea-enum">Qt::ToolBarArea</a></span> QStyleOptionToolBar::<span class="name">toolBarArea</span></h3>
<p>This variable holds the location for drawing the toolbar.</p>
<p>The default value is <a href="../qtcore/qt.html#ToolBarArea-enum">Qt::TopToolBarArea</a>.</p>
<p><b>See also </b><a href="../qtcore/qt.html#ToolBarArea-enum">Qt::ToolBarArea</a>.</p>
<!-- @@@toolBarArea -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2017 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>