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 uic.html

    44     \title User Interface Compiler (uic)

    45     \ingroup qttools

    46     \keyword uic

    47 

    48     \omit KEEP THIS FILE SYNCHRONIZED WITH uic.1 \endomit

    49 

    50     This page documents the \e{User Interface Compiler} for the Qt GUI

    51     toolkit. The \c uic reads an XML format user interface definition

    52     (\c .ui) file as generated by \l{designer-manual.html}{Qt

    53     Designer} and creates a corresponding C++ header file.

    54 

    55     Usage:

    56     \snippet doc/src/snippets/code/doc_src_uic.qdoc 0

    57 

    58     \section1 Options

    59 

    60     The following table lists the command-line options recognized by

    61     \c uic.

    62 

    63     \table

    64     \header \o Option \o Description

    65     \row \o \c{-o <file>} \o Write output to \c <file> instead of to standard output.

    66     \row \o \c{-tr <func>} \o Use \c <func> for translating strings instead of \c tr().

    67     \row \o \c{-p} \o Don't generate guards against multiple inclusion (\c #ifndef FOO_H ...).

    68     \row \o \c{-h} \o Display the usage and the list of options.

    69     \row \o \c{-v} \o Display \c{uic}'s version number.

    70     \endtable

    71 

    72     \section1 Examples

    73 

    74     If you use \c qmake, \c uic will be invoked automatically for

    75     header files.

    76 

    77     Here are useful makefile rules if you only use GNU make:

    78 

    79     \snippet doc/src/snippets/code/doc_src_uic.qdoc 1

    80 

    81     If you want to write portably, you can use individual rules of the

    82     following form:

    83 

    84     \snippet doc/src/snippets/code/doc_src_uic.qdoc 2

    85 

    86     You must also remember to add \c{ui_foo.h} to your \c HEADERS

    87     (substitute your favorite name).

    88 */