doc/src/emb-envvars.qdoc

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the documentation of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 /*!
  43     \page qt-embedded-envvars.html
  44
  45     \title Qt for Embedded Linux Environment Variables
  46     \ingroup qt-embedded-linux
  47
  48     These environment variables are relevant to \l{Qt for Embedded Linux}
  49     users.
  50
  51     \table
  52     \header \o Variable \o Description
  53
  54     \row
  55     \o \bold POINTERCAL_FILE \target POINTERCAL_FILE
  56
  57     \o Specifies the file containing the data used to calibrate the
  58     pointer device.
  59
  60     See also QWSCalibratedMouseHandler and \l{Qt for Embedded Linux Pointer
  61     Handling}.
  62
  63     \row
  64     \o \bold QT_ONSCREEN_PAINT \target QT_ONSCREEN_PAINT
  65
  66     \o If defined, the application will render its widgets directly on
  67     screen. The affected regions of the screen will not be modified by
  68     the screen driver unless another window with a higher focus
  69     requests (parts of) the same region.
  70
  71     Setting this environment variable is equivalent to setting the
  72     Qt::WA_PaintOnScreen attribute for all the widgets in the
  73     application.
  74
  75     See also the Qt for Embedded Linux \l{Qt for Embedded Linux Architecture#Graphics
  76     Rendering}{graphics rendering} documentation.
  77
  78     \row
  79     \o \bold QWS_SW_CURSOR \target QWS_SW_CURSOR
  80     \o If defined, the software mouse cursor is always used (even when using an
  81     accelerated driver that supports a hardware cursor).
  82
  83     \row
  84     \o \bold QWS_DISPLAY \target QWS_DISPLAY
  85     \o
  86
  87     Specifies the display type and framebuffer. For example, if the
  88     current shell is bash, ksh, zsh or sh:
  89
  90     \snippet doc/src/snippets/code/doc_src_emb-envvars.qdoc 0
  91
  92     The valid values for the \c <driver> argument are \c LinuxFb, \c
  93     QVFb, \c VNC, \c Transformed, \c Multi and \l
  94     {QScreenDriverPlugin::keys()}{keys} identifying custom drivers,
  95     and the \c {<display num>} argument is used to separate screens
  96     that are using the same screen driver and to enable multiple
  97     displays (see the \l {Running Qt for Embedded Linux Applications}
  98     documentation for more details).
  99
 100     The driver specific options are described in the \l{Qt for Embedded Linux
 101     Display Management}{display management} documentation.
 102
 103     \row
 104     \o \bold QWS_SIZE \target QWS_SIZE
 105     \o
 106
 107     Specifies the size of the \l{Qt for Embedded Linux} window which is centered
 108     within the screen. For example, if the current shell is bash, ksh,
 109     zsh or sh:
 110
 111     \snippet doc/src/snippets/code/doc_src_emb-envvars.qdoc 1
 112
 113     \row
 114     \o \bold QWS_MOUSE_PROTO \target QWS_MOUSE_PROTO
 115     \o
 116
 117     Specifies the driver for pointer handling. For example, if the
 118     current shell is bash, ksh, zsh or sh:
 119
 120     \snippet doc/src/snippets/code/doc_src_emb-envvars.qdoc 2
 121
 122     The valid values for the \c <driver> argument are \c MouseMan, \c
 123     IntelliMouse, \c Microsoft, \c VR41xx, \c LinuxTP, \c Yopy. \c
 124     Tslib and \l {QMouseDriverPlugin::keys()}{keys} identifying
 125     custom drivers, and the driver specific options are typically a
 126     device, e.g., \c /dev/mouse for mouse devices and \c /dev/ts for
 127     touch panels.
 128
 129     Multiple keyboard drivers can be specified in one go:
 130
 131     \snippet doc/src/snippets/code/doc_src_emb-envvars.qdoc 3
 132
 133     Input will be read from all specified drivers.
 134     Note that the \c Vr41xx driver also accepts two optional
 135     arguments: \c press=<value> defining a mouseclick (the default
 136     value is 750) and \c filter=<value> specifying the length of the
 137     filter used to eliminate noise (the default length is 3). For
 138     example:
 139
 140     \snippet doc/src/snippets/code/doc_src_emb-envvars.qdoc 4
 141
 142     See also \l {Qt for Embedded Linux Pointer Handling}.
 143
 144     \row
 145     \o \bold QWS_KEYBOARD \target QWS_KEYBOARD
 146     \o
 147
 148     Specifies the driver and device for character input. For example, if the
 149     current shell is bash, ksh, zsh or sh:
 150
 151     \snippet doc/src/snippets/code/doc_src_emb-envvars.qdoc 5
 152
 153     The valid values for the \c <driver> argument are \c SL5000, \c
 154     Yopy, \c VR41xx, \c TTY, \c USB and \l
 155     {QKbdDriverPlugin::keys()}{keys} identifying custom drivers,
 156     and the driver specific options are typically a device, e.g., \c
 157     /dev/tty0.
 158
 159     Multiple keyboard drivers can be specified in one go:
 160
 161     \snippet doc/src/snippets/code/doc_src_emb-envvars.qdoc 6
 162
 163     Input will be read from all specified drivers.
 164
 165     See also \l {Qt for Embedded Linux Character Input}.
 166
 167     \endtable
 168 */