tqt3/doc/distributingtqt.doc

/****************************************************************************
**
** Documentation on deploying Qt
**
** Copyright (C) 2000-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 distributingtqt.html

\title Deploying TQt Applications

This document lists the platform-specific files needed to distribute
Qt applications. We do not include any compiler-specific files that
may also be required. (See also, \link winsystem.html Window
System-specific Notes\endlink.)

\tableofcontents

\section1 Static TQt Applications

To distribute static TQt applications, you need the following file for
all platforms:

\list
\i your application's executable
\endlist

\section1 Dynamic TQt Applications

To distribute dynamic TQt applications, you will need the following
files for all platforms:

\list
\i application executable
\i the TQt library 
\endlist

The TQt library must either be in the same directory as the application
executable or in a directory which is included in the system library
path.

The library is in provided by the following platform specific files:

\table
\header \i Platform \i File
\row \i Windows \i \c qt[version].dll
\row \i Unix/Linux \i \c libtqt[version].so
\row \i Mac \i \c libtqt[version].dylib
\endtable

\e version includes the three version numbers. For threaded builds the
version is prefixed with \e {-mt}.

\section2 Distributing Plugins

You must include any plugin files required by the application.

Plugins must be put into a subdirectory under a directory known to
Qt as a plugin directory. The subdirectory must have the name of the
plugin category (e.g. \c styles, \c sqldrivers, \c designer, etc.). 

Qt searches in the following directories for plugin categories:

\list
\i Application specific plugin paths
\i Build-directory of Qt
\i The application directory
\endlist

Application specific plugin paths can be added using 
QApplication::addLibraryPath(). The build-directory of TQt is hardcoded
in the TQt library and can be changed as a part of the installation
process (see the \l distributor-example.html Distributor example).

\section1 Dynamic Dialogs 

For dynamic dialogs if you use TQWidgetFactory, you need the following
files for all platforms:

\list
\i The same files as used for dynamic TQt applications
\i The QUI Library
\endlist

The QUI library is provided by the following platform specific files:
\table
\header \i Platform \i File
\row \i Windows  \i\c tqui.lib
\row \i Unix/Linux  \i\c libtqui.so
\row \i Mac \i \c libtqui.dylib
\endtable

The QUI library must either be in the same directory as the
application executable or in a directory which is included in the
system library path.

*/