Revision control
Copy as Markdown
// Copyright (C) 2016 The Qt Company Ltd.
// Copyright (C) 2012 Klaralvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Christoph Schleifenbaum <christoph.schleifenbaum@kdab.com>
// Copyright (c) 2007-2008, Apple, Inc.
// SPDX-License-Identifier: BSD-3-Clause
// Qt-Security score:significant reason:default
#include <AppKit/AppKit.h>
#include "qcocoasystemtrayicon.h"
#ifndef QT_NO_SYSTEMTRAYICON
#include <qtemporaryfile.h>
#include <qimagewriter.h>
#include <qdebug.h>
#include <QtCore/private/qcore_mac_p.h>
#include "qcocoamenu.h"
#include "qcocoansmenu.h"
#include "qcocoahelpers.h"
#include "qcocoaintegration.h"
#include "qcocoascreen.h"
#include <QtGui/private/qcoregraphics_p.h>
// NSUserNotification was deprecated in macOS 11.
// We should be using UserNotifications.framework instead.
// See QTBUG-110998 for more information.
#define NSUserNotificationCenter QT_IGNORE_DEPRECATIONS(NSUserNotificationCenter)
#define NSUserNotification QT_IGNORE_DEPRECATIONS(NSUserNotification)
QT_BEGIN_NAMESPACE
void QCocoaSystemTrayIcon::init()
{
m_statusItem = [[NSStatusBar.systemStatusBar statusItemWithLength:NSSquareStatusItemLength] retain];
m_delegate = [[QStatusItemDelegate alloc] initWithSysTray:this];
// In case the status item does not have a menu assigned to it
// we fall back to the item's button to detect activation.
m_statusItem.button.target = m_delegate;
m_statusItem.button.action = @selector(statusItemClicked);
[m_statusItem.button sendActionOn:NSEventMaskLeftMouseDown | NSEventMaskRightMouseDown | NSEventMaskOtherMouseDown];
}
void QCocoaSystemTrayIcon::cleanup()
{
NSUserNotificationCenter *center = NSUserNotificationCenter.defaultUserNotificationCenter;
if (center.delegate == m_delegate)
center.delegate = nil;
[NSStatusBar.systemStatusBar removeStatusItem:m_statusItem];
[m_statusItem release];
m_statusItem = nil;
[m_delegate release];
m_delegate = nil;
}
QRect QCocoaSystemTrayIcon::geometry() const
{
if (!m_statusItem)
return QRect();
if (NSWindow *window = m_statusItem.button.window) {
if (QCocoaScreen *screen = QCocoaScreen::get(window.screen))
return screen->mapFromNative(window.frame).toRect();
}
return QRect();
}
static bool heightCompareFunction (QSize a, QSize b) { return (a.height() < b.height()); }
static QList<QSize> sortByHeight(const QList<QSize> &sizes)
{
QList<QSize> sorted = sizes;
std::sort(sorted.begin(), sorted.end(), heightCompareFunction);
return sorted;
}
void QCocoaSystemTrayIcon::updateIcon(const QIcon &icon)
{
if (!m_statusItem)
return;
if (auto *image = [NSImage internalImageFromQIcon:icon]) {
// The icon is backed by QAppleIconEngine, in which case we
// want to pass on the underlying NSImage instead of flattening
// to a QImage. This preserves the isTemplate property of the
// image, and allows AppKit to size and configure the icon for
// the status bar. We also enable NSVariableStatusItemLength,
// to match the behavior of SwiftUI's MenuBarExtra.
m_statusItem.button.image = [[image copy] autorelease];
m_statusItem.button.imageScaling = NSImageScaleProportionallyDown;
m_statusItem.length = NSVariableStatusItemLength;
return;
}
// The recommended maximum title bar icon height is 18 points
// (device independent pixels). The menu height on past and
// current OS X versions is 22 points. Provide some future-proofing
// by deriving the icon height from the menu height.
const int padding = 4;
const int menuHeight = NSStatusBar.systemStatusBar.thickness;
const int maxImageHeight = menuHeight - padding;
// Select pixmap based on the device pixel height. Ideally we would use
// the devicePixelRatio of the target screen, but that value is not
// known until draw time. Use qApp->devicePixelRatio, which returns the
// devicePixelRatio for the "best" screen on the system.
qreal devicePixelRatio = qApp->devicePixelRatio();
const int maxPixmapHeight = maxImageHeight * devicePixelRatio;
QSize selectedSize;
for (const QSize& size : sortByHeight(icon.availableSizes())) {
// Select a pixmap based on the height. We want the largest pixmap
// with a height smaller or equal to maxPixmapHeight. The pixmap
// may rectangular; assume it has a reasonable size. If there is
// not suitable pixmap use the smallest one the icon can provide.
if (size.height() <= maxPixmapHeight) {
selectedSize = size;
} else {
if (!selectedSize.isValid())
selectedSize = size;
break;
}
}
// Handle SVG icons, which do not return anything for availableSizes().
if (!selectedSize.isValid())
selectedSize = icon.actualSize(QSize(maxPixmapHeight, maxPixmapHeight));
QPixmap pixmap = icon.pixmap(selectedSize);
// Draw a low-resolution icon if there is not enough pixels for a retina
// icon. This prevents showing a small icon on retina displays.
if (devicePixelRatio > 1.0 && selectedSize.height() < maxPixmapHeight / 2)
devicePixelRatio = 1.0;
// Scale large pixmaps to fit the available menu bar area.
if (pixmap.height() > maxPixmapHeight)
pixmap = pixmap.scaledToHeight(maxPixmapHeight, Qt::SmoothTransformation);
// The icon will be stretched over the full height of the menu bar
// therefore we create a second pixmap which has the full height
QSize fullHeightSize(!pixmap.isNull() ? pixmap.width():
menuHeight * devicePixelRatio,
menuHeight * devicePixelRatio);
QPixmap fullHeightPixmap(fullHeightSize);
fullHeightPixmap.fill(Qt::transparent);
if (!pixmap.isNull()) {
QPainter p(&fullHeightPixmap);
QRect r = pixmap.rect();
r.moveCenter(fullHeightPixmap.rect().center());
p.drawPixmap(r, pixmap);
}
fullHeightPixmap.setDevicePixelRatio(devicePixelRatio);
auto *nsimage = [NSImage imageFromQImage:fullHeightPixmap.toImage()];
[nsimage setTemplate:icon.isMask()];
m_statusItem.button.image = nsimage;
m_statusItem.button.imageScaling = NSImageScaleProportionallyDown;
}
void QCocoaSystemTrayIcon::updateMenu(QPlatformMenu *menu)
{
auto *nsMenu = menu ? static_cast<QCocoaMenu *>(menu)->nsMenu() : nil;
if (m_statusItem.menu == nsMenu)
return;
if (m_statusItem.menu) {
[NSNotificationCenter.defaultCenter removeObserver:m_delegate
name:NSMenuDidBeginTrackingNotification
object:m_statusItem.menu
];
}
m_statusItem.menu = nsMenu;
if (m_statusItem.menu) {
// When a menu is assigned, NSStatusBarButtonCell will intercept the mouse
// down to pop up the menu, and we never see the NSStatusBarButton action.
// To ensure we emit the 'activated' signal in both cases we detect when
// menu starts tracking, which happens before the menu delegate is sent
// the menuWillOpen callback we use to emit aboutToShow for the menu.
[NSNotificationCenter.defaultCenter addObserver:m_delegate
selector:@selector(statusItemMenuBeganTracking:)
name:NSMenuDidBeginTrackingNotification
object:m_statusItem.menu
];
}
}
void QCocoaSystemTrayIcon::updateToolTip(const QString &toolTip)
{
if (!m_statusItem)
return;
m_statusItem.button.toolTip = toolTip.toNSString();
}
bool QCocoaSystemTrayIcon::isSystemTrayAvailable() const
{
return true;
}
bool QCocoaSystemTrayIcon::supportsMessages() const
{
return true;
}
void QCocoaSystemTrayIcon::showMessage(const QString &title, const QString &message,
const QIcon& icon, MessageIcon, int msecs)
{
if (!m_statusItem)
return;
auto *notification = [[NSUserNotification alloc] init];
notification.title = title.toNSString();
notification.informativeText = message.toNSString();
// Request a size that looks good on the highest resolution screen available
// for icon engines that don't have an intrinsic size (like SVG).
auto image = icon.pixmap(QSize(64, 64), qGuiApp->devicePixelRatio()).toImage();
// The assigned image is scaled by the system to fit into the tile,
// but without taking aspect ratio into account, so let's pad the
// image up front if it's not already square.
image = qt_mac_padToSquareImage(image);
notification.contentImage = [NSImage imageFromQImage:image];
NSUserNotificationCenter *center = NSUserNotificationCenter.defaultUserNotificationCenter;
center.delegate = m_delegate;
[center deliverNotification:[notification autorelease]];
if (msecs) {
NSTimeInterval timeout = msecs / 1000.0;
[center performSelector:@selector(removeDeliveredNotification:) withObject:notification afterDelay:timeout];
}
}
void QCocoaSystemTrayIcon::emitActivated()
{
// NSControls are driven by gesture recognizers in macOS 27,
// which means NSApp.currentEvent may not be a mouse event
// at the point when we receive the status bar button's
// action callback. This is a quick fix to avoid crashing.
if (!qt_mac_isMouseEvent(NSApp.currentEvent)) {
emit activated(QPlatformSystemTrayIcon::Unknown);
return;
}
auto *mouseEvent = NSApp.currentEvent;
auto activationReason = QPlatformSystemTrayIcon::Unknown;
if (mouseEvent.clickCount == 2) {
activationReason = QPlatformSystemTrayIcon::DoubleClick;
} else {
auto mouseButton = cocoaButton2QtButton(mouseEvent);
if (mouseButton == Qt::MiddleButton)
activationReason = QPlatformSystemTrayIcon::MiddleClick;
else if (mouseButton == Qt::RightButton)
activationReason = QPlatformSystemTrayIcon::Context;
else
activationReason = QPlatformSystemTrayIcon::Trigger;
}
emit activated(activationReason);
}
QT_END_NAMESPACE
@implementation QStatusItemDelegate
- (instancetype)initWithSysTray:(QCocoaSystemTrayIcon *)platformSystemTray
{
if ((self = [super init]))
self.platformSystemTray = platformSystemTray;
return self;
}
- (void)dealloc
{
self.platformSystemTray = nullptr;
[super dealloc];
}
- (void)statusItemClicked
{
self.platformSystemTray->emitActivated();
}
- (void)statusItemMenuBeganTracking:(NSNotification*)notification
{
self.platformSystemTray->emitActivated();
}
- (BOOL)userNotificationCenter:(NSUserNotificationCenter *)center shouldPresentNotification:(NSUserNotification *)notification
{
Q_UNUSED(center);
Q_UNUSED(notification);
return YES;
}
- (void)userNotificationCenter:(NSUserNotificationCenter *)center didActivateNotification:(NSUserNotification *)notification
{
[center removeDeliveredNotification:notification];
emit self.platformSystemTray->messageClicked();
}
@end
#endif // QT_NO_SYSTEMTRAYICON