v1::label Class Reference

#include <hikogui/label.hpp>

Public Member Functions
constexpr	label (std::convertible_to< hi::icon > auto &&icon, std::convertible_to< hi::text_variant > auto &&text) noexcept
	Construct a new label from an icon and text.
constexpr	label (std::convertible_to< hi::text_variant > auto &&text) noexcept
	Construct a new label from text.
constexpr	label (std::convertible_to< hi::icon > auto &&icon) noexcept
	Construct a new label from an icon.
constexpr	label () noexcept
	Construct a empty label.
constexpr	label (label const &other) noexcept=default
constexpr label &	operator= (label const &other) noexcept=default
constexpr	label (label &&other) noexcept=default
constexpr label &	operator= (label &&other) noexcept=default
constexpr bool	empty () const noexcept
constexpr	operator bool () const noexcept

Data Fields
hi::icon	icon
	The icon.
hi::text_variant	text
	Localizable text.

Friends
constexpr friend bool	operator== (label const &lhs, label const &rhs) noexcept=default
	Compare if both labels are equal.

Detailed Description

A label consisting of localizable text and an icon.

A label is used for user-visible information. The label is used as information displayed by the label_widget.

The audio subsystem will use labels to return user-visible information such as the name of audio device end-points or surround sound speaker configuration which in both cases includes icons and text that needs to be translated.

Constructor & Destructor Documentation

label() [1/4]

constexpr v1::label::label ( std::convertible_to< hi::icon > auto && icon, std::convertible_to< hi::text_variant > auto && text )

inlineconstexprnoexcept

Construct a new label from an icon and text.

Parameters

icon	The icon.
text	The text.

label() [2/4]

constexpr v1::label::label ( std::convertible_to< hi::text_variant > auto && text )

inlineconstexprnoexcept

Construct a new label from text.

Parameters

text

The text.

label() [3/4]

constexpr v1::label::label ( std::convertible_to< hi::icon > auto && icon )

inlineconstexprnoexcept

Construct a new label from an icon.

Parameters

icon

The icon.

label() [4/4]

constexpr v1::label::label ( )

inlineconstexprnoexcept

Construct a empty label.

Friends And Related Symbol Documentation

operator==

constexpr friend bool operator== ( label const & lhs, label const & rhs )

friend

Compare if both labels are equal.

Parameters

lhs	A label.
rhs	A label.

Returns

True is the text and icon of both labels are equal.

Field Documentation

icon

hi::icon v1::label::icon

The icon.

text

hi::text_variant v1::label::text

Localizable text.

The text in this field is not yet translated nor formatted.

---

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

• hikogui/src/hikogui/label.hpp