v1::metadata Class Reference

#include <hikogui/metadata.hpp>

Static Public Member Functions
static metadata &	application () noexcept
	The global application metadata.
static metadata const &	library () noexcept
	The global hikogui-library metadata.

Data Fields
std::string	name
	The name of the application or library.
std::string	display_name
	Display name of the application or library.
std::string	vendor
	Name of the vendor of the application or library.
semantic_version	version
	The version number of the application or library.
std::string	license
	The copyright license used for distribution.
URL	homepage
	The homepage of the application or library.
std::string	description
	Description of the application or library.

Detailed Description

Metadata for a library or application.

Member Function Documentation

application()

static metadata & v1::metadata::application ( )

staticnoexcept

The global application metadata.

This function returns a reference to the global application metadata. The first time this function is called the application name and display_name are set based on the name of the executable.

The application metadata is used by URL to construct the locations of several directories, such as the application-data directory, or application-preferences directories.

The application metadata is also used when opening the Vulkan API which request the name of the application and version number.

library()

static metadata const & v1::metadata::library ( )

staticnoexcept

The global hikogui-library metadata.

This returns a reference to the metadata of the current hikogui library. It may be useful for an application to read the version number.

Field Documentation

description

std::string v1::metadata::description

Description of the application or library.

This is a free-text description of the application of library. should not be longer than a single paragraph.

display_name

std::string v1::metadata::display_name

Display name of the application or library.

A free text string, may contain spaces and capital letters and letters from other languages. It is however used for file and directory names.

homepage

URL v1::metadata::homepage

The homepage of the application or library.

license

std::string v1::metadata::license

The copyright license used for distribution.

This is a spdx-license-identifier of the license, not the full license text.

name

std::string v1::metadata::name

The name of the application or library.

The name should be in slug-format, i.e. based on the following case-sensitive regular expression: [a-z-][a-z0-9-]*

vendor

std::string v1::metadata::vendor

Name of the vendor of the application or library.

Free text name of the vendor, may contain spaces and capital letters and letters from different languages. However the vendor field will be used to construct file and directory paths.

version

semantic_version v1::metadata::version

The version number of the application or library.

---

The documentation for this class was generated from the following file:

• hikogui/src/hikogui/metadata.hpp