|  | Home · All Classes · Modules

# QSplitter Class Reference
[QtGui module]

The QSplitter class implements a splitter widget. More...

Inherits QFrame.

### Methods

- __init__ (self, QWidget parent = None)
- __init__ (self, Qt.Orientation orientation, QWidget parent = None)
- addWidget (self, QWidget widget)
- changeEvent (self, QEvent)
- childEvent (self, QChildEvent)
- bool childrenCollapsible (self)
- int closestLegalPosition (self, int, int)
- int count (self)
- QSplitterHandle createHandle (self)
- bool event (self, QEvent)
- (int, int) getRange (self, int index)
- QSplitterHandle handle (self, int index)
- int handleWidth (self)
- int indexOf (self, QWidget w)
- insertWidget (self, int index, QWidget widget)
- bool isCollapsible (self, int index)
- QSize minimumSizeHint (self)
- moveSplitter (self, int pos, int index)
- bool opaqueResize (self)
- Qt.Orientation orientation (self)
- refresh (self)
- resizeEvent (self, QResizeEvent)
- bool restoreState (self, QByteArray state)
- QByteArray saveState (self)
- setChildrenCollapsible (self, bool)
- setCollapsible (self, int index, bool)
- setHandleWidth (self, int)
- setOpaqueResize (self, bool opaque = True)
- setOrientation (self, Qt.Orientation)
- setRubberBand (self, int position)
- setSizes (self, unknown-type list)
- setStretchFactor (self, int index, int stretch)
- QSize sizeHint (self)
- unknown-type sizes (self)
- QWidget widget (self, int index)

### Special Methods

- int __len__ (self)

### Qt Signals

- void splitterMoved (int,int)

## Detailed Description

The QSplitter class implements a splitter widget.

A splitter lets the user control the size of child widgets by dragging the boundary between the children. Any number of widgets may be controlled by a single splitter. The typical use of a QSplitter is to create several widgets and add them using insertWidget() or addWidget().

The following example will show a QListView, QTreeView, and QTextEdit side by side, with two splitter handles:

         QSplitter *splitter = new QSplitter(parent);
         QListView *listview = new QListView;
         QTreeView *treeview = new QTreeView;
         QTextEdit *textedit = new QTextEdit;
         splitter->addWidget(listview);
         splitter->addWidget(treeview);
         splitter->addWidget(textedit);

If a widget is already inside a QSplitter when insertWidget() or addWidget() is called, it will move to the new position. This can be used to reorder widgets in the splitter later. You can use indexOf(), widget(), and count() to get access to the widgets inside the splitter.

A default QSplitter lays out its children horizontally (side by side); you can use setOrientation(Qt.Vertical) to lay its children out vertically.

By default, all widgets can be as large or as small as the user wishes, between the minimumSizeHint() (or minimumSize()) and maximumSize() of the widgets.

QSplitter resizes its children dynamically by default. If you would rather have QSplitter resize the children only at the end of a resize operation, call setOpaqueResize(false).

The initial distribution of size between the widgets is determined by multiplying the initial size with the stretch factor. You can also use setSizes() to set the sizes of all the widgets. The function sizes() returns the sizes set by the user. Alternatively, you can save and restore the sizes of the widgets from a QByteArray using saveState() and restoreState() respectively.

When you hide() a child its space will be distributed among the other children. It will be reinstated when you show() it again.

## Method Documentation

### QSplitter.__init__ (self, QWidget parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Constructs a horizontal splitter with the parent argument passed on to the QFrame constructor.

See also setOrientation().

### QSplitter.__init__ (self, Qt.Orientation orientation, QWidget parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Constructs a splitter with the given orientation and parent.

See also setOrientation().

### QSplitter.addWidget (self, QWidget widget)

The widget argument has it's ownership transferred to Qt.

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.

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

### QSplitter.changeEvent (self, QEvent)

Reimplemented from QWidget.changeEvent().

### QSplitter.childEvent (self, QChildEvent)

Reimplemented from QObject.childEvent().

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().

### bool QSplitter.childrenCollapsible (self)

### int QSplitter.closestLegalPosition (self, int, int)

Returns the closest legal position to pos of the widget with index 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().

### int QSplitter.count (self)

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

See also widget() and handle().

### QSplitterHandle QSplitter.createHandle (self)

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().

### bool QSplitter.event (self, QEvent)

Reimplemented from QObject.event().

### (int, int) QSplitter.getRange (self, int index)

Returns the valid range of the splitter with index index in *min and *max if min and max are not 0.

### QSplitterHandle QSplitter.handle (self, int index)

Returns the handle to the left (or above) for the item in the splitter's layout at the given index. 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().

### int QSplitter.handleWidth (self)

### int QSplitter.indexOf (self, QWidget w)

Returns the index in the splitter's layout of the specified widget. 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().

### QSplitter.insertWidget (self, int index, QWidget widget)

The widget argument has it's ownership transferred to Qt.

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.

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

### bool QSplitter.isCollapsible (self, int index)

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

### QSize QSplitter.minimumSizeHint (self)

Reimplemented from QWidget.minimumSizeHint().

### QSplitter.moveSplitter (self, 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().

### bool QSplitter.opaqueResize (self)

### Qt.Orientation QSplitter.orientation (self)

### QSplitter.refresh (self)

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

### QSplitter.resizeEvent (self, QResizeEvent)

Reimplemented from QWidget.resizeEvent().

### bool QSplitter.restoreState (self, 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 splitters'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().

### QByteArray QSplitter.saveState (self)

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().

### QSplitter.setChildrenCollapsible (self, bool)

### QSplitter.setCollapsible (self, int index, bool)

Sets whether the child widget at index 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.

### QSplitter.setHandleWidth (self, int)

### QSplitter.setOpaqueResize (self, bool opaque = True)

### QSplitter.setOrientation (self, Qt.Orientation)

### QSplitter.setRubberBand (self, int position)

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

### QSplitter.setSizes (self, unknown-type list)

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

If the splitter is horizontal, the values set the widths of each widget in pixels, from left to right. If the splitter is vertical, the heights 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 then the minimal size hint of the respective widget will be replaced by the value of the hint.

See also sizes().

### QSplitter.setStretchFactor (self, 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().

### QSize QSplitter.sizeHint (self)

Reimplemented from QWidget.sizeHint().

### unknown-type QSplitter.sizes (self)

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 height 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().

### QWidget QSplitter.widget (self, int index)

Returns the widget at the given index in the splitter's layout.

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

### int QSplitter.__len__ (self)

## Qt Signal Documentation

### void splitterMoved (int,int)

This is the default overload of this signal.

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().