diff options
author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2023-02-02 08:54:27 +0100 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2023-02-07 12:57:32 +0000 |
commit | 27e79dcd1e93a84e9593e91c485f113be563c571 (patch) | |
tree | e261e92afb31fcdf89bfc86772241262997cc472 | |
parent | 23283a144be2a1ff8a6760fc3f0d1bd3f6d6ff34 (diff) | |
download | qtdoc-27e79dcd1e93a84e9593e91c485f113be563c571.tar.gz |
Update uic documentation and command line options
Remove obsolete sections on Makefiles and point to the Qt Designer
documentation for usage.
Task-number: PYSIDE-2191
Change-Id: Iaf377cd7ec4a2e1655825719b5dc8333507ef0af
Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
Reviewed-by: Christian Tismer <tismer@stackless.com>
Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
(cherry picked from commit f499612b658e8449b8e84c61b91be09e14bd1fba)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r-- | doc/src/development/uic.qdoc | 54 | ||||
-rw-r--r-- | doc/src/snippets/code/doc_src_uic.qdoc | 12 |
2 files changed, 24 insertions, 42 deletions
diff --git a/doc/src/development/uic.qdoc b/doc/src/development/uic.qdoc index 65a1f5c7..26d63546 100644 --- a/doc/src/development/uic.qdoc +++ b/doc/src/development/uic.qdoc @@ -7,12 +7,12 @@ \ingroup qttools \keyword uic - \omit KEEP THIS FILE SYNCHRONIZED WITH uic.1 \endomit + \omit KEEP THIS FILE SYNCHRONIZED WITH uic help \endomit This page documents the \e{User Interface Compiler} for the \l{Qt Widgets} module. The \c uic reads an XML format user interface definition (\c .ui) file as generated by \l{Qt Designer Manual}{Qt - Designer} and creates a corresponding C++ header file. + Designer} and creates a corresponding C++ header file or Python source file. Usage: \snippet snippets/code/doc_src_uic.qdoc 0 @@ -24,35 +24,29 @@ \table \header \li Option \li Description - \row \li \c{-h, --help} \li Displays help on commandline options. - \row \li \c{-v, --version} \li Displays version information. - \row \li \c{-d, --dependencies} \li Display the dependencies. - \row \li \c{-o, --output <file>} \li Place the output into \c{<file>} - \row \li \c{-a, --no-autoconnection} \li Do not generate a call to \c{QObject::connectSlotsByName()}. - \row \li \c{-p, --no-protection} \li Disable header protection. - \row \li \c{-n, --no-implicit-includes} \li Disable generation of \c{#include-directives}. - \row \li \c{--postfix <postfix>} \li Postfix to add to all generated classnames. - \row \li \c{--tr, --translate <function>} \li Use <function> for i18n. - \row \li \c{--include <include-file>} \li Add #include \c{<include-file>} to \c{<file>}. - \row \li \c{-g, --generator <python|cpp>} \li Select generator. - \row \li \c{--idbased} \li Use id based function for i18n - \row \li \c{--from-imports} \li Python: generate imports relative to \c{'.'} + \row \li \c{-h, --help} \li Displays help on commandline options. + \row \li \c{-help-all} \li Displays help including Qt specific options. + \row \li \c{-v, --version} \li Displays version information. + \row \li \c{-d, --dependencies} \li Display the dependencies. + \row \li \c{-o, --output <file>} \li Place the output into <file> + \row \li \c{-a, --no-autoconnection} \li Do not generate a call to QObject::connectSlotsByName(). + \row \li \c{-p, --no-protection} \li Disable header protection. + \row \li \c{-n, --no-implicit-includes} \li Disable generation of #include-directives. + \row \li \c{--postfix <postfix>} \li Postfix to add to all generated classnames. + \row \li \c{--tr, --translate <function>} \li Use <function> for i18n. + \row \li \c{--include <include-file>} \li Add #include <include-file> to <file>. + \row \li \c{-g, --generator <python|cpp>} \li Select generator. + \row \li \c{-c, --connections <pmf|string>} \li Connection syntax. + \row \li \c{--idbased} \li Use id based function for i18n + \row \li \c{--from-imports} \li Python: generate imports relative to '.' + \row \li \c{--absolute-imports} \li Python: generate absolute imports + \row \li \c{--rc-prefix} \li Python: Generate "rc_file" instead of "file_rc" import + \row \li \c{--star-imports} \li Python: Use * imports + \row \li \c{--python-paths <pathlist>} \li Python paths for --absolute-imports. \endtable - \section1 Examples + \section1 Usage - If you use \c qmake, \c uic will be invoked automatically for - header files. - - Here are useful makefile rules if you only use GNU make: - - \snippet snippets/code/doc_src_uic.qdoc 1 - - If you want to write portably, you can use individual rules of the - following form: - - \snippet snippets/code/doc_src_uic.qdoc 2 - - You must also remember to add \c{ui_foo.h} to your \c HEADERS - (substitute your favorite name). + See \l {Using a Designer UI File in Your C++ Application} or + \l{Using a Designer UI File in Your Qt for Python Application}. */ diff --git a/doc/src/snippets/code/doc_src_uic.qdoc b/doc/src/snippets/code/doc_src_uic.qdoc index 55ac2bed..c5d02ac2 100644 --- a/doc/src/snippets/code/doc_src_uic.qdoc +++ b/doc/src/snippets/code/doc_src_uic.qdoc @@ -4,15 +4,3 @@ //! [0] uic [options] <uifile> //! [0] - - -//! [1] -ui_%.h: %.ui - uic $< -o $@ -//! [1] - - -//! [2] -ui_foo.h: foo.ui - uic $< -o $@ -//! [2] |