src/gui/util/qsystemtrayicon_mac.mm
changeset 0 1918ee327afb
child 3 41300fa6a67c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/gui/util/qsystemtrayicon_mac.mm	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,556 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtGui module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/****************************************************************************
+**
+** Copyright (c) 2007-2008, Apple, Inc.
+**
+** All rights reserved.
+**
+** Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions are met:
+**
+**   * Redistributions of source code must retain the above copyright notice,
+**     this list of conditions and the following disclaimer.
+**
+**   * Redistributions in binary form must reproduce the above copyright notice,
+**     this list of conditions and the following disclaimer in the documentation
+**     and/or other materials provided with the distribution.
+**
+**   * Neither the name of Apple, Inc. nor the names of its contributors
+**     may be used to endorse or promote products derived from this software
+**     without specific prior written permission.
+**
+** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+** CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+** EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+** PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+** PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+** LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+** NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+**
+****************************************************************************/
+
+#define QT_MAC_SYSTEMTRAY_USE_GROWL
+
+@class QNSMenu;
+
+#include <private/qt_cocoa_helpers_mac_p.h>
+#include <private/qsystemtrayicon_p.h>
+#include <qtemporaryfile.h>
+#include <qimagewriter.h>
+#include <qapplication.h>
+#include <qdebug.h>
+#include <qstyle.h>
+
+#include <private/qt_mac_p.h>
+#import <AppKit/AppKit.h>
+
+QT_BEGIN_NAMESPACE
+extern bool qt_mac_execute_apple_script(const QString &script, AEDesc *ret); //qapplication_mac.cpp
+extern void qtsystray_sendActivated(QSystemTrayIcon *i, int r); //qsystemtrayicon.cpp
+extern NSString *keySequenceToKeyEqivalent(const QKeySequence &accel); // qmenu_mac.mm
+extern NSUInteger keySequenceModifierMask(const QKeySequence &accel);  // qmenu_mac.mm
+QT_END_NAMESPACE
+
+QT_USE_NAMESPACE
+
+@class QNSImageView;
+
+@interface QNSStatusItem : NSObject {
+    NSStatusItem *item;
+    QSystemTrayIcon *icon;
+    QSystemTrayIconPrivate *iconPrivate;
+    QNSImageView *imageCell;
+}
+-(id)initWithIcon:(QSystemTrayIcon*)icon iconPrivate:(QSystemTrayIconPrivate *)iprivate;
+-(void)dealloc;
+-(QSystemTrayIcon*)icon;
+-(NSStatusItem*)item;
+-(QRectF)geometry;
+- (void)triggerSelector:(id)sender;
+- (void)doubleClickSelector:(id)sender;
+@end
+
+@interface QNSImageView : NSImageView {
+    BOOL down;
+    QNSStatusItem *parent;
+}
+-(id)initWithParent:(QNSStatusItem*)myParent;
+-(QSystemTrayIcon*)icon;
+-(void)menuTrackingDone:(NSNotification*)notification;
+-(void)mousePressed:(NSEvent *)mouseEvent;
+@end
+
+
+#if MAC_OS_X_VERSION_MAX_ALLOWED <= MAC_OS_X_VERSION_10_5
+
+@protocol NSMenuDelegate <NSObject>
+-(void)menuNeedsUpdate:(NSMenu*)menu;
+@end
+#endif
+
+
+@interface QNSMenu : NSMenu <NSMenuDelegate> {
+    QMenu *qmenu;
+}
+-(QMenu*)menu;
+-(id)initWithQMenu:(QMenu*)qmenu;
+-(void)selectedAction:(id)item;
+@end
+
+QT_BEGIN_NAMESPACE
+class QSystemTrayIconSys
+{
+public:
+    QSystemTrayIconSys(QSystemTrayIcon *icon, QSystemTrayIconPrivate *d) {
+        QMacCocoaAutoReleasePool pool;
+        item = [[QNSStatusItem alloc] initWithIcon:icon iconPrivate:d];
+    }
+    ~QSystemTrayIconSys() {
+        QMacCocoaAutoReleasePool pool;
+        [[[item item] view] setHidden: YES];
+        [item release];
+    }
+    QNSStatusItem *item;
+};
+
+void QSystemTrayIconPrivate::install_sys()
+{
+    Q_Q(QSystemTrayIcon);
+    if (!sys) {
+        sys = new QSystemTrayIconSys(q, this);
+        updateIcon_sys();
+        updateMenu_sys();
+        updateToolTip_sys();
+    }
+}
+
+QRect QSystemTrayIconPrivate::geometry_sys() const
+{
+    if(sys) {
+        const QRectF geom = [sys->item geometry];
+        if(!geom.isNull())
+            return geom.toRect();
+    }
+    return QRect();
+}
+
+void QSystemTrayIconPrivate::remove_sys()
+{
+    delete sys;
+    sys = 0;
+}
+
+void QSystemTrayIconPrivate::updateIcon_sys()
+{
+    if(sys && !icon.isNull()) {
+        QMacCocoaAutoReleasePool pool;
+#ifndef QT_MAC_USE_COCOA
+        const short scale = GetMBarHeight()-4;
+#else
+        CGFloat hgt = [[[NSApplication sharedApplication] mainMenu] menuBarHeight];
+        const short scale = hgt - 4;
+#endif
+        NSImage *nsimage = static_cast<NSImage *>(qt_mac_create_nsimage(icon.pixmap(QSize(scale, scale))));
+        [(NSImageView*)[[sys->item item] view] setImage: nsimage];
+        [nsimage release];
+    }
+}
+
+void QSystemTrayIconPrivate::updateMenu_sys()
+{
+    if(sys) {
+        QMacCocoaAutoReleasePool pool;
+        if(menu && !menu->isEmpty()) {
+            [[sys->item item] setHighlightMode:YES];
+        } else {
+            [[sys->item item] setHighlightMode:NO];
+        }
+    }
+}
+
+void QSystemTrayIconPrivate::updateToolTip_sys()
+{
+    if(sys) {
+        QMacCocoaAutoReleasePool pool;
+        QCFString string(toolTip);
+        [[[sys->item item] view] setToolTip:(NSString*)static_cast<CFStringRef>(string)];
+    }
+}
+
+bool QSystemTrayIconPrivate::isSystemTrayAvailable_sys()
+{
+    return true;
+}
+
+void QSystemTrayIconPrivate::showMessage_sys(const QString &title, const QString &message, QSystemTrayIcon::MessageIcon icon, int)
+{
+
+    if(sys) {
+#ifdef QT_MAC_SYSTEMTRAY_USE_GROWL
+        // Make sure that we have Growl installed on the machine we are running on.
+        QCFType<CFURLRef> cfurl;
+        OSStatus status = LSGetApplicationForInfo(kLSUnknownType, kLSUnknownCreator,
+                                                  CFSTR("growlTicket"), kLSRolesAll, 0, &cfurl);
+        if (status == kLSApplicationNotFoundErr)
+            return;
+        QCFType<CFBundleRef> bundle = CFBundleCreate(0, cfurl);
+
+        if (CFStringCompare(CFBundleGetIdentifier(bundle), CFSTR("com.Growl.GrowlHelperApp"),
+                    kCFCompareCaseInsensitive |  kCFCompareBackwards) != kCFCompareEqualTo)
+            return;
+        QPixmap notificationIconPixmap;
+        if(icon == QSystemTrayIcon::Information)
+            notificationIconPixmap = QApplication::style()->standardPixmap(QStyle::SP_MessageBoxInformation);
+        else if(icon == QSystemTrayIcon::Warning)
+            notificationIconPixmap = QApplication::style()->standardPixmap(QStyle::SP_MessageBoxWarning);
+        else if(icon == QSystemTrayIcon::Critical)
+            notificationIconPixmap = QApplication::style()->standardPixmap(QStyle::SP_MessageBoxCritical);
+        QTemporaryFile notificationIconFile;
+        QString notificationType(QLatin1String("Notification")), notificationIcon, notificationApp(QApplication::applicationName());
+        if(notificationApp.isEmpty())
+            notificationApp = QLatin1String("Application");
+        if(!notificationIconPixmap.isNull() && notificationIconFile.open()) {
+            QImageWriter writer(&notificationIconFile, "PNG");
+            if(writer.write(notificationIconPixmap.toImage()))
+                notificationIcon = QLatin1String("image from location \"file://") + notificationIconFile.fileName() + QLatin1String("\"");
+        }
+        const QString script(QLatin1String(
+            "tell application \"GrowlHelperApp\"\n"
+            "-- Make a list of all the notification types (all)\n"
+            "set the allNotificationsList to {\"") + notificationType + QLatin1String("\"}\n"
+
+            "-- Make a list of the notifications (enabled)\n"
+            "set the enabledNotificationsList to {\"") + notificationType + QLatin1String("\"}\n"
+
+            "-- Register our script with growl.\n"
+            "register as application \"") + notificationApp + QLatin1String("\" all notifications allNotificationsList default notifications enabledNotificationsList\n"
+
+            "--	Send a Notification...\n") +
+            QLatin1String("notify with name \"") + notificationType +
+            QLatin1String("\" title \"") + title +
+            QLatin1String("\" description \"") + message +
+            QLatin1String("\" application name \"") + notificationApp +
+            QLatin1String("\" ")  + notificationIcon +
+            QLatin1String("\nend tell"));
+        qt_mac_execute_apple_script(script, 0);
+#elif 0
+        Q_Q(QSystemTrayIcon);
+        NSView *v = [[sys->item item] view];
+        NSWindow *w = [v window];
+        w = [[sys->item item] window];
+        qDebug() << w << v;
+        QPoint p(qRound([w frame].origin.x), qRound([w frame].origin.y));
+        qDebug() << p;
+        QBalloonTip::showBalloon(icon, message, title, q, QPoint(0, 0), msecs);
+#else
+        Q_UNUSED(icon);
+        Q_UNUSED(title);
+        Q_UNUSED(message);
+#endif
+    }
+}
+QT_END_NAMESPACE
+
+@implementation NSStatusItem (Qt)
+@end
+
+@implementation QNSImageView
+-(id)initWithParent:(QNSStatusItem*)myParent {
+    self = [super init];
+    parent = myParent;
+    down = NO;
+    return self;
+}
+
+-(QSystemTrayIcon*)icon {
+    return [parent icon];
+}
+
+-(void)menuTrackingDone:(NSNotification*)notification
+{
+    Q_UNUSED(notification);
+    down = NO;
+    if([self icon]->contextMenu())
+        [self icon]->contextMenu()->hide();
+    [self setNeedsDisplay:YES];
+}
+
+-(void)mousePressed:(NSEvent *)mouseEvent
+{
+    int clickCount = [mouseEvent clickCount];
+    down = !down;
+    if(!down && [self icon]->contextMenu())
+        [self icon]->contextMenu()->hide();
+    [self setNeedsDisplay:YES];
+
+    if (down)
+        [parent triggerSelector:self];
+    else if ((clickCount%2))
+        [parent doubleClickSelector:self];
+    while (down) {
+        mouseEvent = [[self window] nextEventMatchingMask:NSLeftMouseDownMask | NSLeftMouseUpMask
+                        | NSLeftMouseDraggedMask | NSRightMouseDownMask | NSRightMouseUpMask
+                        | NSRightMouseDraggedMask];
+        switch ([mouseEvent type]) {
+            case NSRightMouseDown:
+            case NSRightMouseUp:
+            case NSLeftMouseDown:
+            case NSLeftMouseUp:
+                [self menuTrackingDone:nil];
+                break;
+            case NSRightMouseDragged:
+            case NSLeftMouseDragged:
+            default:
+                /* Ignore any other kind of event. */
+                break;
+        }
+    };
+}
+
+-(void)mouseDown:(NSEvent *)mouseEvent
+{
+    [self mousePressed:mouseEvent];
+}
+
+- (void)rightMouseDown:(NSEvent *)mouseEvent
+{
+    [self mousePressed:mouseEvent];
+}
+
+
+-(void)drawRect:(NSRect)rect {
+    [[parent item] drawStatusBarBackgroundInRect:rect withHighlight:down];
+    [super drawRect:rect];
+}
+@end
+
+@implementation QNSStatusItem
+
+-(id)initWithIcon:(QSystemTrayIcon*)i iconPrivate:(QSystemTrayIconPrivate *)iPrivate
+{
+    self = [super init];
+    if(self) {
+        icon = i;
+        iconPrivate = iPrivate;
+        item = [[[NSStatusBar systemStatusBar] statusItemWithLength:NSSquareStatusItemLength] retain];
+        imageCell = [[QNSImageView alloc] initWithParent:self];
+        [item setView: imageCell];
+    }
+    return self;
+}
+-(void)dealloc {
+    [[NSStatusBar systemStatusBar] removeStatusItem:item];
+    [imageCell release];
+    [item release];
+    [super dealloc];
+
+}
+
+-(QSystemTrayIcon*)icon {
+    return icon;
+}
+
+-(NSStatusItem*)item {
+    return item;
+}
+-(QRectF)geometry {
+    if(NSWindow *window = [[item view] window]) {
+        NSRect screenRect = [[window screen] frame];
+        NSRect windowRect = [window frame];
+        return QRectF(windowRect.origin.x, screenRect.size.height-windowRect.origin.y-windowRect.size.height, windowRect.size.width, windowRect.size.height);
+    }
+    return QRectF();
+}
+- (void)triggerSelector:(id)sender {
+    Q_UNUSED(sender);
+    if(!icon)
+        return;
+    qtsystray_sendActivated(icon, QSystemTrayIcon::Trigger);
+    if (icon->contextMenu()) {
+#if 0
+        const QRectF geom = [self geometry];
+        if(!geom.isNull()) {
+            [[NSNotificationCenter defaultCenter] addObserver:imageCell
+                                                  selector:@selector(menuTrackingDone:)
+                                                  name:nil
+                                                  object:self];
+            icon->contextMenu()->exec(geom.topLeft().toPoint(), 0);
+            [imageCell menuTrackingDone:nil];
+        } else 
+#endif
+        {
+#ifndef QT_MAC_USE_COCOA
+            [[[self item] view] removeAllToolTips];
+            iconPrivate->updateToolTip_sys();
+#endif
+            NSMenu *m = [[QNSMenu alloc] initWithQMenu:icon->contextMenu()];
+            [m setAutoenablesItems: NO];
+            [[NSNotificationCenter defaultCenter] addObserver:imageCell
+                                                  selector:@selector(menuTrackingDone:)
+                                                  name:NSMenuDidEndTrackingNotification
+                                                  object:m];
+            [item popUpStatusItemMenu: m];
+            [m release];
+        }
+    }
+}
+- (void)doubleClickSelector:(id)sender {
+    Q_UNUSED(sender);
+    if(!icon)
+        return;
+    qtsystray_sendActivated(icon, QSystemTrayIcon::DoubleClick);
+}
+@end
+
+class QSystemTrayIconQMenu : public QMenu
+{
+public:
+    void doAboutToShow() { emit aboutToShow(); }
+private:
+    QSystemTrayIconQMenu();
+};
+
+@implementation QNSMenu
+-(id)initWithQMenu:(QMenu*)qm {
+    self = [super init];
+    if(self) {
+        self->qmenu = qm;
+        [self setDelegate:self];
+    }
+    return self;
+}
+-(QMenu*)menu {
+    return qmenu;
+}
+-(void)menuNeedsUpdate:(NSMenu*)nsmenu {
+    QNSMenu *menu = static_cast<QNSMenu *>(nsmenu);
+    emit static_cast<QSystemTrayIconQMenu*>(menu->qmenu)->doAboutToShow();
+    for(int i = [menu numberOfItems]-1; i >= 0; --i)
+        [menu removeItemAtIndex:i];
+    QList<QAction*> actions = menu->qmenu->actions();;
+    for(int i = 0; i < actions.size(); ++i) {
+        const QAction *action = actions[i];
+        if(!action->isVisible())
+            continue;
+
+        NSMenuItem *item = 0;
+        bool needRelease = false;
+        if(action->isSeparator()) {
+            item = [NSMenuItem separatorItem];
+        } else {
+            item = [[NSMenuItem alloc] init];
+            needRelease = true;
+            QString text = action->text();
+            QKeySequence accel = action->shortcut();
+            {
+                int st = text.lastIndexOf(QLatin1Char('\t'));
+                if(st != -1) {
+                    accel = QKeySequence(text.right(text.length()-(st+1)));
+                    text.remove(st, text.length()-st);
+                }
+            }
+            if(accel.count() > 1)
+                text += QLatin1String(" (****)"); //just to denote a multi stroke shortcut
+
+            [item setTitle:(NSString*)QCFString::toCFStringRef(qt_mac_removeMnemonics(text))];
+            [item setEnabled:menu->qmenu->isEnabled() && action->isEnabled()];
+            [item setState:action->isChecked() ? NSOnState : NSOffState];
+            [item setToolTip:(NSString*)QCFString::toCFStringRef(action->toolTip())];
+            const QIcon icon = action->icon();
+            if(!icon.isNull()) {
+                const short scale = [[NSApp mainMenu] menuBarHeight];
+                NSImage *nsimage = static_cast<NSImage *>(qt_mac_create_nsimage(icon.pixmap(QSize(scale, scale))));
+                [item setImage: nsimage];
+                [nsimage release];
+            }
+            if(action->menu()) {
+                QNSMenu *sub = [[QNSMenu alloc] initWithQMenu:action->menu()];
+                [item setSubmenu:sub];
+            } else {
+                [item setAction:@selector(selectedAction:)];
+                [item setTarget:self];
+            }
+            if(!accel.isEmpty()) {
+                [item setKeyEquivalent:keySequenceToKeyEqivalent(accel)];
+                [item setKeyEquivalentModifierMask:keySequenceModifierMask(accel)];
+            }
+        }
+        if(item)
+            [menu addItem:item];
+        if (needRelease)
+            [item release];
+    }
+}
+-(void)selectedAction:(id)a {
+    const int activated = [self indexOfItem:a];
+    QAction *action = 0;
+    QList<QAction*> actions = qmenu->actions();
+    for(int i = 0, cnt = 0; i < actions.size(); ++i) {
+        if(actions.at(i)->isVisible() && (cnt++) == activated) {
+            action = actions.at(i);
+            break;
+        }
+    }
+    if(action) {
+        action->activate(QAction::Trigger);
+    }
+}
+@end
+
+
+/* Done here because this is the only .mm for now! -Sam */
+QMacCocoaAutoReleasePool::QMacCocoaAutoReleasePool()
+{
+    NSApplicationLoad();
+    pool = (void*)[[NSAutoreleasePool alloc] init];
+}
+
+QMacCocoaAutoReleasePool::~QMacCocoaAutoReleasePool()
+{
+    [(NSAutoreleasePool*)pool release];
+}
+