WidgetMoverButton Class Reference

Description

Button to move a widget vertically in a layout.

With this button, the "move layer" feature in the layer oriented sample editor is realized (it is the button on each LayerForm).

When pressing the button, the parent layout of the widget is deactivated, and the widget is moved to the position where the pressed mouse cursor is moved. When the mouse is released, the layout is again activated and a signal finishedMoving() is emitted. Any reordering of the widgets in the layout then has to be handled outside - no reordering is done in here.

Definition at line 35 of file WidgetMoverButton.h.

Inheritance diagram for WidgetMoverButton:

Collaboration diagram for WidgetMoverButton:

Signals
void	finishedMoving (QWidget *widgetToMove, QWidget *moveAboveThisWidget)
void	startingToMove ()

Public Member Functions
	WidgetMoverButton (QWidget *parent, QWidget *widgetToMove, int ignoreOnTop=0)
	Create a widget mover button. More...

Protected Member Functions
void	mouseMoveEvent (QMouseEvent *event) override
void	mousePressEvent (QMouseEvent *event) override
void	mouseReleaseEvent (QMouseEvent *event) override

Private Member Functions
void	scrollParent (bool up)

Private Attributes
QMap< QWidget *, QPropertyAnimation * >	m_animations
QTimer	m_dragScrollTimer
QWidget *	m_dropAboveThisWidget
int	m_globalMouseDownY
QPoint	m_hotSpot
	The mouse-down coordinates in the widget to move. More...
int	m_ignoreOnTop
QLayout *	m_layoutToDeactivate = nullptr
int	m_originalWidgetY
QScrollArea *	m_scrollArea
bool	m_started = false
QWidget *	m_widgetToMove
int	m_yOfFirstRelevantWidget

Constructor & Destructor Documentation

WidgetMoverButton()

WidgetMoverButton::WidgetMoverButton	(	QWidget *	parent,
		QWidget *	widgetToMove,
		int	ignoreOnTop = 0
	)

Create a widget mover button.

If the widget shall not be able to be dragged on the top position, this can be defined by ignoreOnTop (the number of widgets at the top of the layout which shall not be affected by the reordering). In the case of the layer moving, the topmost Form (the sample properties) shall not be part of reordering.

Definition at line 23 of file WidgetMoverButton.cpp.

    : QToolButton(parent)
    , m_widgetToMove(widgetToMove)
    , m_dropAboveThisWidget(nullptr)
    , m_ignoreOnTop(ignoreOnTop)
    , m_scrollArea(nullptr)
{
    setIcon(QIcon(":/images/move_up_down.svg"));
    m_dragScrollTimer.setSingleShot(false);
}

References m_dragScrollTimer.

Member Function Documentation

finishedMoving

void WidgetMoverButton::finishedMoving ( QWidget *  widgetToMove, QWidget *  moveAboveThisWidget  )

signal

Referenced by LayerForm::LayerForm(), and mouseReleaseEvent().

mouseMoveEvent()

void WidgetMoverButton::mouseMoveEvent ( QMouseEvent *  event )

overrideprotected

Definition at line 67 of file WidgetMoverButton.cpp.

{
    int dy = event->globalY() - m_globalMouseDownY;
    if (abs(dy) > 5 && !m_started) {
        m_started = true;
 
        m_layoutToDeactivate = m_widgetToMove->parentWidget()->layout();
 
        m_yOfFirstRelevantWidget = m_layoutToDeactivate->itemAt(m_ignoreOnTop)->geometry().top();
        m_layoutToDeactivate->setEnabled(false);
        m_originalWidgetY = m_widgetToMove->y();
        m_widgetToMove->raise();
        emit startingToMove();
        m_widgetToMove->move(m_widgetToMove->x() + 5, m_widgetToMove->y());
        m_widgetToMove->resize(m_widgetToMove->width() - 10, m_widgetToMove->height());
    }
 
    if (m_started) {
        // -- move the dragged widget to the new position
        QPoint newPos =
            m_widgetToMove->parentWidget()->mapFromGlobal(event->globalPos()) - m_hotSpot;
        m_widgetToMove->move(m_widgetToMove->x(), newPos.y());
 
        // -- move other widgets to make room
        m_dropAboveThisWidget = nullptr;
        int yTopOfLayoutItem = m_yOfFirstRelevantWidget;
 
        for (int i = m_ignoreOnTop; i < m_layoutToDeactivate->count(); ++i) {
            auto* layoutItem = m_layoutToDeactivate->itemAt(i);
            if (layoutItem->widget() == m_widgetToMove)
                continue;
 
            const bool movedWidgetIsAboveThisLayoutItem =
                m_widgetToMove->y() < yTopOfLayoutItem + layoutItem->geometry().height() / 2;
            if (movedWidgetIsAboveThisLayoutItem && layoutItem->widget() != nullptr
                && m_dropAboveThisWidget == nullptr)
                m_dropAboveThisWidget = layoutItem->widget();
 
            QRect r = layoutItem->geometry();
            if (movedWidgetIsAboveThisLayoutItem)
                r.moveTop(yTopOfLayoutItem + m_widgetToMove->height()
                          + m_layoutToDeactivate->spacing());
            else
                r.moveTop(yTopOfLayoutItem);
 
            if (r != layoutItem->geometry()) {
                QWidget* w = layoutItem->widget();
                if (w == nullptr)
                    layoutItem->setGeometry(r);
                else if (!m_animations.contains(w)) {
                    auto* animation = new QPropertyAnimation(w, "geometry");
                    animation->setDuration(100);
                    animation->setEasingCurve(QEasingCurve::OutQuad);
                    animation->setStartValue(w->geometry());
                    animation->setEndValue(r);
                    animation->start();
                    m_animations[w] = animation;
                } else {
                    auto* animation = m_animations[w];
                    if (animation->endValue() != r) {
                        animation->stop();
                        animation->setStartValue(w->geometry());
                        animation->setEndValue(r);
                        animation->start();
                    }
                }
            }
 
            yTopOfLayoutItem += r.height() + m_layoutToDeactivate->spacing();
        }
 
        // -- check whether scrolling is necessary
        QPoint parPos = m_scrollArea->mapFromGlobal(mapToGlobal(event->pos()));
        if (parPos.y() < 20) {
            m_dragScrollTimer.setInterval(10);
            m_dragScrollTimer.disconnect();
            connect(&m_dragScrollTimer, &QTimer::timeout, [=]() { scrollParent(true); });
            m_dragScrollTimer.start();
        } else if (parPos.y() > m_scrollArea->height() - 20) {
            m_dragScrollTimer.setInterval(10);
            m_dragScrollTimer.disconnect();
            connect(&m_dragScrollTimer, &QTimer::timeout, [=]() { scrollParent(false); });
            m_dragScrollTimer.start();
        } else
            m_dragScrollTimer.stop();
    }
}

References m_animations, m_dragScrollTimer, m_dropAboveThisWidget, m_globalMouseDownY, m_hotSpot, m_ignoreOnTop, m_layoutToDeactivate, m_originalWidgetY, m_scrollArea, m_started, m_widgetToMove, m_yOfFirstRelevantWidget, scrollParent(), and startingToMove().

Here is the call graph for this function:

mousePressEvent()

void WidgetMoverButton::mousePressEvent ( QMouseEvent *  event )

overrideprotected

Definition at line 34 of file WidgetMoverButton.cpp.

{
    if (m_scrollArea == nullptr) {
        QWidget* p = parentWidget();
        do {
            m_scrollArea = dynamic_cast<QScrollArea*>(p);
            p = p->parentWidget();
        } while (p != nullptr && m_scrollArea == nullptr);
    }
 
    ASSERT(m_scrollArea);
    m_globalMouseDownY = event->globalY();
    m_hotSpot = event->globalPos()
                - m_widgetToMove->parentWidget()->mapToGlobal(m_widgetToMove->geometry().topLeft());
}

References m_globalMouseDownY, m_hotSpot, m_scrollArea, and m_widgetToMove.

mouseReleaseEvent()

void WidgetMoverButton::mouseReleaseEvent ( QMouseEvent *  event )

overrideprotected

Definition at line 50 of file WidgetMoverButton.cpp.

{
    if (!m_started)
        return;
 
    qDeleteAll(m_animations.values());
    m_animations.clear();
 
    m_dragScrollTimer.stop();
    m_started = false;
    if (m_layoutToDeactivate != nullptr) {
        m_layoutToDeactivate->setEnabled(true);
        m_layoutToDeactivate->update();
    }
    emit finishedMoving(m_widgetToMove, m_dropAboveThisWidget);
}

References finishedMoving(), m_animations, m_dragScrollTimer, m_dropAboveThisWidget, m_layoutToDeactivate, m_started, and m_widgetToMove.

scrollParent()

void WidgetMoverButton::scrollParent ( bool  up )

private

Definition at line 155 of file WidgetMoverButton.cpp.

{
    auto* scrollbar = m_scrollArea->verticalScrollBar();
    if (!scrollbar->isVisible())
        return;
 
    const int oldScrollValue = scrollbar->value();
    scrollbar->setValue(oldScrollValue + (up ? -5 : 5));
 
    // move the dragged widget to the new position to avoid jitter effects
    // use the real change of value, not +/-5: scrolling may have been unsuccessful
    m_widgetToMove->move(m_widgetToMove->x(),
                         m_widgetToMove->y() + scrollbar->value() - oldScrollValue);
}

References m_scrollArea, and m_widgetToMove.

Referenced by mouseMoveEvent().

startingToMove

void WidgetMoverButton::startingToMove ( )

signal

Referenced by LayerForm::LayerForm(), and mouseMoveEvent().

Member Data Documentation

m_animations

QMap<QWidget*, QPropertyAnimation*> WidgetMoverButton::m_animations

private

Definition at line 70 of file WidgetMoverButton.h.

Referenced by mouseMoveEvent(), and mouseReleaseEvent().

m_dragScrollTimer

QTimer WidgetMoverButton::m_dragScrollTimer

private

Definition at line 67 of file WidgetMoverButton.h.

Referenced by WidgetMoverButton(), mouseMoveEvent(), and mouseReleaseEvent().

m_dropAboveThisWidget

QWidget* WidgetMoverButton::m_dropAboveThisWidget

private

Definition at line 63 of file WidgetMoverButton.h.

Referenced by mouseMoveEvent(), and mouseReleaseEvent().

m_globalMouseDownY

int WidgetMoverButton::m_globalMouseDownY

private

Definition at line 60 of file WidgetMoverButton.h.

Referenced by mouseMoveEvent(), and mousePressEvent().

m_hotSpot

QPoint WidgetMoverButton::m_hotSpot

private

The mouse-down coordinates in the widget to move.

Definition at line 69 of file WidgetMoverButton.h.

Referenced by mouseMoveEvent(), and mousePressEvent().

m_ignoreOnTop

int WidgetMoverButton::m_ignoreOnTop

private

Definition at line 66 of file WidgetMoverButton.h.

Referenced by mouseMoveEvent().

m_layoutToDeactivate

QLayout* WidgetMoverButton::m_layoutToDeactivate = nullptr

private

Definition at line 61 of file WidgetMoverButton.h.

Referenced by mouseMoveEvent(), and mouseReleaseEvent().

m_originalWidgetY

int WidgetMoverButton::m_originalWidgetY

private

Definition at line 64 of file WidgetMoverButton.h.

Referenced by mouseMoveEvent().

m_scrollArea

QScrollArea* WidgetMoverButton::m_scrollArea

private

Definition at line 68 of file WidgetMoverButton.h.

Referenced by mouseMoveEvent(), mousePressEvent(), and scrollParent().

m_started

bool WidgetMoverButton::m_started = false

private

Definition at line 59 of file WidgetMoverButton.h.

Referenced by mouseMoveEvent(), and mouseReleaseEvent().

m_widgetToMove

QWidget* WidgetMoverButton::m_widgetToMove

private

Definition at line 62 of file WidgetMoverButton.h.

Referenced by mouseMoveEvent(), mousePressEvent(), mouseReleaseEvent(), and scrollParent().

m_yOfFirstRelevantWidget

int WidgetMoverButton::m_yOfFirstRelevantWidget

private

Definition at line 65 of file WidgetMoverButton.h.

Referenced by mouseMoveEvent().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/SampleDesigner/WidgetMoverButton.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/SampleDesigner/WidgetMoverButton.cpp