summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTor Arne Vestbø <tor.arne.vestbo@qt.io>2020-10-12 15:09:13 +0200
committerTor Arne Vestbø <tor.arne.vestbo@qt.io>2020-10-14 11:52:26 +0200
commit7d2212042b16b6881c14a3b5b6812b54f227e763 (patch)
tree6fc45029c7b68147d19108bf654859fed33e625f
parentbc312e64a98dde932db4d5ff918614973c275976 (diff)
downloadqtdoc-7d2212042b16b6881c14a3b5b6812b54f227e763.tar.gz
Add platform type conversions documentation
Change-Id: I2e1a27d027f6110ed4e63f391cd7ceaff6c4d9b8 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
-rw-r--r--doc/src/platformintegration/platformintegration.qdoc20
-rw-r--r--doc/src/platformintegration/platformintegration.qdocinc35
2 files changed, 55 insertions, 0 deletions
diff --git a/doc/src/platformintegration/platformintegration.qdoc b/doc/src/platformintegration/platformintegration.qdoc
index 0957fe8d..91b7dc57 100644
--- a/doc/src/platformintegration/platformintegration.qdoc
+++ b/doc/src/platformintegration/platformintegration.qdoc
@@ -45,6 +45,17 @@
\section1 Type Conversions
+ \include platformintegration.qdocinc type-conversions
+
+ For example, to get the current user's username on Apple platforms:
+
+ \code
+ NSProcessInfo *processInfo = NSProcessInfo.processInfo;
+ QString userName = QString::fromNSString(processInfo.userName)
+ \endcode
+
+ For a complete list of all type conversions, see the \l{Type Conversions} overview.
+
\section1 Window Embedding
\section1 Native Interfaces
@@ -61,3 +72,12 @@
The main abstraction layer here is the \l{Qt Platform Abstraction},
or QPA for short, which deals with window system integration and related use-cases.
*/
+
+/*!
+ \group platform-type-conversions
+ \title Type Conversions
+
+ \include platformintegration.qdocinc type-conversions
+
+ The following list enumerates all of the available type conversions:
+*/
diff --git a/doc/src/platformintegration/platformintegration.qdocinc b/doc/src/platformintegration/platformintegration.qdocinc
new file mode 100644
index 00000000..e394ad50
--- /dev/null
+++ b/doc/src/platformintegration/platformintegration.qdocinc
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: https://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 https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+
+//! [type-conversions]
+Many of Qt's basic data types, such as QString, QPoint, or QImage, provide
+conversions to and from the native equivalent types.
+//! [type-conversions]
+
+*/