src/gui/widgets/qmacnativewidget_mac.mm
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the QtGui module of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 #import <Cocoa/Cocoa.h>
       
    43 #import <private/qcocoaview_mac_p.h>
       
    44 #include "qmacnativewidget_mac.h"
       
    45 #include <private/qwidget_p.h>
       
    46 
       
    47 /*!
       
    48     \class QMacNativeWidget
       
    49     \since 4.5
       
    50     \brief The QMacNativeWidget class provides a widget for Mac OS X that provides a way to put Qt widgets into Carbon
       
    51     or Cocoa hierarchies depending on how Qt was configured.
       
    52 
       
    53     \ingroup advanced
       
    54 
       
    55     On Mac OS X, there is a difference between a window and view;
       
    56     normally expressed as widgets in Qt.  Qt makes assumptions about its
       
    57     parent-child hierarchy that make it complex to put an arbitrary Qt widget
       
    58     into a hierarchy of "normal" views from Apple frameworks. QMacNativeWidget
       
    59     bridges the gap between views and windows and makes it possible to put a
       
    60     hierarchy of Qt widgets into a non-Qt window or view.
       
    61 
       
    62     QMacNativeWidget pretends it is a window (i.e. isWindow() will return true),
       
    63     but it cannot be shown on its own. It needs to be put into a window
       
    64     when it is created or later through a native call.
       
    65 
       
    66     QMacNativeWidget works for either Carbon or Cocoa depending on how Qt was configured. If Qt is
       
    67     using Carbon, QMacNativeWidget will embed into Carbon hierarchies. If Qt is
       
    68     using Cocoa, QMacNativeWidget embeds into Cocoa hierarchies.
       
    69 
       
    70     Here is an example of putting a QPushButton into a NSWindow:
       
    71 
       
    72     \snippet doc/src/snippets/qmacnativewidget/main.mm 0
       
    73 
       
    74     On Carbon, this would do the equivalent:
       
    75 
       
    76     \snippet doc/src/snippets/qmacnativewidget/main.mm 1
       
    77 
       
    78     Note that QMacNativeWidget requires knowledge of Carbon or Cocoa. All it
       
    79     does is get the Qt hierarchy into a window not owned by Qt. It is then up
       
    80     to the programmer to ensure it is placed correctly in the window and
       
    81     responds correctly to events.
       
    82 */
       
    83 
       
    84 QT_BEGIN_NAMESPACE
       
    85 
       
    86 class QMacNativeWidgetPrivate : public QWidgetPrivate
       
    87 {
       
    88 };
       
    89 
       
    90 extern OSViewRef qt_mac_create_widget(QWidget *widget, QWidgetPrivate *widgetPrivate, OSViewRef parent);
       
    91 
       
    92 
       
    93 /*!
       
    94     Create a QMacNativeWidget with \a parentView as its "superview" (i.e.,
       
    95     parent). The \a parentView is either an HIViewRef if Qt is using Carbon or
       
    96     a NSView pointer if Qt is using Cocoa.
       
    97 */
       
    98 QMacNativeWidget::QMacNativeWidget(void *parentView)
       
    99     : QWidget(*new QMacNativeWidgetPrivate, 0, Qt::Window)
       
   100 {
       
   101     Q_D(QMacNativeWidget);
       
   102     OSViewRef myView = qt_mac_create_widget(this, d, OSViewRef(parentView));
       
   103 
       
   104     d->topData()->embedded = true;
       
   105     create(WId(myView), false, false);
       
   106     setPalette(QPalette(Qt::transparent));
       
   107     setAttribute(Qt::WA_SetPalette, false);
       
   108     setAttribute(Qt::WA_LayoutUsesWidgetRect);
       
   109 }
       
   110 
       
   111 /*!
       
   112     Destroy the QMacNativeWidget.
       
   113 */
       
   114 QMacNativeWidget::~QMacNativeWidget()
       
   115 {
       
   116 }
       
   117 
       
   118 /*!
       
   119     \reimp
       
   120 */
       
   121 QSize QMacNativeWidget::sizeHint() const
       
   122 {
       
   123     return QSize(200, 200);
       
   124 }
       
   125 /*!
       
   126     \reimp
       
   127 */
       
   128 bool QMacNativeWidget::event(QEvent *ev)
       
   129 {
       
   130     return QWidget::event(ev);
       
   131 }
       
   132 
       
   133 QT_END_NAMESPACE