QSplitter 类

The QSplitter class implements a splitter widget. 更多...

头: #include <QSplitter>
继承: QFrame

特性

公共函数

QSplitter (QWidget * parent = 0)
QSplitter (Qt::Orientation orientation , QWidget * parent = 0)
~QSplitter ()
void addWidget (QWidget * widget )
bool childrenCollapsible () const
int count () const
void getRange (int index , int * min , int * max ) const
QSplitterHandle * handle (int index ) const
int handleWidth () const
int indexOf (QWidget * widget ) const
void insertWidget (int index , QWidget * widget )
bool isCollapsible (int index ) const
bool opaqueResize () const
Qt::Orientation orientation () const
void refresh ()
bool restoreState (const QByteArray & state )
QByteArray saveState () const
void setChildrenCollapsible (bool)
void setCollapsible (int index , bool collapse )
void setHandleWidth (int)
void setOpaqueResize (bool opaque = true)
void setOrientation (Qt::Orientation)
void setSizes (const QList<int> & list )
void setStretchFactor (int index , int stretch )
QList<int> sizes () const
QWidget * widget (int index ) const

重实现公共函数

virtual QSize minimumSizeHint () const
virtual QSize sizeHint () const

信号

void splitterMoved (int pos , int index )

保护函数

int closestLegalPosition (int pos , int index )
virtual QSplitterHandle * createHandle ()
void moveSplitter (int pos , int index )
void setRubberBand (int pos )

重实现保护函数

virtual void changeEvent (QEvent * ev )
virtual void childEvent (QChildEvent * c )
virtual bool event (QEvent * e )
virtual void resizeEvent (QResizeEvent *)

额外继承成员

详细描述

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

以下范例将展示 QListView , QTreeView ,和 QTextEdit 并排,采用 2 个分割器手柄:

    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 insertWidget () 或 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 (),和 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 使用 saveState () 和 restoreState () 分别。

When you hide () a child its space will be distributed among the other children. It will be reinstated when you show () 它再次。

另请参阅 QSplitterHandle , QHBoxLayout , QVBoxLayout ,和 QTabWidget .

特性文档编制

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

访问函数:

bool childrenCollapsible () const
void setChildrenCollapsible (bool)

另请参阅 setCollapsible ().

handleWidth : int

This property holds the width of the splitter handles.

默认情况下,此特性包含从属用户平台和样式首选项的值。

If you set handleWidth to 1, the actual grab area will grow to overlap a few pixels of it's respective widgets.

访问函数:

int handleWidth () const
void setHandleWidth (int)

opaqueResize : bool

This property holds whether resizing is opaque.

Opaque resizing is on by default.

访问函数:

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

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 .

访问函数:

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

另请参阅 QSplitterHandle::orientation ().

成员函数文档编制

QSplitter:: QSplitter ( QWidget * parent = 0)

构造水平分割器按 parent 自变量被传递给 QFrame 构造函数。

另请参阅 setOrientation ().

QSplitter:: QSplitter ( Qt::Orientation orientation , QWidget * parent = 0)

构造分割器采用给定 orientation and parent .

另请参阅 setOrientation ().

QSplitter:: ~QSplitter ()

销毁分割器。删除所有子级。

void QSplitter:: addWidget ( QWidget * widget )

添加给定 widget 到分割器布局在所有其它项之后。

widget 已在分割器中,将它移至新位置。

另请参阅 insertWidget (), widget (),和 indexOf ().

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

重实现自 QWidget::changeEvent ().

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

重实现自 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 () 或 addWidget (). This is for compatibility and not the recommended way of putting widgets into a splitter in new code. Please use insertWidget () 或 addWidget () in new code.

另请参阅 addWidget () 和 insertWidget ().

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

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.

另请参阅 getRange ().

int QSplitter:: count () const

返回分割器布局所包含的 Widget 数。

另请参阅 widget () 和 handle ().

[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.

另请参阅 handle () 和 indexOf ().

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

重实现自 QObject::event ().

void QSplitter:: getRange ( int index , int * min , int * max ) const

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

QSplitterHandle * QSplitter:: handle ( int index ) const

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 .

另请参阅 count (), widget (), indexOf (), createHandle (),和 setHandleWidth ().

int QSplitter:: indexOf ( QWidget * widget ) const

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.

另请参阅 count () 和 widget ().

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

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

widget 已在分割器中,将它移至新位置。

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

另请参阅 addWidget (), indexOf (),和 widget ().

bool QSplitter:: isCollapsible ( int index ) const

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

[虚拟] QSize QSplitter:: minimumSizeHint () const

重实现自 QWidget::minimumSizeHint ().

[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.

另请参阅 splitterMoved (), closestLegalPosition (),和 getRange ().

void QSplitter:: refresh ()

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

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

重实现自 QWidget::resizeEvent ().

bool QSplitter:: restoreState (const QByteArray & state )

将分割器布局还原成 state specified. Returns true if the state is restored; otherwise returns false.

通常,这用于结合 QSettings 从过去的会话还原尺寸。这里是范例:

Restore the splitters's state:

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

所提供的字节数组中的数据,无效或过期可能导致无法还原分割器布局。

另请参阅 saveState ().

QByteArray QSplitter:: saveState () const

保存分割器布局的状态。

通常,这用于结合 QSettings 以记住用于未来会议的尺寸。版本号作为数据的一部分被存储。这里是范例:

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

另请参阅 restoreState ().

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

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 () 或 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 特性。

另请参阅 isCollapsible () 和 childrenCollapsible .

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

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

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

另请参阅 sizes ().

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);
					

另请参阅 setSizes () 和 widget ().

[虚拟] QSize QSplitter:: sizeHint () const

重实现自 QWidget::sizeHint ().

QList < int > QSplitter:: sizes () const

返回此分割器所有 Widget 尺寸的参数列表。

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.

将值赋予另一分割器的 setSizes () 函数将产生如此具有相同布局的分割器。

注意:不可见 Widget 拥有 0 尺寸。

另请参阅 setSizes ().

[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.

另请参阅 moveSplitter ().

QWidget * QSplitter:: widget ( int index ) const

返回 Widget 在给定 index in the splitter's layout.

另请参阅 count (), handle (), indexOf (),和 insertWidget ().