summaryrefslogtreecommitdiffstats
path: root/doc/html/uic.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/uic.html')
-rw-r--r--doc/html/uic.html133
1 files changed, 133 insertions, 0 deletions
diff --git a/doc/html/uic.html b/doc/html/uic.html
new file mode 100644
index 000000000..58f20744b
--- /dev/null
+++ b/doc/html/uic.html
@@ -0,0 +1,133 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/doc/uic.doc:1 -->
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>User Interface Compiler (uic)</title>
+<style type="text/css"><!--
+fn { margin-left: 1cm; text-indent: -1cm; }
+a:link { color: #004faf; text-decoration: none }
+a:visited { color: #672967; text-decoration: none }
+body { background: #ffffff; color: black; }
+--></style>
+</head>
+<body>
+
+<table border="0" cellpadding="0" cellspacing="0" width="100%">
+<tr bgcolor="#E5E5E5">
+<td valign=center>
+ <a href="index.html">
+<font color="#004faf">Home</font></a>
+ | <a href="classes.html">
+<font color="#004faf">All&nbsp;Classes</font></a>
+ | <a href="mainclasses.html">
+<font color="#004faf">Main&nbsp;Classes</font></a>
+ | <a href="annotated.html">
+<font color="#004faf">Annotated</font></a>
+ | <a href="groups.html">
+<font color="#004faf">Grouped&nbsp;Classes</font></a>
+ | <a href="functions.html">
+<font color="#004faf">Functions</font></a>
+</td>
+<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>User Interface Compiler (uic)</h1>
+
+
+
+
+<p> This page documents the <em>User Interface Compiler</em> for the TQt GUI
+toolkit. The <em>uic</em> reads a user interface definition
+(.ui) file in XML as generated by <a href="designer-manual.html">TQt
+Designer</a> and creates corresponding C++ header or source files.
+It can also generate an image file to embed raw image data in C++
+source code.
+<p> <h2> Options
+</h2>
+<a name="1"></a><p> <h3> File Generation Options
+</h3>
+<a name="1-1"></a><p> Generate declaration:
+<pre>
+uic [options] &lt;file&gt;
+</pre>
+
+<p> Generate implementation:
+<pre>
+uic [options] -impl &lt;headerfile&gt; &lt;file&gt;
+</pre>
+
+<ul>
+<li> &lt;headerfile&gt; - name of the declaration file
+</ul>
+<p> Generate image collection:
+<pre>
+uic [options] -embed &lt;project&gt; &lt;image1&gt; &lt;image2&gt; &lt;image3&gt; ...
+</pre>
+
+<ul>
+<li> &lt;project&gt; - project name
+<li> &lt;image[0..n]&gt; - image files
+</ul>
+<p> For convenience, <em>uic</em> can also generate declaration or
+implementation stubs for subclasses.
+<p> Generate subclass declaration:
+<pre>
+uic [options] -subdecl &lt;classname&gt; &lt;headerfile&gt; &lt;file&gt;
+</pre>
+
+<ul>
+<li> &lt;classname&gt; - name of the subclass to generate
+<li> &lt;headerfile&gt; - declaration file of the <b>baseclass</b>
+</ul>
+<p> Generate subclass implementation:
+<pre>
+uic [options] -subimpl &lt;classname&gt; &lt;headerfile&gt; &lt;file&gt;
+</pre>
+
+<ul>
+<li> &lt;classname&gt; - name of the subclass to generate
+<li> &lt;headerfile&gt; - declaration file of the <b>subclass</b>
+</ul>
+<p> <h3> General Options
+</h3>
+<a name="1-2"></a><p> <ul>
+<li> <tt>-o file</tt> - write output to 'file' rather than to stdout.
+<li> <tt>-nofwd</tt> - omit forward declarations of custom classes in the
+generated header file. This is necessary if typedef classes are used.
+<li> <tt>-tr func</tt> - use <tt>func(sourceText, comment)</tt> rather than
+trUtf8(sourceText, comment) for <a href="i18n.html#internationalization">internationalization</a>.
+<li> <tt>-pch file</tt> - add <tt>#include "file"</tt> as the first statement in the implementation file.
+</ul>
+<p> <h2> Usage
+</h2>
+<a name="2"></a><p> <em>uic</em> is almost always invoked by <tt>make (1)</tt>, rather than by hand.
+<p> Here are useful makefile rules if you only use GNU make:
+<pre>
+ %.h: %.ui
+ uic $&lt; -o $@
+
+ %.cpp: %.ui
+ uic -impl $*.h $&lt; -o $@
+</pre>
+
+If you want to write portably, you can use individual rules of the
+following form:
+<pre>
+ NAME.h: NAME.ui
+ uic $&lt; -o $@
+
+ NAME.cpp: NAME.ui
+ uic -impl $*.h $&lt; -o $@
+</pre>
+
+You must also remember to add <tt>NAME.cpp</tt> to your SOURCES (substitute
+your favorite name) variable and <tt>NAME.o</tt> to your OBJECTS variable.
+<p> (While we prefer to name our C++ source files .cpp, the <em>uic</em> doesn't
+care, so you can use .C, .cc, .CC, .cxx or even .c++ if you prefer.)
+<p>
+<!-- eof -->
+<p><address><hr><div align=center>
+<table width=100% cellspacing=0 border=0><tr>
+<td>Copyright &copy; 2007
+<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
+<td align=right><div align=right>TQt 3.3.8</div>
+</table></div></address></body>
+</html>