diff options
Diffstat (limited to 'Modules/DeployQt4.cmake')
| -rw-r--r-- | Modules/DeployQt4.cmake | 111 |
1 files changed, 71 insertions, 40 deletions
diff --git a/Modules/DeployQt4.cmake b/Modules/DeployQt4.cmake index 5f8a9fb..9b31567 100644 --- a/Modules/DeployQt4.cmake +++ b/Modules/DeployQt4.cmake @@ -1,68 +1,99 @@ -# - Functions to help assemble a standalone Qt4 executable. -# A collection of CMake utility functions useful for deploying -# Qt4 executables. +#.rst: +# DeployQt4 +# --------- +# +# Functions to help assemble a standalone Qt4 executable. +# +# A collection of CMake utility functions useful for deploying Qt4 +# executables. # # The following functions are provided by this module: -# write_qt4_conf -# resolve_qt4_paths -# fixup_qt4_executable -# install_qt4_plugin_path -# install_qt4_plugin -# install_qt4_executable +# +# :: +# +# write_qt4_conf +# resolve_qt4_paths +# fixup_qt4_executable +# install_qt4_plugin_path +# install_qt4_plugin +# install_qt4_executable +# # Requires CMake 2.6 or greater because it uses function and -# PARENT_SCOPE. Also depends on BundleUtilities.cmake. +# PARENT_SCOPE. Also depends on BundleUtilities.cmake. +# +# :: +# +# WRITE_QT4_CONF(<qt_conf_dir> <qt_conf_contents>) # -# WRITE_QT4_CONF(<qt_conf_dir> <qt_conf_contents>) # Writes a qt.conf file with the <qt_conf_contents> into <qt_conf_dir>. # -# RESOLVE_QT4_PATHS(<paths_var> [<executable_path>]) +# :: +# +# RESOLVE_QT4_PATHS(<paths_var> [<executable_path>]) +# # Loop through <paths_var> list and if any don't exist resolve them -# relative to the <executable_path> (if supplied) or the CMAKE_INSTALL_PREFIX. +# relative to the <executable_path> (if supplied) or the +# CMAKE_INSTALL_PREFIX. +# +# :: # -# FIXUP_QT4_EXECUTABLE(<executable> [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf>]) -# Copies Qt plugins, writes a Qt configuration file (if needed) and fixes up a -# Qt4 executable using BundleUtilities so it is standalone and can be -# drag-and-drop copied to another machine as long as all of the system -# libraries are compatible. +# FIXUP_QT4_EXECUTABLE(<executable> [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf>]) +# +# Copies Qt plugins, writes a Qt configuration file (if needed) and +# fixes up a Qt4 executable using BundleUtilities so it is standalone +# and can be drag-and-drop copied to another machine as long as all of +# the system libraries are compatible. # # <executable> should point to the executable to be fixed-up. # -# <qtplugins> should contain a list of the names or paths of any Qt plugins -# to be installed. +# <qtplugins> should contain a list of the names or paths of any Qt +# plugins to be installed. # -# <libs> will be passed to BundleUtilities and should be a list of any already -# installed plugins, libraries or executables to also be fixed-up. +# <libs> will be passed to BundleUtilities and should be a list of any +# already installed plugins, libraries or executables to also be +# fixed-up. # -# <dirs> will be passed to BundleUtilities and should contain and directories -# to be searched to find library dependencies. +# <dirs> will be passed to BundleUtilities and should contain and +# directories to be searched to find library dependencies. # # <plugins_dir> allows an custom plugins directory to be used. # -# <request_qt_conf> will force a qt.conf file to be written even if not needed. +# <request_qt_conf> will force a qt.conf file to be written even if not +# needed. +# +# :: +# +# INSTALL_QT4_PLUGIN_PATH(plugin executable copy installed_plugin_path_var <plugins_dir> <component> <configurations>) # -# INSTALL_QT4_PLUGIN_PATH(plugin executable copy installed_plugin_path_var <plugins_dir> <component> <configurations>) # Install (or copy) a resolved <plugin> to the default plugins directory # (or <plugins_dir>) relative to <executable> and store the result in # <installed_plugin_path_var>. # # If <copy> is set to TRUE then the plugins will be copied rather than -# installed. This is to allow this module to be used at CMake time rather than -# install time. +# installed. This is to allow this module to be used at CMake time +# rather than install time. # # If <component> is set then anything installed will use this COMPONENT. # -# INSTALL_QT4_PLUGIN(plugin executable copy installed_plugin_path_var <plugins_dir> <component>) -# Install (or copy) an unresolved <plugin> to the default plugins directory -# (or <plugins_dir>) relative to <executable> and store the result in -# <installed_plugin_path_var>. See documentation of INSTALL_QT4_PLUGIN_PATH. -# -# INSTALL_QT4_EXECUTABLE(<executable> [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf> <component>]) -# Installs Qt plugins, writes a Qt configuration file (if needed) and fixes up -# a Qt4 executable using BundleUtilities so it is standalone and can be -# drag-and-drop copied to another machine as long as all of the system -# libraries are compatible. The executable will be fixed-up at install time. -# <component> is the COMPONENT used for bundle fixup and plugin installation. -# See documentation of FIXUP_QT4_BUNDLE. +# :: +# +# INSTALL_QT4_PLUGIN(plugin executable copy installed_plugin_path_var <plugins_dir> <component>) +# +# Install (or copy) an unresolved <plugin> to the default plugins +# directory (or <plugins_dir>) relative to <executable> and store the +# result in <installed_plugin_path_var>. See documentation of +# INSTALL_QT4_PLUGIN_PATH. +# +# :: +# +# INSTALL_QT4_EXECUTABLE(<executable> [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf> <component>]) +# +# Installs Qt plugins, writes a Qt configuration file (if needed) and +# fixes up a Qt4 executable using BundleUtilities so it is standalone +# and can be drag-and-drop copied to another machine as long as all of +# the system libraries are compatible. The executable will be fixed-up +# at install time. <component> is the COMPONENT used for bundle fixup +# and plugin installation. See documentation of FIXUP_QT4_BUNDLE. #============================================================================= # Copyright 2011 Mike McQuaid <mike@mikemcquaid.com> |