hi::v1::widget_baseline Class Reference

#include <hikogui/widgets/widget_baseline.hpp>

Public Member Functions
constexpr	widget_baseline (widget_baseline const &) noexcept=default
constexpr	widget_baseline (widget_baseline &&) noexcept=default
constexpr widget_baseline &	operator= (widget_baseline const &) noexcept=default
constexpr widget_baseline &	operator= (widget_baseline &&) noexcept=default
constexpr	widget_baseline (float priority, vertical_alignment alignment, float cap_height, float graphic_height=0.0f) noexcept
	Construct a widget base-line.
constexpr	widget_baseline (float priority, float gain, float bias) noexcept
	Construct a widget base-line.
constexpr auto friend	operator<=> (widget_baseline const &lhs, widget_baseline const &rhs) noexcept
constexpr bool	empty () const noexcept
	operator bool () const noexcept
constexpr float	absolute (float height) const noexcept
	Calculate the absolute base-line.

Friends
constexpr friend bool	operator== (widget_baseline const &, widget_baseline const &) noexcept=default

Detailed Description

The base-line of a widget on which to set the text and graphics.

Constructor & Destructor Documentation

widget_baseline() [1/2]

constexpr hi::v1::widget_baseline::widget_baseline ( float priority, vertical_alignment alignment, float cap_height, float graphic_height = 0.0f )

inlineconstexprnoexcept

Construct a widget base-line.

Parameters

priority	The priority of the widget for dictating the baseline.
alignment	The alignment of the widget.
cap_height	The capital height of the default label font.
graphic_height	The height of the graphics of the widget where the text is beside or inside.

widget_baseline() [2/2]

constexpr hi::v1::widget_baseline::widget_baseline ( float priority, float gain, float bias )

inlineconstexprnoexcept

Construct a widget base-line.

Parameters

priority	How sure a widget is that its base-line should be used. 0.0: bad, 0.1: text label, 0.5 small widget, 1.0 large widget.
gain	The relative position of the base-line compared to the height of the widget.
bias	The absolute offset of the base-line.

Member Function Documentation

absolute()

constexpr float hi::v1::widget_baseline::absolute ( float height ) const

inlineconstexprnoexcept

Calculate the absolute base-line.

Parameters

height

The height of the widget.

Returns

height * gain + bias.

---

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

• hikogui/src/hikogui/widgets/widget_baseline.hpp