QSplitterHandle Class Reference

#include <qsplitter.h>

Inheritance diagram for QSplitterHandle:

[legend]Collaboration diagram for QSplitterHandle:

[legend]List of all members.

---

Detailed Description

The QSplitterHandle class provides handle functionality of the splitter.

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 then reimplement QSplitter::createHandle() to instantiate the custom splitter handle. For example, a minimum QSplitter subclass might look like this:

snippets/splitterhandle/splitter.h class Splitter : public QSplitter /^;/

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

snippets/splitterhandle/splitter.cpp createHandle() /^/

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:

snippets/splitterhandle/splitter.cpp paintEvent /^/

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

Definition at line 138 of file qsplitter.h.

Public Member Functions
	QSplitterHandle (Qt::Orientation o, QSplitter *parent)
void	setOrientation (Qt::Orientation o)
Qt::Orientation	orientation () const
bool	opaqueResize () const
QSplitter *	splitter () const
QSize	sizeHint () const
Protected Member Functions
void	paintEvent (QPaintEvent *)
void	mouseMoveEvent (QMouseEvent *)
void	mousePressEvent (QMouseEvent *)
void	mouseReleaseEvent (QMouseEvent *)
bool	event (QEvent *)
void	moveSplitter (int p)
int	closestLegalPosition (int p)

---

Constructor & Destructor Documentation

QSplitterHandle::QSplitterHandle	(	Qt::Orientation	orientation,
		QSplitter *	parent
	)

Creates a QSplitter handle with the given orientation and QSplitter parent.

Definition at line 102 of file qsplitter.cpp.

References d, QObject::parent(), and setOrientation().

    : QWidget(*new QSplitterHandlePrivate, parent, 0)
{
    Q_D(QSplitterHandle);
    d->s = parent;
    d->hover = false;
    setOrientation(orientation);
}

Here is the call graph for this function:

---

Member Function Documentation

void QSplitterHandle::setOrientation

(

Qt::Orientation

orientation

)

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

See also:

QSplitter::setOrientation()

Definition at line 117 of file qsplitter.cpp.

References d, Qt::Horizontal, QWidget::setCursor(), Qt::SplitHCursor, and Qt::SplitVCursor.

Referenced by QSplitterHandle().

{
    Q_D(QSplitterHandle);
    d->orient = orientation;
#ifndef QT_NO_CURSOR
    setCursor(orientation == Qt::Horizontal ? Qt::SplitHCursor : Qt::SplitVCursor);
#endif
}

Here is the call graph for this function:

Qt::Orientation QSplitterHandle::orientation

(

)

const

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

See also:

QSplitter::orientation()

Definition at line 131 of file qsplitter.cpp.

References d.

Referenced by paintEvent().

{
    Q_D(const QSplitterHandle);
    return d->orient;
}

bool QSplitterHandle::opaqueResize

(

)

const

Returns true if widgets are resized dynamically (opaquely), otherwise returns false. This value is controlled by the QSplitter.

See also:

QSplitter::opaqueResize()

Definition at line 145 of file qsplitter.cpp.

References d.

Referenced by mouseMoveEvent(), and mouseReleaseEvent().

{
    Q_D(const QSplitterHandle);
    return d->s->opaqueResize();
}

QSplitter * QSplitterHandle::splitter

(

)

const

Returns the splitter associated with this splitter handle.

See also:

QSplitter::handle()

Definition at line 157 of file qsplitter.cpp.

{
    return d_func()->s;
}

QSize QSplitterHandle::sizeHint

(

)

const [virtual]

Reimplemented from QWidget.

Definition at line 202 of file qsplitter.cpp.

References QStyle::CT_Splitter, d, QSize::expandedTo(), QApplication::globalStrut(), QStyleOption::init(), QWidget::parentWidget(), QStyle::sizeFromContents(), QStyleOption::state, QStyle::State_None, and QWidget::style().

Referenced by QSplitterLayoutStruct::getHandleSize().

{
    Q_D(const QSplitterHandle);
    int hw = d->s->handleWidth();
    QStyleOption opt(0);
    opt.init(d->s);
    opt.state = QStyle::State_None;
    return parentWidget()->style()->sizeFromContents(QStyle::CT_Splitter, &opt, QSize(hw, hw), d->s)
        .expandedTo(QApplication::globalStrut());
}

Here is the call graph for this function:

void QSplitterHandle::paintEvent

(

QPaintEvent *

)

[protected, virtual]

Reimplemented from QWidget.

Definition at line 278 of file qsplitter.cpp.

References QStyle::CE_Splitter, d, QStyle::drawControl(), Qt::Horizontal, QWidget::isEnabled(), orientation(), p, QWidget::palette(), QStyleOption::palette, QWidget::parentWidget(), QStyleOption::rect, QWidget::rect(), QStyleOption::state, QStyle::State_Enabled, QStyle::State_Horizontal, QStyle::State_MouseOver, QStyle::State_None, and QWidget::style().

{
    Q_D(QSplitterHandle);
    QPainter p(this);
    QStyleOption opt(0);
    opt.rect = rect();
    opt.palette = palette();
    if (orientation() == Qt::Horizontal)
        opt.state = QStyle::State_Horizontal;
    else
        opt.state = QStyle::State_None;
    if (d->hover)
        opt.state |= QStyle::State_MouseOver;
    if (isEnabled())
        opt.state |= QStyle::State_Enabled;
    parentWidget()->style()->drawControl(QStyle::CE_Splitter, &opt, &p, d->s);
}

Here is the call graph for this function:

void QSplitterHandle::mouseMoveEvent

(

QMouseEvent *

e

)

[protected, virtual]

Reimplemented from QWidget.

Definition at line 237 of file qsplitter.cpp.

References QMouseEvent::buttons(), closestLegalPosition(), d, QMouseEvent::globalPos(), Qt::LeftButton, QWidget::mapFromGlobal(), moveSplitter(), opaqueResize(), QWidget::parentWidget(), and QWidget::pos().

{
    Q_D(QSplitterHandle);
    if (!(e->buttons() & Qt::LeftButton))
        return;
    int pos = d->pick(parentWidget()->mapFromGlobal(e->globalPos()))
                 - d->mouseOffset;
    if (opaqueResize()) {
        moveSplitter(pos);
    } else {
        d->s->setRubberBand(closestLegalPosition(pos));
    }
}

Here is the call graph for this function:

void QSplitterHandle::mousePressEvent

(

QMouseEvent *

e

)

[protected, virtual]

Reimplemented from QWidget.

Definition at line 254 of file qsplitter.cpp.

References QMouseEvent::button(), d, Qt::LeftButton, and QMouseEvent::pos().

{
    Q_D(QSplitterHandle);
    if (e->button() == Qt::LeftButton)
        d->mouseOffset = d->pick(e->pos());
}

Here is the call graph for this function:

void QSplitterHandle::mouseReleaseEvent

(

QMouseEvent *

e

)

[protected, virtual]

Reimplemented from QWidget.

Definition at line 264 of file qsplitter.cpp.

References QMouseEvent::button(), d, QMouseEvent::globalPos(), Qt::LeftButton, QWidget::mapFromGlobal(), moveSplitter(), opaqueResize(), QWidget::parentWidget(), and QWidget::pos().

{
    Q_D(QSplitterHandle);
    if (!opaqueResize() && e->button() == Qt::LeftButton) {
        int pos = d->pick(parentWidget()->mapFromGlobal(e->globalPos()))
                     - d->mouseOffset;
        d->s->setRubberBand(-1);
        moveSplitter(pos);
    }
}

Here is the call graph for this function:

bool QSplitterHandle::event

(

QEvent *

event

)

[protected, virtual]

Reimplemented from QWidget.

Definition at line 216 of file qsplitter.cpp.

References d, QWidget::event(), QEvent::HoverEnter, QEvent::HoverLeave, and QWidget::update().

{
    Q_D(QSplitterHandle);
    switch(event->type()) {
    case QEvent::HoverEnter:
        d->hover = true;
        update();
        break;
    case QEvent::HoverLeave:
        d->hover = false;
        update();
        break;
    default:
        break;
    }
    return QWidget::event(event);
}

Here is the call graph for this function:

void QSplitterHandle::moveSplitter

(

int

pos

)

[protected]

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 QSplitter::moveSplitter().

See also:

QSplitter::moveSplitter() closestLegalPosition()

Definition at line 172 of file qsplitter.cpp.

References d, and Qt::Horizontal.

Referenced by mouseMoveEvent(), and mouseReleaseEvent().

{
    Q_D(QSplitterHandle);
    if (d->s->isRightToLeft() && d->orient == Qt::Horizontal)
        pos = d->s->contentsRect().width() - pos;
    d->s->moveSplitter(pos, d->s->indexOf(this));
}

int QSplitterHandle::closestLegalPosition

(

int

pos

)

[protected]

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.

See also:

QSplitter::closestLegalPosition(), moveSplitter()

Definition at line 188 of file qsplitter.cpp.

References d, Qt::Horizontal, s, and w.

Referenced by mouseMoveEvent().

{
    Q_D(QSplitterHandle);
    QSplitter *s = d->s;
    if (s->isRightToLeft() && d->orient == Qt::Horizontal) {
        int w = s->contentsRect().width();
        return w - s->closestLegalPosition(w - pos, s->indexOf(this));
    }
    return s->closestLegalPosition(pos, s->indexOf(this));
}

---

The documentation for this class was generated from the following files:

• src/gui/widgets/qsplitter.h
• src/gui/widgets/qsplitter.cpp

---