<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qsplitter.cpp --> <title>QSplitterHandle 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 >QSplitterHandle</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-functions">Public Functions</a></li> <li class="level1"><a href="#reimplemented-public-functions">Reimplemented Public Functions</a></li> <li class="level1"><a href="#protected-functions">Protected Functions</a></li> <li class="level1"><a href="#reimplemented-protected-functions">Reimplemented Protected Functions</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">QSplitterHandle Class</h1> <!-- $$$QSplitterHandle-brief --> <p>The <a href="qsplitterhandle.html">QSplitterHandle</a> class provides handle functionality for the splitter. <a href="#details">More...</a></p> <!-- @@@QSplitterHandle --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QSplitterHandle></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="qwidget.html">QWidget</a></td></tr></table></div><ul> <li><a href="qsplitterhandle-members.html">List of all members, including inherited members</a></li> </ul> <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="qsplitterhandle.html#QSplitterHandle">QSplitterHandle</a></b>(Qt::Orientation <i>orientation</i>, QSplitter *<i>parent</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#dtor.QSplitterHandle">~QSplitterHandle</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#opaqueResize">opaqueResize</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Qt::Orientation </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#orientation">orientation</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#setOrientation">setOrientation</a></b>(Qt::Orientation <i>orientation</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QSplitter *</td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#splitter">splitter</a></b>() const</td></tr> </table></div> <a name="reimplemented-public-functions"></a> <h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> virtual QSize </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#sizeHint">sizeHint</a></b>() const</td></tr> </table></div> <ul> <li class="fn">214 public functions inherited from <a href="qwidget.html#public-functions">QWidget</a></li> <li class="fn">32 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</a></li> <li class="fn">14 public functions inherited from <a href="../qtgui/qpaintdevice.html#public-functions">QPaintDevice</a></li> </ul> <a name="protected-functions"></a> <h2 id="protected-functions">Protected Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#closestLegalPosition">closestLegalPosition</a></b>(int <i>pos</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#moveSplitter">moveSplitter</a></b>(int <i>pos</i>)</td></tr> </table></div> <a name="reimplemented-protected-functions"></a> <h2 id="reimplemented-protected-functions">Reimplemented Protected Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#event">event</a></b>(QEvent *<i>event</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#mouseMoveEvent">mouseMoveEvent</a></b>(QMouseEvent *<i>e</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#mousePressEvent">mousePressEvent</a></b>(QMouseEvent *<i>e</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#mouseReleaseEvent">mouseReleaseEvent</a></b>(QMouseEvent *<i>e</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#paintEvent">paintEvent</a></b>(<i>QPaintEvent *</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qsplitterhandle.html#resizeEvent">resizeEvent</a></b>(QResizeEvent *<i>event</i>)</td></tr> </table></div> <ul> <li class="fn">35 protected functions inherited from <a href="qwidget.html#protected-functions">QWidget</a></li> <li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li> <li class="fn">1 protected function inherited from <a href="../qtgui/qpaintdevice.html#protected-functions">QPaintDevice</a></li> </ul> <h3>Additional Inherited Members</h3> <ul> <li class="fn">59 properties inherited from <a href="qwidget.html#properties">QWidget</a></li> <li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</a></li> <li class="fn">19 public slots inherited from <a href="qwidget.html#public-slots">QWidget</a></li> <li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li> <li class="fn">3 signals inherited from <a href="qwidget.html#signals">QWidget</a></li> <li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li> <li class="fn">1 public variable inherited from <a href="../qtcore/qobject.html#public-variables">QObject</a></li> <li class="fn">5 static public members inherited from <a href="qwidget.html#static-public-members">QWidget</a></li> <li class="fn">10 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li> <li class="fn">1 protected slot inherited from <a href="qwidget.html#protected-slots">QWidget</a></li> <li class="fn">2 protected variables inherited from <a href="../qtcore/qobject.html#protected-variables">QObject</a></li> <li class="fn">1 protected type inherited from <a href="../qtgui/qpaintdevice.html#protected-variables">QPaintDevice</a></li> </ul> <a name="details"></a> <!-- $$$QSplitterHandle-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qsplitterhandle.html">QSplitterHandle</a> class provides handle functionality for the splitter.</p> <p><a href="qsplitterhandle.html">QSplitterHandle</a> is typically what people think about when they think about a splitter. It is the handle that is used to resize the widgets.</p> <p>A typical developer using <a href="qsplitter.html">QSplitter</a> will never have to worry about <a href="qsplitterhandle.html">QSplitterHandle</a>. It is provided for developers who want splitter handles that provide extra features, such as popup menus.</p> <p>The typical way one would create splitter handles is to subclass <a href="qsplitter.html">QSplitter</a> and then reimplement <a href="qsplitter.html#createHandle">QSplitter::createHandle</a>() to instantiate the custom splitter handle. For example, a minimum <a href="qsplitter.html">QSplitter</a> subclass might look like this:</p> <pre class="cpp"> <span class="keyword">class</span> Splitter : <span class="keyword">public</span> <span class="type"><a href="qsplitter.html">QSplitter</a></span> { <span class="keyword">public</span>: Splitter(<span class="type"><a href="../qtcore/qt.html">Qt</a></span><span class="operator">::</span>Orientation orientation<span class="operator">,</span> <span class="type"><a href="qwidget.html#QWidget">QWidget</a></span> <span class="operator">*</span>parent <span class="operator">=</span> <span class="number">0</span>); <span class="keyword">protected</span>: <span class="type"><a href="qsplitterhandle.html#QSplitterHandle">QSplitterHandle</a></span> <span class="operator">*</span>createHandle(); }; </pre> <p>The <a href="qsplitter.html#createHandle">createHandle()</a> implementation simply constructs a custom splitter handle, called <code>Splitter</code> in this example:</p> <pre class="cpp"> <span class="type"><a href="qsplitterhandle.html#QSplitterHandle">QSplitterHandle</a></span> <span class="operator">*</span>Splitter<span class="operator">::</span>createHandle() { <span class="keyword">return</span> <span class="keyword">new</span> SplitterHandle(orientation()<span class="operator">,</span> <span class="keyword">this</span>); } </pre> <p>Information about a given handle can be obtained using functions like <a href="qsplitterhandle.html#orientation">orientation</a>() and <a href="qsplitterhandle.html#opaqueResize">opaqueResize</a>(), and is retrieved from its parent splitter. Details like these can be used to give custom handles different appearances depending on the splitter's orientation.</p> <p>The complexity of a custom handle subclass depends on the tasks that it needs to perform. A simple subclass might only provide a <a href="qsplitterhandle.html#paintEvent">paintEvent</a>() implementation:</p> <pre class="cpp"> <span class="type">void</span> SplitterHandle<span class="operator">::</span>paintEvent(<span class="type"><a href="../qtgui/qpaintevent.html">QPaintEvent</a></span> <span class="operator">*</span>event) { <span class="type"><a href="../qtgui/qpainter.html">QPainter</a></span> painter(<span class="keyword">this</span>); <span class="keyword">if</span> (orientation() <span class="operator">=</span><span class="operator">=</span> <span class="type"><a href="../qtcore/qt.html">Qt</a></span><span class="operator">::</span>Horizontal) { gradient<span class="operator">.</span>setStart(rect()<span class="operator">.</span>left()<span class="operator">,</span> rect()<span class="operator">.</span>height()<span class="operator">/</span><span class="number">2</span>); gradient<span class="operator">.</span>setFinalStop(rect()<span class="operator">.</span>right()<span class="operator">,</span> rect()<span class="operator">.</span>height()<span class="operator">/</span><span class="number">2</span>); } <span class="keyword">else</span> { gradient<span class="operator">.</span>setStart(rect()<span class="operator">.</span>width()<span class="operator">/</span><span class="number">2</span><span class="operator">,</span> rect()<span class="operator">.</span>top()); gradient<span class="operator">.</span>setFinalStop(rect()<span class="operator">.</span>width()<span class="operator">/</span><span class="number">2</span><span class="operator">,</span> rect()<span class="operator">.</span>bottom()); } painter<span class="operator">.</span>fillRect(event<span class="operator">-</span><span class="operator">></span>rect()<span class="operator">,</span> <span class="type"><a href="../qtgui/qbrush.html">QBrush</a></span>(gradient)); } </pre> <p>In this example, a predefined gradient is set up differently depending on the orientation of the handle. <a href="qsplitterhandle.html">QSplitterHandle</a> provides a reasonable size hint for the handle, so the subclass does not need to provide a reimplementation of <a href="qsplitterhandle.html#sizeHint">sizeHint</a>() unless the handle has special size requirements.</p> </div> <p><b>See also </b><a href="qsplitter.html">QSplitter</a>.</p> <!-- @@@QSplitterHandle --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QSplitterHandle[overload1]$$$QSplitterHandleQt::OrientationQSplitter* --> <h3 class="fn" id="QSplitterHandle"><a name="QSplitterHandle"></a>QSplitterHandle::<span class="name">QSplitterHandle</span>(<span class="type"><a href="../qtcore/qt.html#Orientation-enum">Qt::Orientation</a></span> <i>orientation</i>, <span class="type"><a href="qsplitter.html">QSplitter</a></span> *<i>parent</i>)</h3> <p>Creates a <a href="qsplitter.html">QSplitter</a> handle with the given <i>orientation</i> and <i>parent</i>.</p> <!-- @@@QSplitterHandle --> <!-- $$$~QSplitterHandle[overload1]$$$~QSplitterHandle --> <h3 class="fn" id="dtor.QSplitterHandle"><a name="dtor.QSplitterHandle"></a>QSplitterHandle::<span class="name">~QSplitterHandle</span>()</h3> <p>Destructor.</p> <!-- @@@~QSplitterHandle --> <!-- $$$closestLegalPosition[overload1]$$$closestLegalPositionint --> <h3 class="fn" id="closestLegalPosition"><a name="closestLegalPosition"></a><code>[protected] </code><span class="type">int</span> QSplitterHandle::<span class="name">closestLegalPosition</span>(<span class="type">int</span> <i>pos</i>)</h3> <p>Returns the closest legal position to <i>pos</i> of the splitter handle. The positions are measured from the left or top edge of the splitter, even for right-to-left languages.</p> <p><b>See also </b><a href="qsplitter.html#closestLegalPosition">QSplitter::closestLegalPosition</a>() and <a href="qsplitterhandle.html#moveSplitter">moveSplitter</a>().</p> <!-- @@@closestLegalPosition --> <!-- $$$event[overload1]$$$eventQEvent* --> <h3 class="fn" id="event"><a name="event"></a><code>[virtual protected] </code><span class="type">bool</span> QSplitterHandle::<span class="name">event</span>(<span class="type"><a href="../qtcore/qevent.html">QEvent</a></span> *<i>event</i>)</h3> <p>Reimplemented from <a href="../qtcore/qobject.html#event">QObject::event</a>().</p> <!-- @@@event --> <!-- $$$mouseMoveEvent[overload1]$$$mouseMoveEventQMouseEvent* --> <h3 class="fn" id="mouseMoveEvent"><a name="mouseMoveEvent"></a><code>[virtual protected] </code><span class="type">void</span> QSplitterHandle::<span class="name">mouseMoveEvent</span>(<span class="type"><a href="../qtgui/qmouseevent.html">QMouseEvent</a></span> *<i>e</i>)</h3> <p>Reimplemented from <a href="qwidget.html#mouseMoveEvent">QWidget::mouseMoveEvent</a>().</p> <!-- @@@mouseMoveEvent --> <!-- $$$mousePressEvent[overload1]$$$mousePressEventQMouseEvent* --> <h3 class="fn" id="mousePressEvent"><a name="mousePressEvent"></a><code>[virtual protected] </code><span class="type">void</span> QSplitterHandle::<span class="name">mousePressEvent</span>(<span class="type"><a href="../qtgui/qmouseevent.html">QMouseEvent</a></span> *<i>e</i>)</h3> <p>Reimplemented from <a href="qwidget.html#mousePressEvent">QWidget::mousePressEvent</a>().</p> <!-- @@@mousePressEvent --> <!-- $$$mouseReleaseEvent[overload1]$$$mouseReleaseEventQMouseEvent* --> <h3 class="fn" id="mouseReleaseEvent"><a name="mouseReleaseEvent"></a><code>[virtual protected] </code><span class="type">void</span> QSplitterHandle::<span class="name">mouseReleaseEvent</span>(<span class="type"><a href="../qtgui/qmouseevent.html">QMouseEvent</a></span> *<i>e</i>)</h3> <p>Reimplemented from <a href="qwidget.html#mouseReleaseEvent">QWidget::mouseReleaseEvent</a>().</p> <!-- @@@mouseReleaseEvent --> <!-- $$$moveSplitter[overload1]$$$moveSplitterint --> <h3 class="fn" id="moveSplitter"><a name="moveSplitter"></a><code>[protected] </code><span class="type">void</span> QSplitterHandle::<span class="name">moveSplitter</span>(<span class="type">int</span> <i>pos</i>)</h3> <p>Tells the splitter to move this handle to position <i>pos</i>, which is the distance from the left or top edge of the widget.</p> <p>Note that <i>pos</i> is also measured from the left (or top) for right-to-left languages. This function will map <i>pos</i> to the appropriate position before calling <a href="qsplitter.html#moveSplitter">QSplitter::moveSplitter</a>().</p> <p><b>See also </b><a href="qsplitter.html#moveSplitter">QSplitter::moveSplitter</a>() and <a href="qsplitterhandle.html#closestLegalPosition">closestLegalPosition</a>().</p> <!-- @@@moveSplitter --> <!-- $$$opaqueResize[overload1]$$$opaqueResize --> <h3 class="fn" id="opaqueResize"><a name="opaqueResize"></a><span class="type">bool</span> QSplitterHandle::<span class="name">opaqueResize</span>() const</h3> <p>Returns <code>true</code> if widgets are resized dynamically (opaquely), otherwise returns <code>false</code>. This value is controlled by the <a href="qsplitter.html">QSplitter</a>.</p> <p><b>See also </b><a href="qsplitter.html#opaqueResize-prop">QSplitter::opaqueResize</a>().</p> <!-- @@@opaqueResize --> <!-- $$$orientation[overload1]$$$orientation --> <h3 class="fn" id="orientation"><a name="orientation"></a><span class="type"><a href="../qtcore/qt.html#Orientation-enum">Qt::Orientation</a></span> QSplitterHandle::<span class="name">orientation</span>() const</h3> <p>Returns the handle's orientation. This is usually propagated from the <a href="qsplitter.html">QSplitter</a>.</p> <p><b>See also </b><a href="qsplitterhandle.html#setOrientation">setOrientation</a>() and <a href="qsplitter.html#orientation-prop">QSplitter::orientation</a>().</p> <!-- @@@orientation --> <!-- $$$paintEvent[overload1]$$$paintEventQPaintEvent* --> <h3 class="fn" id="paintEvent"><a name="paintEvent"></a><code>[virtual protected] </code><span class="type">void</span> QSplitterHandle::<span class="name">paintEvent</span>(<i>QPaintEvent *</i>)</h3> <p>Reimplemented from <a href="qwidget.html#paintEvent">QWidget::paintEvent</a>().</p> <!-- @@@paintEvent --> <!-- $$$resizeEvent[overload1]$$$resizeEventQResizeEvent* --> <h3 class="fn" id="resizeEvent"><a name="resizeEvent"></a><code>[virtual protected] </code><span class="type">void</span> QSplitterHandle::<span class="name">resizeEvent</span>(<span class="type"><a href="../qtgui/qresizeevent.html">QResizeEvent</a></span> *<i>event</i>)</h3> <p>Reimplemented from <a href="qwidget.html#resizeEvent">QWidget::resizeEvent</a>().</p> <!-- @@@resizeEvent --> <!-- $$$setOrientation[overload1]$$$setOrientationQt::Orientation --> <h3 class="fn" id="setOrientation"><a name="setOrientation"></a><span class="type">void</span> QSplitterHandle::<span class="name">setOrientation</span>(<span class="type"><a href="../qtcore/qt.html#Orientation-enum">Qt::Orientation</a></span> <i>orientation</i>)</h3> <p>Sets the orientation of the splitter handle to <i>orientation</i>. This is usually propagated from the <a href="qsplitter.html">QSplitter</a>.</p> <p><b>See also </b><a href="qsplitterhandle.html#orientation">orientation</a>() and <a href="qsplitter.html#orientation-prop">QSplitter::setOrientation</a>().</p> <!-- @@@setOrientation --> <!-- $$$sizeHint[overload1]$$$sizeHint --> <h3 class="fn" id="sizeHint"><a name="sizeHint"></a><code>[virtual] </code><span class="type"><a href="../qtcore/qsize.html">QSize</a></span> QSplitterHandle::<span class="name">sizeHint</span>() const</h3> <p>Reimplemented from <a href="qwidget.html#sizeHint-prop">QWidget::sizeHint</a>().</p> <!-- @@@sizeHint --> <!-- $$$splitter[overload1]$$$splitter --> <h3 class="fn" id="splitter"><a name="splitter"></a><span class="type"><a href="qsplitter.html">QSplitter</a></span> *QSplitterHandle::<span class="name">splitter</span>() const</h3> <p>Returns the splitter associated with this splitter handle.</p> <p><b>See also </b><a href="qsplitter.html#handle">QSplitter::handle</a>().</p> <!-- @@@splitter --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</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>