markup.hpp File Reference

#include "grapheme.hpp"
#include "phrasing.hpp"
#include "gstring.hpp"
#include "../i18n/i18n.hpp"
#include "../utility/utility.hpp"
#include <string>
#include <string_view>
#include <algorithm>
#include <iterator>
#include <ranges>
#include <concepts>

Go to the source code of this file.

Namespaces
namespace	hi
	The HikoGUI namespace.
namespace	hi::v1
	The HikoGUI API version 1.

Functions
	hi_export_module (hikogui.unicode.markup)
template<std::input_or_output_iterator It, std::sentinel_for< It > ItEnd> requires std::same_as<typename It::value_type, grapheme>
hi_export constexpr It	hi::v1::apply_markup (It first, ItEnd last, language_tag default_language=language_tag{"en-US"}, phrasing default_phrasing=phrasing::regular) noexcept
	Inplace-apply markup to a string of graphemes.
hi_export constexpr gstring	hi::v1::apply_markup (gstring str, language_tag default_language=language_tag{"en-US"}, phrasing default_phrasing=phrasing::regular) noexcept
	Apply markup to a string of graphemes.
hi_export constexpr gstring	hi::v1::apply_markup (std::string_view str, language_tag default_language=language_tag{"en-US"}, phrasing default_phrasing=phrasing::regular) noexcept
	Apply markup to a string of graphemes.

Detailed Description

Sequence	Description
[[	Escape literal ~
[.]	Reset phrasing and language to default.
[r]	Set phrasing to regular
[e]	Set phrasing to emphesis
[s]	Set phrasing to strong
[c]	Set phrasing to code
[a]	Set phrasing to abbreviation
[q]	Set phrasing to quote
[k]	Set phrasing to keyboard
[h]	Set phrasing to highlight
[m]	Set phrasing to math
[x]	Set phrasing to example
[u]	Set phrasing to unarticulated
[t]	Set phrasing to title
[S]	Set phrasing to success
[W]	Set phrasing to warning
[E]	Set phrasing to error
[ tag ]	Set language to the tag.

This [e]is[.] [NL-nl]hallo[.] world.