diff options
Diffstat (limited to 'src/platformheaders/cocoafunctions/qcocoawindowfunctions.qdoc')
-rw-r--r-- | src/platformheaders/cocoafunctions/qcocoawindowfunctions.qdoc | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/src/platformheaders/cocoafunctions/qcocoawindowfunctions.qdoc b/src/platformheaders/cocoafunctions/qcocoawindowfunctions.qdoc new file mode 100644 index 0000000000..e95f92edb5 --- /dev/null +++ b/src/platformheaders/cocoafunctions/qcocoawindowfunctions.qdoc @@ -0,0 +1,58 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** 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 http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \class QCocoaWindowFunctions + \inmodule QtPlatformHeaders + + \brief The QCocoaWindowFunctions class is an inline class containing + miscellaneous functionality for NSWindow and NSView window specific functionality. + + \note There is no binary compatibility guarantee for this class, + meaning that an application using it is only guaranteed to work with the Qt + version it was developed against. +*/ + +/*! + \typedef QCocoaWindowFunctions::BottomLeftClippedByNSWindowOffset + + This is the typedef for the function returned by QGuiApplication::platformFunction when passed clippedByNSWindowIdentifier. +*/ + +/*! + \fn QByteArray QCocoaWindowFunctions::bottomLeftClippedByNSWindowOffsetIdentifier() + + This function returnes the bytearray that can be used to query + QGuiApplication::platformFunction to retrieve the BottomLeftClippedByNSWindowOffset function. +*/ + +/*! + \fn QPoint QCocoaWindowFunctions::bottomLeftClippedByNSWindowOffset(QWindow *window) + + This is a convenience function that can be used directly instead of resolving the function pointer. + \a window will be relayed to the function retrieved by QGuiApplication +*/ |