|
guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
|
The identity card of an application: its name, version, author and similar descriptive strings. More...
#include <headers/guillaume/metadata.hpp>
Public Member Functions | |
| Metadata (void)=default | |
| Create a record in which every string is empty. | |
| Metadata (const std::string &name, const std::string &version, const std::string &identifier, const std::string &creator, const std::string ©right, const std::string &url, const std::string &type) | |
| Create a record with every string given. | |
| void | setName (const std::string &name) |
| Replace the name shown to the user. | |
| std::string & | getName (void) |
| Get the name shown to the user. | |
| void | setVersion (const std::string &version) |
| Replace the version string. | |
| std::string & | getVersion (void) |
| Get the version string. | |
| void | setIdentifier (const std::string &identifier) |
| Replace the unique identifier of the application. | |
| std::string & | getIdentifier (void) |
| Get the unique identifier of the application. | |
| void | setCreator (const std::string &creator) |
| Replace the author or publisher. | |
| std::string & | getCreator (void) |
| Get the author or publisher. | |
| void | setCopyright (const std::string ©right) |
| Replace the copyright notice. | |
| std::string & | getCopyright (void) |
| Get the copyright notice. | |
| void | setUrl (const std::string &url) |
| Replace the home page of the application. | |
| std::string & | getUrl (void) |
| Get the home page of the application. | |
| void | setType (const std::string &type) |
| Replace the kind of application. | |
| std::string & | getType (void) |
| Get the kind of application. | |
The identity card of an application: its name, version, author and similar descriptive strings.
A plain record of seven free-form strings, meant to be filled by the program and handed to whatever needs to show or report them (a window title, an about box, a platform layer). The class does not interpret or validate them, and the framework does not read them: Application holds no Metadata.
Definition at line 51 of file metadata.hpp.
| guillaume::Metadata::Metadata | ( | const std::string & | name, |
| const std::string & | version, | ||
| const std::string & | identifier, | ||
| const std::string & | creator, | ||
| const std::string & | copyright, | ||
| const std::string & | url, | ||
| const std::string & | type ) |
Create a record with every string given.
| name | The name shown to the user. |
| version | The version string, such as "1.4.0". |
| identifier | A unique identifier, such as the reverse-domain name "com.example.notes". |
| creator | The author or publisher. |
| copyright | The copyright notice. |
| url | The home page of the application. |
| type | The kind of application; free-form. |
| std::string & guillaume::Metadata::getCopyright | ( | void | ) |
Get the copyright notice.
| std::string & guillaume::Metadata::getCreator | ( | void | ) |
Get the author or publisher.
| std::string & guillaume::Metadata::getIdentifier | ( | void | ) |
Get the unique identifier of the application.
| std::string & guillaume::Metadata::getName | ( | void | ) |
Get the name shown to the user.
| std::string & guillaume::Metadata::getType | ( | void | ) |
Get the kind of application.
| std::string & guillaume::Metadata::getUrl | ( | void | ) |
Get the home page of the application.
| std::string & guillaume::Metadata::getVersion | ( | void | ) |
Get the version string.
| void guillaume::Metadata::setCopyright | ( | const std::string & | copyright | ) |
Replace the copyright notice.
| copyright | The new notice, such as "Copyright (c) 2026 Example Corp". |
| void guillaume::Metadata::setCreator | ( | const std::string & | creator | ) |
Replace the author or publisher.
| creator | The new author or publisher name. |
| void guillaume::Metadata::setIdentifier | ( | const std::string & | identifier | ) |
Replace the unique identifier of the application.
| identifier | The new identifier, such as the reverse-domain name "com.example.notes". |
| void guillaume::Metadata::setName | ( | const std::string & | name | ) |
Replace the name shown to the user.
| name | The new name. |
| void guillaume::Metadata::setType | ( | const std::string & | type | ) |
Replace the kind of application.
| type | The new kind; free-form, such as "application" or "game". |
| void guillaume::Metadata::setUrl | ( | const std::string & | url | ) |
Replace the home page of the application.
| url | The new address. It is stored as given, not checked. |
| void guillaume::Metadata::setVersion | ( | const std::string & | version | ) |
Replace the version string.
| version | The new version, such as "1.4.0". No format is imposed. |