KoToolBoxScrollArea Class Reference

#include <KoToolBoxScrollArea_p.h>

Inheritance diagram for KoToolBoxScrollArea:

Public Slots
void	slotScrollerStateChange (QScroller::State state)

Public Member Functions
	KoToolBoxScrollArea (KoToolBox *toolBox, QWidget *parent)
QSize	minimumSizeHint () const override
Qt::Orientation	orientation () const
void	setOrientation (Qt::Orientation orientation)
QSize	sizeHint () const override

Protected Member Functions
bool	event (QEvent *event) override
bool	eventFilter (QObject *watched, QEvent *event) override
void	resizeEvent (QResizeEvent *event) override
void	scrollContentsBy (int dx, int dy) override
void	wheelEvent (QWheelEvent *event) override

Private Slots
void	doScrollNext ()
void	doScrollPrev ()

Private Member Functions
void	layoutItems ()
int	scrollButtonWidth () const
void	updateScrollButtons ()

Private Attributes
Qt::Orientation	m_orientation
QToolButton *	m_scrollNext
QToolButton *	m_scrollPrev
KoToolBox *	m_toolBox

Detailed Description

Definition at line 20 of file KoToolBoxScrollArea_p.h.

Constructor & Destructor Documentation

KoToolBoxScrollArea()

KoToolBoxScrollArea::KoToolBoxScrollArea ( KoToolBox * toolBox, QWidget * parent )

inline

Definition at line 24 of file KoToolBoxScrollArea_p.h.

        : QScrollArea(parent)
        , m_toolBox(toolBox)
        , m_orientation(Qt::Vertical)
        , m_scrollPrev(new QToolButton(this))
        , m_scrollNext(new QToolButton(this))
    {
        setFrameShape(QFrame::NoFrame);
        setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
        setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
 
        m_toolBox->setOrientation(m_orientation);
        setWidget(m_toolBox);
 
        m_scrollPrev->setAutoRepeat(true);
        m_scrollPrev->setAutoFillBackground(true);
        m_scrollPrev->setFocusPolicy(Qt::NoFocus);
        connect(m_scrollPrev, &QToolButton::clicked, this, &KoToolBoxScrollArea::doScrollPrev);
        m_scrollNext->setAutoRepeat(true);
        m_scrollNext->setAutoFillBackground(true);
        m_scrollNext->setFocusPolicy(Qt::NoFocus);
        connect(m_scrollNext, &QToolButton::clicked, this, &KoToolBoxScrollArea::doScrollNext);
        // These are for filtering the mouse wheel events:
        m_scrollPrev->installEventFilter(this);
        m_scrollNext->installEventFilter(this);
 
        QScroller *scroller = KisKineticScroller::createPreconfiguredScroller(this);
        if (!scroller) {
            QScroller::grabGesture(viewport(), QScroller::MiddleMouseButtonGesture);
            scroller = QScroller::scroller(viewport());
            QScrollerProperties sp = scroller->scrollerProperties();
 
            sp.setScrollMetric(QScrollerProperties::MaximumVelocity, 0.0);
            sp.setScrollMetric(QScrollerProperties::OvershootDragResistanceFactor, 0.1);
            sp.setScrollMetric(QScrollerProperties::OvershootDragDistanceFactor, 0.1);
            sp.setScrollMetric(QScrollerProperties::OvershootScrollDistanceFactor, 0.0);
            sp.setScrollMetric(QScrollerProperties::OvershootScrollTime, 0.4);
 
            scroller->setScrollerProperties(sp);
        }
        connect(scroller, SIGNAL(stateChanged(QScroller::State)), this, SLOT(slotScrollerStateChange(QScroller::State)));
    }

References connect(), KisKineticScroller::createPreconfiguredScroller(), doScrollNext(), doScrollPrev(), m_orientation, m_scrollNext, m_scrollPrev, m_toolBox, KoToolBox::setOrientation(), and slotScrollerStateChange().

Member Function Documentation

doScrollNext

void KoToolBoxScrollArea::doScrollNext ( )

inlineprivateslot

Definition at line 149 of file KoToolBoxScrollArea_p.h.

    {
        if (m_orientation == Qt::Vertical) {
            verticalScrollBar()->triggerAction(QAbstractSlider::SliderSingleStepAdd);
        } else {
            horizontalScrollBar()->triggerAction(QAbstractSlider::SliderSingleStepAdd);
        }
    }

References m_orientation.

doScrollPrev

void KoToolBoxScrollArea::doScrollPrev ( )

inlineprivateslot

Definition at line 140 of file KoToolBoxScrollArea_p.h.

    {
        if (m_orientation == Qt::Vertical) {
            verticalScrollBar()->triggerAction(QAbstractSlider::SliderSingleStepSub);
        } else {
            horizontalScrollBar()->triggerAction(QAbstractSlider::SliderSingleStepSub);
        }
    }

References m_orientation.

event()

bool KoToolBoxScrollArea::event ( QEvent * event )

inlineoverrideprotected

Definition at line 96 of file KoToolBoxScrollArea_p.h.

    {
        if (event->type() == QEvent::LayoutRequest) {
            // LayoutRequest can be triggered by icon changes, so resize the toolbox
            layoutItems();
            // The toolbox might have changed the sizeHint and minimumSizeHint
            updateGeometry();
        }
        return QScrollArea::event(event);
    }

References event(), and layoutItems().

eventFilter()

bool KoToolBoxScrollArea::eventFilter ( QObject * watched, QEvent * event )

inlineoverrideprotected

Definition at line 107 of file KoToolBoxScrollArea_p.h.

    {
        // The toolbuttons eat the wheel events, so we filter them for our use.
        if ((watched == m_scrollPrev || watched == m_scrollNext) && event->type() == QEvent::Wheel) {
            wheelEvent(static_cast<QWheelEvent *>(event));
            return true;
        }
        return QScrollArea::eventFilter(watched, event);
    }

References event(), m_scrollNext, m_scrollPrev, and wheelEvent().

layoutItems()

void KoToolBoxScrollArea::layoutItems ( )

inlineprivate

Definition at line 166 of file KoToolBoxScrollArea_p.h.

    {
        const KoToolBoxLayout *l = m_toolBox->toolBoxLayout();
        QSize newSize = viewport()->size();
        if (m_orientation == Qt::Vertical) {
            newSize.setHeight(l->heightForWidth(newSize.width()));
        } else {
            newSize.setWidth(l->widthForHeight(newSize.height()));
        }
        m_toolBox->resize(newSize);
 
        updateScrollButtons();
    }

References KoToolBoxLayout::heightForWidth(), m_orientation, m_toolBox, KoToolBox::toolBoxLayout(), updateScrollButtons(), and KoToolBoxLayout::widthForHeight().

minimumSizeHint()

QSize KoToolBoxScrollArea::minimumSizeHint ( ) const

inlineoverride

Definition at line 82 of file KoToolBoxScrollArea_p.h.

    {
        return m_toolBox->minimumSizeHint();
    }

References m_toolBox.

orientation()

Qt::Orientation KoToolBoxScrollArea::orientation ( ) const

inline

Definition at line 77 of file KoToolBoxScrollArea_p.h.

    {
        return m_orientation;
    }

References m_orientation.

resizeEvent()

void KoToolBoxScrollArea::resizeEvent ( QResizeEvent * event )

inlineoverrideprotected

Definition at line 117 of file KoToolBoxScrollArea_p.h.

    {
        layoutItems();
        QScrollArea::resizeEvent(event);
        updateScrollButtons();
    }

References event(), layoutItems(), and updateScrollButtons().

scrollButtonWidth()

int KoToolBoxScrollArea::scrollButtonWidth ( ) const

inlineprivate

Definition at line 159 of file KoToolBoxScrollArea_p.h.

    {
        QStyleOption opt;
        opt.initFrom(this);
        return style()->pixelMetric(QStyle::PM_TabBarScrollButtonWidth, &opt, this);
    }

scrollContentsBy()

void KoToolBoxScrollArea::scrollContentsBy ( int dx, int dy )

inlineoverrideprotected

Definition at line 133 of file KoToolBoxScrollArea_p.h.

    {
        QScrollArea::scrollContentsBy(dx, dy);
        updateScrollButtons();
    }

References updateScrollButtons().

setOrientation()

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

inline

Definition at line 67 of file KoToolBoxScrollArea_p.h.

    {
        if (orientation == m_orientation) {
            return;
        }
        m_orientation = orientation;
        m_toolBox->setOrientation(orientation);
        layoutItems();
    }

References layoutItems(), m_orientation, m_toolBox, orientation(), and KoToolBox::setOrientation().

sizeHint()

QSize KoToolBoxScrollArea::sizeHint ( ) const

inlineoverride

Definition at line 87 of file KoToolBoxScrollArea_p.h.

    {
        return m_toolBox->sizeHint();
    }

References m_toolBox.

slotScrollerStateChange

void KoToolBoxScrollArea::slotScrollerStateChange ( QScroller::State state )

inlineslot

Definition at line 93 of file KoToolBoxScrollArea_p.h.

{ KisKineticScroller::updateCursor(this, state); }

References KisKineticScroller::updateCursor().

updateScrollButtons()

void KoToolBoxScrollArea::updateScrollButtons ( )

inlineprivate

Definition at line 180 of file KoToolBoxScrollArea_p.h.

    {
        // We move the scroll buttons outside the widget rect instead of setting
        // the visibility, because setting the visibility triggers a relayout
        // of QAbstractScrollArea, which occasionally causes an offset bug when
        // QScroller performs the overshoot animation. (Overshoot is done by
        // moving the viewport widget, but the viewport position is reset during
        // a relayout.)
        const int scrollButtonWidth = this->scrollButtonWidth();
        const QScrollBar *scrollbar = m_orientation == Qt::Vertical ? verticalScrollBar() : horizontalScrollBar();
        const bool canPrev = scrollbar->value() != scrollbar->minimum();
        const bool canNext = scrollbar->value() != scrollbar->maximum();
        m_scrollPrev->setEnabled(canPrev);
        m_scrollNext->setEnabled(canNext);
        if (m_orientation == Qt::Vertical) {
            m_scrollPrev->setArrowType(Qt::UpArrow);
            m_scrollPrev->setGeometry(canPrev ? 0 : -width(), 0, width(), scrollButtonWidth);
            m_scrollNext->setArrowType(Qt::DownArrow);
            m_scrollNext->setGeometry(canNext? 0 : -width(), height() - scrollButtonWidth, width(), scrollButtonWidth);
        } else if (isLeftToRight()) {
            m_scrollPrev->setArrowType(Qt::LeftArrow);
            m_scrollPrev->setGeometry(0, canPrev ? 0 : -height(), scrollButtonWidth, height());
            m_scrollNext->setArrowType(Qt::RightArrow);
            m_scrollNext->setGeometry(width() - scrollButtonWidth, canNext ? 0 : -height(), scrollButtonWidth, height());
        } else {
            // Right-to-left is mirrored.
            m_scrollPrev->setArrowType(Qt::RightArrow);
            m_scrollPrev->setGeometry(width() - scrollButtonWidth, canPrev ? 0 : -height(), scrollButtonWidth, height());
            m_scrollNext->setArrowType(Qt::LeftArrow);
            m_scrollNext->setGeometry(0, canNext ? 0 : -height(), scrollButtonWidth, height());
        }
    }

References m_orientation, m_scrollNext, m_scrollPrev, and scrollButtonWidth().

wheelEvent()

void KoToolBoxScrollArea::wheelEvent ( QWheelEvent * event )

inlineoverrideprotected

Definition at line 124 of file KoToolBoxScrollArea_p.h.

    {
        if (m_orientation == Qt::Vertical) {
            QApplication::sendEvent(verticalScrollBar(), event);
        } else {
            QApplication::sendEvent(horizontalScrollBar(), event);
        }
    }

References event(), and m_orientation.

Member Data Documentation

m_orientation

Qt::Orientation KoToolBoxScrollArea::m_orientation

private

Definition at line 214 of file KoToolBoxScrollArea_p.h.

m_scrollNext

QToolButton* KoToolBoxScrollArea::m_scrollNext

private

Definition at line 217 of file KoToolBoxScrollArea_p.h.

m_scrollPrev

QToolButton* KoToolBoxScrollArea::m_scrollPrev

private

Definition at line 216 of file KoToolBoxScrollArea_p.h.

m_toolBox

KoToolBox* KoToolBoxScrollArea::m_toolBox

private

Definition at line 213 of file KoToolBoxScrollArea_p.h.

---

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

• libs/ui/toolbox/KoToolBoxScrollArea_p.h