summaryrefslogtreecommitdiffstats
path: root/doc/man/rbuic.1
blob: d59caa1acc540b1b7feda6539cc8a6d32c9da851 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
.TH RBUIC 1 "Apr 2004" "Trinity Desktop Environment" "Qt Ruby UI Compiler Manual"
.SH NAME
rbuic \- The Qt Ruby UI Compiler
.SH SYNOPSIS
Generate implementation:
.B rbuic
[options] uifile
.LP
Generate subclass implementation:
.B rbuic
[options] -subimpl <classname> <uifile>
.LP
Generate image collection:
.B rbuic
[options] -embed <project> <image1> <image2> <image3> ...
.SH DESCRIPTION
Rbuic is the Qt Ruby UI Compiler.  It generates Ruby code from a XML
UI Description file.  This XML UI Description file can be generated by
Qt Designer, Qt's graphical UI designer.  Rbuic is the Ruby equivalent
for the C++ uic program.

When invoked to generate an implementation, rbuic generates Ruby code
for the Qt UI Description File passed to it, and outputs it on
standard output.

When invoked to generate a subclass implementation, rbuic generates
template Ruby code for a subclass of the widget in the Qt UI
Description File passed to it, and outputs it on standard output.

When invoked to generate an image collection, rbuic generates Ruby
code containing the image data in strings.  This is useful to avoid
having to distribute image files along with your application.  It is
arguably more useful for C++ ( where the image strings can be compiled
into an executable ), but still, it is available for Ruby as well.
.SH OPTIONS
.TP
.B \-o <file>
Write output to file rather than stdout.
.TP
.B \-p <indent>
Set the indent in spaces (0 to use a tab)
.TP
.B \-nofwd
Omit imports of custom widgets
.TP
.B \-kde
Use TDE widgets, require 'Korundum' extension
.TP
.B \-tr <func>
Use func(...) rather than trUtf8(...) for i18n
.TP
.B \-x
Generate extra code to test the class
.TP
.B \-version
Print the Rbuic and Qt versions
.TP
.B \-help
Display some help information.
.SH AUTHOR
Germain Garand
Phil Thompson
.SH SEE ALSO
uic(1)