diff options
author | Luca Falavigna <dktrkranz@debian.org> | 2010-01-02 20:56:27 +0100 |
---|---|---|
committer | Luca Falavigna <dktrkranz@debian.org> | 2010-01-02 20:56:27 +0100 |
commit | 72c578fd4b0b4a5a43e18594339ac4ff26c376dc (patch) | |
tree | cadaf3abe37a1066ceae933bc8fe7b75c85f56d2 /src/engine/SCons/Tool/qt.xml | |
parent | 548ed1064f327bccc6e538806740d41ea2d928a1 (diff) |
Imported Upstream version 1.2.0.d20091224upstream/1.2.0.d20091224
Diffstat (limited to 'src/engine/SCons/Tool/qt.xml')
-rw-r--r-- | src/engine/SCons/Tool/qt.xml | 314 |
1 files changed, 314 insertions, 0 deletions
diff --git a/src/engine/SCons/Tool/qt.xml b/src/engine/SCons/Tool/qt.xml new file mode 100644 index 0000000..3e41c68 --- /dev/null +++ b/src/engine/SCons/Tool/qt.xml @@ -0,0 +1,314 @@ +<!-- +Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 The SCons Foundation + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> +<tool name="qt"> +<summary> +Sets construction variables for building Qt applications. +</summary> +<sets> +QTDIR +QT_BINPATH +QT_CPPPATH +QT_LIBPATH +QT_MOC +QT_UIC +QT_LIB +QT_AUTOSCAN +QT_UICIMPLFLAGS +QT_UICDECLFLAGS +QT_MOCFROMHFLAGS +QT_MOCFROMCXXFLAGS +QT_UICDECLPREFIX +QT_UICDECLSUFFIX +QT_UICIMPLPREFIX +QT_UICIMPLSUFFIX +QT_MOCHPREFIX +QT_MOCHSUFFIX +QT_MOCCXXPREFIX +QT_MOCCXXSUFFIX +QT_UISUFFIX +QT_UICCOM +QT_MOCFROMHCOM +QT_MOCFROMCXXCOM +</sets> +<uses> +</uses> +</tool> + +<builder name="Moc"> +<summary> +Builds an output file from a moc input file. Moc input files are either +header files or cxx files. This builder is only available after using the +tool 'qt'. See the &cv-link-QTDIR; variable for more information. +Example: + +<example> +env.Moc('foo.h') # generates moc_foo.cc +env.Moc('foo.cpp') # generates foo.moc +</example> +</summary> +</builder> + +<builder name="Uic"> +<summary> +Builds a header file, an implementation file and a moc file from an ui file. +and returns the corresponding nodes in the above order. +This builder is only available after using the tool 'qt'. Note: you can +specify <filename>.ui</filename> files directly as source +files to the &b-Program;, +&b-Library; and &b-SharedLibrary; builders +without using this builder. Using this builder lets you override the standard +naming conventions (be careful: prefixes are always prepended to names of +built files; if you don't want prefixes, you may set them to ``). +See the &cv-link-QTDIR; variable for more information. +Example: + +<example> +env.Uic('foo.ui') # -> ['foo.h', 'uic_foo.cc', 'moc_foo.cc'] +env.Uic(target = Split('include/foo.h gen/uicfoo.cc gen/mocfoo.cc'), + source = 'foo.ui') # -> ['include/foo.h', 'gen/uicfoo.cc', 'gen/mocfoo.cc'] +</example> +</summary> +</builder> + +<cvar name="QTDIR"> +<summary> +The qt tool tries to take this from os.environ. +It also initializes all QT_* +construction variables listed below. +(Note that all paths are constructed +with python's os.path.join() method, +but are listed here with the '/' separator +for easier reading.) +In addition, the construction environment +variables &cv-link-CPPPATH;, +&cv-link-LIBPATH; and +&cv-link-LIBS; may be modified +and the variables +PROGEMITTER, SHLIBEMITTER and LIBEMITTER +are modified. Because the build-performance is affected when using this tool, +you have to explicitly specify it at Environment creation: + +<example> +Environment(tools=['default','qt']) +</example> + +The qt tool supports the following operations: + +<emphasis Role="strong">Automatic moc file generation from header files.</emphasis> +You do not have to specify moc files explicitly, the tool does it for you. +However, there are a few preconditions to do so: Your header file must have +the same filebase as your implementation file and must stay in the same +directory. It must have one of the suffixes .h, .hpp, .H, .hxx, .hh. You +can turn off automatic moc file generation by setting QT_AUTOSCAN to 0. +See also the corresponding builder method +.B Moc() + +<emphasis Role="strong">Automatic moc file generation from cxx files.</emphasis> +As stated in the qt documentation, include the moc file at the end of +the cxx file. Note that you have to include the file, which is generated +by the transformation ${QT_MOCCXXPREFIX}<basename>${QT_MOCCXXSUFFIX}, by default +<basename>.moc. A warning is generated after building the moc file, if you +do not include the correct file. If you are using VariantDir, you may +need to specify duplicate=1. You can turn off automatic moc file generation +by setting QT_AUTOSCAN to 0. See also the corresponding +&b-Moc; +builder method. + +<emphasis Role="strong">Automatic handling of .ui files.</emphasis> +The implementation files generated from .ui files are handled much the same +as yacc or lex files. Each .ui file given as a source of Program, Library or +SharedLibrary will generate three files, the declaration file, the +implementation file and a moc file. Because there are also generated headers, +you may need to specify duplicate=1 in calls to VariantDir. +See also the corresponding +&b-Uic; +builder method. +</summary> +</cvar> + +<cvar name="QT_AUTOSCAN"> +<summary> +Turn off scanning for mocable files. Use the Moc Builder to explicitely +specify files to run moc on. +</summary> +</cvar> + +<cvar name="QT_BINPATH"> +<summary> +The path where the qt binaries are installed. +The default value is '&cv-link-QTDIR;/bin'. +</summary> +</cvar> + +<cvar name="QT_CPPPATH"> +<summary> +The path where the qt header files are installed. +The default value is '&cv-link-QTDIR;/include'. +Note: If you set this variable to None, +the tool won't change the &cv-link-CPPPATH; +construction variable. +</summary> +</cvar> + +<cvar name="QT_DEBUG"> +<summary> +Prints lots of debugging information while scanning for moc files. +</summary> +</cvar> + +<cvar name="QT_LIB"> +<summary> +Default value is 'qt'. You may want to set this to 'qt-mt'. Note: If you set +this variable to None, the tool won't change the &cv-link-LIBS; variable. +</summary> +</cvar> + +<cvar name="QT_LIBPATH"> +<summary> +The path where the qt libraries are installed. +The default value is '&cv-link-QTDIR;/lib'. +Note: If you set this variable to None, +the tool won't change the &cv-link-LIBPATH; +construction variable. +</summary> +</cvar> + +<cvar name="QT_MOC"> +<summary> +Default value is '&cv-link-QT_BINPATH;/moc'. +</summary> +</cvar> + +<cvar name="QT_MOCCXXPREFIX"> +<summary> +Default value is ''. Prefix for moc output files, when source is a cxx file. +</summary> +</cvar> + +<cvar name="QT_MOCCXXSUFFIX"> +<summary> +Default value is '.moc'. Suffix for moc output files, when source is a cxx +file. +</summary> +</cvar> + +<cvar name="QT_MOCFROMCXXFLAGS"> +<summary> +Default value is '-i'. These flags are passed to moc, when moccing a +C++ file. +</summary> +</cvar> + +<cvar name="QT_MOCFROMCXXCOM"> +<summary> +Command to generate a moc file from a cpp file. +</summary> +</cvar> + +<cvar name="QT_MOCFROMCXXCOMSTR"> +<summary> +The string displayed when generating a moc file from a cpp file. +If this is not set, then &cv-link-QT_MOCFROMCXXCOM; (the command line) is displayed. +</summary> +</cvar> + +<cvar name="QT_MOCFROMHCOM"> +<summary> +Command to generate a moc file from a header. +</summary> +</cvar> + +<cvar name="QT_MOCFROMHCOMSTR"> +<summary> +The string displayed when generating a moc file from a cpp file. +If this is not set, then &cv-link-QT_MOCFROMHCOM; (the command line) is displayed. +</summary> +</cvar> + +<cvar name="QT_MOCFROMHFLAGS"> +<summary> +Default value is ''. These flags are passed to moc, when moccing a header +file. +</summary> +</cvar> + +<cvar name="QT_MOCHPREFIX"> +<summary> +Default value is 'moc_'. Prefix for moc output files, when source is a header. +</summary> +</cvar> + +<cvar name="QT_MOCHSUFFIX"> +<summary> +Default value is '&cv-link-CXXFILESUFFIX;'. Suffix for moc output files, when source is +a header. +</summary> +</cvar> + +<cvar name="QT_UIC"> +<summary> +Default value is '&cv-link-QT_BINPATH;/uic'. +</summary> +</cvar> + +<cvar name="QT_UICCOM"> +<summary> +Command to generate header files from .ui files. +</summary> +</cvar> + +<cvar name="QT_UICCOMSTR"> +<summary> +The string displayed when generating header files from .ui files. +If this is not set, then &cv-link-QT_UICCOM; (the command line) is displayed. +</summary> +</cvar> + +<cvar name="QT_UICDECLFLAGS"> +<summary> +Default value is ''. These flags are passed to uic, when creating a a h +file from a .ui file. +</summary> +</cvar> + +<cvar name="QT_UICDECLPREFIX"> +<summary> +Default value is ''. Prefix for uic generated header files. +</summary> +</cvar> + +<cvar name="QT_UICDECLSUFFIX"> +<summary> +Default value is '.h'. Suffix for uic generated header files. +</summary> +</cvar> + +<cvar name="QT_UICIMPLFLAGS"> +<summary> +Default value is ''. These flags are passed to uic, when creating a cxx +file from a .ui file. +</summary> +</cvar> + +<cvar name="QT_UICIMPLPREFIX"> +<summary> +Default value is 'uic_'. Prefix for uic generated implementation files. +</summary> +</cvar> + +<cvar name="QT_UICIMPLSUFFIX"> +<summary> +Default value is '&cv-link-CXXFILESUFFIX;'. Suffix for uic generated implementation +files. +</summary> +</cvar> + +<cvar name="QT_UISUFFIX"> +<summary> +Default value is '.ui'. Suffix of designer input files. +</summary> +</cvar> |