Add QtMacCocoaViewContainer.

QtMacCocoaViewContainer supports embedding a native
NSView in a QWidget hierarchy.

The embedding itself is implemented in the Cocoa platform
plugin in the QPlatformWindow layer, and is accessed
via the "setcontentview" platform function.

Change-Id: I43a189952ce31da4e39da6442a4a19ad15e497a3
Reviewed-by: Jake Petroules <jake.petroules@petroules.com>
Reviewed-by: Gabriel de Dietrich <gabriel.dedietrich@digia.com>

6 files changed, 321 insertions, 1 deletions

diff --git a/examples/examples.pro b/examples/examples.pro
index 6ec6651..d3ff936 100644
--- a/examples/examples.pro
+++ b/examples/examples.pro
@@ -3,5 +3,5 @@ SUBDIRS = embeddedqwindow \
           macfunctions \
           macpasteboardmime	\
           macunifiedtoolbar	\
+          qtmaccocoaviewcontainer \
           qtmacnativewidget \
-          
\ No newline at end of file
diff --git a/examples/qtmaccocoaviewcontainer/main.mm b/examples/qtmaccocoaviewcontainer/main.mm
new file mode 100644
index 0000000..691b9ea
--- /dev/null
+++ b/examples/qtmaccocoaviewcontainer/main.mm
@@ -0,0 +1,67 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtMacExtras module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** 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, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QtWidgets>
+#include <Cocoa/Cocoa.h>
+#include <QtMacCocoaViewContainer>
+
+class WindowWidget : public QWidget
+{
+public:
+    WindowWidget()
+    {
+        QtMacCocoaViewContainer *cocoaViewContainer = new QtMacCocoaViewContainer(0, this);
+        cocoaViewContainer->move(100, 100);
+        cocoaViewContainer->resize(300, 300);
+        NSTextView *text = [[NSTextView alloc] initWithFrame : NSMakeRect(0, 0, 300, 300)];
+        cocoaViewContainer->setCocoaView(text);
+    }
+};
+
+int main(int argc, char *argv[])
+{
+    QApplication app(argc, argv);
+
+    WindowWidget widget;
+    widget.show();
+
+    return app.exec();
+}
diff --git a/examples/qtmaccocoaviewcontainer/qtmacococaviewcontainer.pro b/examples/qtmaccocoaviewcontainer/qtmacococaviewcontainer.pro
new file mode 100644
index 0000000..47b5de1
--- /dev/null
+++ b/examples/qtmaccocoaviewcontainer/qtmacococaviewcontainer.pro
@@ -0,0 +1,7 @@
+TEMPLATE = app
+
+OBJECTIVE_SOURCES += main.mm
+LIBS += -framework Cocoa
+
+QT += gui widgets macextras
+
diff --git a/src/macextras/macextras-lib.pri b/src/macextras/macextras-lib.pri
index 87fcf91..cdc5fb4 100644
--- a/src/macextras/macextras-lib.pri
+++ b/src/macextras/macextras-lib.pri
@@ -3,6 +3,7 @@ INCLUDEPATH += $$PWD
 PUBLIC_HEADERS += \
     $$PWD/qtmacfunctions.h \
     $$PWD/qtmacnativewidget.h \
+    $$PWD/qtmaccocoaviewcontainer.h \
     $$PWD/qtmactoolbutton.h \
     $$PWD/qtmacunifiedtoolbar.h
 
@@ -14,6 +15,7 @@ macx:!ios {
     OBJECTIVE_SOURCES += \
         $$PWD/qtmacfunctions.mm \
         $$PWD/qtmacnativewidget.mm \
+        $$PWD/qtmaccocoaviewcontainer.mm \
         $$PWD/qtmactoolbardelegate.mm \
         $$PWD/qtmactoolbutton.mm \
         $$PWD/qtmacunifiedtoolbar.mm \
diff --git a/src/macextras/qtmaccocoaviewcontainer.h b/src/macextras/qtmaccocoaviewcontainer.h
new file mode 100644
index 0000000..7b259a8
--- /dev/null
+++ b/src/macextras/qtmaccocoaviewcontainer.h
@@ -0,0 +1,78 @@
+/****************************************************************************
+ **
+ ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
+ ** Contact: http://www.qt-project.org/legal
+ **
+ ** This file is part of the QtMacExtras module the Qt Toolkit.
+ **
+ ** $QT_BEGIN_LICENSE:LGPL$
+ ** Commercial License Usage
+ ** Licensees holding valid commercial Qt licenses may use this file in
+ ** accordance with the commercial license agreement provided with the
+ ** Software or, alternatively, in accordance with the terms contained in
+ ** a written agreement between you and Digia.  For licensing terms and
+ ** conditions see http://qt.digia.com/licensing.  For further information
+ ** use the contact form at http://qt.digia.com/contact-us.
+ **
+ ** 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, Digia gives you certain additional
+ ** rights.  These rights are described in the Digia Qt LGPL Exception
+ ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+ **
+ ** GNU General Public License Usage
+ ** Alternatively, this file may be used under the terms of the GNU
+ ** General Public License version 3.0 as published by the Free Software
+ ** Foundation and appearing in the file LICENSE.GPL included in the
+ ** packaging of this file.  Please review the following information to
+ ** ensure the GNU General Public License version 3.0 requirements will be
+ ** met: http://www.gnu.org/copyleft/gpl.html.
+ **
+ **
+ ** $QT_END_LICENSE$
+ **
+ ****************************************************************************/
+#ifndef QTMACCOCOAVIEWCONTAINER_H
+#define QTMACCOCOAVIEWCONTAINER_H
+
+#include "qmacextrasglobal.h"
+
+#include <QtWidgets/QWidget>
+
+QT_BEGIN_HEADER
+
+QT_BEGIN_NAMESPACE
+
+#ifdef __OBJC__
+@class NSView;
+#else
+typedef struct objc_object NSView;
+#endif
+
+class QtMacCocoaViewContainerPrivate;
+class Q_MACEXTRAS_EXPORT QtMacCocoaViewContainer : public QWidget
+{
+    Q_OBJECT
+public:
+    QtMacCocoaViewContainer(NSView *cocoaViewToWrap, QWidget *parent = 0);
+    virtual ~QtMacCocoaViewContainer();
+
+    void setCocoaView(NSView *virew);
+    NSView *cocoaView() const;
+
+private:
+    QtMacCocoaViewContainerPrivate *d;
+};
+
+QT_END_NAMESPACE
+
+QT_END_HEADER
+
+#endif // QTMACCOCOAVIEWCONTAINER_H
+
diff --git a/src/macextras/qtmaccocoaviewcontainer.mm b/src/macextras/qtmaccocoaviewcontainer.mm
new file mode 100644
index 0000000..9721e25
--- /dev/null
+++ b/src/macextras/qtmaccocoaviewcontainer.mm
@@ -0,0 +1,166 @@
+/****************************************************************************
+ **
+ ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
+ ** Contact: http://www.qt-project.org/legal
+ **
+ ** This file is part of thee QtMacExtras module of the Qt Toolkit.
+ **
+ ** $QT_BEGIN_LICENSE:LGPL$
+ ** Commercial License Usage
+ ** Licensees holding valid commercial Qt licenses may use this file in
+ ** accordance with the commercial license agreement provided with the
+ ** Software or, alternatively, in accordance with the terms contained in
+ ** a written agreement between you and Digia.  For licensing terms and
+ ** conditions see http://qt.digia.com/licensing.  For further information
+ ** use the contact form at http://qt.digia.com/contact-us.
+ **
+ ** 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, Digia gives you certain additional
+ ** rights.  These rights are described in the Digia Qt LGPL Exception
+ ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+ **
+ ** GNU General Public License Usage
+ ** Alternatively, this file may be used under the terms of the GNU
+ ** General Public License version 3.0 as published by the Free Software
+ ** Foundation and appearing in the file LICENSE.GPL included in the
+ ** packaging of this file.  Please review the following information to
+ ** ensure the GNU General Public License version 3.0 requirements will be
+ ** met: http://www.gnu.org/copyleft/gpl.html.
+ **
+ **
+ ** $QT_END_LICENSE$
+ **
+ ****************************************************************************/
+
+#import <Cocoa/Cocoa.h>
+
+#include "qtmaccocoaviewcontainer.h"
+
+#include <qpa/qplatformnativeinterface.h>
+#include <QtGui/QWindow>
+
+/*!
+    \class QtMacCocoaViewContainer
+
+    \brief The QtMacCocoaViewContainer class provides a widget for Mac OS X that can be used to wrap arbitrary
+    Cocoa views (i.e., NSView subclasses) and insert them into Qt hierarchies.
+
+    \ingroup advanced
+
+    While Qt offers a lot of classes for writing your application, Apple's
+    Cocoa framework offers lots of functionality that is not currently in Qt or
+    may never end up in Qt. Using QtMacCocoaViewContainer, it is possible to put an
+    arbitrary NSView-derived class from Cocoa and put it in a Qt hierarchy.
+    Depending on how comfortable you are with using objective-C, you can use
+    QtMacCocoaViewContainer directly, or subclass it to wrap further functionality
+    of the underlying NSView.
+
+    It should be also noted that at the low level on Mac OS X, there is a
+    difference between windows (top-levels) and view (widgets that are inside a
+    window). For this reason, make sure that the NSView that you are wrapping
+    doesn't end up as a top-level. The best way to ensure this is to make sure
+    you always have a parent and not set the parent to 0.
+
+    If you are using QtMacCocoaViewContainer as a sub-class and are mixing and
+    matching objective-C with C++ (a.k.a. objective-C++). It is probably
+    simpler to have your file end with \tt{.mm} than \tt{.cpp}. Most Apple tools will
+    correctly identify the source as objective-C++.
+
+    QtMacCocoaViewContainer requires knowledge of how Cocoa works, especially in
+    regard to its reference counting (retain/release) nature. It is noted in
+    the functions below if there is any change in the reference count. Cocoa
+    views often generate temporary objects that are released by an autorelease
+    pool. If this is done outside of a running event loop, it is up to the
+    developer to provide the autorelease pool.
+
+    The following is a snippet of subclassing QtMacCocoaViewContainer to wrap a NSSearchField.
+    \snippet demos/macmainwindow/macmainwindow.mm 0
+
+*/
+
+QT_BEGIN_NAMESPACE
+
+class QtMacCocoaViewContainerPrivate
+{
+public:
+    NSView *nsview;
+    QtMacCocoaViewContainerPrivate();
+    ~QtMacCocoaViewContainerPrivate();
+};
+
+QtMacCocoaViewContainerPrivate::QtMacCocoaViewContainerPrivate()
+     : nsview(0)
+{
+}
+
+QtMacCocoaViewContainerPrivate::~QtMacCocoaViewContainerPrivate()
+{
+    [nsview release];
+}
+
+/*!
+    \fn QtMacCocoaViewContainer::QtMacCocoaViewContainer(NSView *cocoaViewToWrap, QWidget *parent)
+
+    Create a new QtMacCocoaViewContainer using the NSView pointer in \a
+    cocoaViewToWrap with parent, \a parent. QtMacCocoaViewContainer will
+    retain \a cocoaViewToWrap.
+
+*/
+QtMacCocoaViewContainer::QtMacCocoaViewContainer(NSView *view, QWidget *parent)
+   : QWidget(parent, 0)
+   , d(new QtMacCocoaViewContainerPrivate)
+{
+
+    if (view)
+        setCocoaView(view);
+
+    // QtMacCocoaViewContainer requires a native window handle.
+    setAttribute(Qt::WA_NativeWindow);
+}
+
+/*!
+    Destroy the QtMacCocoaViewContainer and release the wrapped view.
+*/
+QtMacCocoaViewContainer::~QtMacCocoaViewContainer()
+{
+    delete d;
+}
+
+/*!
+    Returns the NSView that has been set on this container.
+*/
+NSView *QtMacCocoaViewContainer::cocoaView() const
+{
+    return d->nsview;
+}
+
+/*!
+    Sets the NSView to contain to be \a cocoaViewToWrap and retains it. If this
+    container already had a view set, it will release the previously set view.
+*/
+void QtMacCocoaViewContainer::setCocoaView(NSView *view)
+{
+    NSView *oldView = d->nsview;
+    [view retain];
+    d->nsview = view;
+
+    // Create window and platformwindow
+    winId();
+    QPlatformWindow *platformWindow = this->windowHandle()->handle();
+
+    // Set the new view as the content view for the window.
+    extern QPlatformNativeInterface::NativeResourceForIntegrationFunction resolvePlatformFunction(const QByteArray &functionName);
+    typedef void (*SetWindowContentViewFunction)(QPlatformWindow *window, void *nsview);
+    reinterpret_cast<SetWindowContentViewFunction>(resolvePlatformFunction("setwindowcontentview"))(platformWindow, view);
+
+    [oldView release];
+}
+
+QT_END_NAMESPACE