cmake-qt

AUTOMOC

The AUTOMOC <#prop_tgt:AUTOMOC> target property controls whether cmake(1) <#manual:cmake(1)> inspects the C++ files in the target to determine if they require moc to be run, and to create rules to execute moc at the appropriate time.

If a macro from AUTOMOC_MACRO_NAMES <#prop_tgt:AUTOMOC_MACRO_NAMES> is found in a header file, moc will be run on the file. The result will be put into a file named according to moc_<basename>.cpp. If the macro is found in a C++ implementation file, the moc output will be put into a file named according to <basename>.moc, following the Qt conventions. The <basename>.moc must be included by the user in the C++ implementation file with a preprocessor #include.

Included moc_*.cpp and *.moc files will be generated in the <AUTOGEN_BUILD_DIR>/include directory which is automatically added to the target's INCLUDE_DIRECTORIES <#prop_tgt:INCLUDE_DIRECTORIES>.

Not included moc_<basename>.cpp files will be generated in custom folders to avoid name collisions and included in a separate file which is compiled into the target, named either <AUTOGEN_BUILD_DIR>/mocs_compilation.cpp or <AUTOGEN_BUILD_DIR>/mocs_compilation_$<CONFIG>.cpp.

The moc command line will consume the COMPILE_DEFINITIONS <#prop_tgt:COMPILE_DEFINITIONS> and INCLUDE_DIRECTORIES <#prop_tgt:INCLUDE_DIRECTORIES> target properties from the target it is being invoked for, and for the appropriate build configuration.

The AUTOMOC <#prop_tgt:AUTOMOC> target property may be pre-set for all following targets by setting the CMAKE_AUTOMOC <#variable:CMAKE_AUTOMOC> variable. The AUTOMOC_MOC_OPTIONS <#prop_tgt:AUTOMOC_MOC_OPTIONS> target property may be populated to set options to pass to moc. The CMAKE_AUTOMOC_MOC_OPTIONS <#variable:CMAKE_AUTOMOC_MOC_OPTIONS> variable may be populated to pre-set the options for all following targets.

Additional macro names to search for can be added to AUTOMOC_MACRO_NAMES <#prop_tgt:AUTOMOC_MACRO_NAMES>.

Additional moc dependency file names can be extracted from source code by using AUTOMOC_DEPEND_FILTERS <#prop_tgt:AUTOMOC_DEPEND_FILTERS>.

Source C++ files can be excluded from AUTOMOC <#prop_tgt:AUTOMOC> processing by enabling SKIP_AUTOMOC <#prop_sf:SKIP_AUTOMOC> or the broader SKIP_AUTOGEN <#prop_sf:SKIP_AUTOGEN>.

AUTOUIC

The AUTOUIC <#prop_tgt:AUTOUIC> target property controls whether cmake(1) <#manual:cmake(1)> inspects the C++ files in the target to determine if they require uic to be run, and to create rules to execute uic at the appropriate time.

If a preprocessor #include directive is found which matches <path>ui_<basename>.h, and a <basename>.ui file exists, then uic will be executed to generate the appropriate file. The <basename>.ui file is searched for in the following places

where <source_dir> is the directory of the C++ file and AUTOUIC_SEARCH_PATHS <#prop_tgt:AUTOUIC_SEARCH_PATHS> is a list of additional search paths.

The generated generated ui_*.h files are placed in the <AUTOGEN_BUILD_DIR>/include directory which is automatically added to the target's INCLUDE_DIRECTORIES <#prop_tgt:INCLUDE_DIRECTORIES>.

The AUTOUIC <#prop_tgt:AUTOUIC> target property may be pre-set for all following targets by setting the CMAKE_AUTOUIC <#variable:CMAKE_AUTOUIC> variable. The AUTOUIC_OPTIONS <#prop_tgt:AUTOUIC_OPTIONS> target property may be populated to set options to pass to uic. The CMAKE_AUTOUIC_OPTIONS <#variable:CMAKE_AUTOUIC_OPTIONS> variable may be populated to pre-set the options for all following targets. The AUTOUIC_OPTIONS <#prop_sf:AUTOUIC_OPTIONS> source file property may be set on the <basename>.ui file to set particular options for the file. This overrides options from the AUTOUIC_OPTIONS <#prop_tgt:AUTOUIC_OPTIONS> target property.

A target may populate the INTERFACE_AUTOUIC_OPTIONS <#prop_tgt:INTERFACE_AUTOUIC_OPTIONS> target property with options that should be used when invoking uic. This must be consistent with the AUTOUIC_OPTIONS <#prop_tgt:AUTOUIC_OPTIONS> target property content of the depender target. The CMAKE_DEBUG_TARGET_PROPERTIES <#variable:CMAKE_DEBUG_TARGET_PROPERTIES> variable may be used to track the origin target of such INTERFACE_AUTOUIC_OPTIONS <#prop_tgt:INTERFACE_AUTOUIC_OPTIONS>. This means that a library which provides an alternative translation system for Qt may specify options which should be used when running uic:

add_library(KI18n klocalizedstring.cpp)
target_link_libraries(KI18n Qt6::Core)
# KI18n uses the tr2i18n() function instead of tr().  That function is
# declared in the klocalizedstring.h header.
set(autouic_options
  -tr tr2i18n
  -include klocalizedstring.h
)
set_property(TARGET KI18n APPEND PROPERTY
  INTERFACE_AUTOUIC_OPTIONS ${autouic_options}
)

A consuming project linking to the target exported from upstream automatically uses appropriate options when uic is run by AUTOUIC <#prop_tgt:AUTOUIC>, as a result of linking with the IMPORTED <#prop_tgt:IMPORTED> target:

set(CMAKE_AUTOUIC ON)
# Uses a libwidget.ui file:
add_library(LibWidget libwidget.cpp)
target_link_libraries(LibWidget
  KF5::KI18n
  Qt5::Widgets
)

Source files can be excluded from AUTOUIC <#prop_tgt:AUTOUIC> processing by enabling SKIP_AUTOUIC <#prop_sf:SKIP_AUTOUIC> or the broader SKIP_AUTOGEN <#prop_sf:SKIP_AUTOGEN>.

AUTORCC

The AUTORCC <#prop_tgt:AUTORCC> target property controls whether cmake(1) <#manual:cmake(1)> creates rules to execute rcc at the appropriate time on source files which have the suffix .qrc.

add_executable(myexe main.cpp resource_file.qrc)

The AUTORCC <#prop_tgt:AUTORCC> target property may be pre-set for all following targets by setting the CMAKE_AUTORCC <#variable:CMAKE_AUTORCC> variable. The AUTORCC_OPTIONS <#prop_tgt:AUTORCC_OPTIONS> target property may be populated to set options to pass to rcc. The CMAKE_AUTORCC_OPTIONS <#variable:CMAKE_AUTORCC_OPTIONS> variable may be populated to pre-set the options for all following targets. The AUTORCC_OPTIONS <#prop_sf:AUTORCC_OPTIONS> source file property may be set on the <name>.qrc file to set particular options for the file. This overrides options from the AUTORCC_OPTIONS <#prop_tgt:AUTORCC_OPTIONS> target property.

Source files can be excluded from AUTORCC <#prop_tgt:AUTORCC> processing by enabling SKIP_AUTORCC <#prop_sf:SKIP_AUTORCC> or the broader SKIP_AUTOGEN <#prop_sf:SKIP_AUTOGEN>.