ScrollAxisEnum.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
namespace PhosphorProtocol {
 
enum class ScrollAxis : int {
    Horizontal = 0,
    Vertical = 1,
};
 
inline constexpr int scrollAxisMinValue = static_cast<int>(ScrollAxis::Horizontal);
inline constexpr int scrollAxisMaxValue = static_cast<int>(ScrollAxis::Vertical);
 
inline constexpr bool isValidScrollAxis(int value)
{
    return value >= scrollAxisMinValue && value <= scrollAxisMaxValue;
}
 
inline constexpr ScrollAxis scrollAxisFromInt(int value)
{
    return isValidScrollAxis(value) ? static_cast<ScrollAxis>(value) : ScrollAxis::Horizontal;
}
 
inline constexpr ScrollAxis autoScrollAxisFor(int workAreaWidth, int workAreaHeight)
{
    return workAreaHeight > workAreaWidth ? ScrollAxis::Vertical : ScrollAxis::Horizontal;
}
 
} // namespace PhosphorProtocol