Skip to content

PythonQt.QtGui.QSplitter · declarations 001

Back to PythonQt.QtGui.QSplitter

addWidget

addWidget(widget: Any) -> None

X.addWidget(widget)

Supplemental documentation: Qt 5 reference:

void QSplitter::addWidget(QWidget *widget)

Adds the given widget to the splitter's layout after all the other items.

If widget is already in the splitter, it will be moved to the new position.

Note: The splitter takes ownership of the widget.

See also insertWidget(), widget(), and indexOf().

Upstream PySide2 reference signatures (binding differences may apply):

addWidget(self, widget: PySide2.QtWidgets.QWidget) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#addWidget

changeEvent

changeEvent(arg__1: Any) -> None

X.changeEvent(arg__1)

Supplemental documentation: Qt 5 reference:

[override virtual protected] void QSplitter::changeEvent(QEvent *ev)

Reimplements: QFrame::changeEvent(QEvent *ev).

Upstream PySide2 reference signatures (binding differences may apply):

changeEvent(self, arg__1: PySide2.QtCore.QEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#changeEvent

childEvent

childEvent(arg__1: Any) -> None

X.childEvent(arg__1)

Supplemental documentation: Qt 5 reference:

[override virtual protected] void QSplitter::childEvent(QChildEvent *c)

Reimplements: QObject::childEvent(QChildEvent *event).

Tells the splitter that the child widget described by c has been inserted or removed.

This method is also used to handle the situation where a widget is created with the splitter as a parent but not explicitly added with insertWidget() or addWidget(). This is for compatibility and not the recommended way of putting widgets into a splitter in new code. Please use insertWidget() or addWidget() in new code.

See also addWidget() and insertWidget().

Upstream PySide2 reference signatures (binding differences may apply):

childEvent(self, arg__1: PySide2.QtCore.QChildEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#childEvent

childrenCollapsible instance-attribute

childrenCollapsible: bool

Qt 5 reference:

childrenCollapsible : bool

This property holds whether child widgets can be resized down to size 0 by the user

By default, children are collapsible. It is possible to enable and disable the collapsing of individual children using setCollapsible().

Access functions:

bool childrenCollapsible() const
void setChildrenCollapsible(bool)

See also setCollapsible().

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#childrenCollapsible

closestLegalPosition

closestLegalPosition(arg__1: int, arg__2: int) -> int

X.closestLegalPosition(arg__1, arg__2) -> int

Supplemental documentation: Qt 5 reference:

[protected] int QSplitter::closestLegalPosition(int pos, int index)

Returns the closest legal position to pos of the widget at index.

For right-to-left languages such as Arabic and Hebrew, the layout of horizontal splitters is reversed. Positions are then measured from the right edge of the widget.

See also getRange().

Upstream PySide2 reference signatures (binding differences may apply):

closestLegalPosition(self, arg__1: int, arg__2: int) -> int

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#closestLegalPosition

count

count() -> int

X.count() -> int

Supplemental documentation: Qt 5 reference:

int QSplitter::count() const

Returns the number of widgets contained in the splitter's layout.

See also widget() and handle().

Upstream PySide2 reference signatures (binding differences may apply):

count(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#count

createHandle

createHandle() -> Any

X.createHandle() -> PythonQt.QtGui.QSplitterHandle

Supplemental documentation: Qt 5 reference:

[virtual protected] QSplitterHandle *QSplitter::createHandle()

Returns a new splitter handle as a child widget of this splitter. This function can be reimplemented in subclasses to provide support for custom handles.

See also handle() and indexOf().

Upstream PySide2 reference signatures (binding differences may apply):

createHandle(self) -> PySide2.QtWidgets.QSplitterHandle

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#createHandle

customContextMenuRequested

customContextMenuRequested(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QSplitter.customContextMenuRequested; argument details are not documented.

destroyed

destroyed(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QSplitter.destroyed; argument details are not documented.

event

event(arg__1: Any) -> bool

X.event(arg__1) -> bool

Supplemental documentation: Qt 5 reference:

[override virtual protected] bool QSplitter::event(QEvent *e)

Reimplements: QFrame::event(QEvent *e).

Upstream PySide2 reference signatures (binding differences may apply):

event(self, arg__1: PySide2.QtCore.QEvent) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#event

handle

handle(index: int) -> Any

X.handle(index) -> PythonQt.QtGui.QSplitterHandle

Supplemental documentation: Qt 5 reference:

QSplitterHandle *QSplitter::handle(int index) const

Returns the handle to the left of (or above) the item in the splitter's layout at the given index, or nullptr if there is no such item. The handle at index 0 is always hidden.

For right-to-left languages such as Arabic and Hebrew, the layout of horizontal splitters is reversed. The handle will be to the right of the widget at index.

See also count(), widget(), indexOf(), createHandle(), and setHandleWidth().

Upstream PySide2 reference signatures (binding differences may apply):

handle(self, index: int) -> PySide2.QtWidgets.QSplitterHandle

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#handle

handleWidth instance-attribute

handleWidth: int

Qt 5 reference:

handleWidth : int

This property holds the width of the splitter handles

By default, this property contains a value that depends on the user's platform and style preferences.

If you set handleWidth to 1 or 0, the actual grab area will grow to overlap a few pixels of its respective widgets.

Access functions:

int handleWidth() const
void setHandleWidth(int)

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#handleWidth

indexOf

indexOf(w: Any) -> int

X.indexOf(w) -> int

Supplemental documentation: Qt 5 reference:

int QSplitter::indexOf(QWidget *widget) const

Returns the index in the splitter's layout of the specified widget, or -1 if widget is not found. This also works for handles.

Handles are numbered from 0. There are as many handles as there are child widgets, but the handle at position 0 is always hidden.

See also count() and widget().

Upstream PySide2 reference signatures (binding differences may apply):

indexOf(self, w: PySide2.QtWidgets.QWidget) -> int

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#indexOf

insertWidget

insertWidget(index: int, widget: Any) -> None

X.insertWidget(index, widget)

Supplemental documentation: Qt 5 reference:

void QSplitter::insertWidget(int index, QWidget *widget)

Inserts the widget specified into the splitter's layout at the given index.

If widget is already in the splitter, it will be moved to the new position.

If index is an invalid index, then the widget will be inserted at the end.

Note: The splitter takes ownership of the widget.

See also addWidget(), indexOf(), and widget().

Upstream PySide2 reference signatures (binding differences may apply):

insertWidget(self, index: int, widget: PySide2.QtWidgets.QWidget) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#insertWidget

isCollapsible

isCollapsible(index: int) -> bool

X.isCollapsible(index) -> bool

Supplemental documentation: Qt 5 reference:

bool QSplitter::isCollapsible(int index) const

Returns true if the widget at index is collapsible, otherwise returns false.

Upstream PySide2 reference signatures (binding differences may apply):

isCollapsible(self, index: int) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#isCollapsible

minimumSizeHint instance-attribute

minimumSizeHint: QSize

Qt 5 reference:

[override virtual] QSize QSplitter::minimumSizeHint() const

Reimplements an access function for property: QWidget::minimumSizeHint.

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#minimumSizeHint

moveSplitter

moveSplitter(pos: int, index: int) -> None

X.moveSplitter(pos, index)

Supplemental documentation: Qt 5 reference:

[protected] void QSplitter::moveSplitter(int pos, int index)

Moves the left or top edge of the splitter handle at index as close as possible to position pos, which is the distance from the left or top edge of the widget.

For right-to-left languages such as Arabic and Hebrew, the layout of horizontal splitters is reversed. pos is then the distance from the right edge of the widget.

See also splitterMoved(), closestLegalPosition(), and getRange().

Upstream PySide2 reference signatures (binding differences may apply):

moveSplitter(self, pos: int, index: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#moveSplitter

objectNameChanged

objectNameChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QSplitter.objectNameChanged; argument details are not documented.

opaqueResize instance-attribute

opaqueResize: bool

Qt 5 reference:

opaqueResize : bool

Returns true if widgets are resized dynamically (opaquely) while interactively moving the splitter. Otherwise returns false.

The default resize behavior is style dependent (determined by the SH_Splitter_OpaqueResize style hint). However, you can override it by calling setOpaqueResize()

Access functions:

bool opaqueResize() const
void setOpaqueResize(bool opaque \= true)

See also QStyle::StyleHint.

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#opaqueResize

orientation instance-attribute

orientation: Any

Qt 5 reference:

orientation : Qt::Orientation

This property holds the orientation of the splitter

By default, the orientation is horizontal (i.e., the widgets are laid out side by side). The possible orientations are Qt::Horizontal and Qt::Vertical.

Access functions:

Qt::Orientation orientation() const
void setOrientation(Qt::Orientation)

See also QSplitterHandle::orientation().

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#orientation

refresh

refresh() -> None

X.refresh()

Supplemental documentation: Qt 5 reference:

void QSplitter::refresh()

Updates the splitter's state. You should not need to call this function.

Upstream PySide2 reference signatures (binding differences may apply):

refresh(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#refresh

resizeEvent

resizeEvent(arg__1: Any) -> None

X.resizeEvent(arg__1)

Supplemental documentation: Qt 5 reference:

[override virtual protected] void QSplitter::resizeEvent(QResizeEvent *)

Reimplements: QWidget::resizeEvent(QResizeEvent *event).

Upstream PySide2 reference signatures (binding differences may apply):

resizeEvent(self, arg__1: PySide2.QtGui.QResizeEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#resizeEvent

restoreState

restoreState(state: Any) -> bool

X.restoreState(state) -> bool

Supplemental documentation: Qt 5 reference:

bool QSplitter::restoreState(const QByteArray \&state)

Restores the splitter's layout to the state specified. Returns true if the state is restored; otherwise returns false.

Typically this is used in conjunction with QSettings to restore the size from a past session. Here is an example:

Restore the splitter's state:

    QSettings settings;
    splitter->restoreState(settings.value("splitterSizes").toByteArray());

A failure to restore the splitter's layout may result from either invalid or out-of-date data in the supplied byte array.

See also saveState().

Upstream PySide2 reference signatures (binding differences may apply):

restoreState(self, state: PySide2.QtCore.QByteArray) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#restoreState

saveState

saveState() -> Any

X.saveState() -> PythonQt.QtCore.QByteArray

Supplemental documentation: Qt 5 reference:

QByteArray QSplitter::saveState() const

Saves the state of the splitter's layout.

Typically this is used in conjunction with QSettings to remember the size for a future session. A version number is stored as part of the data. Here is an example:

    QSettings settings;
    settings.setValue("splitterSizes", splitter->saveState());

See also restoreState().

Upstream PySide2 reference signatures (binding differences may apply):

saveState(self) -> PySide2.QtCore.QByteArray

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#saveState

setChildrenCollapsible

setChildrenCollapsible(arg__1: bool) -> None

X.setChildrenCollapsible(arg__1)

Upstream PySide2 reference signatures (binding differences may apply):

setChildrenCollapsible(self, arg__1: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#setChildrenCollapsible

setCollapsible

setCollapsible(index: int, arg__2: bool) -> None

X.setCollapsible(index, arg__2)

Supplemental documentation: Qt 5 reference:

void QSplitter::setCollapsible(int index, bool collapse)

Sets whether the child widget at index is collapsible to collapse.

By default, children are collapsible, meaning that the user can resize them down to size 0, even if they have a non-zero minimumSize() or minimumSizeHint(). This behavior can be changed on a per-widget basis by calling this function, or globally for all the widgets in the splitter by setting the childrenCollapsible property.

See also isCollapsible() and childrenCollapsible.

Upstream PySide2 reference signatures (binding differences may apply):

setCollapsible(self, index: int, arg__2: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#setCollapsible

setHandleWidth

setHandleWidth(arg__1: int) -> None

X.setHandleWidth(arg__1)

Upstream PySide2 reference signatures (binding differences may apply):

setHandleWidth(self, arg__1: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#setHandleWidth

setOpaqueResize

setOpaqueResize(opaque: bool) -> None

X.setOpaqueResize(opaque)

Upstream PySide2 reference signatures (binding differences may apply):

setOpaqueResize(self, opaque: bool=...) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#setOpaqueResize

setOrientation

setOrientation(arg__1: Any) -> None

X.setOrientation(arg__1)

Upstream PySide2 reference signatures (binding differences may apply):

setOrientation(self, arg__1: PySide2.QtCore.Qt.Orientation) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#setOrientation

setRubberBand

setRubberBand(position: int) -> None

X.setRubberBand(position)

Supplemental documentation: Qt 5 reference:

[protected] void QSplitter::setRubberBand(int pos)

Displays a rubber band at position pos. If pos is negative, the rubber band is removed.

Upstream PySide2 reference signatures (binding differences may apply):

setRubberBand(self, position: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#setRubberBand

setSizes

setSizes(list: Any) -> None

X.setSizes(list)

Supplemental documentation: Qt 5 reference:

void QSplitter::setSizes(const QList\<int> \&list)

Sets the child widgets' respective sizes to the values given in the list.

If the splitter is horizontal, the values set the width of each widget in pixels, from left to right. If the splitter is vertical, the height of each widget is set, from top to bottom.

Extra values in the list are ignored. If list contains too few values, the result is undefined, but the program will still be well-behaved.

The overall size of the splitter widget is not affected. Instead, any additional/missing space is distributed amongst the widgets according to the relative weight of the sizes.

If you specify a size of 0, the widget will be invisible. The size policies of the widgets are preserved. That is, a value smaller than the minimal size hint of the respective widget will be replaced by the value of the hint.

See also sizes().

Upstream PySide2 reference signatures (binding differences may apply):

setSizes(self, list: shibokensupport.typing27.Sequence) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#setSizes

setStretchFactor

setStretchFactor(index: int, stretch: int) -> None

X.setStretchFactor(index, stretch)

Supplemental documentation: Qt 5 reference:

void QSplitter::setStretchFactor(int index, int stretch)

Updates the size policy of the widget at position index to have a stretch factor of stretch.

stretch is not the effective stretch factor; the effective stretch factor is calculated by taking the initial size of the widget and multiplying it with stretch.

This function is provided for convenience. It is equivalent to

QWidget *widget = splitter->widget(index);
QSizePolicy policy = widget->sizePolicy();
policy.setHorizontalStretch(stretch);
policy.setVerticalStretch(stretch);
widget->setSizePolicy(policy);

See also setSizes() and widget().

Upstream PySide2 reference signatures (binding differences may apply):

setStretchFactor(self, index: int, stretch: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#setStretchFactor

sizeHint instance-attribute

sizeHint: QSize

Qt 5 reference:

[override virtual] QSize QSplitter::sizeHint() const

Reimplements: QFrame::sizeHint() const.

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#sizeHint

sizes

sizes() -> tuple

X.sizes() -> tuple

Supplemental documentation: Qt 5 reference:

QList\<int> QSplitter::sizes() const

Returns a list of the size parameters of all the widgets in this splitter.

If the splitter's orientation is horizontal, the list contains the widgets width in pixels, from left to right; if the orientation is vertical, the list contains the widgets' heights in pixels, from top to bottom.

Giving the values to another splitter's setSizes() function will produce a splitter with the same layout as this one.

Note that invisible widgets have a size of 0.

See also setSizes().

Upstream PySide2 reference signatures (binding differences may apply):

sizes(self) -> typing.List[int]

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#sizes

splitterMoved

splitterMoved(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QSplitter.splitterMoved; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QSplitter::splitterMoved(int pos, int index)

This signal is emitted when the splitter handle at a particular index has been moved to position pos.

For right-to-left languages such as Arabic and Hebrew, the layout of horizontal splitters is reversed. pos is then the distance from the right edge of the widget.

See also moveSplitter().

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#splitterMoved

widget

widget(index: int) -> Any

X.widget(index) -> PythonQt.QtGui.QWidget

Supplemental documentation: Qt 5 reference:

QWidget *QSplitter::widget(int index) const

Returns the widget at the given index in the splitter's layout, or nullptr if there is no such widget.

See also count(), handle(), indexOf(), and insertWidget().

Upstream PySide2 reference signatures (binding differences may apply):

widget(self, index: int) -> PySide2.QtWidgets.QWidget

Source: https://doc.qt.io/archives/qt-5.15/qsplitter.html#widget

windowIconChanged

windowIconChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QSplitter.windowIconChanged; argument details are not documented.

windowIconTextChanged

windowIconTextChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QSplitter.windowIconTextChanged; argument details are not documented.

windowTitleChanged

windowTitleChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QSplitter.windowTitleChanged; argument details are not documented.