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
|
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the QtGui module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** 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.
**
** 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.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#import <Cocoa/Cocoa.h>
#include <private/qwidget_p.h>
#include "qmaccocoaviewcontainer_mac.h"
#include <private/qt_mac_p.h>
/*!
\class QMacCocoaViewContainer
\since 4.5
\brief The QMacCocoaViewContainer 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
\inmodule QtWidgets
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 QMacCocoaViewContainer, 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
QMacCocoaViewContainer directly, or subclass it to wrap further functionality
of the underlying NSView.
QMacCocoaViewContainer works regardless if Qt is built against Carbon or
Cocoa. However, QCocoaContainerView requires Mac OS X 10.5 or better to be
used with Carbon.
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 QMacCocoaViewContainer 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++.
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 of subclassing QMacCocoaViewContainer to wrap a NSSearchField.
\snippet examples/mainwindows/macmainwindow/macmainwindow.mm 0
*/
QT_BEGIN_NAMESPACE
class QMacCocoaViewContainerPrivate : public QWidgetPrivate
{
Q_DECLARE_PUBLIC(QMacCocoaViewContainer)
public:
NSView *nsview;
QMacCocoaViewContainerPrivate();
~QMacCocoaViewContainerPrivate();
};
QMacCocoaViewContainerPrivate::QMacCocoaViewContainerPrivate()
: nsview(0)
{
}
QMacCocoaViewContainerPrivate::~QMacCocoaViewContainerPrivate()
{
[nsview release];
}
/*!
\fn QMacCocoaViewContainer::QMacCocoaViewContainer(void *cocoaViewToWrap, QWidget *parent)
Create a new QMacCocoaViewContainer using the NSView pointer in \a
cocoaViewToWrap with parent, \a parent. QMacCocoaViewContainer will
retain \a cocoaViewToWrap.
\a cocoaViewToWrap is a void pointer that allows the header to be included
with C++ source.
*/
QMacCocoaViewContainer::QMacCocoaViewContainer(void *cocoaViewToWrap, QWidget *parent)
: QWidget(*new QMacCocoaViewContainerPrivate, parent, 0)
{
if (cocoaViewToWrap)
setCocoaView(cocoaViewToWrap);
}
/*!
Destroy the QMacCocoaViewContainer and release the wrapped view.
*/
QMacCocoaViewContainer::~QMacCocoaViewContainer()
{
}
/*!
Returns the NSView that has been set on this container. The returned view
has been autoreleased, so you will need to retain it if you want to make
use of it.
*/
void *QMacCocoaViewContainer::cocoaView() const
{
Q_D(const QMacCocoaViewContainer);
return [[d->nsview retain] autorelease];
}
/*!
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 QMacCocoaViewContainer::setCocoaView(void *cocoaViewToWrap)
{
Q_D(QMacCocoaViewContainer);
QMacCocoaAutoReleasePool pool;
NSView *view = static_cast<NSView *>(cocoaViewToWrap);
NSView *oldView = d->nsview;
destroy(true, true);
[view retain];
d->nsview = view;
create(WId(d->nsview), false, true);
[oldView release];
}
QT_END_NAMESPACE
|
