xtd - Reference Guide

xtd (pronounced "extend") is a modern C++17/20 framework to create console (CLI), forms (GUI) and unit test (xUnit) applications on Windows, macOS, Linux, iOS, Android, FreeBSD, and Haiku.

Write Once, Run Everywhere!

Features

• Free and open-source (MIT License);
• a collection of native C++ classes libraries, to complete std;
• API close to the .net API with a modern C++ approach and full integration with the std standard;
• xtd is designed to manage GUI controls and dialogs in pure native mode or with CSS styles.
• written in efficient, modern C++ 17/20 with RAII programming idiom;
• and highly portable and available on many different platforms (Windows, macOS, Linux, iOS and android);
• See features for more informations.

xtd libraries architecture

xtd is composed of several libraries.

xtd.core

The xtd.core library is modern C++17/20 libraries of classes, interfaces, and value types that provide access to system functionality. It is the foundation on which c++ applications, components, and controls are built.

xtd.drawing

The xtd.drawing library contains types that support basic GDI+ graphics functionality. Child namespaces support advanced two-dimensional and vector graphics functionality, advanced imaging functionality, and print-related and typographical services. A child namespace also contains types that extend design-time user-interface logic and drawing.

xtd.forms

The xtd.forms library contains classes for creating Windows-based applications that take full advantage of the rich user interface features available in the Microsoft Windows, Apple macOS and linux base operating system.

xtd.tunit

The xtd.tunit library is a unit-testing framework for modern C++17/20 inspired by Microsoft.VisualStudio.TestTools.Cpp.

See xtd libraries hierarchy.

Getting Started

• Installation provides download, install and uninstall documentation.
• Guide provides xtd guides and tutorials.
• Examples provides over 800 examples to help you use xtd, grouped by libraries and topics.

Examples

The classic first application 'Hello World'.

Console

hello_world_console.cpp:

#include <xtd/xtd>
 
using namespace xtd;
 
auto main() -> int {
  console::background_color(console_color::blue);
  console::foreground_color(console_color::white);
  console::write_line("Hello, World!");
}

CMakeLists.txt:

cmake_minimum_required(VERSION 3.20)
 
project(hello_world_console)
find_package(xtd REQUIRED)
add_sources(hello_world_console.cpp)
target_type(CONSOLE_APPLICATION)

Build and run

Open "Command Prompt" or "Terminal". Navigate to the folder that contains the project and type the following:

xtdc run

Output

Hello, World!

Forms

hello_world_forms.cpp:

#include <xtd/xtd>
 
using namespace xtd::forms;
 
class main_form : public form {
public:
  main_form() {
    text("Hello world (message_box)");
 
    button1.location({10, 10});
    button1.parent(*this);
    button1.text("&Click me");
    button1.click += [] {
      message_box::show("Hello, World!");
    };
  }
  
private:
  button button1;
};
 
auto main() -> int {
  application::run(main_form());
}

CMakeLists.txt:

cmake_minimum_required(VERSION 3.20)
 
project(hello_world_forms)
find_package(xtd REQUIRED)
add_sources(hello_world_forms.cpp)
target_type(GUI_APPLICATION)

Build and run

Open "Command Prompt" or "Terminal". Navigate to the folder that contains the project and type the following:

xtdc run

Output

Windows:

macOS:

Linux Gnome:

Unit tests

hello_world_test.cpp:

#include <xtd/xtd>
 
using namespace xtd;
using namespace xtd::tunit;
 
namespace unit_tests {
  class test_class_(hello_world_test) {
    void test_method_(create_string_from_literal) {
      string s = "Hello, World!";
      assert::are_equal("Hello, World!", s);
    }
 
    void test_method_(create_string_from_chars) {
      string s = {'H', 'e', 'l', 'l', 'o', ',', ' ', 'W', 'o', 'r', 'l', 'd', '!'};
      valid::are_equal(13, s.size());
      string_assert::starts_with("Hello,", s);
      string_assert::ends_with(" World!", s);
    }
  };
}
 
auto main() -> int {
  return console_unit_test(argv, argc).run();
}

CMakeLists.txt:

cmake_minimum_required(VERSION 3.20)
 
project(hello_world_test)
find_package(xtd REQUIRED)
add_sources(hello_world_test.cpp)
target_type(TEST_APPLICATION)

Build and run

Open "Command Prompt" or "Terminal". Navigate to the folder that contains the project and type the following:

xtdc run

Output

See also

• Website
• Wiki
• Sources
• Project
• Reference Guide