Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions

QSplitter Class Reference

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

#include <qsplitter.h>

Inherits QFrame.

List of all member functions.

Public Members

• enum ResizeMode { Stretch, KeepSize, FollowSizeHint, Auto }
• QSplitter ( QWidget * parent = 0, const char * name = 0 )
• QSplitter ( Orientation o, QWidget * parent = 0, const char * name = 0 )
• ~QSplitter ()
• virtual void setOrientation ( Orientation )
• Orientation orientation () const
• virtual void setResizeMode ( QWidget * w, ResizeMode mode )
• virtual void setOpaqueResize ( bool on = TRUE )
• bool opaqueResize () const
• void moveToFirst ( QWidget * w )
• void moveToLast ( QWidget * w )
• void refresh ()
• QValueList<int> sizes () const
• void setSizes ( QValueList<int> list )

Properties

• Orientation orientation - the orientation of the splitter

Protected Members

• virtual void childEvent ( QChildEvent * c )
• int idAfter ( QWidget * w ) const
• void moveSplitter ( QCOORD p, int id )
• virtual void drawSplitter ( QPainter * p, QCOORD x, QCOORD y, QCOORD w, QCOORD h )  (obsolete)
• int adjustPos ( int pos, int id )
• virtual void setRubberband ( int p )
• void getRange ( int id, int * min, int * max )

Related Functions

• QTextStream & operator<< ( QTextStream & ts, const QSplitter & splitter )
• QTextStream & operator>> ( QTextStream & ts, QSplitter & splitter )

Detailed Description

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.

To show a QListBox, a QListView and a QTextEdit side by side:

        QSplitter *split = new QSplitter( parent );
        QListBox *lb = new QListBox( split );
        QListView *lv = new QListView( split );
        QTextEdit *ed = new QTextEdit( split );
    

In QSplitter the boundary can be either horizontal or vertical. The default is horizontal (the children are side by side) but you can use setOrientation( QSplitter::Vertical ) to set it to vertical.

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. Use setResizeMode() to specify that a widget should keep its size when the splitter is resized, or set the stretch component of the sizePolicy.

Although QSplitter normally resizes the children only at the end of a resize operation, if you call setOpaqueResize( TRUE ) the widgets are resized as often as possible.

The initial distribution of size between the widgets is determined by the initial size of each widget. You can also use setSizes() to set the sizes of all the widgets. The function sizes() returns the sizes set by the user.

If you hide() a child its space will be distributed among the other children. It will be reinstated when you show() it again. It is also possible to reorder the widgets within the splitter using moveToFirst() and moveToLast().

See also QTabBar and Organizers.

Member Type Documentation

QSplitter::ResizeMode

This enum type describes how QSplitter will resize each of its child widgets.

• QSplitter::Auto - The widget will be resized according to the stretch factors set in its sizePolicy().
• QSplitter::Stretch - The widget will be resized when the splitter itself is resized.
• QSplitter::KeepSize - QSplitter will try to keep this widget's size unchanged.
• QSplitter::FollowSizeHint - QSplitter will resize the widget when the widget's size hint changes.

Member Function Documentation

QSplitter::QSplitter ( QWidget * parent = 0, const char * name = 0 )

QSplitter::QSplitter ( Orientation o, QWidget * parent = 0, const char * name = 0 )

QSplitter::~QSplitter ()

int QSplitter::adjustPos ( int pos, int id ) [protected]

See also idAfter().

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

Reimplemented from QObject.

void QSplitter::drawSplitter ( QPainter * p, QCOORD x, QCOORD y, QCOORD w, QCOORD h ) [virtual protected]

Draws the splitter handle in the rectangle described by x, y, w, h using painter p.

See also QStyle::drawPrimitive().

void QSplitter::getRange ( int id, int * min, int * max ) [protected]

See also idAfter().

int QSplitter::idAfter ( QWidget * w ) const [protected]

void QSplitter::moveSplitter ( QCOORD p, int id ) [protected]

For Arabic and Hebrew the layout is reversed, and using this function to set the position of the splitter might lead to unexpected results, since in Arabic and Hebrew the position of splitter one is to the left of the position of splitter zero.

See also idAfter().

void QSplitter::moveToFirst ( QWidget * w )

Example: splitter/splitter.cpp.

void QSplitter::moveToLast ( QWidget * w )

bool QSplitter::opaqueResize () const

See also setOpaqueResize().

Orientation QSplitter::orientation () const

Returns the orientation of the splitter. See the "orientation" property for details.

void QSplitter::refresh ()

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

void QSplitter::setOpaqueResize ( bool on = TRUE ) [virtual]

See also opaqueResize().

Example: splitter/splitter.cpp.

void QSplitter::setOrientation ( Orientation ) [virtual]

Sets the orientation of the splitter. See the "orientation" property for details.

void QSplitter::setResizeMode ( QWidget * w, ResizeMode mode ) [virtual]

Examples: fileiconview/mainwindow.cpp, listviews/listviews.cpp, and splitter/splitter.cpp.

void QSplitter::setRubberband ( int p ) [virtual protected]

void QSplitter::setSizes ( QValueList<int> list )

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

See also sizes().

QValueList<int> QSplitter::sizes () const

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

Note that if you want to iterate over the list, you should iterate over a copy, e.g.

    QValueList<int> list = mySplitter.sizes();
    QValueList<int>::Iterator it = list.begin();
    while( it != list.end() ) {
        myProcessing( *it );
        ++it;
    }
    

See also setSizes().

Property Documentation

Orientation orientation

This property holds the orientation of the splitter.

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

Set this property's value with setOrientation() and get this property's value with orientation().

Related Functions

QTextStream & operator<< ( QTextStream & ts, const QSplitter & splitter )

Writes the sizes and the hidden state of the widgets in the splitter splitter to the text stream ts.

See also operator>>(), sizes(), and QWidget::hidden.

QTextStream & operator>> ( QTextStream & ts, QSplitter & splitter )

Reads the sizes and the hidden state of the widgets in the splitter splitter from the text stream ts. The sizes must have been previously written by the operator<<() function.

See also operator<<(), setSizes(), and QWidget::hide().

This file is part of the Qt toolkit. Copyright © 1995-2003 Trolltech. All Rights Reserved.