HikoGUI
A low latency retained GUI
Loading...
Searching...
No Matches
hi::v1::iso_15924 Class Reference

#include <hikogui/i18n/iso_15924_intf.hpp>

Public Member Functions

constexpr iso_15924 (iso_15924 const &) noexcept=default
constexpr iso_15924 (iso_15924 &&) noexcept=default
constexpr iso_15924 & operator= (iso_15924 const &) noexcept=default
constexpr iso_15924 & operator= (iso_15924 &&) noexcept=default
constexpr iso_15924 (std::integral auto number)
constexpr iso_15924 (std::string_view code4)
constexpr iso_15924 (std::in_place_t, uint16_t v) noexcept
constexpr uint16_t const & intrinsic () const noexcept
constexpr uint16_t & intrinsic () noexcept
constexpr bool empty () const noexcept
constexpr operator bool () const noexcept
constexpr uint16_t number () const noexcept
 Get the iso-15924 numeric value.
constexpr std::string code4 () const noexcept
 Get the iso-15924 4-letter code.
constexpr std::string code4_open_type () const noexcept
 Get the 4-letter code used by open-type.
constexpr bool left_to_right () const noexcept
 Is this script written left-to-right.

Static Public Member Functions

static constexpr iso_15924 wildcard () noexcept
 When any script is allowed.
static constexpr iso_15924 common () noexcept
 Common script is used for characters that are common in different scripts.
static constexpr iso_15924 uncoded () noexcept
 Used when the script was not encoded with the text.
static constexpr iso_15924 inherited () noexcept

Friends

constexpr friend std::string to_string (iso_15924 const &rhs) noexcept
constexpr friend bool operator== (iso_15924 const &lhs, iso_15924 const &rhs) noexcept=default
constexpr friend auto operator<=> (iso_15924 const &lhs, iso_15924 const &rhs) noexcept=default
constexpr friend bool matches (iso_15924 const &lhs, iso_15924 const &rhs) noexcept
 Check if rhs matches with lhs.

Detailed Description

ISO-15924 script code.

A 4 letter title case script code:

Member Function Documentation

◆ code4()

std::string hi::v1::iso_15924::code4 ( ) const
nodiscardconstexprnoexcept

Get the iso-15924 4-letter code.

◆ code4_open_type()

std::string hi::v1::iso_15924::code4_open_type ( ) const
nodiscardconstexprnoexcept

Get the 4-letter code used by open-type.

◆ common()

constexpr iso_15924 hi::v1::iso_15924::common ( )
inlinestaticnodiscardconstexprnoexcept

Common script is used for characters that are common in different scripts.

Punctuation for example are of a common script.

◆ left_to_right()

bool hi::v1::iso_15924::left_to_right ( ) const
nodiscardconstexprnoexcept

Is this script written left-to-right.

◆ number()

uint16_t hi::v1::iso_15924::number ( ) const
inlinenodiscardconstexprnoexcept

Get the iso-15924 numeric value.

◆ uncoded()

constexpr iso_15924 hi::v1::iso_15924::uncoded ( )
inlinestaticnodiscardconstexprnoexcept

Used when the script was not encoded with the text.

◆ wildcard()

constexpr iso_15924 hi::v1::iso_15924::wildcard ( )
inlinestaticnodiscardconstexprnoexcept

When any script is allowed.

◆ matches

friend bool matches ( iso_15924 const & lhs,
iso_15924 const & rhs )
friend

Check if rhs matches with lhs.

Parameters
lhsThe script or wild-card.
rhsThe script.
Returns
True when lhs is a wild-card or when lhs and rhs are equal.

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