From 5a1d03de6b56d254662b5d3a57f809907359fff0 Mon Sep 17 00:00:00 2001 From: OBATA Akio Date: Tue, 7 Jul 2020 17:12:46 +0900 Subject: Refrect qt -> tqt changes to man1 Adjust page name to the installed tool name and follow class name changes in examples. Signed-off-by: OBATA Akio --- doc/man/man1/designer.1 | 54 ------ doc/man/man1/linguist.1 | 37 ---- doc/man/man1/lrelease.1 | 101 ----------- doc/man/man1/lupdate.1 | 107 ----------- doc/man/man1/moc.1 | 449 ---------------------------------------------- doc/man/man1/qembed.1 | 32 ---- doc/man/man1/qtconfig.1 | 17 -- doc/man/man1/tqdesigner.1 | 54 ++++++ doc/man/man1/tqembed.1 | 32 ++++ doc/man/man1/tqlinguist.1 | 37 ++++ doc/man/man1/tqlrelease.1 | 101 +++++++++++ doc/man/man1/tqlupdate.1 | 107 +++++++++++ doc/man/man1/tqmoc.1 | 449 ++++++++++++++++++++++++++++++++++++++++++++++ doc/man/man1/tqtconfig.1 | 17 ++ doc/man/man1/tquic.1 | 136 ++++++++++++++ doc/man/man1/uic.1 | 136 -------------- 16 files changed, 933 insertions(+), 933 deletions(-) delete mode 100644 doc/man/man1/designer.1 delete mode 100644 doc/man/man1/linguist.1 delete mode 100644 doc/man/man1/lrelease.1 delete mode 100644 doc/man/man1/lupdate.1 delete mode 100644 doc/man/man1/moc.1 delete mode 100644 doc/man/man1/qembed.1 delete mode 100644 doc/man/man1/qtconfig.1 create mode 100644 doc/man/man1/tqdesigner.1 create mode 100644 doc/man/man1/tqembed.1 create mode 100644 doc/man/man1/tqlinguist.1 create mode 100644 doc/man/man1/tqlrelease.1 create mode 100644 doc/man/man1/tqlupdate.1 create mode 100644 doc/man/man1/tqmoc.1 create mode 100644 doc/man/man1/tqtconfig.1 create mode 100644 doc/man/man1/tquic.1 delete mode 100644 doc/man/man1/uic.1 (limited to 'doc/man/man1') diff --git a/doc/man/man1/designer.1 b/doc/man/man1/designer.1 deleted file mode 100644 index 32a49cb3..00000000 --- a/doc/man/man1/designer.1 +++ /dev/null @@ -1,54 +0,0 @@ -.TH "qt-designer" "1" "3.0.3" "Troll Tech AS, Norway." "" -.SH "NAME" -.LP -qt\-designer \- Visual user interface designer for Qt. -.SH "DESCRIPTION" -.LP -Qt Designer simplifies the process of designing and -creating graphical user interfaces (GUI) using the -award\-winning TQt toolkit. TQt Designer is easy to learn. -There are tutorials, walkthrough examples and the -reference documentation accelerating you through the -learning phase. After that, TQt Designer greatly reduces -the time and effort needed to develop even the most -complex dialogs with an easy\-to\-use GUI and an integrated -help system. - - TQt Designer provides a rich set of features aimed at -making the creation of dialogs as easy and smooth as -possible without reducing the power of Qt. It offers all -the strength of the TQt layout system with a well\-designed -user interface. This, combined with the TQt Designer's -undo/redo system makes it simple to try different -arrangements of the widgets until the result satisfies -you. - - Using TQt Designer's convenient property editor along -with the dynamic TQt property system it is easy to set the -initial state of your widgets. Special editors for some -widgets (like listboxes, comboboxes, etc.) allow you to -fill these widgets with content without writing any code. -Using the object hierarchy view, the parent\-child -relationship between the widgets of a dialog can be -understood at a glance. - - Integrating dialogs into a TQt project is straightforward -thanks to the User Interface Compiler (UIC), which -generates C++ code from the XML dialog description on the -fly. The programmer can easily extend the functionality -of the generated classes by subclassing without touching -generated code at all or running the risk of loosing -their changes. -.SH "FILES" -.LP -\fI/usr/share/qt/tools/designer/*\fP -.SH "ENVIRONMENT VARIABLES" -.LP -.TP -\fBTQTDIR\fP -Specifies the TQt base directory. On Debian systems this -should be set to /usr/share/qt. The /usr/bin/designer -wrapper script takes care of this. -.SH "AUTHORS" -.LP -TrollTech diff --git a/doc/man/man1/linguist.1 b/doc/man/man1/linguist.1 deleted file mode 100644 index d8960da9..00000000 --- a/doc/man/man1/linguist.1 +++ /dev/null @@ -1,37 +0,0 @@ -.TH LINGUIST 1 "28 August 2004" -.SH "NAME" -linguist \- Translation tool for Qt. - -.SH "SYNPOSIS" -.B linguist -[ -.I TRANSLATION -] - -.SH "DESCRIPTION" -.B TQt Linguist -is a tool for adding translations to TQt applications. It -introduces the concept of a translation "context" which -means a group of phrases that appear together on the -screen e.g. in the same menu or dialog. - -The only parameter accepted on the command line is -.I TRANSLATION -wich is the name of the translation file you wish to open. - -.SH FILES -.I ~/.qt/qt_designerrc -.RS -Per user configuration file. - -.SH SEE ALSO -.B TQt Linguist -is too complex to be described completely in the "man" page -format. If your system is properly configured, you can access -the full documentation within -.B TQt Linguist -under the Help menu. - -.SH AUTHOR -This manual page was written by Jeremy Laine , -for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/man1/lrelease.1 b/doc/man/man1/lrelease.1 deleted file mode 100644 index 722e6f5a..00000000 --- a/doc/man/man1/lrelease.1 +++ /dev/null @@ -1,101 +0,0 @@ -.TH lrelease 1 "18 October 2001" "Trolltech AS" \" -*- nroff -*- -.\" -.\" Copyright (C) 2001-2007 Trolltech ASA. All rights reserved. -.\" -.\" This file may be used under the terms of the GNU General Public -.\" License versions 2.0 or 3.0 as published by the Free Software -.\" Foundation and appearing in the file LICENSE.GPL included in the -.\" packaging of this file. Alternatively you may (at your option) use any -.\" later version of the GNU General Public License if such license has -.\" been publicly approved by Trolltech ASA (or its successors, if any) -.\" and the KDE Free TQt Foundation. -.\" -.\" Please review the following information to ensure GNU General -.\" Public Licensing requirements will be met: -.\" http://trolltech.com/products/qt/licenses/licensing/opensource/. -.\" If you are unsure which license is appropriate for your use, please -.\" review the following information: -.\" http://trolltech.com/products/qt/licenses/licensing/licensingoverview -.\" or contact the sales department at sales@trolltech.com. -.\" -.\" Licensees holding valid TQt Commercial licenses may use this file in -.\" accordance with the TQt Commercial License Agreement provided with -.\" the Software. -.\" -.\" This file is provided "AS IS" with NO WARRANTY OF ANY KIND, -.\" INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR -.\" A PARTICULAR PURPOSE. Trolltech reserves all rights not granted -.\" herein. -.\" -.SH NAME -lrelease \- generate TQt message files from TQt Linguist translation files -.SH SYNOPSIS -.B lrelease -.RI "[ " options " ] " project-file -.br -.B lrelease -.RI "[ " options " ] " ts-files " [ -qm " qm-file " ]" -.SH DESCRIPTION -This page documents the -.B TQt Linguist Release -tool for the TQt GUI toolkit. -.B Lrelease -reads a qmake/tmake project file (.pro file) and converts the -translation files (.ts files) specified in it into TQt message files -(.qm files) used by the application to translate. -.PP -The .qm file format is a compact binary format that provides -extremely fast lookups for translations and that is used by Qt. -.SH OPTIONS -.TP -.I "-help" -Display the usage and exit. -.TP -.I "-nocompress" -Do not compress the .qm files. -.TP -.I "-verbose" -Explain what is being done. -.TP -.I "-version" -Display the version of -.B lrelease -and exit. -.SH USAGE -Here is an example .pro file that can be given to -.B lrelease: -.PP -.in +4 -.nf -HEADERS = funnydialog.h \\ - wackywidget.h -SOURCES = funnydialog.cpp \\ - main.cpp \\ - wackywidget.cpp -FORMS = fancybox.ui -TRANSLATIONS = gnomovision_dk.ts \\ - gnomovision_fi.ts \\ - gnomovision_no.ts \\ - gnomovision_se.ts -.fi -.in -4 -.PP -When running -.B lrelease -on this project file, the TQt message files gnomovision_dk.qm, -gnomovision_fi.qm, gnomovision_no.qm and gnomovision_se.qm will be -generated from gnomovision_dk.ts, gnomovision_fi.ts, -gnomovision_no.ts and gnomovision_se.ts, respectively. -.PP -.B Lrelease -can also be invoked with a list of .ts files to convert: -.PP -.in +4 -.nf -lrelease gnomovision_*.ts -.fi -.in -4 -.SH "SEE ALSO" -.BR lupdate (1) -and -.BR http://doc.trolltech.com/i18n.html diff --git a/doc/man/man1/lupdate.1 b/doc/man/man1/lupdate.1 deleted file mode 100644 index 3add01c7..00000000 --- a/doc/man/man1/lupdate.1 +++ /dev/null @@ -1,107 +0,0 @@ -.TH lupdate 1 "18 October 2001" "Trolltech AS" \" -*- nroff -*- -.\" -.\" Copyright (C) 2001-2007 Trolltech ASA. All rights reserved. -.\" -.\" This file may be used under the terms of the GNU General Public -.\" License versions 2.0 or 3.0 as published by the Free Software -.\" Foundation and appearing in the file LICENSE.GPL included in the -.\" packaging of this file. Alternatively you may (at your option) use any -.\" later version of the GNU General Public License if such license has -.\" been publicly approved by Trolltech ASA (or its successors, if any) -.\" and the KDE Free TQt Foundation. -.\" -.\" Please review the following information to ensure GNU General -.\" Public Licensing requirements will be met: -.\" http://trolltech.com/products/qt/licenses/licensing/opensource/. -.\" If you are unsure which license is appropriate for your use, please -.\" review the following information: -.\" http://trolltech.com/products/qt/licenses/licensing/licensingoverview -.\" or contact the sales department at sales@trolltech.com. -.\" -.\" Licensees holding valid TQt Commercial licenses may use this file in -.\" accordance with the TQt Commercial License Agreement provided with -.\" the Software. -.\" -.\" This file is provided "AS IS" with NO WARRANTY OF ANY KIND, -.\" INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR -.\" A PARTICULAR PURPOSE. Trolltech reserves all rights not granted -.\" herein. -.\" -.SH NAME -lupdate \- update TQt Linguist translation files -.SH SYNOPSIS -.B lupdate -.RI "[ " options " ] " project-file -.br -.B lupdate -.RI "[ " options " ] " source-files " -ts " ts-files -.SH DESCRIPTION -This page documents the -.B TQt Linguist Update -tool for the TQt GUI toolkit. -.B Lupdate -reads a qmake/tmake project file (.pro file), finds the translatable -strings in the specified source, header and interface files, and -updates the translation files (.ts files) specified in it. The -translation files are given to the translator who uses -.B TQt Linguist -to read the files and insert the translations. -.PP -The .ts file format is a simple human-readable XML format that can be -used with version control systems if required. -.PP -.SH OPTIONS -.TP -.I "-help" -Display the usage and exit. -.TP -.I "-noobsolete" -Drop all obsolete strings. -.TP -.I "-verbose" -Explain what is being done. -.TP -.I "-version" -Display the version of -.B lupdate -and exit. -.SH USAGE -Here is an example .pro file that can be given to -.B lupdate: -.PP -.in +4 -.nf -HEADERS = funnydialog.h \\ - wackywidget.h -SOURCES = funnydialog.cpp \\ - main.cpp \\ - wackywidget.cpp -FORMS = fancybox.ui -TRANSLATIONS = gnomovision_dk.ts \\ - gnomovision_fi.ts \\ - gnomovision_no.ts \\ - gnomovision_se.ts -.fi -.in -4 -.PP -When running -.B lupdate -on this project file, the translatable strings in all the files -listed in the HEADERS, SOURCES and FORMS entries will be put in -the translation files listed in the TRANSLATIONS entry. Previous -translations will be reused as far as possible, and translated -strings that have vanished from the source files are marked obsolete. -.PP -.B Lupdate -can also be invoked with a list of C++ source files, .ui files -and .ts files: -.PP -.in +4 -.nf -lupdate *.cpp *.h *.ui -ts gnomovision_dk.ts -.fi -.in -4 -.SH "SEE ALSO" -.BR lrelease (1) -and -.BR http://doc.trolltech.com/i18n.html diff --git a/doc/man/man1/moc.1 b/doc/man/man1/moc.1 deleted file mode 100644 index 24ed9690..00000000 --- a/doc/man/man1/moc.1 +++ /dev/null @@ -1,449 +0,0 @@ -.TH moc 1 "24 June 2001" "Trolltech AS" \" -*- nroff -*- -.\" -.\" $Id: qt/moc.1 3.3.8 edited Jan 11 14:38 $ -.\" -.\" Copyright (C) 1992-2007 Trolltech ASA. All rights reserved. -.\" -.\" This file is part of TQt and may be distributed and used according to -.\" the terms and conditions described in the LICENSE file. -.\" -.nh -.SH NAME -moc \- generate TQt meta object support code -.SH SYNOPSIS -.B moc -[-o file] [-i] [-f] [-k] [-ldbg] [-nw] [-p path] [-q path] [-v] file -.SH DESCRIPTION -This page documents the -.B Meta Object Compiler -for the TQt GUI application framework. The -.B moc -reads one or more C++ class declarations from a C++ header or source -file and generates one C++ source file containing meta object -information for the classes. The C++ source file generated by the -.B moc -must be compiled and linked with the implementation of the class (or it -can be #included into the class's source file). -.PP -If you use -.B qmake -to create your Makefiles, build rules will be included that call the -.B moc -when required, so you will not need to use the -.B moc -directly. -.PP -In brief, the meta object system is a structure used by TQt (see -.BR http://doc.trolltech.com ")" -for component programming and run time type information. It adds -properties and inheritance information to (some) classes and -provides a new type of communication between those instances of those -classes, signal-slot -connections. -.SH OPTIONS -.TP -.I "-o file" -Write output to -.I file -rather than to stdout. -.TP -.I -f -Force the generation of an #include statement in the output. -This is the default for files whose name matches the regular -expression .[hH][^.]* (i.e. the extension starts with -.B H -or -.B h -). This -option is only useful if you have header files that do not follow the -standard naming conventions. -.TP -.I "-i" -Do not generate an #include statement in the output. This may be used -to run -.B moc -on a C++ file containing one or more class declarations. You should then -#include the meta object code in the .cpp file (see USAGE below). If both -.I -f -and -.I -i -are present, the last one wins. -.TP -.I "-nw" -Do not generate any warnings. Not recommended. -.TP -.I "-ldbg" -Write a flood of lex debug information to stdout. -.TP -.I "-p path" -Makes -.B moc -prepend -.IR path / -to the file name in the generated #include statement (if one is generated). -.TP -.I "-q path" -Makes -.B moc -prepend -.IR path / -to the file name of qt #include files in the generated code. -.TP -.I "-v" -Displays the version of -.B moc -and Qt. -.PP -You can explicitly tell the -.B moc -not to parse parts of a header -file. It recognizes any C++ comment (//) that contains the substrings -MOC_SKIP_BEGIN or MOC_SKIP_END. They work as you would expect and you -can have several levels of them. The net result as seen by the -.B moc -is as if you had removed all lines between a MOC_SKIP_BEGIN and a -MOC_SKIP_END -.SH USAGE -.B moc -is almost always invoked by -.BR make (1), -not by hand. -.PP -.B moc -is typically used with an input file containing class declarations -like this: -.PP -.in +4 -.nf -class YourClass : public QObject { - TQ_OBJECT - TQ_PROPERTY( ... ) - TQ_CLASSINFO( ... ) - -public: - YourClass( QObject * parent=0, const char * name=0 ); - ~YourClass(); - -signals: - -public slots: - -}; -.fi -.in -4 -.PP -Here is a useful makefile rule if you only use GNU make: -.PP -.in +4 -.nf -m%.cpp: %.h - moc $< -o $@ -.fi -.in -4 -.PP -If you want to write portably, you can use individual rules of the -following form: -.PP -.in +4 -.nf -mNAME.cpp: NAME.h - moc $< -o $@ -.fi -.in -4 -.PP -You must also remember to add -.I mNAME.cpp -to your SOURCES (substitute your favorite name) variable and -.I mNAME.o -to your OBJECTS variable. -.PP -(While we prefer to name our C++ source files .cpp, the -.B moc -doesn't know that, so you can use .C, .cc, .CC, .cxx or even .c++ if -you prefer.) -.PP -If you have class declarations in C++ files, we recommend that you use -a makefile rule like this: -.PP -.in +4 -.nf -NAME.o: mNAME.cpp - -mNAME.cpp: NAME.cpp - moc -i $< -o $@ -.fi -.in -4 -.PP -This guarantees that -.BR make (1) -will run the -.B moc -before it compiles -.IR NAME.cpp . -You can then put -.PP -.ti +4 -#include "nNAME.cpp" -.PP -at the end of -.IR NAME.cpp , -where all the classes declared in that file are fully known. -.SH DIAGNOSTICS -Sometimes you may get linkage errors, saying that -YourClass::className() is undefined or that YourClass lacks a vtbl. -Those errors happen most often when you forget to compile the -moc-generated C++ code or include that object file in the link -command. -.PP -The -.B moc -will warn you about a number of dangerous or illegal constructs. -.SH BUGS - -The -.B moc -does not expand #include or #define, it simply skips any preprocessor -directives it encounters. This is regrettable, but is normally not a -problem in practice. - -The -.B moc -does not handle all of C++. The main problem is that class templates -cannot have signals or slots. This is an important bug. Here is an -example: -.PP -.in +4 -.nf -class SomeTemplate : public QFrame { - TQ_OBJECT - .... -signals: - void bugInMocDetected( int ); -}; -.fi -.in -4 -.PP -Less importantly, the following constructs are illegal. All of them -have have alternatives which we think are usually better, so removing -these limitations is not a high priority for us. -.SS "Multiple inheritance requires QObject to be first." -If you are using multiple inheritance, -.B moc -assumes that the -.B first -inherited class is a subclass of QObject. Also, be sure that -.B only -the first inherited class is a QObject. -.PP -.in +4 -.nf -class SomeClass : public QObject, public OtherClass { - ... -}; -.fi -.in -4 -.PP -This bug is almost impossible to fix; since the -.B moc -does not expand -#include or #define, it cannot find out which one of the base classes is a -QObject. -.SS "Function pointers cannot be arguments to signals or slots." -In most cases where you would consider that, we think inheritance is a -better alternative. Here is an example of illegal syntax: -.PP -.in +4 -.nf -class SomeClass : public QObject { - TQ_OBJECT - ... -public slots: - // illegal - void apply( void (*apply)(List *, void *), void * ); -}; -.fi -.in -4 -.PP -You can work around this restriction like this: -.PP -.in +4 -.nf -typedef void (*ApplyFunctionType)( List *, void * ); - -class SomeClass : public QObject { - TQ_OBJECT - ... -public slots: - void apply( ApplyFunctionType, char * ); -}; -.fi -.in -4 -.PP -It may sometimes be even better to replace the function pointer with -inheritance and virtual functions, signals or slots. -.SS "Friend declarations cannot be placed in signals or slots sections" -Sometimes it will work, but in general, friend declarations cannot be -placed in -.B signals -or -.B slots -sections. Put them in the good old -.BR private ", " protected -or -.B public -sections instead. Here is an example of the illegal syntax: -.PP -.in +4 -.nf -class SomeClass : public QObject { - TQ_OBJECT - ... -signals: - friend class ClassTemplate; // illegal -}; -.fi -.in -4 -.SS "Signals and slots cannot be upgraded" -The C++ feature of upgrading an inherited member function to -.B public -status is not extended to cover signals and slots. Here is an illegal -example: -.PP -.in +4 -.nf -class Whatever : public QButtonGroup { - ... -public slots: - QButtonGroup::buttonPressed; // illegal - ... -}; -.fi -.in -4 -.PP -The QButtonGroup::buttonPressed() slot is protected. -.PP -C++ quiz: What happens if you try to upgrade a protected member -function which is overloaded? -.IP -- All the functions are upgraded. -.IP -- That is not legal C++. -.\" Good idea, but look in the SEE ALSO section... -.SS "Type macros cannot be used for signal and slot arguments" - -Since the -.B moc -does not expand #define, type macros that take an argument -will not work in signals and slots. Here is an illegal example: -.PP -.in +4 -.nf -#ifdef ultrix -#define SIGNEDNESS(a) unsigned a -#else -#define SIGNEDNESS(a) a -#endif -class Whatever : public QObject { - ... -signals: - void someSignal( SIGNEDNESS(int) ); // illegal -}; -.PP -A #define without arguments works. -.fi -.in -4 -.SS "Nested classes cannot be in the signals or slots sections nor have signals or slots" -Here's an example: -.PP -.in +4 -.nf -class A { - TQ_OBJECT -public: - class B { - public slots: // illegal - void b(); - ... - }; -signals: - class B { // illegal - void b(); - ... - }: -}; -.fi -.in -4 -.PP -.SS "Constructors cannot be used in signals or slots sections" -It is a mystery to us why anyone would put a constructor on either the -.B signals -or -.B slots -sections. You can't, anyway (except that it happens to work in some -cases). Put them in -.BR private ", " protected -or -.B public -sections, where they belong. Here is an example of the illegal syntax: -.PP -.in +4 -.nf -class SomeClass : public QObject { - TQ_OBJECT -public slots: - SomeClass( QObject *parent, const char *name ) - : QObject( parent, name ) {} // illegal - ... -}; -.fi -.in -4 -.SS "Properties need to be declared before the public section that contains the respective get and set functions" -.PP -Declaring the first property within or after the public section that -contains the type definition and the respective get and set functions -does not work as expected. The -.B moc -will complain that it can neither -find the functions nor resolve the type. Here is an example of the -illegal syntax: -.PP -.in +4 -.nf -class SomeClass : public QObject { - TQ_OBJECT -public: - ... - // illegal - TQ_PROPERTY( Priority priority READ priority WRITE setPriority ) - TQ_ENUMS( Priority ) - enum Priority { High, Low, VeryHigh, VeryLow }; - void setPriority( Priority ); - Priority priority() const; - ... -}; -.fi -.in -4 -.PP -Work around this limitation by declaring all properties at the -beginning of the class declaration, right after TQ_OBJECT: -.PP -.in +4 -.nf -class SomeClass : public QObject { - TQ_OBJECT - TQ_PROPERTY( Priority priority READ priority WRITE setPriority ) - TQ_ENUMS( Priority ) -public: - ... - enum Priority { High, Low, VeryHigh, VeryLow }; - void setPriority( Priority ); - Priority priority() const; - ... -}; -.fi -.in -4 -.PP -.SH "SEE ALSO" -.BR http://www.trolltech.com ", " -.BR "C++ ARM, section r.11.3" " (for the answer to the quiz), and" -.BR http://doc.trolltech.com " (for complete TQt documentation)." diff --git a/doc/man/man1/qembed.1 b/doc/man/man1/qembed.1 deleted file mode 100644 index a9b262f1..00000000 --- a/doc/man/man1/qembed.1 +++ /dev/null @@ -1,32 +0,0 @@ -.TH "qembed" "1" "3.0.3" "Troll Tech AS, Norway." "" -.SH "NAME" -.LP -qembed \- Converts arbitrary files into C++ code. -.SH "DESCRIPTION" -.LP -The QEmbed tool, found in qt/tools/qembed, converts -arbitrary files into C++ code. This is useful for -including image files and other resources directly into -your application rather than loading the data from -external files. - -QEmbed can also generate uncompressed versions of images -that can be included directly into your application, -thus avoiding both the external file and the need to -parse the image file format. This is useful for small -images such as icons for which compression is not a -great gain. - - -.SH "SYNTAX" -qembed [ \fIgeneral\-files\fP ] <[ \fI\-\-images image\-files \fP]> -.br - -general\-files - These files can be any type of file. -\-\-images image\-files - These files must be in image formats supported by Qt. - -.SH "AUTHORS" -.LP -TrollTech diff --git a/doc/man/man1/qtconfig.1 b/doc/man/man1/qtconfig.1 deleted file mode 100644 index 2e280772..00000000 --- a/doc/man/man1/qtconfig.1 +++ /dev/null @@ -1,17 +0,0 @@ -.TH "qtconfig" "1" "3.0.3" "Troll Tech AS, Norway." "" -.SH "NAME" -.LP -qtconfig \- Configuration tool for Qt -.SH "DESCRIPTION" -.LP -QConfig allows for GUI based configuration of TQt and - other TQt based sources. - -.SH "ENVIRONMENT VARIABLES" -.LP -.TP -\fBTQTDIR\fP -Specifies the base TQt dir -.SH "AUTHORS" -.LP -TrollTech diff --git a/doc/man/man1/tqdesigner.1 b/doc/man/man1/tqdesigner.1 new file mode 100644 index 00000000..cb760d23 --- /dev/null +++ b/doc/man/man1/tqdesigner.1 @@ -0,0 +1,54 @@ +.TH "tqtdesigner" "1" "3.0.3" "Troll Tech AS, Norway." "" +.SH "NAME" +.LP +tqtdesigner \- Visual user interface designer for TQt. +.SH "DESCRIPTION" +.LP +TQt Designer simplifies the process of designing and +creating graphical user interfaces (GUI) using the +award\-winning TQt toolkit. TQt Designer is easy to learn. +There are tutorials, walkthrough examples and the +reference documentation accelerating you through the +learning phase. After that, TQt Designer greatly reduces +the time and effort needed to develop even the most +complex dialogs with an easy\-to\-use GUI and an integrated +help system. + + TQt Designer provides a rich set of features aimed at +making the creation of dialogs as easy and smooth as +possible without reducing the power of Qt. It offers all +the strength of the TQt layout system with a well\-designed +user interface. This, combined with the TQt Designer's +undo/redo system makes it simple to try different +arrangements of the widgets until the result satisfies +you. + + Using TQt Designer's convenient property editor along +with the dynamic TQt property system it is easy to set the +initial state of your widgets. Special editors for some +widgets (like listboxes, comboboxes, etc.) allow you to +fill these widgets with content without writing any code. +Using the object hierarchy view, the parent\-child +relationship between the widgets of a dialog can be +understood at a glance. + + Integrating dialogs into a TQt project is straightforward +thanks to the User Interface Compiler (UIC), which +generates C++ code from the XML dialog description on the +fly. The programmer can easily extend the functionality +of the generated classes by subclassing without touching +generated code at all or running the risk of loosing +their changes. +.SH "FILES" +.LP +\fI/usr/share/qt/tools/designer/*\fP +.SH "ENVIRONMENT VARIABLES" +.LP +.TP +\fBTQTDIR\fP +Specifies the TQt base directory. On Debian systems this +should be set to /usr/share/qt. The /usr/bin/designer +wrapper script takes care of this. +.SH "AUTHORS" +.LP +TrollTech diff --git a/doc/man/man1/tqembed.1 b/doc/man/man1/tqembed.1 new file mode 100644 index 00000000..82255a69 --- /dev/null +++ b/doc/man/man1/tqembed.1 @@ -0,0 +1,32 @@ +.TH "tqembed" "1" "3.0.3" "Troll Tech AS, Norway." "" +.SH "NAME" +.LP +tqembed \- Converts arbitrary files into C++ code. +.SH "DESCRIPTION" +.LP +The TQEmbed tool, found in tqt3/tools/qembed, converts +arbitrary files into C++ code. This is useful for +including image files and other resources directly into +your application rather than loading the data from +external files. + +TQEmbed can also generate uncompressed versions of images +that can be included directly into your application, +thus avoiding both the external file and the need to +parse the image file format. This is useful for small +images such as icons for which compression is not a +great gain. + + +.SH "SYNTAX" +tqembed [ \fIgeneral\-files\fP ] <[ \fI\-\-images image\-files \fP]> +.br + +general\-files + These files can be any type of file. +\-\-images image\-files + These files must be in image formats supported by TQt. + +.SH "AUTHORS" +.LP +TrollTech diff --git a/doc/man/man1/tqlinguist.1 b/doc/man/man1/tqlinguist.1 new file mode 100644 index 00000000..8aeab518 --- /dev/null +++ b/doc/man/man1/tqlinguist.1 @@ -0,0 +1,37 @@ +.TH LINGUIST 1 "28 August 2004" +.SH "NAME" +tqlinguist \- Translation tool for TQt. + +.SH "SYNPOSIS" +.B tqlinguist +[ +.I TRANSLATION +] + +.SH "DESCRIPTION" +.B TQt Linguist +is a tool for adding translations to TQt applications. It +introduces the concept of a translation "context" which +means a group of phrases that appear together on the +screen e.g. in the same menu or dialog. + +The only parameter accepted on the command line is +.I TRANSLATION +wich is the name of the translation file you wish to open. + +.SH FILES +.I ~/.qt/qt_designerrc +.RS +Per user configuration file. + +.SH SEE ALSO +.B TQt Linguist +is too complex to be described completely in the "man" page +format. If your system is properly configured, you can access +the full documentation within +.B TQt Linguist +under the Help menu. + +.SH AUTHOR +This manual page was written by Jeremy Laine , +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/man1/tqlrelease.1 b/doc/man/man1/tqlrelease.1 new file mode 100644 index 00000000..fd3abacb --- /dev/null +++ b/doc/man/man1/tqlrelease.1 @@ -0,0 +1,101 @@ +.TH tqlrelease 1 "18 October 2001" "Trolltech AS" \" -*- nroff -*- +.\" +.\" Copyright (C) 2001-2007 Trolltech ASA. All rights reserved. +.\" +.\" This file may be used under the terms of the GNU General Public +.\" License versions 2.0 or 3.0 as published by the Free Software +.\" Foundation and appearing in the file LICENSE.GPL included in the +.\" packaging of this file. Alternatively you may (at your option) use any +.\" later version of the GNU General Public License if such license has +.\" been publicly approved by Trolltech ASA (or its successors, if any) +.\" and the KDE Free TQt Foundation. +.\" +.\" Please review the following information to ensure GNU General +.\" Public Licensing requirements will be met: +.\" http://trolltech.com/products/qt/licenses/licensing/opensource/. +.\" If you are unsure which license is appropriate for your use, please +.\" review the following information: +.\" http://trolltech.com/products/qt/licenses/licensing/licensingoverview +.\" or contact the sales department at sales@trolltech.com. +.\" +.\" Licensees holding valid TQt Commercial licenses may use this file in +.\" accordance with the TQt Commercial License Agreement provided with +.\" the Software. +.\" +.\" This file is provided "AS IS" with NO WARRANTY OF ANY KIND, +.\" INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR +.\" A PARTICULAR PURPOSE. Trolltech reserves all rights not granted +.\" herein. +.\" +.SH NAME +tqlrelease \- generate TQt message files from TQt Linguist translation files +.SH SYNOPSIS +.B tqlrelease +.RI "[ " options " ] " project-file +.br +.B tqlrelease +.RI "[ " options " ] " ts-files " [ -qm " qm-file " ]" +.SH DESCRIPTION +This page documents the +.B TQt Linguist Release +tool for the TQt GUI toolkit. +.B Lrelease +reads a tqmake/tmake project file (.pro file) and converts the +translation files (.ts files) specified in it into TQt message files +(.qm files) used by the application to translate. +.PP +The .qm file format is a compact binary format that provides +extremely fast lookups for translations and that is used by Qt. +.SH OPTIONS +.TP +.I "-help" +Display the usage and exit. +.TP +.I "-nocompress" +Do not compress the .qm files. +.TP +.I "-verbose" +Explain what is being done. +.TP +.I "-version" +Display the version of +.B tqlrelease +and exit. +.SH USAGE +Here is an example .pro file that can be given to +.B tqlrelease: +.PP +.in +4 +.nf +HEADERS = funnydialog.h \\ + wackywidget.h +SOURCES = funnydialog.cpp \\ + main.cpp \\ + wackywidget.cpp +FORMS = fancybox.ui +TRANSLATIONS = gnomovision_dk.ts \\ + gnomovision_fi.ts \\ + gnomovision_no.ts \\ + gnomovision_se.ts +.fi +.in -4 +.PP +When running +.B tqlrelease +on this project file, the TQt message files gnomovision_dk.qm, +gnomovision_fi.qm, gnomovision_no.qm and gnomovision_se.qm will be +generated from gnomovision_dk.ts, gnomovision_fi.ts, +gnomovision_no.ts and gnomovision_se.ts, respectively. +.PP +.B Lrelease +can also be invoked with a list of .ts files to convert: +.PP +.in +4 +.nf +tqlrelease gnomovision_*.ts +.fi +.in -4 +.SH "SEE ALSO" +.BR tqlupdate (1) +and +.BR http://doc.trolltech.com/i18n.html diff --git a/doc/man/man1/tqlupdate.1 b/doc/man/man1/tqlupdate.1 new file mode 100644 index 00000000..32cc4e14 --- /dev/null +++ b/doc/man/man1/tqlupdate.1 @@ -0,0 +1,107 @@ +.TH tqlupdate 1 "18 October 2001" "Trolltech AS" \" -*- nroff -*- +.\" +.\" Copyright (C) 2001-2007 Trolltech ASA. All rights reserved. +.\" +.\" This file may be used under the terms of the GNU General Public +.\" License versions 2.0 or 3.0 as published by the Free Software +.\" Foundation and appearing in the file LICENSE.GPL included in the +.\" packaging of this file. Alternatively you may (at your option) use any +.\" later version of the GNU General Public License if such license has +.\" been publicly approved by Trolltech ASA (or its successors, if any) +.\" and the KDE Free TQt Foundation. +.\" +.\" Please review the following information to ensure GNU General +.\" Public Licensing requirements will be met: +.\" http://trolltech.com/products/qt/licenses/licensing/opensource/. +.\" If you are unsure which license is appropriate for your use, please +.\" review the following information: +.\" http://trolltech.com/products/qt/licenses/licensing/licensingoverview +.\" or contact the sales department at sales@trolltech.com. +.\" +.\" Licensees holding valid TQt Commercial licenses may use this file in +.\" accordance with the TQt Commercial License Agreement provided with +.\" the Software. +.\" +.\" This file is provided "AS IS" with NO WARRANTY OF ANY KIND, +.\" INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR +.\" A PARTICULAR PURPOSE. Trolltech reserves all rights not granted +.\" herein. +.\" +.SH NAME +tqlupdate \- update TQt Linguist translation files +.SH SYNOPSIS +.B tqlupdate +.RI "[ " options " ] " project-file +.br +.B tqlupdate +.RI "[ " options " ] " source-files " -ts " ts-files +.SH DESCRIPTION +This page documents the +.B TQt Linguist Update +tool for the TQt GUI toolkit. +.B Lupdate +reads a tqmake/tmake project file (.pro file), finds the translatable +strings in the specified source, header and interface files, and +updates the translation files (.ts files) specified in it. The +translation files are given to the translator who uses +.B TQt Linguist +to read the files and insert the translations. +.PP +The .ts file format is a simple human-readable XML format that can be +used with version control systems if required. +.PP +.SH OPTIONS +.TP +.I "-help" +Display the usage and exit. +.TP +.I "-noobsolete" +Drop all obsolete strings. +.TP +.I "-verbose" +Explain what is being done. +.TP +.I "-version" +Display the version of +.B tqlupdate +and exit. +.SH USAGE +Here is an example .pro file that can be given to +.B tqlupdate: +.PP +.in +4 +.nf +HEADERS = funnydialog.h \\ + wackywidget.h +SOURCES = funnydialog.cpp \\ + main.cpp \\ + wackywidget.cpp +FORMS = fancybox.ui +TRANSLATIONS = gnomovision_dk.ts \\ + gnomovision_fi.ts \\ + gnomovision_no.ts \\ + gnomovision_se.ts +.fi +.in -4 +.PP +When running +.B tqlupdate +on this project file, the translatable strings in all the files +listed in the HEADERS, SOURCES and FORMS entries will be put in +the translation files listed in the TRANSLATIONS entry. Previous +translations will be reused as far as possible, and translated +strings that have vanished from the source files are marked obsolete. +.PP +.B Lupdate +can also be invoked with a list of C++ source files, .ui files +and .ts files: +.PP +.in +4 +.nf +tqlupdate *.cpp *.h *.ui -ts gnomovision_dk.ts +.fi +.in -4 +.SH "SEE ALSO" +.BR tqlrelease (1) +and +.BR http://doc.trolltech.com/i18n.html diff --git a/doc/man/man1/tqmoc.1 b/doc/man/man1/tqmoc.1 new file mode 100644 index 00000000..cbf201a4 --- /dev/null +++ b/doc/man/man1/tqmoc.1 @@ -0,0 +1,449 @@ +.TH tqmoc 1 "24 June 2001" "Trolltech AS" \" -*- nroff -*- +.\" +.\" $Id: qt/moc.1 3.3.8 edited Jan 11 14:38 $ +.\" +.\" Copyright (C) 1992-2007 Trolltech ASA. All rights reserved. +.\" +.\" This file is part of TQt and may be distributed and used according to +.\" the terms and conditions described in the LICENSE file. +.\" +.nh +.SH NAME +tqmoc \- generate TQt meta object support code +.SH SYNOPSIS +.B tqmoc +[-o file] [-i] [-f] [-k] [-ldbg] [-nw] [-p path] [-q path] [-v] file +.SH DESCRIPTION +This page documents the +.B Meta Object Compiler +for the TQt GUI application framework. The +.B tqmoc +reads one or more C++ class declarations from a C++ header or source +file and generates one C++ source file containing meta object +information for the classes. The C++ source file generated by the +.B tqmoc +must be compiled and linked with the implementation of the class (or it +can be #included into the class's source file). +.PP +If you use +.B tqmake +to create your Makefiles, build rules will be included that call the +.B tqmoc +when required, so you will not need to use the +.B tqmoc +directly. +.PP +In brief, the meta object system is a structure used by TQt (see +.BR http://doc.trolltech.com ")" +for component programming and run time type information. It adds +properties and inheritance information to (some) classes and +provides a new type of communication between those instances of those +classes, signal-slot +connections. +.SH OPTIONS +.TP +.I "-o file" +Write output to +.I file +rather than to stdout. +.TP +.I -f +Force the generation of an #include statement in the output. +This is the default for files whose name matches the regular +expression .[hH][^.]* (i.e. the extension starts with +.B H +or +.B h +). This +option is only useful if you have header files that do not follow the +standard naming conventions. +.TP +.I "-i" +Do not generate an #include statement in the output. This may be used +to run +.B tqmoc +on a C++ file containing one or more class declarations. You should then +#include the meta object code in the .cpp file (see USAGE below). If both +.I -f +and +.I -i +are present, the last one wins. +.TP +.I "-nw" +Do not generate any warnings. Not recommended. +.TP +.I "-ldbg" +Write a flood of lex debug information to stdout. +.TP +.I "-p path" +Makes +.B tqmoc +prepend +.IR path / +to the file name in the generated #include statement (if one is generated). +.TP +.I "-q path" +Makes +.B tqmoc +prepend +.IR path / +to the file name of qt #include files in the generated code. +.TP +.I "-v" +Displays the version of +.B tqmoc +and TQt. +.PP +You can explicitly tell the +.B tqmoc +not to parse parts of a header +file. It recognizes any C++ comment (//) that contains the substrings +MOC_SKIP_BEGIN or MOC_SKIP_END. They work as you would expect and you +can have several levels of them. The net result as seen by the +.B tqmoc +is as if you had removed all lines between a MOC_SKIP_BEGIN and a +MOC_SKIP_END +.SH USAGE +.B tqmoc +is almost always invoked by +.BR make (1), +not by hand. +.PP +.B tqmoc +is typically used with an input file containing class declarations +like this: +.PP +.in +4 +.nf +class YourClass : public TQObject { + TQ_OBJECT + TQ_PROPERTY( ... ) + TQ_CLASSINFO( ... ) + +public: + YourClass( TQObject * parent=0, const char * name=0 ); + ~YourClass(); + +signals: + +public slots: + +}; +.fi +.in -4 +.PP +Here is a useful makefile rule if you only use GNU make: +.PP +.in +4 +.nf +m%.cpp: %.h + tqmoc $< -o $@ +.fi +.in -4 +.PP +If you want to write portably, you can use individual rules of the +following form: +.PP +.in +4 +.nf +mNAME.cpp: NAME.h + tqmoc $< -o $@ +.fi +.in -4 +.PP +You must also remember to add +.I mNAME.cpp +to your SOURCES (substitute your favorite name) variable and +.I mNAME.o +to your OBJECTS variable. +.PP +(While we prefer to name our C++ source files .cpp, the +.B tqmoc +doesn't know that, so you can use .C, .cc, .CC, .cxx or even .c++ if +you prefer.) +.PP +If you have class declarations in C++ files, we recommend that you use +a makefile rule like this: +.PP +.in +4 +.nf +NAME.o: mNAME.cpp + +mNAME.cpp: NAME.cpp + tqmoc -i $< -o $@ +.fi +.in -4 +.PP +This guarantees that +.BR make (1) +will run the +.B tqmoc +before it compiles +.IR NAME.cpp . +You can then put +.PP +.ti +4 +#include "nNAME.cpp" +.PP +at the end of +.IR NAME.cpp , +where all the classes declared in that file are fully known. +.SH DIAGNOSTICS +Sometimes you may get linkage errors, saying that +YourClass::className() is undefined or that YourClass lacks a vtbl. +Those errors happen most often when you forget to compile the +tqmoc-generated C++ code or include that object file in the link +command. +.PP +The +.B tqmoc +will warn you about a number of dangerous or illegal constructs. +.SH BUGS + +The +.B tqmoc +does not expand #include or #define, it simply skips any preprocessor +directives it encounters. This is regrettable, but is normally not a +problem in practice. + +The +.B tqmoc +does not handle all of C++. The main problem is that class templates +cannot have signals or slots. This is an important bug. Here is an +example: +.PP +.in +4 +.nf +class SomeTemplate : public TQFrame { + TQ_OBJECT + .... +signals: + void bugInMocDetected( int ); +}; +.fi +.in -4 +.PP +Less importantly, the following constructs are illegal. All of them +have have alternatives which we think are usually better, so removing +these limitations is not a high priority for us. +.SS "Multiple inheritance requires TQObject to be first." +If you are using multiple inheritance, +.B tqmoc +assumes that the +.B first +inherited class is a subclass of TQObject. Also, be sure that +.B only +the first inherited class is a TQObject. +.PP +.in +4 +.nf +class SomeClass : public TQObject, public OtherClass { + ... +}; +.fi +.in -4 +.PP +This bug is almost impossible to fix; since the +.B tqmoc +does not expand +#include or #define, it cannot find out which one of the base classes is a +TQObject. +.SS "Function pointers cannot be arguments to signals or slots." +In most cases where you would consider that, we think inheritance is a +better alternative. Here is an example of illegal syntax: +.PP +.in +4 +.nf +class SomeClass : public TQObject { + TQ_OBJECT + ... +public slots: + // illegal + void apply( void (*apply)(List *, void *), void * ); +}; +.fi +.in -4 +.PP +You can work around this restriction like this: +.PP +.in +4 +.nf +typedef void (*ApplyFunctionType)( List *, void * ); + +class SomeClass : public TQObject { + TQ_OBJECT + ... +public slots: + void apply( ApplyFunctionType, char * ); +}; +.fi +.in -4 +.PP +It may sometimes be even better to replace the function pointer with +inheritance and virtual functions, signals or slots. +.SS "Friend declarations cannot be placed in signals or slots sections" +Sometimes it will work, but in general, friend declarations cannot be +placed in +.B signals +or +.B slots +sections. Put them in the good old +.BR private ", " protected +or +.B public +sections instead. Here is an example of the illegal syntax: +.PP +.in +4 +.nf +class SomeClass : public TQObject { + TQ_OBJECT + ... +signals: + friend class ClassTemplate; // illegal +}; +.fi +.in -4 +.SS "Signals and slots cannot be upgraded" +The C++ feature of upgrading an inherited member function to +.B public +status is not extended to cover signals and slots. Here is an illegal +example: +.PP +.in +4 +.nf +class Whatever : public TQButtonGroup { + ... +public slots: + TQButtonGroup::buttonPressed; // illegal + ... +}; +.fi +.in -4 +.PP +The TQButtonGroup::buttonPressed() slot is protected. +.PP +C++ quiz: What happens if you try to upgrade a protected member +function which is overloaded? +.IP +- All the functions are upgraded. +.IP +- That is not legal C++. +.\" Good idea, but look in the SEE ALSO section... +.SS "Type macros cannot be used for signal and slot arguments" + +Since the +.B tqmoc +does not expand #define, type macros that take an argument +will not work in signals and slots. Here is an illegal example: +.PP +.in +4 +.nf +#ifdef ultrix +#define SIGNEDNESS(a) unsigned a +#else +#define SIGNEDNESS(a) a +#endif +class Whatever : public TQObject { + ... +signals: + void someSignal( SIGNEDNESS(int) ); // illegal +}; +.PP +A #define without arguments works. +.fi +.in -4 +.SS "Nested classes cannot be in the signals or slots sections nor have signals or slots" +Here's an example: +.PP +.in +4 +.nf +class A { + TQ_OBJECT +public: + class B { + public slots: // illegal + void b(); + ... + }; +signals: + class B { // illegal + void b(); + ... + }: +}; +.fi +.in -4 +.PP +.SS "Constructors cannot be used in signals or slots sections" +It is a mystery to us why anyone would put a constructor on either the +.B signals +or +.B slots +sections. You can't, anyway (except that it happens to work in some +cases). Put them in +.BR private ", " protected +or +.B public +sections, where they belong. Here is an example of the illegal syntax: +.PP +.in +4 +.nf +class SomeClass : public TQObject { + TQ_OBJECT +public slots: + SomeClass( TQObject *parent, const char *name ) + : TQObject( parent, name ) {} // illegal + ... +}; +.fi +.in -4 +.SS "Properties need to be declared before the public section that contains the respective get and set functions" +.PP +Declaring the first property within or after the public section that +contains the type definition and the respective get and set functions +does not work as expected. The +.B tqmoc +will complain that it can neither +find the functions nor resolve the type. Here is an example of the +illegal syntax: +.PP +.in +4 +.nf +class SomeClass : public TQObject { + TQ_OBJECT +public: + ... + // illegal + TQ_PROPERTY( Priority priority READ priority WRITE setPriority ) + TQ_ENUMS( Priority ) + enum Priority { High, Low, VeryHigh, VeryLow }; + void setPriority( Priority ); + Priority priority() const; + ... +}; +.fi +.in -4 +.PP +Work around this limitation by declaring all properties at the +beginning of the class declaration, right after TQ_OBJECT: +.PP +.in +4 +.nf +class SomeClass : public TQObject { + TQ_OBJECT + TQ_PROPERTY( Priority priority READ priority WRITE setPriority ) + TQ_ENUMS( Priority ) +public: + ... + enum Priority { High, Low, VeryHigh, VeryLow }; + void setPriority( Priority ); + Priority priority() const; + ... +}; +.fi +.in -4 +.PP +.SH "SEE ALSO" +.BR http://www.trolltech.com ", " +.BR "C++ ARM, section r.11.3" " (for the answer to the quiz), and" +.BR http://doc.trolltech.com " (for complete TQt documentation)." diff --git a/doc/man/man1/tqtconfig.1 b/doc/man/man1/tqtconfig.1 new file mode 100644 index 00000000..54661333 --- /dev/null +++ b/doc/man/man1/tqtconfig.1 @@ -0,0 +1,17 @@ +.TH "tqtconfig" "1" "3.0.3" "Troll Tech AS, Norway." "" +.SH "NAME" +.LP +tqtconfig \- Configuration tool for TQt +.SH "DESCRIPTION" +.LP +TQtConfig allows for GUI based configuration of TQt and + other TQt based sources. + +.SH "ENVIRONMENT VARIABLES" +.LP +.TP +\fBTQTDIR\fP +Specifies the base TQt dir +.SH "AUTHORS" +.LP +TrollTech diff --git a/doc/man/man1/tquic.1 b/doc/man/man1/tquic.1 new file mode 100644 index 00000000..53126fdd --- /dev/null +++ b/doc/man/man1/tquic.1 @@ -0,0 +1,136 @@ +.TH tquic 1 "2 Aug 2001" "Trolltech AS" \" -*- nroff -*- +.\" +.\" Copyright (C) 2000-2007 Trolltech ASA. All rights reserved. +.\" +.\" This file is part of TQt and may be distributed and used according to +.\" the terms and conditions described in the LICENSE file. +.\" +.SH NAME +tquic \- TQt user interface compiler +.SH SYNOPSIS +.B tquic +[options] file +.SH DESCRIPTION +This page documents the +.B User Interface Compiler +for the TQt GUI toolkit. The +.B tquic +reads a user interface definition (.ui) file in XML as generated by +.I TQt 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 tquic [options] \fI" +.br +.PP +Generate implementation: +.br +.I "\fB tquic [options] -impl \fI " +.br + \fI\fP: name of the declaration file +.br +.PP +Generate image collection: +.br +.I "\fB tquic [options] -embed \fI \fP ..." +.br + \fI\fP: project name + \fI\fP: image files +.br +.\" .PP +.\" Generate binary UI file: +.\" .br +.\" .I "\fB tquic [options] -binary \fI" +.\" .br +.PP +.PP +For convenience, +.B tquic +can also generate declaration or implementation stubs for subclasses. +.PP +Generate subclass declaration: +.br +.I "\fB tquic [options] -subdecl \fI " +.br + \fI\fP: name of the subclass to generate +.br + \fI\fP: declaration file of the baseclass +.PP +Generate subclass implementation: +.br +.I "\fB tquic [options] -subimpl \fI " +.br + \fI\fP: name of the subclass to generate +.br + \fI\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 tquic +and exit. + +.SH USAGE +.B tquic +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 + tquic $< -o $@ +.br +%.cpp: %.ui +.br + tquic -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 + tquic $< -o $@ +.br +NAME.cpp: NAME.ui +.br + tquic -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 tquic +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 diff --git a/doc/man/man1/uic.1 b/doc/man/man1/uic.1 deleted file mode 100644 index 194fc54f..00000000 --- a/doc/man/man1/uic.1 +++ /dev/null @@ -1,136 +0,0 @@ -.TH uic 1 "2 Aug 2001" "Trolltech AS" \" -*- nroff -*- -.\" -.\" Copyright (C) 2000-2007 Trolltech ASA. All rights reserved. -.\" -.\" This file is part of TQt and may be distributed and used according to -.\" the terms and conditions described in the LICENSE file. -.\" -.SH NAME -uic \- TQt user interface compiler -.SH SYNOPSIS -.B uic -[options] file -.SH DESCRIPTION -This page documents the -.B User Interface Compiler -for the TQt GUI toolkit. The -.B uic -reads a user interface definition (.ui) file in XML as generated by -.I TQt 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" -.br -.PP -Generate implementation: -.br -.I "\fB uic [options] -impl \fI " -.br - \fI\fP: name of the declaration file -.br -.PP -Generate image collection: -.br -.I "\fB uic [options] -embed \fI \fP ..." -.br - \fI\fP: project name - \fI\fP: image files -.br -.\" .PP -.\" Generate binary UI file: -.\" .br -.\" .I "\fB uic [options] -binary \fI" -.\" .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 " -.br - \fI\fP: name of the subclass to generate -.br - \fI\fP: declaration file of the baseclass -.PP -Generate subclass implementation: -.br -.I "\fB uic [options] -subimpl \fI " -.br - \fI\fP: name of the subclass to generate -.br - \fI\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 -- cgit v1.2.1