~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to doc/src/uic.qdoc

  • Committer: Bazaar Package Importer
  • Author(s): Alessandro Ghersi
  • Date: 2009-11-02 18:30:08 UTC
  • mfrom: (1.2.2 upstream)
  • mto: (15.2.5 experimental)
  • mto: This revision was merged to the branch mainline in revision 88.
  • Revision ID: james.westby@ubuntu.com-20091102183008-b6a4gcs128mvfb3m
Tags: upstream-4.6.0~beta1
ImportĀ upstreamĀ versionĀ 4.6.0~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
/****************************************************************************
2
 
**
3
 
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4
 
** Contact: Nokia Corporation (qt-info@nokia.com)
5
 
**
6
 
** This file is part of the documentation of the Qt Toolkit.
7
 
**
8
 
** $QT_BEGIN_LICENSE:LGPL$
9
 
** Commercial Usage
10
 
** Licensees holding valid Qt Commercial licenses may use this file in
11
 
** accordance with the Qt Commercial License Agreement provided with the
12
 
** Software or, alternatively, in accordance with the terms contained in
13
 
** a written agreement between you and Nokia.
14
 
**
15
 
** GNU Lesser General Public License Usage
16
 
** Alternatively, this file may be used under the terms of the GNU Lesser
17
 
** General Public License version 2.1 as published by the Free Software
18
 
** Foundation and appearing in the file LICENSE.LGPL included in the
19
 
** packaging of this file.  Please review the following information to
20
 
** ensure the GNU Lesser General Public License version 2.1 requirements
21
 
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22
 
**
23
 
** In addition, as a special exception, Nokia gives you certain
24
 
** additional rights. These rights are described in the Nokia Qt LGPL
25
 
** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26
 
** package.
27
 
**
28
 
** GNU General Public License Usage
29
 
** Alternatively, this file may be used under the terms of the GNU
30
 
** General Public License version 3.0 as published by the Free Software
31
 
** Foundation and appearing in the file LICENSE.GPL included in the
32
 
** packaging of this file.  Please review the following information to
33
 
** ensure the GNU General Public License version 3.0 requirements will be
34
 
** met: http://www.gnu.org/copyleft/gpl.html.
35
 
**
36
 
** If you are unsure which license is appropriate for your use, please
37
 
** contact the sales department at http://www.qtsoftware.com/contact.
38
 
** $QT_END_LICENSE$
39
 
**
40
 
****************************************************************************/
41
 
 
42
 
/*!
43
 
    \page uic.html
44
 
    \title User Interface Compiler (uic)
45
 
    \ingroup buildsystem
46
 
    \ingroup qttools
47
 
    \keyword uic
48
 
 
49
 
    \omit KEEP THIS FILE SYNCHRONIZED WITH uic.1 \endomit
50
 
 
51
 
    This page documents the \e{User Interface Compiler} for the Qt GUI
52
 
    toolkit. The \c uic reads an XML format user interface definition
53
 
    (\c .ui) file as generated by \l{designer-manual.html}{Qt
54
 
    Designer} and creates a corresponding C++ header file.
55
 
 
56
 
    Usage:
57
 
    \snippet doc/src/snippets/code/doc_src_uic.qdoc 0
58
 
 
59
 
    \section1 Options
60
 
 
61
 
    The following table lists the command-line options recognized by
62
 
    \c uic.
63
 
 
64
 
    \table
65
 
    \header \o Option \o Description
66
 
    \row \o \c{-o <file>} \o Write output to \c <file> instead of to standard output.
67
 
    \row \o \c{-tr <func>} \o Use \c <func> for translating strings instead of \c tr().
68
 
    \row \o \c{-p} \o Don't generate guards against multiple inclusion (\c #ifndef FOO_H ...).
69
 
    \row \o \c{-h} \o Display the usage and the list of options.
70
 
    \row \o \c{-v} \o Display \c{uic}'s version number.
71
 
    \endtable
72
 
 
73
 
    \section1 Examples
74
 
 
75
 
    If you use \c qmake, \c uic will be invoked automatically for
76
 
    header files.
77
 
 
78
 
    Here are useful makefile rules if you only use GNU make:
79
 
 
80
 
    \snippet doc/src/snippets/code/doc_src_uic.qdoc 1
81
 
 
82
 
    If you want to write portably, you can use individual rules of the
83
 
    following form:
84
 
 
85
 
    \snippet doc/src/snippets/code/doc_src_uic.qdoc 2
86
 
 
87
 
    You must also remember to add \c{ui_foo.h} to your \c HEADERS
88
 
    (substitute your favorite name).
89
 
*/