class QSplitterHandle

The QSplitterHandle class provides handle functionality for the splitter. More…

Inheritance diagram of PySide6.QtWidgets.QSplitterHandle

Synopsis

Methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

QSplitterHandle is typically what people think about when they think about a splitter. It is the handle that is used to resize the widgets.

A typical developer using QSplitter will never have to worry about QSplitterHandle . It is provided for developers who want splitter handles that provide extra features, such as popup menus.

The typical way one would create splitter handles is to subclass QSplitter and then reimplement createHandle() to instantiate the custom splitter handle. For example, a minimum QSplitter subclass might look like this:

class Splitter(QSplitter):

# public
    Splitter(Qt.Orientation orientation, QWidget parent = None)
# protected
    QSplitterHandle createHandle() override

The createHandle() implementation simply constructs a custom splitter handle, called Splitter in this example:

QSplitterHandle Splitter.createHandle()

    return SplitterHandle(orientation(), self)

Information about a given handle can be obtained using functions like orientation() and opaqueResize() , 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.

The complexity of a custom handle subclass depends on the tasks that it needs to perform. A simple subclass might only provide a paintEvent() implementation:

def paintEvent(self, event):

    painter = QPainter(self)
    if orientation() == Qt.Horizontal:
        gradient.setStart(rect().left(), rect().height()/2)
        gradient.setFinalStop(rect().right(), rect().height()/2)
    else:
        gradient.setStart(rect().width()/2, rect().top())
        gradient.setFinalStop(rect().width()/2, rect().bottom())

    painter.fillRect(event.rect(), QBrush(gradient))

In this example, a predefined gradient is set up differently depending on the orientation of the handle. QSplitterHandle provides a reasonable size hint for the handle, so the subclass does not need to provide a reimplementation of sizeHint() unless the handle has special size requirements.

See also

QSplitter

__init__(o, parent)
Parameters:

Creates a QSplitter handle with the given orientation and parent.

closestLegalPosition(p)
Parameters:

p – int

Return type:

int

Returns the closest legal position to pos of the splitter handle. The positions are measured from the left or top edge of the splitter, even for right-to-left languages.

moveSplitter(p)
Parameters:

p – int

Tells the splitter to move this handle to position pos, which is the distance from the left or top edge of the widget.

Note that pos is also measured from the left (or top) for right-to-left languages. This function will map pos to the appropriate position before calling moveSplitter() .

opaqueResize()
Return type:

bool

Returns true if widgets are resized dynamically (opaquely) while interactively moving the splitter. Otherwise returns false. This value is controlled by the QSplitter .

See also

opaqueResize()

orientation()
Return type:

Orientation

Returns the handle’s orientation. This is usually propagated from the QSplitter .

setOrientation(o)
Parameters:

o – Orientation

Sets the orientation of the splitter handle to orientation. This is usually propagated from the QSplitter .

splitter()
Return type:

QSplitter

Returns the splitter associated with this splitter handle.

See also

handle()