Functions
function	paraview_client_add ()
	.md Building a client More...

function	_paraview_client_escape_cmake_list (variable)
	.md INTERNAL Quoting More...

function	_paraview_client_unescape_cmake_list (variable)

function	paraview_client_documentation ()
	.md Documentation from XML files More...

function	paraview_client_generate_help ()
	.md Generating help documentation More...

function	paraview_client_qt_resource ()
	.md Qt resources More...

function	paraview_client_qt_resources ()
	.md Many files More...

Function Documentation

◆ paraview_client_add()

function paraview_client_add ( )

.md

Building a client

TODO: Document

paraview_client_add(
  NAME    <name>
  VERSION <version>
  SOURCES <source>...
  [APPLICATION_XMLS <xml>...]
  [QCH_FILES <file>...]
  [MAIN_WINDOW_CLASS    <class>]
  [MAIN_WINDOW_INCLUDE  <include>]
  [PLUGINS_TARGETS  <target>...]
  [REQUIRED_PLUGINS <plugin>...]
  [OPTIONAL_PLUGINS <plugin>...]
  [APPLICATION_NAME <name>]
  [ORGANIZATION     <organization>]
  [TITLE            <title>]
  [DEFAULT_STYLE  <style>]
  [APPLICATION_ICON <icon>]
  [BUNDLE_ICON      <icon>]
  [BUNDLE_PLIST     <plist>]
  [SPLASH_IMAGE     <image>]
  [NAMESPACE            <namespace>]
  [EXPORT               <export>]
  [FORCE_UNIX_LAYOUT    <ON|OFF>]
  [BUNDLE_DESTINATION   <directory>]
  [RUNTIME_DESTINATION  <directory>]
  [LIBRARY_DESTINATION  <directory>]
  [TRANSLATE_XML           <ON|OFF>]
  [TRANSLATIONS_DIRECTORY  <directory>]
  [TRANSLATION_TARGET      <target>])

NAME: (Required) The name of the application. This is used as the target name as well.
VERSION: (Required) The version of the application.
SOURCES: (Required) Source files for the application.
APPLICATION_XMLS: Server manager XML files.
QCH_FILES: Any .qch files containing documentation.
MAIN_WINDOW_CLASS: (Defaults to QMainWindow) The name of the main window class.
MAIN_WINDOW_INCLUDE: (Defaults to QMainWindow or <MAIN_WINDOW_CLASS>.h if it is specified) The include file for the main window.
PLUGINS_TARGETS: The targets for plugins. The associated functions will be called upon startup.
REQUIRED_PLUGINS: Plugins to load upon startup.
OPTIONAL_PLUGINS: Plugins to load upon startup if available.
APPLICATION_NAME: (Defaults to <NAME>) The displayed name of the application.
ORGANIZATION: (Defaults to Anonymous) The organization for the application. This is used for the macOS GUI identifier.
TITLE: The window title for the application.
DEFAULT_STYLE: The default Qt style for the application.
APPLICATION_ICON: The path to the icon for the Windows application.
BUNDLE_ICON: The path to the icon for the macOS bundle.
BUNDLE_PLIST: The path to the Info.plist.in template.
SPLASH_IMAGE: The image to display upon startup.
NAMESPACE: If provided, an alias target <NAMESPACE>::<NAME> will be created.
EXPORT: If provided, the target will be exported.
FORCE_UNIX_LAYOUT: (Defaults to OFF) Forces a Unix-style layout even on platforms for which they are not the norm for GUI applications (e.g., macOS).
BUNDLE_DESTINATION: (Defaults to Applications) Where to place the bundle executable.
RUNTIME_DESTINATION: (Defaults to ${CMAKE_INSTALL_BINDIR}) Where to place the binary.
LIBRARY_DESTINATION: (Defaults to ${CMAKE_INSTALL_LIBDIR}) Where libraries are placed. Sets up RPATH on ELF platforms (e.g., Linux and the BSD family).
TRANSLATE_XML: (Defaults to OFF) Produce a translations source file from APPLICATION_XMLS files.
TRANSLATIONS_DIRECTORY: (Defaults to ${CMAKE_CURRENT_BINARY_DIR}/Translations) The path of the directory where translation source files are stored.
TRANSLATION_TARGET : The name of the target on which to add the ts file as dependency.

Definition at line 92 of file ParaViewClient.cmake.

◆ _paraview_client_escape_cmake_list()

function _paraview_client_escape_cmake_list ( variable )

.md INTERNAL

Quoting

Passing CMake lists down to the help generation and proxy documentation steps requires escaping the ; in them. These functions escape and unescape the variable passed in. The new value is placed in the same variable in the calling scope.

Definition at line 506 of file ParaViewClient.cmake.

◆ _paraview_client_unescape_cmake_list()

function _paraview_client_unescape_cmake_list ( variable )

Definition at line 514 of file ParaViewClient.cmake.

◆ paraview_client_documentation()

function paraview_client_documentation ( )

.md

Documentation from XML files

Documentation can be generated from server manager XML files. The paraview_client_documentation generates Qt help, HTML, and Wiki documentation from them.

paraview_client_documentation(
  TARGET  <target>
  XMLS    <xml>...
  [OUTPUT_DIR <directory>])

TARGET: (Required) The name of the target to generate.
XMLS: (Required) The list of XML files to process.
OUTPUT_DIR: (Defaults to ${CMAKE_CURRENT_BINARY_DIR}) Where to place generated documentation.

Definition at line 541 of file ParaViewClient.cmake.

◆ paraview_client_generate_help()

function paraview_client_generate_help ( )

.md

Generating help documentation

TODO: Document

paraview_client_generate_help(
  NAME    <name>
  [TARGET <target>]
  OUTPUT_PATH <var>
  [OUTPUT_DIR <directory>]
  [SOURCE_DIR <directory>]
  [PATTERNS   <pattern>...]
  [DEPENDS    <depend>...]
  [NAMESPACE  <namespace>]
  [FOLDER     <folder>]
  [TABLE_OF_CONTENTS      <toc>]
  [TABLE_OF_CONTENTS_FILE <tocfile>]
  [RESOURCE_FILE    <qrcfile>]
  [RESOURCE_PREFIX  <prefix>]

NAME: (Required) The basename of the generated .qch file.
TARGET: (Defaults to <NAME>) The name of the generated target.
OUTPUT_PATH: (Required) This variable is set to the output path of the generated .qch file.
OUTPUT_DIR: (Defaults to ${CMAKE_CURRENT_BINARY_DIR}) Where to place generated files.
SOURCE_DIR: Where to copy input files from.
PATTERNS: (Defaults to *.*) If SOURCE_DIR is specified, files matching these globs will be copied to OUTPUT_DIR.
DEPENDS: A list of dependencies which are required before the help can be generated. Note that file paths which are generated via add_custom_command must be in the same directory as the paraview_client_generate_help on non-Ninja generators.
NAMESPACE: (Defaults to <NAME>.org) The namespace for the generated help.
FOLDER: (Defaults to <NAME>) The folder for the generated help.
TABLE_OF_CONTENTS and TABLE_OF_CONTENTS_FILE: At most one may be provided. This is used as the <toc> element in the generated help. If not provided at all, a table of contents will be generated.
RESOURCE_FILE: If provided, a Qt resource file providing the contents of the generated help will be generated at this path. It will be available as <RESOURCE_PREFIX>/<NAME>.
RESOURCE_PREFIX: The prefix to use for the generated help's Qt resource.

Definition at line 798 of file ParaViewClient.cmake.

◆ paraview_client_qt_resource()

function paraview_client_qt_resource ( )

.md

Qt resources

Compiling Qt resources into a client can be a little tedious. To help with this, some functions are provided to make it easier to embed content into the client. .md

Single file

paraview_client_qt_resource(
  OUTPUT  <file>
  PREFIX  <prefix>
  FILE    <file>
  [ALIAS  <alias>])

Outputs a Qt resource to the file given to the OUTPUT argument. Its resource name is <PREFIX>/<ALIAS>. The contents are copied from the contents of the file specified by the FILE argument. If not given the name of the file is used as the ALIAS.

Definition at line 1034 of file ParaViewClient.cmake.

◆ paraview_client_qt_resources()

function paraview_client_qt_resources ( )

.md

Many files

paraview_client_qt_resources(
  OUTPUT  <file>
  PREFIX  <prefix>
  FILES   <file>...)

Outputs a Qt resource to the file given to the OUTPUT argument. Its resource name is <PREFIX>/<filename> for each of the files in the given list. If aliases other than the filenames are required, the paraview_client_qt_resource function should be used instead.

Definition at line 1109 of file ParaViewClient.cmake.

Functions

Building a client

Quoting

Documentation from XML files

Generating help documentation

Qt resources

Many files

Function Documentation

◆ paraview_client_add()

Building a client

◆ _paraview_client_escape_cmake_list()

Quoting

◆ _paraview_client_unescape_cmake_list()

◆ paraview_client_documentation()

Documentation from XML files

◆ paraview_client_generate_help()

Generating help documentation

◆ paraview_client_qt_resource()

Qt resources

Single file

◆ paraview_client_qt_resources()

Many files