Qt 4.8: QMacNativeWidget Class Reference

Qt Reference Documentation

- Qt 4.8
- ALL VERSIONS

- A
- A
- A
- Print

# QMacNativeWidget Class Reference

The QMacNativeWidget class provides a widget for Mac OS X that provides a way to put Qt widgets into Carbon or Cocoa hierarchies depending on how Qt was configured. More...

     #include <QMacNativeWidget>

Inherits: QWidget.

This class was introduced in Qt 4.5.

- List of all members, including inherited members

## Public Functions

| QMacNativeWidget ( void * parentView = 0 )
| ~QMacNativeWidget ()

## Reimplemented Public Functions

virtual QSize | sizeHint () const

- 221 public functions inherited from QWidget
- 29 public functions inherited from QObject
- 13 public functions inherited from QPaintDevice

## Reimplemented Protected Functions

virtual bool | event ( QEvent * ev )

- 37 protected functions inherited from QWidget
- 8 protected functions inherited from QObject
- 1 protected function inherited from QPaintDevice

### Additional Inherited Members

- 58 properties inherited from QWidget
- 1 property inherited from QObject
- 19 public slots inherited from QWidget
- 1 public slot inherited from QObject
- 1 signal inherited from QWidget
- 1 signal inherited from QObject
- 4 static public members inherited from QWidget
- 7 static public members inherited from QObject
- 37 protected functions inherited from QWidget
- 8 protected functions inherited from QObject
- 1 protected function inherited from QPaintDevice
- 1 protected slot inherited from QWidget

## Detailed Description

The QMacNativeWidget class provides a widget for Mac OS X that provides a way to put Qt widgets into Carbon or Cocoa hierarchies depending on how Qt was configured.

On Mac OS X, there is a difference between a window and view; normally expressed as widgets in Qt. Qt makes assumptions about its parent-child hierarchy that make it complex to put an arbitrary Qt widget into a hierarchy of "normal" views from Apple frameworks. QMacNativeWidget bridges the gap between views and windows and makes it possible to put a hierarchy of Qt widgets into a non-Qt window or view.

QMacNativeWidget pretends it is a window (i.e. isWindow() will return true), but it cannot be shown on its own. It needs to be put into a window when it is created or later through a native call.

QMacNativeWidget works for either Carbon or Cocoa depending on how Qt was configured. If Qt is using Carbon, QMacNativeWidget will embed into Carbon hierarchies. If Qt is using Cocoa, QMacNativeWidget embeds into Cocoa hierarchies.

Here is an example of putting a QPushButton into a NSWindow:

         NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
         NSWindow *window = [[NSWindow alloc] initWithContentRect:NSMakeRect(200, app.desktop()->height() - 200, 239, 200)
                             styleMask:NSTitledWindowMask | NSClosableWindowMask
                                       | NSMiniaturizableWindowMask | NSResizableWindowMask
                             backing:NSBackingStoreBuffered defer:NO];

         QMacNativeWidget *nativeWidget = new QMacNativeWidget();
         nativeWidget->move(0, 0);
         nativeWidget->setPalette(QPalette(Qt::red));
         nativeWidget->setAutoFillBackground(true);
         QVBoxLayout *layout = new QVBoxLayout();
         QPushButton *pushButton = new QPushButton("An Embedded Qt Button!", nativeWidget);
         pushButton->setAttribute(Qt::WA_LayoutUsesWidgetRect); // Don't use the layout rect calculated from QMacStyle.
         layout->addWidget(pushButton);
         nativeWidget->setLayout(layout);

         // Adjust Cocoa layouts
         NSView *nativeWidgetView = reinterpret_cast<NSView *>(nativeWidget->winId());
         NSView *contentView = [window contentView];
         [contentView setAutoresizesSubviews:YES];
         [nativeWidgetView setAutoresizingMask:NSViewWidthSizable | NSViewHeightSizable];
         [nativeWidgetView setAutoresizesSubviews:YES];
         NSView *pushButtonView = reinterpret_cast<NSView *>(pushButton->winId());
         [pushButtonView setAutoresizingMask:NSViewWidthSizable];

         // Add the nativeWidget to the window.
         [contentView addSubview:nativeWidgetView positioned:NSWindowAbove relativeTo:nil];
         nativeWidget->show();
         pushButton->show();

         // Show the window.
         [window makeKeyAndOrderFront:window];
         [pool release];

On Carbon, this would do the equivalent:

         Rect contentRect;
         SetRect(&contentRect, 200, 200, 400, 400);
         HIWindowRef windowRef;
         CreateNewWindow(kDocumentWindowClass, kWindowStandardDocumentAttributes | kWindowCompositingAttribute | kWindowStandardHandlerAttribute | kWindowLiveResizeAttribute, &contentRect, &windowRef);
         HIViewRef contentView = 0;
         GetRootControl(windowRef, &contentView);

         QMacNativeWidget *nativeWidget = new QMacNativeWidget();
         nativeWidget->move(0, 0);
         nativeWidget->setPalette(QPalette(Qt::red));
         nativeWidget->setAutoFillBackground(true);
         QVBoxLayout *layout = new QVBoxLayout();
         QPushButton *pushButton = new QPushButton("An Embedded Qt Button!", nativeWidget);
         pushButton->setAttribute(Qt::WA_LayoutUsesWidgetRect); // Don't use the layout rect calculated from QMacStyle.
         layout->addWidget(pushButton);
         nativeWidget->setLayout(layout);
         HIViewRef nativeWidgetView = reinterpret_cast<HIViewRef>(nativeWidget->winId());
         // Add the nativeWidget to the window.
         HIViewAddSubview(contentView, nativeWidgetView);

         // Adjust Carbon layouts
         HILayoutInfo layoutInfo;
         layoutInfo.version = kHILayoutInfoVersionZero;
         HIViewGetLayoutInfo(nativeWidgetView, &layoutInfo);

         layoutInfo.binding.top.toView = contentView;
         layoutInfo.binding.top.kind = kHILayoutBindTop;
         layoutInfo.binding.left.toView = contentView;
         layoutInfo.binding.left.kind = kHILayoutBindLeft;
         layoutInfo.binding.right.toView = contentView;
         layoutInfo.binding.right.kind = kHILayoutBindRight;
         layoutInfo.binding.bottom.toView = contentView;
         layoutInfo.binding.bottom.kind = kHILayoutBindBottom;

         HIViewSetLayoutInfo(nativeWidgetView, &layoutInfo);
         HIViewApplyLayout(nativeWidgetView);

         pushButton->show();
         nativeWidget->show();
         // Show the window.
         ShowWindow(windowRef);

Note that QMacNativeWidget requires knowledge of Carbon or Cocoa. All it does is get the Qt hierarchy into a window not owned by Qt. It is then up to the programmer to ensure it is placed correctly in the window and responds correctly to events.

## Member Function Documentation

### QMacNativeWidget::QMacNativeWidget ( void * parentView = 0 )

Create a QMacNativeWidget with parentView as its "superview" (i.e., parent). The parentView is either an HIViewRef if Qt is using Carbon or a NSView pointer if Qt is using Cocoa.

### QMacNativeWidget::~QMacNativeWidget ()

Destroy the QMacNativeWidget.

### bool QMacNativeWidget::event ( QEvent * ev )`[virtual protected]`

Reimplemented from QObject::event().

### QSize QMacNativeWidget::sizeHint () const`[virtual]`

Reimplemented from QWidget::sizeHint().