diff options
Diffstat (limited to 'doc/man/man1/uic.1')
-rw-r--r-- | doc/man/man1/uic.1 | 136 |
1 files changed, 136 insertions, 0 deletions
diff --git a/doc/man/man1/uic.1 b/doc/man/man1/uic.1 new file mode 100644 index 0000000..154e494 --- /dev/null +++ b/doc/man/man1/uic.1 @@ -0,0 +1,136 @@ +.TH uic 1 "2 Aug 2001" "Trolltech AS" \" -*- nroff -*- +.\" +.\" Copyright (C) 2000-2007 Trolltech ASA. All rights reserved. +.\" +.\" This file is part of Qt and may be distributed and used according to +.\" the terms and conditions described in the LICENSE file. +.\" +.SH NAME +uic \- Qt user interface compiler +.SH SYNOPSIS +.B uic +[options] file +.SH DESCRIPTION +This page documents the +.B User Interface Compiler +for the Qt GUI toolkit. The +.B uic +reads a user interface definition (.ui) file in XML as generated by +.I Qt Designer +and creates corresponding C++ header or source files. It also +generates an image file that embeds raw image data in C++ source code. +.PP +.PP +Generate declaration: +.br +.I "\fB uic [options] \fI<file>" +.br +.PP +Generate implementation: +.br +.I "\fB uic [options] -impl \fI<headerfile> <file>" +.br + \fI<headerfile>\fP: name of the declaration file +.br +.PP +Generate image collection: +.br +.I "\fB uic [options] -embed \fI<project> <image1> <image2> <image3>\fP ..." +.br + \fI<project>\fP: project name + \fI<image[1..n]>\fP: image files +.br +.\" .PP +.\" Generate binary UI file: +.\" .br +.\" .I "\fB uic [options] -binary \fI<file>" +.\" .br +.PP +.PP +For convenience, +.B uic +can also generate declaration or implementation stubs for subclasses. +.PP +Generate subclass declaration: +.br +.I "\fB uic [options] -subdecl \fI<subclassname> <baseclassheaderfile> <file>" +.br + \fI<subclassname>\fP: name of the subclass to generate +.br + \fI<baseclassheaderfile>\fP: declaration file of the baseclass +.PP +Generate subclass implementation: +.br +.I "\fB uic [options] -subimpl \fI<subclassname> <subclassheaderfile> <file>" +.br + \fI<subclassname>\fP: name of the subclass to generate +.br + \fI<subclassheaderfile>\fP: declaration file of the subclass + +.SH GENERAL OPTIONS +.TP +.I "-o file" +Write output to +.I file +rather than to stdout. +.TP +.I "-nofwd" +Omit forward declarations of custom classes in the generated +header file. This is necessary if typedef classes are used. +.TP +.I "-tr func" +Use +.I func() +instead of tr() for internationalization. +.TP +.I "-version" +Display the version of +.B uic +and exit. + +.SH USAGE +.B uic +is almost always invoked by +.BR make (1), +rather than by hand. +.PP +Here are useful makefile rules if you only use GNU make: +.PP +.in +4 +%.h: %.ui +.br + uic $< -o $@ +.br +%.cpp: %.ui +.br + uic -impl $*.h $< -o $@ +.in -4 +.PP +If you want to write portably, you can use individual rules of the +following form: +.PP +.in +4 +NAME.h: NAME.ui +.br + uic $< -o $@ +.br +NAME.cpp: NAME.ui +.br + uic -impl $*.h $< -o $@ +.in -4 +.PP +You must also remember to add +.I NAME.cpp +to your SOURCES (substitute your favorite name) variable and +.I NAME.o +to your OBJECTS variable. +.PP +(While we prefer to name our C++ source files .cpp, the +.B uic +doesn't care, so you can use .C, .cc, .CC, .cxx or even .c++ if +you prefer.) +.PP +.SH "SEE ALSO" +.BR http://www.trolltech.com/ " " +.SH AUTHOR +Trolltech ASA <[email protected]> |