Update copyright headers
[qt:qt.git] / doc / src / development / uic.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 uic.html
30     \title User Interface Compiler (uic)
31     \ingroup qttools
32     \keyword uic
33
34     \omit KEEP THIS FILE SYNCHRONIZED WITH uic.1 \endomit
35
36     This page documents the \e{User Interface Compiler} for the Qt GUI
37     toolkit. The \c uic reads an XML format user interface definition
38     (\c .ui) file as generated by \l{designer-manual.html}{Qt
39     Designer} and creates a corresponding C++ header file.
40
41     Usage:
42     \snippet doc/src/snippets/code/doc_src_uic.qdoc 0
43
44     \section1 Options
45
46     The following table lists the command-line options recognized by
47     \c uic.
48
49     \table
50     \header \o Option \o Description
51     \row \o \c{-o <file>} \o Write output to \c <file> instead of to standard output.
52     \row \o \c{-tr <func>} \o Use \c <func> for translating strings instead of \c tr().
53     \row \o \c{-p} \o Don't generate guards against multiple inclusion (\c #ifndef FOO_H ...).
54     \row \o \c{-h} \o Display the usage and the list of options.
55     \row \o \c{-v} \o Display \c{uic}'s version number.
56     \endtable
57
58     \section1 Examples
59
60     If you use \c qmake, \c uic will be invoked automatically for
61     header files.
62
63     Here are useful makefile rules if you only use GNU make:
64
65     \snippet doc/src/snippets/code/doc_src_uic.qdoc 1
66
67     If you want to write portably, you can use individual rules of the
68     following form:
69
70     \snippet doc/src/snippets/code/doc_src_uic.qdoc 2
71
72     You must also remember to add \c{ui_foo.h} to your \c HEADERS
73     (substitute your favorite name).
74 */