xtd 0.2.0

Searching...

No Matches

Contains specific CMake commands to manage project, assembly informations and application properties.

These specific CMake commands are automatically added when you add find_package(xtd REQUIRED) to your CMakeLists.txt file.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

xtd
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition xtd_about_box.h:10

xtd Specific CMake commands

Generic commands
- choice_options provides a choice options for the user to select an option from options list.
Target properties commands
- target_categories Specifies the application categories.
- target_default_namespace specifies the the base namespace for files added to the project.
- target_display specifies if application is displaying in GNOME or KDE menu.
- target_icon specifies the icon file (.ico for Windows, icons for maOS and png or svg for linux) that you want to use as your program icon.
- target_name specifies the name of the output file.
- target_registered Specify the target is registered in the system.
- target_startup specifies the entry point to be called when the application is load.
- target_type specifies the type of target to build.
Assembly informations commands
- assembly_company specifies a company name for the assembly manifest. Corresponds to AssemblyCompanyAttribute.
- assembly_configuration specifies a configuration for the assembly manifest. Corresponds to AssemblyConfigurationAttribute.
- assembly_copyright specifies a configuration for the assembly manifest. Corresponds to AssemblyConfigurationAttribute.
- assembly_culture specifies the culture for the assembly manifest. Corresponds to AssemblyConfigurationAttribute.
- assembly_description specifies an optional description for the assembly manifest. Corresponds to AssemblyDescriptionAttribute.
- assembly_file_version specifies a version number that instructs the compiler to use a specific version for the Win32 file version resource. Corresponds to AssemblyFileVersionAttribute.
- assembly_guid specifies an unique GUID that identifies the assembly. When you create a project, Visual Studio generates a GUID for the assembly. Corresponds to Guid.
- assembly_product specifies a product name for the assembly manifest. Corresponds to AssemblyProductAttribute.
- assembly_title specifies a title for the assembly manifest. Corresponds to AssemblyTitleAttribute.
- assembly_trademark specifies a trademark for the assembly manifest. Corresponds to AssemblyTrademarkAttribute.
- assembly_version specifies the version of the assembly. Corresponds to AssemblyVersionAttribute.
Build options commands
- build_output_directory specifies the directory into which runtime target files should be built.
Install commands
- add_install_include_directories Install include directories.
- add_install_include_files installs include files.
- install_component installs component.
- install_package installs application MODULE_LIBRARY, STATIC_LIBRARY or SHARED_LIBRARY package.
- install_name specifies the install name.
Project commands
- add_include_directories Add include directory to current project.
- add_packages adds, finds and loads settings from external required projects to current project.
- add_projects adds child projects to parent project.
- add_references adds references (libraries) to current project.
- resource adds resources to current project.
- resource_string adds resource string to current project.
- setting adds a setting to current project.
- setting_include adds a setting_include to current project.
- add_sources adds source and header files to current project.

xtd Specific CMake variables

Target properties Variables
- TARGET_CATEGORIES contains the application categories.
- TARGET_DEFAULT_NAMESPACE contains default namespace use by application.
- TARGET_ICON contains application icon file name without extension.
- TARGET_NAME contains application name.
- TARGET_REGISTERED contains boolean that specify if application is registered or not on the system.
- TARGET_TYPE contains application type.
Assembly informations Variables
- ASSEMBLY_COMPANY contains assembly company name.
- ASSEMBLY_CONFIGURATION contains assembly configuration string.
- ASSEMBLY_COPYRIGHT contains assembly copyright string.
- ASSEMBLY_CULTURE contains assembly culture information.
- ASSEMBLY_DESCRIPTION contains assembly description string.
- ASSEMBLY_FILE_VERSION contains assembly file version number.
- ASSEMBLY_GUID contains assembly guid string.
- ASSEMBLY_PRODUCT contains assembly product string.
- ASSEMBLY_TITLE contains assembly title string.
- ASSEMBLY_TRADEMARK contains assembly trademark information.
- ASSEMBLY_VERSION contains assembly version number.
Build options Variables
- BUILD_OUTPUT_DIRECTORY contains build output directory.
- BUILD_TYPE contains build type.
Install Variables
- INSTALL_COMPONENTS contains install project components.
- INSTALL_INCLUDE_DIRECTORIES contains install include directories.
- INSTALL_INCLUDE_FILES contains install include files.
- INSTALL_NAME contains install name.
Project Variables
- PROJECT_APPLICATION_SETTINGS contains project application settings.
- PROJECT_INCLUDE_DIRECTORIES contains include directories.
- PROJECT_PACKAGES contains project packages.
- PROJECT_PROJECTS contains solution or project projects.
- PROJECT_REFERENCES contains project references.
- PROJECT_RESOURCES contains project resources.
- PROJECT_RESOURCE_STRINGS contains project resource strings.
- PROJECT_SETTING_INCLUDE_FILES contains project setting include files.
- PROJECT_SOURCES contains project sources.
- PROJECT_USER_SETTINGS contains project user settings.
System Variables
- USER_DIRECTORY The path to user home.

Generic commands

choice_options

Provides a choice options for the user to select an option from options list.

Parameters

OPTION	the option to set.
MESSAGE	Description message for the choice options.
DEFAULT_OPTION	The default option.
...	Other options.

Remarks: This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

choice_options(TARGET_TYPE "Choose library dynamic, static, interface or module" DYNAMIC_LIBRARY STATIC_LIBRARY INTERFACE_LIBRARY MODULE_LIBRARY)

target_type(${TARGET_TYPE})

Target properties commands

target_categories

Parameters

MAIN_CATEGORY	Main categories to set.
ARGV0	One or more additional categories to set.

Remarks: Only effect on linux.; If you don't specify the target_categories, the application has no category.; Call only once by project.; This method must be call before target_type().; This method is optional.; For more inforamtion see Desktop Entry Specification.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

target_categories(Development IDE GUIDesigner)

target_type(CONSOLE_APPLICATION)

target_default_namespace

Specifies the the base namespace for files added to the project.

Parameters

TARGET_DEFAULT_NAMESPACE the namespace to set.

Remarks: If you don't specify the target_default_namespace, it will be the same of the project name.; Call only once by project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

target_default_namespace("my_namespace")

target_type(CONSOLE_APPLICATION)

target_display

Specifies if application is displaying in GNOME or KDE menu.

Parameters

TARGET_DISPLAY option to display (ON or OFF)

Remarks: Only effect on linux.; By default the application is registered but not visible in the general menu.; Call only once by project.; This method must be call before target_type().; This method is optional.; For more inforamtion see Desktop Entry Specification.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

target_display(ON)

target_type(GUI_APPLICATION)

target_icon

Specifies the icon file (.ico for Windows, icons for maOS and png or svg for linux) that you want to use as your program icon.

Parameters

ARGV0 the icon to set without extension. It can be empty.

Remarks

Do not specify the extension of file. It's operation system dependant.

If you write multiplatform application you must have the specified file in ico, icons and png or svg formats.

On Linux you can specify one icon format like icon.png or icon.svg (typically 512 x 512 pixels) or more icon format terminated by the number of pixels:

icon8.png (8 x 8 pixels)
icon16.png (16 x 16 pixels)
icon22.png (22 x 22 pixels)
icon24.png (24 x 24 pixels)
icon32.png (32 x 32 pixels)
icon36.png (36 x 36 pixels)
icon42.png (42 x 42 pixels)
icon48.png (48 x 48 pixels)
icon52.png (52 x 52 pixels)
icon64.png (64 x 64 pixels)
icon72.png (72 x 72 pixels)
icon96.png (96 x 96 pixels)
icon128.png (128 x 128 pixels)
icon192.png (192 x 192 pixels)
icon256.png (256 x 256 pixels)
icon512.png (512 x 512 pixels)

Call only once by project.

This method must be call before target_type().

This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

target_icon(my_icon)

target_type(CONSOLE_APPLICATION)

target_name

Specifies the name of the output file.

Parameters

TARGET_NAME the name to set.

Remarks: If you don't specify the target_name, it will be the same of the project name.; Call only once by project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

target_name("my_exe")

target_type(CONSOLE_APPLICATION)

target_registered

Specify the application is registered in the system.

Remarks: Only effect on linux.; By default the application is registered but not visible in GNOME or KDE menu.; Call only once by project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

target_registered(OFF)

target_type(GUI_APPLICATION)

target_startup

Specifies the entry point to be called when the application is load.

Parameters

ARGV0	the object that contains the entry point.
ARGV1	the object definition file. (optional if you use TUnitMain_ or TUnitFrameworkMain_ entry point)

Remarks: Do not use this method of startup_(...) is present in your files or if you use standard c++ main() method.; Call only once by project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

target_startup("my_project::my_class" my_project.cpp)

target_type(GUI_APPLICATION)

target_type

Specifies the type of application to build.

Parameters

TARGET_TYPE

Type of application. Possible values :

CONSOLE_APPLICATION Console application
GUI_APPLICATION Gui application (Winforms)
TEST_APPLICATION Test application (TUnit)
MODULE_LIBRARY Module library
SHARED_LIBRARY Shared library (.dll or .so)
STATIC_LIBRARY Static library (.lib or .a)
INTERFACE_LIBRARY Interface library (header files only)
CUSTOM_TARGET Target with no output.

Remarks: This method is required except container project like Solution.; This method must be the last method.; Call only once by project.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

add_references(xtd.drawing xtd.drawing.native)

target_type(CONSOLE_APPLICATION)

Assembly informations commands

assembly_company

Specifies a company name for the assembly manifest. Corresponds to AssemblyCompanyAttribute.

Parameters

ASSEMBLY_COMPANY The company name to set.

Remarks: Call only once by project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

assembly_company("Gammasoft")

target_type(GUI_APPLICATION)

assembly_configuration

Specifies a configuration for the assembly manifest. Corresponds to AssemblyConfigurationAttribute.

Parameters

ASSEMBLY_CONFIGURATION The configuration to set.

Remarks: Call only once by project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

assembly_configuration("Beta public")

target_type(GUI_APPLICATION)

assembly_copyright

Specifies a copyright notice for the assembly manifest. Corresponds to AssemblyCopyrightAttribute.

Parameters

ASSEMBLY_COPYRIGHT The copyright to set.

Remarks: Call only once by project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

assembly_copyright("© 2024 by Gammasoft.")

target_type(GUI_APPLICATION)

assembly_culture

Specifies the culture for the assembly manifest. Corresponds to AssemblyConfigurationAttribute.

Parameters

ASSEMBLY_CONFIGURATION The culture to set.

Remarks: Call only once by project.; This method must be call before target_type().; This method is optional.

assembly_description

Specifies an optional description for the assembly manifest. Corresponds to AssemblyDescriptionAttribute.

Parameters

ASSEMBLY_DESCRIPTION The description to set.

Remarks: Call only once by project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

assembly_description("The application to stuff it.")

target_type(GUI_APPLICATION)

assembly_file_version

Specifies a version number that instructs the compiler to use a specific version for the Win32 file version resource. Corresponds to AssemblyFileVersionAttribute.

Parameters

ASSEMBLY_FILE_VERSION The file version to set (Major, Minor and build).

Remarks: Call only once by project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

assembly_file_version("1.2.3")

target_type(GUI_APPLICATION)

assembly_guid

Specifies an unique GUID that identifies the assembly. When you create a project, Visual Studio generates a GUID for the assembly. Corresponds to Guid.

Parameters

ASSEMBLY_GUID The guid to set.

Remarks: Call only once by project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

assembly_guid("fc5beb89-a4cc-445e-8ef7-07a9e471ef9a")

target_type(GUI_APPLICATION)

assembly_product

Specifies a product name for the assembly manifest. Corresponds to AssemblyProductAttribute.

Parameters

ASSEMBLY_PRODUCT The product name to set.

Remarks: Call only once by project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

assembly_product("my_project")

target_type(GUI_APPLICATION)

assembly_title

Specifies a title for the assembly manifest. Corresponds to AssemblyTitleAttribute.

Parameters

ASSEMBLY_TITLE The title to set.

Remarks: Call only once by project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

assembly_title("My Project")

target_type(GUI_APPLICATION)

assembly_trademark

Specifies a trademark for the assembly manifest. Corresponds to AssemblyTrademarkAttribute.

Parameters

ASSEMBLY_TRADEMARK The trademark to set.

Remarks: Call only once by project.; This method must be call before target_type().; This method is optional.

assembly_version

Specifies the version of the assembly. Corresponds to AssemblyVersionAttribute.

Parameters

ASSEMBLY_FILE_VERSION The version to set (Major, Minor and build).

Remarks: Call only once by project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

assembly_version("1.2.3")

target_type(GUI_APPLICATION)

Build options commands

build_output_directory

Specifies the directory into which runtime target files should be built.

Parameters

OUTPUT_DIRECTORY the directory where runtime target files should be built.

Remarks: This option is use mainly when a solution as more than one project.

Examples: cmake_minimum_required(VERSION 3.20)

project(MySolution)

find_package(xtd REQUIRED)

build_output_directory("${USER_DIRECTORY}/Output")

add_projects(lib_project1 lib_project2 lib_project3)

add_projects(tests/test_lib_project1 tests/test_lib_project2 tests/test_lib_project3)

Install commands

add_install_include_directories

Installs include directories.

Parameters

ARGN	Include directories to install.

Remarks: This method is required for install package.; This method can be call more than once in the same project.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(src/my_project1.cpp src/my_project2.cpp include/my_project/my_project.h include/my_project/MyProject2.h)

target_type(STATIC_LIBRARY)

add_install_include_directories(include/my_project)

install_component()

install_application()

add_install_include_files

Installs include files.

Parameters

ARGN	Include files to install.

Remarks: This method is required for install package.; This method can be call more than once in the same project.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project1.cpp my_project2.cpp my_project.h MyProject2.h)

target_type(STATIC_LIBRARY)

install_include_files(my_project1.h my_project2.h)

install_component()

install_application()

install_component

Parameters

ARGV0 Install name (optional).

Remarks: if install name no specified and install_name() method no called, the install name is equal to application name.; This method is required for install package.; This method must be call after target_type.; Call only once by project.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp my_project.h)

target_type(STATIC_LIBRARY)

add_install_include_files(my_project.h)

install_component()

install_package()

install_package

Installs package MODULE_LIBRARY, STATIC_LIBRARY or SHARED_LIBRARY package.

Parameters

ARGV0 Install name (optional).

Remarks: if install name no specified and install_name() method no called, the install name is equal to application name.; This method is required for install package.; This method must be after target_type.; Call only once by project.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp my_project.h)

target_type(STATIC_LIBRARY)

add_install_include_files(my_project.h)

install_component()

install_package()

install_name

Specifies the install name.

Parameters

NAME	Install name.

Remarks: This method is optional.; This method must be after add_references.; Call only once by project.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp my_project.h)

target_type(STATIC_LIBRARY)

install_name("specific_project")

add_install_include_files(my_project.h)

install_component()

install_application()

Project commands

add_include_directories

Add include directory to current project.

Parameters

ARGN	directories to add.

Remarks: This method can be call more than once in the same project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_include_directories(include)

add_sources(my_project.cpp include/my_project/my_project.h)

target_type(STATIC_LIBRARY)

add_packages

Adds, finds and loads settings from external required projects to current project.

Parameters

ARGN	packages to add.

Remarks: This method can be call more than once in the same project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_packages(my_package1 my_package2)

add_references(my_project1_in_my_package1 my_project1_in_my_package2 my_project2_in_my_package2)

add_sources(my_project.cpp)

target_type(CONSOLE_APPLICATION)

add_projects

Add child projects to parent project.

Parameters

ARGN	projects to add.

Remarks: The path can be relative from CMAKE_CURRENT_SOURCE_DIR or absolute.; This method can be call more than once in the same project.; This method is optional except container project like Solution.; This method must be call before target_type().

Examples: cmake_minimum_required(VERSION 3.20)

project(MySolution)

find_package(xtd REQUIRED)

add_projects(lib_project1 lib_project2 lib_project3)

add_projects(tests/test_lib_project1 tests/test_lib_project2 tests/test_lib_project3)

add_references

Add references (libraries) to current project.

Parameters

ARGN	references to add.

Remarks: This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(my_project.cpp)

add_references(xtd.drawing xtd.drawing.native)

add_references(xtd.forms)

target_type(CONSOLE_APPLICATION)

xtd::forms
The xtd::forms namespace contains classes for creating Windows-based applications that take full adva...
Definition xtd_about_box.h:12

resource

Add resources to current project.

Parameters

NAME	resource name to add.
FILE	resource file to add.

Remarks: The path can be relative from CMAKE_CURRENT_SOURCE_DIR or absolute.; This method can be call more than once in the same project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(file.h file.cpp)

resource(image1 resources/image1.png)

resource(image2 resources/image2.bmp)

resource(animation1 animations/ani1.gif)

target_type(CONSOLE_APPLICATION)

resource_string

Add resource string to current project.

Parameters

NAME	Name of string to add.
VALUE	Value of string to add.
COMMENT	Comment of string to add.

Remarks: This method can be call more than once in the same project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(file.h file.cpp)

resource_string(caption "\"Form examples\"" "Caption of main Form.")

resource_string(button_close_text "\"Close\"" "Text of close button.")

target_type(GUI_APPLICATION)

setting

Add a setting to current project.

Parameters

NAME	The name of setting to add.
TYPE	The type of setting to add.
SCOPE	The scope of setting to add (APPLICATION or USER).
VALUE	The value of setting to add.

Remarks: Application-scope settings are read only at run time.; User-scope settings are read/write at run time, and their values can be changed and saved in code.; This method can be call more than once in the same project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(file.h file.cpp)

setting(name xtd::string APPLICATION "\"Settings example\"")

setting(back_color xtd::drawing::color USER "xtd::drawing::color::spring_green")

target_type(CONSOLE_APPLICATION)

setting_include

Adds a setting include file to current project.

Parameters

SETTIING_INCLUDE_FILE The include file to add.

Remarks: This method can be call more than once in the same project.; This method must be call before target_type().; This method is optional.

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(file.h file.cpp)

setting_include("xtd/drawing/color")

setting_include("xtd/string")

setting(name xtd::string APPLICATION "\"Settings example\"")

setting(back_color xtd::drawing::color USER "xtd::drawing::color::spring_green")

target_type(CONSOLE_APPLICATION)

add_sources

Add source and header files to current project.

Parameters

ARGN	Files list to add.

Remarks: The path can be relative from CMAKE_CURRENT_SOURCE_DIR or absolute.; This method can be call more than once in the same project.; This method is required except container project like Solution.; This method must be call before target_type().

Examples: cmake_minimum_required(VERSION 3.20)

project(my_project)

find_package(xtd REQUIRED)

add_sources(file1.h file2.h options/file3.h)

add_sources(file1.cpp file2.cpp options/file3.cpp)

target_type(CONSOLE_APPLICATION)