doc/src/platforms/winsystem.qdoc

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2015 The Qt Company Ltd.
   4 ** Contact: http://www.qt.io/licensing/
   5 **
   6 ** This file is part of the documentation of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:FDL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and The Qt Company. For licensing terms
  14 ** and conditions see http://www.qt.io/terms-conditions. For further
  15 ** information use the contact form at http://www.qt.io/contact-us.
  16 **
  17 ** GNU Free Documentation License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Free
  19 ** Documentation License version 1.3 as published by the Free Software
  20 ** Foundation and appearing in the file included in the packaging of
  21 ** this file.  Please review the following information to ensure
  22 ** the GNU Free Documentation License version 1.3 requirements
  23 ** will be met: http://www.gnu.org/copyleft/fdl.html.
  24 ** $QT_END_LICENSE$
  25 **
  26 ****************************************************************************/
  27
  28 /*!
  29     \page winsystem.html
  30     \title Window System Specific Notes
  31     \ingroup platform-specific
  32     \brief Collections of notes about Qt implementations on different window systems.
  33
  34     Qt is a cross-platform GUI toolkit, so almost the entire API is the
  35     same on all platforms and window systems. If you wish to use
  36     platform-specific features, and still maintain a platform-independent
  37     source tree, you should protect the platform-specific code using the
  38     appropriate \c{#ifdef} directives (see below).
  39
  40     Qt provides a few low-level global functions for fine-tuning
  41     applications on specific platforms. See \l{Platform-Specific
  42     Functions} for details.
  43
  44     \tableofcontents
  45
  46     For information about which platforms are supported by Qt, see the
  47     \l{Platform and Compiler Notes}. For information on distributing Qt
  48     applications, see \l{Deploying Qt Applications}.
  49
  50     \target x11
  51     \section1 Qt for X11
  52
  53     When compiling for this platform, the macro \c{Q_WS_X11} is defined.
  54
  55     \e{Not documented here. Please contact Qt's technical support team
  56     if you have queries.}
  57
  58     See the \l{Qt for X11 Requirements} page for more information about the
  59     libraries required to build Qt with as many features as possible.
  60
  61     \target win
  62     \section1 Qt for Windows
  63
  64     When compiling for this platform, the macro \c{Q_WS_WIN} is defined.
  65
  66     \e{Not documented here. Please contact Qt's technical support team
  67     if you have queries.}
  68
  69     \target macosx
  70     \section1 Qt for Mac OS X
  71
  72     When compiling for this platform, the macro \c{Q_WS_MAC} is defined.
  73
  74     \list
  75     \i \l{Qt for Mac OS X - Specific Issues}
  76     \i \l{Qt is Mac OS X Native}
  77     \endlist
  78
  79     \target qws
  80     \section1 Qt for Embedded Linux
  81
  82     When compiling for this platform, the macro \c{Q_WS_QWS} is
  83     defined (the window system is literally the Qt Window System). See
  84     the \l{Qt for Embedded Linux} documentation for more information.
  85
  86     \section1 Qt for Windows CE
  87
  88     When compiling for this platform, the macro \c{Q_WS_WINCE} is defined.
  89     See the \l{Qt for Windows CE} documentation for more information.
  90
  91     \section1 Qt for the Symbian platform
  92
  93     When compiling for this platform, the macro \c{Q_WS_S60} is defined.
  94     See the \l{The Symbian platform - Introduction to Qt} documentation for
  95     more information.
  96 */