1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtWidgets 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#import <AppKit/AppKit.h>
#include "qmaccocoaviewcontainer_mac.h"
#include <QtCore/QDebug>
#include <QtGui/QWindow>
#include <qpa/qplatformnativeinterface.h>
#include <private/qwidget_p.h>
#include <private/qwindow_p.h>
/*!
\class QMacCocoaViewContainer
\since 4.5
\brief The QMacCocoaViewContainer class provides a widget for \macos that can be used to wrap arbitrary
Cocoa views (i.e., NSView subclasses) and insert them into Qt hierarchies.
\ingroup advanced
\inmodule QtWidgets
While Qt offers a lot of classes for writing your application, Apple's
Cocoa frameworks offer functionality that is not currently available (or
may never end up) in Qt. Using QMacCocoaViewContainer, it is possible to take an
arbitrary NSView-derived class from Cocoa and put it in a Qt widgets hierarchy.
Depending on the level of integration you need, you can use QMacCocoaViewContainer
directly or subclass it to wrap more functionality of the underlying NSView.
It should be also noted that, at the Cocoa level, there is a difference
between top-level windows and views (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 window. The best way to ensure this is to make sure
QMacCocoaViewContainer's parent widget is not null.
If you are using QMacCocoaViewContainer as a subclass and are accessing Cocoa API,
it is probably simpler to have your file end with \tt{.mm} instead of \tt{.cpp}.
Most Apple tools will correctly identify the source as Objective-C++.
QMacCocoaViewContainer 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 showing how to subclass QMacCocoaViewContainer
to wrap an NSSearchField.
\code
SearchWidget::SearchWidget(QWidget *parent)
: QMacCocoaViewContainer(0, parent)
{
// Many Cocoa objects create temporary autorelease objects,
// so create a pool to catch them.
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
// Create the NSSearchField, set it on the QCocoaViewContainer.
NSSearchField *search = [[NSSearchField alloc] init];
setCocoaView(search);
// Use a Qt menu for the search field menu.
QMenu *qtMenu = createMenu(this);
NSMenu *nsMenu = qtMenu->macMenu(0);
[[search cell] setSearchMenuTemplate:nsMenu];
// Release our reference, since our super class takes ownership and we
// don't need it anymore.
[search release];
// Clean up our pool as we no longer need it.
[pool release];
}
\endcode
*/
QT_BEGIN_NAMESPACE
class QMacCocoaViewContainerPrivate : public QWidgetPrivate
{
Q_DECLARE_PUBLIC(QMacCocoaViewContainer)
public:
NSView *nsview;
QMacCocoaViewContainerPrivate();
~QMacCocoaViewContainerPrivate();
};
QMacCocoaViewContainerPrivate::QMacCocoaViewContainerPrivate()
: nsview(0)
{
}
QMacCocoaViewContainerPrivate::~QMacCocoaViewContainerPrivate()
{
[nsview release];
}
/*!
Create a new QMacCocoaViewContainer using the NSView pointer in
the \a view with parent, \a parent. QMacCocoaViewContainer will
retain the \a view.
*/
QMacCocoaViewContainer::QMacCocoaViewContainer(NSView *view, QWidget *parent)
: QWidget(*new QMacCocoaViewContainerPrivate, parent, 0)
{
// Ensures that we have a QWindow, even if we're not a top level widget
setAttribute(Qt::WA_NativeWindow);
setCocoaView(view);
}
/*!
Destroy the QMacCocoaViewContainer and release the wrapped view.
*/
QMacCocoaViewContainer::~QMacCocoaViewContainer()
{
}
/*!
Returns the NSView that has been set on this container.
*/
NSView *QMacCocoaViewContainer::cocoaView() const
{
Q_D(const QMacCocoaViewContainer);
return d->nsview;
}
/*!
Sets \a view as the NSView to contain and retains it. If this
container already had a view set, it will release the previously set view.
*/
void QMacCocoaViewContainer::setCocoaView(NSView *view)
{
Q_D(QMacCocoaViewContainer);
NSView *oldView = d->nsview;
[view retain];
d->nsview = view;
// Get rid of QWindow completely, and re-create a new vanilla one, which
// we will then re-configure to be a foreign window.
destroy();
create();
// Can't use QWindow::fromWinId() here due to QWidget controlling its
// QWindow, and can't use QWidget::createWindowContainer() due to the
// QMacCocoaViewContainer class being public API instead of a factory
// function.
QWindow *window = windowHandle();
window->destroy();
qt_window_private(window)->create(false, WId(view));
Q_ASSERT(window->handle());
[oldView release];
// The QWindow::destroy()) call above will explicitly hide this widget.
// Clear the hidden state here so it can be implicitly shown again.
setAttribute(Qt::WA_WState_Hidden, false);
}
QT_END_NAMESPACE
|
