ScrollAxisEnum.h File Reference

Go to the source code of this file.

Namespaces
namespace	PhosphorProtocol
	D-Bus marshalling for the shared tiling-family value types (see AutotileTypes.h; the file names predate the autotile-to-tiling generalization and are load-bearing across the build, so only the docs moved with the split).

Enumerations
enum class	PhosphorProtocol::ScrollAxis : int { PhosphorProtocol::Horizontal = 0 , PhosphorProtocol::Vertical = 1 }
	Which way a scrolling strip runs on one screen. More...

Functions
constexpr bool	PhosphorProtocol::isValidScrollAxis (int value)
	True if value is a valid ScrollAxis underlying value.
constexpr ScrollAxis	PhosphorProtocol::scrollAxisFromInt (int value)
	Cast an int that crossed a process boundary to a ScrollAxis; out-of-range values (version skew, a malformed caller) fall back to Horizontal, which is the same answer an absent value gives.
constexpr ScrollAxis	PhosphorProtocol::autoScrollAxisFor (int workAreaWidth, int workAreaHeight)
	The Auto rule, resolving a work area's dimensions to a strip axis: a work area taller than it is wide runs the strip vertically.

Variables
constexpr int	PhosphorProtocol::scrollAxisMinValue = static_cast<int>(ScrollAxis::Horizontal)
	Inclusive bounds of the valid ScrollAxis underlying values — used to range-check an int that crossed a process boundary before casting it back.
constexpr int	PhosphorProtocol::scrollAxisMaxValue = static_cast<int>(ScrollAxis::Vertical)