menu.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Pier Luigi Fiorini <pierluigi.fiorini@gmail.com>
// SPDX-License-Identifier: MPL-2.0
 
#pragma once
 
#include <QtCore/qobject.h>
#include <QtQml/qqmlregistration.h>
 
#include "elevationtokens.h"
#include "shapetokens.h"
#include "statetokens.h"
 
// Component values map to the AndroidX Material 3 generated tokens:
// https://android.googlesource.com/platform/frameworks/support/+/5ba2cdd61be7b6945db999b238d14f3c626136fb/compose/material3/material3/src/commonMain/kotlin/androidx/compose/material3/tokens/
// MenuTokens.kt and MenuItemTokens.kt.
 
namespace Fluid {
 
struct Menu
{
    Q_GADGET
    QML_ANONYMOUS
 
    Q_PROPERTY(qreal containerElevation READ containerElevation CONSTANT FINAL)
    Q_PROPERTY(Fluid::ShapeValue containerShape READ containerShape CONSTANT FINAL)
    Q_PROPERTY(qreal topPadding READ topPadding CONSTANT FINAL)
    Q_PROPERTY(qreal bottomPadding READ bottomPadding CONSTANT FINAL)
    Q_PROPERTY(qreal viewportMargin READ viewportMargin CONSTANT FINAL)
    Q_PROPERTY(qreal minimumWidth READ minimumWidth CONSTANT FINAL)
    Q_PROPERTY(qreal maximumWidth READ maximumWidth CONSTANT FINAL)
    Q_PROPERTY(qreal itemHeight READ itemHeight CONSTANT FINAL)
    Q_PROPERTY(qreal itemHorizontalPadding READ itemHorizontalPadding CONSTANT FINAL)
    Q_PROPERTY(qreal iconSize READ iconSize CONSTANT FINAL)
    Q_PROPERTY(qreal iconLabelGap READ iconLabelGap CONSTANT FINAL)
    Q_PROPERTY(qreal hoverStateLayerOpacity READ hoverStateLayerOpacity CONSTANT FINAL)
    Q_PROPERTY(qreal focusStateLayerOpacity READ focusStateLayerOpacity CONSTANT FINAL)
    Q_PROPERTY(qreal pressedStateLayerOpacity READ pressedStateLayerOpacity CONSTANT FINAL)
    Q_PROPERTY(qreal disabledContentOpacity READ disabledContentOpacity CONSTANT FINAL)
    Q_PROPERTY(Fluid::ShapeValue verticalContainerShape READ verticalContainerShape CONSTANT FINAL)
    Q_PROPERTY(Fluid::ShapeValue verticalGroupShape READ verticalGroupShape CONSTANT FINAL)
    Q_PROPERTY(Fluid::ShapeValue verticalFirstGroupShape READ verticalFirstGroupShape CONSTANT FINAL)
    Q_PROPERTY(Fluid::ShapeValue verticalMiddleGroupShape READ verticalMiddleGroupShape CONSTANT FINAL)
    Q_PROPERTY(Fluid::ShapeValue verticalLastGroupShape READ verticalLastGroupShape CONSTANT FINAL)
    Q_PROPERTY(Fluid::ShapeValue verticalOnlyGroupShape READ verticalOnlyGroupShape CONSTANT FINAL)
    Q_PROPERTY(Fluid::ShapeValue verticalItemShape READ verticalItemShape CONSTANT FINAL)
    Q_PROPERTY(Fluid::ShapeValue verticalOnlyItemShape READ verticalOnlyItemShape CONSTANT FINAL)
    Q_PROPERTY(Fluid::ShapeValue verticalFirstItemShape READ verticalFirstItemShape CONSTANT FINAL)
    Q_PROPERTY(
            Fluid::ShapeValue verticalMiddleItemShape READ verticalMiddleItemShape CONSTANT FINAL)
    Q_PROPERTY(Fluid::ShapeValue verticalLastItemShape READ verticalLastItemShape CONSTANT FINAL)
    Q_PROPERTY(Fluid::ShapeValue verticalSelectedItemShape READ verticalSelectedItemShape CONSTANT
                       FINAL)
    Q_PROPERTY(Fluid::ShapeValue verticalInactiveItemShape READ verticalInactiveItemShape CONSTANT
                       FINAL)
    Q_PROPERTY(qreal verticalItemHeight READ verticalItemHeight CONSTANT FINAL)
    Q_PROPERTY(qreal verticalGroupPadding READ verticalGroupPadding CONSTANT FINAL)
    Q_PROPERTY(qreal verticalGroupContentPadding READ verticalGroupContentPadding CONSTANT FINAL)
    Q_PROPERTY(qreal verticalSegmentedGap READ verticalSegmentedGap CONSTANT FINAL)
    Q_PROPERTY(qreal verticalDividerInset READ verticalDividerInset CONSTANT FINAL)
    Q_PROPERTY(qreal verticalSectionLabelHeight READ verticalSectionLabelHeight CONSTANT FINAL)
    Q_PROPERTY(qreal verticalSectionLabelLeadingSpace READ verticalSectionLabelLeadingSpace CONSTANT
                       FINAL)
    Q_PROPERTY(qreal verticalSectionLabelTrailingSpace READ verticalSectionLabelTrailingSpace CONSTANT
                       FINAL)
    Q_PROPERTY(qreal verticalItemTopPadding READ verticalItemTopPadding CONSTANT FINAL)
    Q_PROPERTY(qreal verticalItemBottomPadding READ verticalItemBottomPadding CONSTANT FINAL)
    Q_PROPERTY(qreal verticalItemLeadingSpace READ verticalItemLeadingSpace CONSTANT FINAL)
    Q_PROPERTY(qreal verticalItemTrailingSpace READ verticalItemTrailingSpace CONSTANT FINAL)
    Q_PROPERTY(qreal verticalItemBetweenSpace READ verticalItemBetweenSpace CONSTANT FINAL)
    Q_PROPERTY(qreal verticalIconSize READ verticalIconSize CONSTANT FINAL)
    Q_PROPERTY(qreal closedScale READ closedScale CONSTANT FINAL)
    Q_PROPERTY(qreal horizontalViewportMargin READ horizontalViewportMargin CONSTANT FINAL)
    Q_PROPERTY(qreal verticalViewportMargin READ verticalViewportMargin CONSTANT FINAL)
 
public:
    constexpr qreal containerElevation() const
    {
        return ElevationTokens{ }.level2();
    }
 
    constexpr ShapeValue containerShape() const
    {
        return ShapeTokens{ }.cornerExtraSmall();
    }
 
    constexpr qreal topPadding() const
    {
        return 8.0;
    }
 
    constexpr qreal bottomPadding() const
    {
        return 8.0;
    }
 
    constexpr qreal viewportMargin() const
    {
        return 8.0;
    }
 
    constexpr qreal minimumWidth() const
    {
        return 112.0;
    }
 
    constexpr qreal maximumWidth() const
    {
        return 280.0;
    }
 
    constexpr qreal itemHeight() const
    {
        return 48.0;
    }
 
    constexpr qreal itemHorizontalPadding() const
    {
        return 16.0;
    }
 
    constexpr qreal iconSize() const
    {
        return 24.0;
    }
 
    constexpr qreal iconLabelGap() const
    {
        return 12.0;
    }
 
    constexpr qreal hoverStateLayerOpacity() const
    {
        return StateTokens{ }.hoverStateLayerOpacity();
    }
 
    constexpr qreal focusStateLayerOpacity() const
    {
        return StateTokens{ }.focusStateLayerOpacity();
    }
 
    constexpr qreal pressedStateLayerOpacity() const
    {
        return StateTokens{ }.pressedStateLayerOpacity();
    }
 
    constexpr qreal disabledContentOpacity() const
    {
        return 0.38;
    }
 
    constexpr ShapeValue verticalContainerShape() const
    {
        return ShapeTokens{ }.cornerLarge();
    }
 
    constexpr ShapeValue verticalGroupShape() const
    {
        return ShapeTokens{ }.cornerSmall();
    }
 
    constexpr ShapeValue verticalFirstGroupShape() const
    {
        return { ShapeTokens{ }.cornerValueLarge(), ShapeTokens{ }.cornerValueLarge(),
                 ShapeTokens{ }.cornerValueSmall(), ShapeTokens{ }.cornerValueSmall() };
    }
 
    constexpr ShapeValue verticalMiddleGroupShape() const
    {
        return verticalGroupShape();
    }
 
    constexpr ShapeValue verticalLastGroupShape() const
    {
        return { ShapeTokens{ }.cornerValueSmall(), ShapeTokens{ }.cornerValueSmall(),
                 ShapeTokens{ }.cornerValueLarge(), ShapeTokens{ }.cornerValueLarge() };
    }
 
    constexpr ShapeValue verticalOnlyGroupShape() const
    {
        return verticalContainerShape();
    }
 
    constexpr ShapeValue verticalItemShape() const
    {
        return ShapeTokens{ }.cornerExtraSmall();
    }
 
    constexpr ShapeValue verticalOnlyItemShape() const
    {
        return ShapeTokens{ }.cornerMedium();
    }
 
    constexpr ShapeValue verticalFirstItemShape() const
    {
        return { ShapeTokens{ }.cornerValueMedium(), ShapeTokens{ }.cornerValueMedium(),
                 ShapeTokens{ }.cornerValueExtraSmall(), ShapeTokens{ }.cornerValueExtraSmall() };
    }
 
    constexpr ShapeValue verticalMiddleItemShape() const
    {
        return ShapeTokens{ }.cornerExtraSmall();
    }
 
    constexpr ShapeValue verticalLastItemShape() const
    {
        return { ShapeTokens{ }.cornerValueExtraSmall(), ShapeTokens{ }.cornerValueExtraSmall(),
                 ShapeTokens{ }.cornerValueMedium(), ShapeTokens{ }.cornerValueMedium() };
    }
 
    constexpr ShapeValue verticalSelectedItemShape() const
    {
        return ShapeTokens{ }.cornerMedium();
    }
 
    constexpr ShapeValue verticalInactiveItemShape() const
    {
        return ShapeTokens{ }.cornerSmall();
    }
 
    constexpr qreal verticalItemHeight() const
    {
        return 44.0;
    }
 
    constexpr qreal verticalGroupPadding() const
    {
        return 4.0;
    }
 
    constexpr qreal verticalGroupContentPadding() const
    {
        return 2.0;
    }
 
    constexpr qreal verticalSegmentedGap() const
    {
        return 2.0;
    }
 
    constexpr qreal verticalDividerInset() const
    {
        return 12.0;
    }
 
    constexpr qreal verticalSectionLabelHeight() const
    {
        return 32.0;
    }
 
    constexpr qreal verticalSectionLabelLeadingSpace() const
    {
        return 12.0;
    }
 
    constexpr qreal verticalSectionLabelTrailingSpace() const
    {
        return 4.0;
    }
 
    constexpr qreal verticalItemTopPadding() const
    {
        return 8.0;
    }
 
    constexpr qreal verticalItemBottomPadding() const
    {
        return 8.0;
    }
 
    constexpr qreal verticalItemLeadingSpace() const
    {
        return 16.0;
    }
 
    constexpr qreal verticalItemTrailingSpace() const
    {
        return 16.0;
    }
 
    constexpr qreal verticalItemBetweenSpace() const
    {
        return 12.0;
    }
 
    constexpr qreal verticalIconSize() const
    {
        return 20.0;
    }
 
    constexpr qreal closedScale() const
    {
        return 0.8;
    }
 
    constexpr qreal horizontalViewportMargin() const
    {
        return 8.0;
    }
 
    constexpr qreal verticalViewportMargin() const
    {
        return 48.0;
    }
};
 
} // namespace Fluid