roo_display
API Documentation for roo_display
Loading...
Searching...
No Matches
roo_display::VAlign Class Reference

Vertical alignment. More...

#include <alignment.h>

Inheritance diagram for roo_display::VAlign:
[legend]
Collaboration diagram for roo_display::VAlign:
[legend]

Public Member Functions

constexpr VAlign shiftBy (int16_t shift_by) const
 
constexpr VAlign toTop () const
 
constexpr VAlign toMiddle () const
 
constexpr VAlign toBottom () const
 
constexpr VAlign toBaseline () const
 
- Public Member Functions inherited from roo_display::internal::AlignBase
constexpr AlignBase ()
 
constexpr AlignBase (Anchor dst, Anchor src, int16_t shift)
 
constexpr Anchor src () const
 
constexpr Anchor dst () const
 
constexpr int16_t shift () const
 
template<typename Dim >
Dim resolveOffset (Dim first_outer, Dim last_outer, Dim first_inner, Dim last_inner) const
 
bool operator== (AlignBase other) const
 
bool operator!= (AlignBase other) const
 

Additional Inherited Members

- Protected Attributes inherited from roo_display::internal::AlignBase
uint16_t rep_
 

Detailed Description

Vertical alignment.

Consists of: 1) source anchor (top/middle/bottom/baseline) 2) destination anchor (top/middle/bottom/baseline) 3) absolute offset (padding)

Prefer using the constants and modifying them, e.g. kTop.toMiddle().shiftBy(5) aligns the top boundary of the source to be 5 pixels below the destination middle.

Definition at line 123 of file alignment.h.

Member Function Documentation

◆ shiftBy()

constexpr VAlign roo_display::VAlign::shiftBy ( int16_t  shift_by) const
inlineconstexpr

◆ toBaseline()

constexpr VAlign roo_display::VAlign::toBaseline ( ) const
inlineconstexpr

◆ toBottom()

constexpr VAlign roo_display::VAlign::toBottom ( ) const
inlineconstexpr

◆ toMiddle()

constexpr VAlign roo_display::VAlign::toMiddle ( ) const
inlineconstexpr

◆ toTop()

constexpr VAlign roo_display::VAlign::toTop ( ) const
inlineconstexpr

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