diff options
Diffstat (limited to 'src/platformheaders/windowsfunctions/qwindowswindowfunctions.qdoc')
-rw-r--r-- | src/platformheaders/windowsfunctions/qwindowswindowfunctions.qdoc | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/src/platformheaders/windowsfunctions/qwindowswindowfunctions.qdoc b/src/platformheaders/windowsfunctions/qwindowswindowfunctions.qdoc new file mode 100644 index 0000000000..84fae2f56d --- /dev/null +++ b/src/platformheaders/windowsfunctions/qwindowswindowfunctions.qdoc @@ -0,0 +1,71 @@ +/**************************************************************************** +** +** 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 QWindowsWindowFunctions + \inmodule QtPlatformHeaders + \since 5.5 + \brief The QWindowsWindowFunctions class is an inline class containing + miscellaneous functionality for Windows window specific functionality. + + A common usage pattern is as follows: + \snippet qwindowswindowfunctions/main.cpp 0 + + \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. +*/ + +/*! + \enum QWindowsWindowFunctions::TouchWindowTouchType + + This enum represents the supported TouchWindow touch flags for RegisterTouchWindow(). + + \value NormalTouch + \value FineTouch + \value WantPalmTouch +*/ + +/*! + \typedef QWindowsWindowFunctions::SetTouchWindowTouchType + + This is the typedef for the function returned by QGuiApplication::platformFunction when passed setTouchWindowTouchTypeIdentifier. +*/ + +/*! + \fn QByteArray QWindowsWindowFunctions::setTouchWindowTouchTypeIdentifier() + + This function returns the bytearray that can be used to query + QGuiApplication::platformFunction to retrieve the SetTouchWindowTouchType function. +*/ + +/*! + \fn void QWindowsWindowFunctions::setTouchWindowTouchType(QWindow *window, TouchWindowTouchTypes type) + + This is a convenience function that can be used directly instead of resolving the function pointer. + \a window and \a type will be relayed to the function retrieved by QGuiApplication +*/ |