tqt3/doc/features.doc

/****************************************************************************
**
** TQt feature definition file documentation
**
** Copyright (C) 1992-2008 Trolltech ASA.  All rights reserved.
**
** This file is part of the TQt GUI Toolkit.
**
** This file may be used under the terms of the GNU General
** Public License versions 2.0 or 3.0 as published by the Free
** Software Foundation and appearing in the files LICENSE.GPL2
** and LICENSE.GPL3 included in the packaging of this file.
** Alternatively you may (at your option) use any later version
** of the GNU General Public License if such license has been
** publicly approved by Trolltech ASA (or its successors, if any)
** and the KDE Free TQt Foundation.
**
** Please review the following information to ensure GNU General
** Public Licensing requirements will be met:
** http://trolltech.com/products/qt/licenses/licensing/opensource/.
** If you are unsure which license is appropriate for your use, please
** review the following information:
** http://trolltech.com/products/qt/licenses/licensing/licensingoverview
** or contact the sales department at sales@trolltech.com.
**
** This file may be used under the terms of the Q Public License as
** defined by Trolltech ASA and appearing in the file LICENSE.QPL
** included in the packaging of this file.  Licensees holding valid Qt
** Commercial licenses may use this file in accordance with the Qt
** Commercial License Agreement provided with the Software.
**
** This file is provided "AS IS" with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE. Trolltech reserves all rights not granted
** herein.
**
**********************************************************************/

/*!
\page emb-features.html

\title The Feature Definition File

By modifying the configured \c ntqconfig.h file from src/tools, you
can define a subset of the full TQt functionality that you wish to
be available in your installation. The -qconfig option to
configure is used to select the configuration.

Note that such modification is only supported on Qt/Embedded
platforms, where reducing the size of TQt is
important and the application set is often fixed.

The \c ntqconfig.h definition file simply defines macros to disable
features. Some features are dependent on other features and these
dependencies are expressed in \c ntqfeatures.h.

The available options are:

\table
\header \i Macro \i Disables \i Set automatically by

\header \i31 Images (\l QImageIO)
\row \i TQT_NO_IMAGEIO_BMP
     \i Microsoft Bitmap image file format.
     \i  
\row \i TQT_NO_IMAGEIO_PPM
     \i Portable Pixmap image file format.
     \i  
\row \i TQT_NO_IMAGEIO_XBM
     \i X11 Bitmap image file format.
     \i  
\row \i TQT_NO_IMAGEIO_XPM
     \i X11 Pixmap image file format.
     \i  
\row \i TQT_NO_IMAGEIO_PNG
     \i Portable Network Graphics image file format.
     \i  

\header \i31 Animation
\row \i TQT_NO_ASYNC_IO
     \i Asynchronous I/O (\l QAsyncIO)
     \i  
\row \i TQT_NO_ASYNC_IMAGE_IO
     \i Asynchronous Image I/O and GIF image support (\l QImageDecoder, ...)
     \i  
\row \i TQT_NO_MOVIE
     \i Animation support (\l QMovie)
     \i TQT_NO_ASYNC_IO, TQT_NO_ASYNC_IMAGE_IO

\header \i31 Fonts
\row \i TQT_NO_TRUETYPE
     \i TrueType (TTF and TTC) font file format, only used by Qt/Embedded.
     \i  
\row \i TQT_NO_BDF
     \i Bitmap Distribution Format (BDF) font file format, only used by Qt/Embedded.
     \i  
\row \i TQT_NO_FONTDATABASE
     \i Font database.
     \i  

\header \i31 Internationalization
\row \i TQT_NO_I18N
     \i Conversions between Unicode and 8-bit encodings.
     \i  
\row \i TQT_NO_UNICODETABLES
     \i Large tables defining such things as upper and lowercase conversions
	for all Unicode characters.
     \i  

\header \i31 MIME
\row \i TQT_NO_MIME
     \i Multipurpose Internet Mail Extensions, an Internet standard for encoding
	and tagging typed data (eg. text, images, colors) (\l QMimeSource)
     \i  
\row \i TQT_NO_RICHTEXT
     \i HTML-like text (\l QStyleSheet, \l QLabel)
     \i TQT_NO_MIME
\row \i TQT_NO_DRAGANDDROP
     \i Drag-and-drop data between applications (\l QDragObject)
     \i TQT_NO_MIME
\row \i TQT_NO_CLIPBOARD
     \i Cut-and-paste data between applications (\l QClipboard)
     \i TQT_NO_MIME

\header \i31 Sound
\row \i TQT_NO_SOUND
     \i Playing audio files (\l QSound)
     \i  

\header \i31 Scripting
\row \i TQT_NO_PROPERTIES
     \i Scripting Qt-based applications.
     \i  

\header \i31 Qt/Embedded-specific
\row \i TQT_NO_QWS_CURSOR
     \i The cursor sprite on Qt/Embedded. Pen-operated devices would not
	normally need this feature.
     \i  
\row \i TQT_NO_QWS_DEPTH_8GRAYSCALE
     \i11 8 bits per pixel: 256 levels of gray.
	Incompatible with QWS_DEPTH_8.
     \i  
\row \i TQT_NO_QWS_DEPTH_8
     \i11 8 bits per pixel: 216-color cube with 40 auxiliary colors.
	Incompatible with QWS_DEPTH_8GRAYSCALE.
     \i  
\row \i TQT_NO_QWS_DEPTH_15
     \i11 15 bits per pixel: 32 levels for each of red, green and blue.
     \i  
\row \i TQT_NO_QWS_DEPTH_16
     \i11 16 bits per pixel: 64 levels of green, 32 levels for red and for blue.
     \i  
\row \i TQT_NO_QWS_DEPTH_32
     \i11 32 bits per pixel: 256 levels for each of red, green and blue.
     \i  
\row \i TQT_NO_QWS_MACH64
     \i Mach64 accelerated driver (demonstration only).
     \i  
\row \i TQT_NO_QWS_VFB
     \i Virtual framebuffer running on X11 (see reference documentation).
     \i  

\header \i31 Networking
\row \i TQT_NO_NETWORKPROTOCOL
     \i Abstract multi-protocol data retrieval,
	with local file retrieval included (\l QNetworkProtocol)
     \i  
\row \i TQT_NO_NETWORKPROTOCOL_FTP
     \i FTP-protocol data retrieval.
     \i TQT_NO_NETWORKPROTOCOL
\row \i TQT_NO_NETWORKPROTOCOL_HTTP
     \i HTTP-protocol data retrieval.
     \i TQT_NO_NETWORKPROTOCOL

\header \i31 Painting/drawing
\row \i TQT_NO_COLORNAMES
     \i Color names such as "red", used by some \l TQColor constructors
	and by some HTML documents (\l TQColor, \l QStyleSheet)
     \i  
\row \i TQT_NO_TRANSFORMATIONS
     \i Used by a number of classes in Qt. With this, rotation and
	scaling are possible. Without it you can only do coordinate
	translation (\l QWMatrix)
     \i  
\row \i TQT_NO_PSPRINTER
     \i PostScript printer support.
     \i  
\row \i TQT_NO_PRINTER
     \i Printer support (\l QPrinter)
     \i TQT_NO_PSPRINTER (Unix only)
\row \i TQT_NO_PICTURE
     \i Save TQt drawing commands to a files (\l QPicture)
     \i  

\header \i31 Widgets
\row \i TQT_NO_WIDGETS
     \i Disabling this disables all widgets except \l TQWidget.
     \i  
\row \i TQT_NO_TEXTVIEW
     \i HTML document viewing (\l QTextView)
     \i TQT_NO_WIDGETS, TQT_NO_RICHTEXT
\row \i TQT_NO_TEXTBROWSER
     \i HTML document browsing (\l QTextBrowser)
     \i TQT_NO_TEXTVIEW
\row \i TQT_NO_ICONVIEW
     \i Labelled icons (\l QIconView)
     \i TQT_NO_WIDGETS, TQT_NO_DRAGANDDROP
\row \i TQT_NO_LISTVIEW
     \i Lists of information (\l QListView)
     \i TQT_NO_WIDGETS
\row \i TQT_NO_CANVAS
     \i Object canvas (\l QCanvas)
     \i TQT_NO_WIDGETS
\row \i TQT_NO_DIAL
     \i Value control (\l QDial)
     \i TQT_NO_WIDGETS
\row \i TQT_NO_WORKSPACE
     \i MDI (Multiple Document Interface) (\l QWorkspace)
     \i TQT_NO_WIDGETS
\row \i TQT_NO_LCDNUMBER
     \i LCD-like number display (\l QLCDNumber)
     \i TQT_NO_WIDGETS

\header \i31 GUI Styles
\row \i TQT_NO_STYLE_WINDOWS
     \i Microsoft Windows style (\l QWindowsStyle)
     \i TQT_NO_WIDGETS
\row \i TQT_NO_STYLE_MOTIF
     \i OSF Motif style (\l QMotifStyle)
     \i TQT_NO_WIDGETS
\row \i TQT_NO_STYLE_CDE
     \i Open Group CDE style (\l QCDEStyle)
     \i TQT_NO_STYLE_MOTIF
\row \i TQT_NO_STYLE_AQUA
     \i MacOS X style (\l QAquaStyle)
\row \i TQT_NO_STYLE_PLATINUM
     \i MacOS 9 style (\l QPlatinumStyle)
     \i TQT_NO_WIDGETS
\row \i TQT_NO_STYLE_SGI
     \i SGI style (\l QSGIStyle)
     \i TQT_NO_STYLE_MOTIF

\header \i31 Dialogs
\row \i TQT_NO_DIALOGS
     \i Disabling this disables all common dialogs \l TQWidget.
     \i TQT_NO_WIDGETS
\row \i TQT_NO_FILEDIALOG
     \i The file selection dialog (\l QFileDialog)
     \i TQT_NO_DIALOGS, TQT_NO_NETWORKPROTOCOL, TQT_NO_LISTVIEW
\row \i TQT_NO_FONTDIALOG
     \i The font selection dialog (\l QFontDialog)
     \i TQT_NO_DIALOGS, TQT_NO_FONTDATABASE
\row \i TQT_NO_COLORDIALOG
     \i The color selection dialog (\l QColorDialog)
     \i TQT_NO_DIALOGS
\row \i TQT_NO_INPUTDIALOG
     \i Text input dialog (\l QInputDialog)
     \i TQT_NO_DIALOGS
\row \i TQT_NO_MESSAGEBOX
     \i Message/prompting dialog (\l QMessageBox)
     \i TQT_NO_DIALOGS
\row \i TQT_NO_PROGRESSDIALOG
     \i Long-computation progress dialog (\l QProgressDialog)
     \i TQT_NO_DIALOGS
\row \i TQT_NO_TABDIALOG
     \i Tabbed-pages dialog (\l QTabDialog)
     \i TQT_NO_DIALOGS
\row \i TQT_NO_WIZARD
     \i Multi-step dialog (\l QWizard)
     \i TQT_NO_DIALOGS
\endtable

*/