/* SPDX-FileCopyrightText: 2011 Viranch Mehta SPDX-License-Identifier: GPL-2.0-or-later */ #include "qmenu.h" #include #include #include #include #include #include #include #include #include #include "plasma.h" QMenuProxy::QMenuProxy(QObject *parent) : QObject(parent) , m_menu(nullptr) , m_status(Closed) , m_placement(LeftPosedTopAlignedPopup) , m_preferSeamlessEdges(false) { if (qobject_cast(QCoreApplication::instance())) { m_menu = new QMenu(nullptr); // Breeze and Oxygen have rounded corners on menus. They set this attribute in polish() // but at that time the underlying surface has already been created where setting this // flag makes no difference anymore (Bug 385311) m_menu->setAttribute(Qt::WA_TranslucentBackground); KAcceleratorManager::manage(m_menu); connect(m_menu, &QMenu::triggered, this, &QMenuProxy::itemTriggered); connect(m_menu, &QMenu::aboutToHide, this, [this]() { m_status = Closed; Q_EMIT statusChanged(); }); } } QMenuProxy::~QMenuProxy() { delete m_menu; } QQmlListProperty QMenuProxy::content() { return QQmlListProperty(this, &m_items); } int QMenuProxy::actionCount() const { return m_items.count(); } QMenuItem *QMenuProxy::action(int index) const { return m_items.at(index); } QMenuProxy::Status QMenuProxy::status() const { return m_status; } QObject *QMenuProxy::visualParent() const { return m_visualParent.data(); } void QMenuProxy::setVisualParent(QObject *parent) { if (m_visualParent.data() == parent) { return; } // if the old parent was a QAction, disconnect the menu from it QAction *action = qobject_cast(m_visualParent.data()); if (action) { action->setMenu(nullptr); m_menu->clear(); } // if parent is a QAction, become a submenu action = qobject_cast(parent); if (action) { action->setMenu(m_menu); m_menu->clear(); for (QMenuItem *item : std::as_const(m_items)) { if (item->section()) { if (!item->isVisible()) { continue; } m_menu->addSection(item->text()); } else { m_menu->addAction(item->action()); } } m_menu->updateGeometry(); } m_visualParent = parent; Q_EMIT visualParentChanged(); } QWindow *QMenuProxy::transientParent() { if (!m_menu || !m_menu->windowHandle()) { return nullptr; } return m_menu->windowHandle()->transientParent(); } void QMenuProxy::setTransientParent(QWindow *parent) { if (!m_menu || !m_menu->windowHandle() || parent == m_menu->windowHandle()->transientParent()) { return; } m_menu->windowHandle()->setTransientParent(parent); Q_EMIT transientParentChanged(); } QMenuProxy::PopupPlacement QMenuProxy::placement() const { return m_placement; } void QMenuProxy::setPlacement(QMenuProxy::PopupPlacement placement) { if (m_placement != placement) { m_placement = placement; Q_EMIT placementChanged(); } } bool QMenuProxy::preferSeamlessEdges() const { return m_preferSeamlessEdges; } void QMenuProxy::setPreferSeamlessEdges(bool request) { if (m_preferSeamlessEdges != request) { m_preferSeamlessEdges = request; Q_EMIT preferSeamlessEdgesChanged(); } } int QMenuProxy::minimumWidth() const { return m_menu->minimumWidth(); } void QMenuProxy::setMinimumWidth(int width) { if (m_menu->minimumWidth() != width) { m_menu->setMinimumWidth(width); Q_EMIT minimumWidthChanged(); } } int QMenuProxy::maximumWidth() const { return m_menu->maximumWidth(); } void QMenuProxy::setMaximumWidth(int width) { if (m_menu->maximumWidth() != width) { m_menu->setMaximumWidth(width); Q_EMIT maximumWidthChanged(); } } void QMenuProxy::resetMaximumWidth() { setMaximumWidth(QWIDGETSIZE_MAX); } bool QMenuProxy::event(QEvent *event) { switch (event->type()) { case QEvent::ChildAdded: { QChildEvent *ce = static_cast(event); QMenuItem *mi = qobject_cast(ce->child()); // FIXME: linear complexity here if (mi && !m_items.contains(mi)) { if (mi->separator()) { m_menu->addSection(mi->text()); } else { m_menu->addAction(mi->action()); } m_items << mi; } break; } case QEvent::ChildRemoved: { QChildEvent *ce = static_cast(event); QMenuItem *mi = qobject_cast(ce->child()); // FIXME: linear complexity here if (mi) { m_menu->removeAction(mi->action()); m_items.removeAll(mi); } break; } default: break; } return QObject::event(event); } void QMenuProxy::clearMenuItems() { qDeleteAll(m_items); m_items.clear(); } void QMenuProxy::addMenuItem(const QString &text) { QMenuItem *item = new QMenuItem(); item->setText(text); m_menu->addAction(item->action()); m_items << item; } void QMenuProxy::addMenuItem(QMenuItem *item, QMenuItem *before) { if (before) { if (m_items.contains(item)) { m_menu->removeAction(item->action()); m_items.removeAll(item); } m_menu->insertAction(before->action(), item->action()); const int index = m_items.indexOf(before); if (index != -1) { m_items.insert(index, item); } else { m_items << item; } } else if (!m_items.contains(item)) { m_menu->addAction(item->action()); m_items << item; } connect(item, &QMenuItem::destroyed, this, [this, item]() { removeMenuItem(item); }); } void QMenuProxy::addSection(const QString &text) { m_menu->addSection(text); } void QMenuProxy::removeMenuItem(QMenuItem *item) { if (!item) { return; } m_menu->removeAction(item->action()); m_items.removeOne(item); } void QMenuProxy::itemTriggered(QAction *action) { for (int i = 0; i < m_items.count(); ++i) { QMenuItem *item = m_items.at(i); if (item->action() == action) { Q_EMIT triggered(item); Q_EMIT triggeredIndex(i); break; } } } void QMenuProxy::rebuildMenu() { m_menu->clear(); for (QMenuItem *item : std::as_const(m_items)) { if (item->section()) { if (!item->isVisible()) { continue; } m_menu->addSection(item->text()); } else { m_menu->addAction(item->action()); if (item->action()->menu()) { // This ensures existence of the QWindow m_menu->winId(); item->action()->menu()->winId(); item->action()->menu()->windowHandle()->setTransientParent(m_menu->windowHandle()); } } } m_menu->adjustSize(); } // Map to global coordinate space, accounting for embedded offscreen windows, e.g. QQuickWidget. static QPoint mapToGlobalUsingRenderWindowOfItem(const QQuickItem *parentItem, QPointF posF) { QPoint pos = posF.toPoint(); // XXX: Drop rounding if mapToGlobal ever supports floating points if (QQuickWindow *quickWindow = parentItem->window()) { QPoint offset; if (auto renderWindow = QQuickRenderControl::renderWindowFor(quickWindow, &offset)) { QPoint relativePos = pos + offset; return renderWindow->mapToGlobal(relativePos); } else { return quickWindow->mapToGlobal(pos); } } else { return pos; } } void QMenuProxy::open(int x, int y) { QQuickItem *parentItem = nullptr; if (m_visualParent) { parentItem = qobject_cast(m_visualParent.data()); } else { parentItem = qobject_cast(parent()); } if (!parentItem) { return; } rebuildMenu(); QPointF posLocal = parentItem->mapToScene(QPointF(x, y)); QPoint posGlobal = mapToGlobalUsingRenderWindowOfItem(parentItem, posLocal); setupSeamlessEdges(std::nullopt); openInternal(posGlobal); } void QMenuProxy::openRelative() { QQuickItem *parentItem = nullptr; if (m_visualParent) { parentItem = qobject_cast(m_visualParent.data()); } else { parentItem = qobject_cast(parent()); } if (!parentItem) { return; } rebuildMenu(); QPointF posLocal; QPoint posGlobal; auto boundaryCorrection = [this, &posLocal, &posGlobal, parentItem](int hDelta, int vDelta) { if (auto window = parentItem->window(); // QScreen *screen = window->screen()) { QRect geo = screen->geometry(); QPoint pos = mapToGlobalUsingRenderWindowOfItem(parentItem, posLocal); if (pos.x() < geo.x()) { pos.setX(pos.x() + hDelta); } if (pos.y() < geo.y()) { pos.setY(pos.y() + vDelta); } if (geo.x() + geo.width() < pos.x() + this->m_menu->width()) { pos.setX(pos.x() + hDelta); } if (geo.y() + geo.height() < pos.y() + this->m_menu->height()) { pos.setY(pos.y() + vDelta); } posGlobal = pos; } else { posGlobal = posLocal.toPoint(); } }; const QQmlProperty enabledProp(parentItem, QStringLiteral("LayoutMirroring.enabled"), qmlContext(parentItem)); const bool mirrored(enabledProp.read().toBool()); const auto placement = visualPopupPlacement(m_placement, mirrored ? Qt::RightToLeft : Qt::LeftToRight); using namespace Plasma; switch (placement) { case TopPosedLeftAlignedPopup: { posLocal = parentItem->mapToScene(QPointF(0, -m_menu->height())); boundaryCorrection(-m_menu->width() + parentItem->width(), m_menu->height() + parentItem->height()); break; } case LeftPosedTopAlignedPopup: { posLocal = parentItem->mapToScene(QPointF(-m_menu->width(), 0)); boundaryCorrection(m_menu->width() + parentItem->width(), -m_menu->height() + parentItem->height()); break; } case TopPosedRightAlignedPopup: posLocal = parentItem->mapToScene(QPointF(parentItem->width() - m_menu->width(), -m_menu->height())); boundaryCorrection(m_menu->width() - parentItem->width(), m_menu->height() + parentItem->height()); break; case RightPosedTopAlignedPopup: { posLocal = parentItem->mapToScene(QPointF(parentItem->width(), 0)); boundaryCorrection(-m_menu->width() - parentItem->width(), -m_menu->height() + parentItem->height()); break; } case LeftPosedBottomAlignedPopup: posLocal = parentItem->mapToScene(QPointF(-m_menu->width(), -m_menu->height() + parentItem->height())); boundaryCorrection(m_menu->width() + parentItem->width(), m_menu->height() - parentItem->height()); break; case BottomPosedLeftAlignedPopup: { posLocal = parentItem->mapToScene(QPointF(0, parentItem->height())); boundaryCorrection(-m_menu->width() + parentItem->width(), -m_menu->height() - parentItem->height()); break; } case BottomPosedRightAlignedPopup: { posLocal = parentItem->mapToScene(QPointF(parentItem->width() - m_menu->width(), parentItem->height())); boundaryCorrection(m_menu->width() - parentItem->width(), -m_menu->height() - parentItem->height()); break; } case RightPosedBottomAlignedPopup: { posLocal = parentItem->mapToScene(QPointF(parentItem->width(), -m_menu->height() + parentItem->height())); boundaryCorrection(-m_menu->width() - parentItem->width(), m_menu->height() - parentItem->height()); break; } default: open(); return; } setupSeamlessEdges(std::optional(placement)); openInternal(posGlobal); } void QMenuProxy::openInternal(QPoint pos) { QQuickItem *parentItem = this->parentItem(); if (parentItem && parentItem->window()) { // create the QWindow m_menu->winId(); m_menu->windowHandle()->setTransientParent(parentItem->window()); // Workaround for QTBUG-59044 // pre 5.8.0 QQuickWindow code is "item->grabMouse(); sendEvent(item, mouseEvent)" // post 5.8.0 QQuickWindow code is sendEvent(item, mouseEvent); item->grabMouse() QMetaObject::invokeMethod( this, [this]() { QQuickItem *parentItem = this->parentItem(); if (parentItem && parentItem->window() && parentItem->window()->mouseGrabberItem()) { parentItem->window()->mouseGrabberItem()->ungrabMouse(); } }, Qt::QueuedConnection); // end workaround } m_menu->popup(pos); m_status = Open; Q_EMIT statusChanged(); } QQuickItem *QMenuProxy::parentItem() const { if (m_visualParent) { return qobject_cast(m_visualParent.data()); } return qobject_cast(parent()); } void QMenuProxy::close() { m_menu->hide(); } QMenuProxy::PopupPlacement QMenuProxy::visualPopupPlacement(PopupPlacement placement, Qt::LayoutDirection layoutDirection) { const bool mirrored = (layoutDirection == Qt::LayoutDirectionAuto) ? qApp->isRightToLeft() : (layoutDirection == Qt::RightToLeft); if (!mirrored) { return placement; } switch (placement) { case TopPosedLeftAlignedPopup: return TopPosedRightAlignedPopup; case TopPosedRightAlignedPopup: return TopPosedLeftAlignedPopup; case LeftPosedTopAlignedPopup: return RightPosedTopAlignedPopup; case LeftPosedBottomAlignedPopup: return RightPosedBottomAlignedPopup; case BottomPosedLeftAlignedPopup: return BottomPosedRightAlignedPopup; case BottomPosedRightAlignedPopup: return BottomPosedLeftAlignedPopup; case RightPosedTopAlignedPopup: return LeftPosedTopAlignedPopup; case RightPosedBottomAlignedPopup: return LeftPosedBottomAlignedPopup; case FloatingPopup: default: return placement; } } Qt::Edges QMenuProxy::seamlessEdgesForPlacement(std::optional placement) { if (m_preferSeamlessEdges && placement.has_value()) { switch (placement.value()) { case TopPosedLeftAlignedPopup: case TopPosedRightAlignedPopup: return Qt::BottomEdge; case LeftPosedTopAlignedPopup: case LeftPosedBottomAlignedPopup: return Qt::RightEdge; case BottomPosedLeftAlignedPopup: case BottomPosedRightAlignedPopup: return Qt::TopEdge; case RightPosedTopAlignedPopup: case RightPosedBottomAlignedPopup: return Qt::LeftEdge; case FloatingPopup: default: break; } } return Qt::Edges(); } void QMenuProxy::setupSeamlessEdges(std::optional placement) { // Note: Assume that seamless edges don't affect size of the menu. auto edges = seamlessEdgesForPlacement(placement); m_menu->setProperty("_breeze_menu_seamless_edges", QVariant::fromValue(edges)); } #include "moc_qmenu.cpp"