Widget.h

浏览该文件的文档.

#pragma once
#include "common/Export.h"
 
#include "ui/Icons.h"
#include "ui/UIHost.h"
 
#include <functional>
#include <string>
#include <utility>
#include <vector>
 
namespace eve::ui {
 
struct WidgetDesc {
    NodeType type = NodeType::Text;
    std::string id;
    std::string key;
    std::string text;
    std::string valueText;
    std::string tooltip;
    bool visible = true;
    bool enabled = true;
    bool checked = false;
    bool open = true;
    FocusMode focusMode = FocusMode::All;
    MouseFilter mouseFilter = MouseFilter::Stop;
    ThemePreset themePreset = ThemePreset::Inherit;
    std::string styleClass;
    int tabIndex = 0;
    std::string focusNext;
    std::string focusPrevious;
    std::string focusLeft;
    std::string focusRight;
    std::string focusUp;
    std::string focusDown;
    AccessibilityRole accessibilityRole = AccessibilityRole::Auto;
    std::string accessibilityName;
    std::string accessibilityDescription;
    bool dragSource = false;
    bool dropTarget = false;
    std::string dragPayloadType;
    std::string dragPayloadText;
    std::string acceptedDropType;
    float value = 0.f;
    float minValue = 0.f;
    float maxValue = 1.f;
    float sizeX = 0.f;
    float sizeY = 0.f;
    // --- Layout box model (mirrors UINode) ---
    float marginL = 0.f;
    float marginT = 0.f;
    float marginR = 0.f;
    float marginB = 0.f;
    float paddingL = 0.f;
    float paddingT = 0.f;
    float paddingR = 0.f;
    float paddingB = 0.f;
    float minSizeX = 0.f;
    float minSizeY = 0.f;
    float maxSizeX = 0.f;
    float maxSizeY = 0.f;
    float percentW = 0.f;
    float percentH = 0.f;
    float aspectRatio = 0.f;
    float anchorX = 0.f;
    float anchorY = 0.f;
    float posX = 0.f;
    float posY = 0.f;
    bool absolute = false;
    // --- Image / ImageButton props ---
    uint64_t textureId = 0;
    float tintR = 1.f;
    float tintG = 1.f;
    float tintB = 1.f;
    float tintA = 1.f;
    float uv0x = 0.f;
    float uv0y = 0.f;
    float uv1x = 1.f;
    float uv1y = 1.f;
    float borderL = 0.f;
    float borderT = 0.f;
    float borderR = 0.f;
    float borderB = 0.f;
    float cornerRadius = 0.f;
    float wrapWidth = 0.f;
    float itemHeight = 0.f;  // ScrollList uniform row height
    FlexDirection flexDirection = FlexDirection::Row;
    FlexAlign alignItems = FlexAlign::Start;
    FlexJustify justifyContent = FlexJustify::Start;
    float gap = -1.f;
    float flexGrow = 0.f;
    float flexShrink = 1.f;
    float flexBasis = -1.f;
    int alignSelf = -1;
    float columnGap = -1.f;
    float rowGap = -1.f;
    FlexWrap flexWrap = FlexWrap::NoWrap;
    OverflowMode overflow = OverflowMode::Visible;
    int gridColumns = 1;
    int gridColumnSpan = 1;
    std::function<void()> onClick;
    std::function<void(bool)> onToggle;
    std::function<void(float)> onValue;
    std::function<void(const std::string &)> onTextChange;
    std::vector<WidgetDesc> children;
 
    WidgetDesc &withId(std::string v) {
        id = std::move(v);
        return *this;
    }
    WidgetDesc &withKey(std::string v) {
        key = std::move(v);
        return *this;
    }
    WidgetDesc &withText(std::string v) {
        text = std::move(v);
        return *this;
    }
    WidgetDesc &withValueText(std::string v) {
        valueText = std::move(v);
        return *this;
    }
    WidgetDesc &withTooltip(std::string v) {
        tooltip = std::move(v);
        return *this;
    }
    WidgetDesc &withVisible(bool v) {
        visible = v;
        return *this;
    }
    WidgetDesc &withEnabled(bool v) {
        enabled = v;
        return *this;
    }
    WidgetDesc &withFocusMode(FocusMode v) {
        focusMode = v;
        return *this;
    }
    WidgetDesc &withMouseFilter(MouseFilter v) {
        mouseFilter = v;
        return *this;
    }
    WidgetDesc &withTheme(ThemePreset v) {
        themePreset = v;
        return *this;
    }
    WidgetDesc &withTabIndex(int v) {
        tabIndex = v;
        return *this;
    }
    WidgetDesc &withFocusOrder(std::string previous, std::string next) {
        focusPrevious = std::move(previous);
        focusNext = std::move(next);
        return *this;
    }
    WidgetDesc &withFocusNeighbors(std::string left, std::string right, std::string up,
                                   std::string down) {
        focusLeft = std::move(left);
        focusRight = std::move(right);
        focusUp = std::move(up);
        focusDown = std::move(down);
        return *this;
    }
    WidgetDesc &withAccessibility(AccessibilityRole role, std::string name,
                                  std::string description = {}) {
        accessibilityRole = role;
        accessibilityName = std::move(name);
        accessibilityDescription = std::move(description);
        return *this;
    }
    WidgetDesc &withDragSource(std::string payloadType, std::string payloadText) {
        dragSource = true;
        dragPayloadType = std::move(payloadType);
        dragPayloadText = std::move(payloadText);
        return *this;
    }
    WidgetDesc &withDropTarget(std::string acceptedType) {
        dropTarget = true;
        acceptedDropType = std::move(acceptedType);
        return *this;
    }
    WidgetDesc &withChecked(bool v) {
        checked = v;
        return *this;
    }
    WidgetDesc &withOpen(bool v) {
        open = v;
        return *this;
    }
    WidgetDesc &withValue(float v) {
        value = v;
        return *this;
    }
    WidgetDesc &withRange(float lo, float hi) {
        minValue = lo;
        maxValue = hi;
        return *this;
    }
    WidgetDesc &withSize(float w, float h) {
        sizeX = w;
        sizeY = h;
        return *this;
    }
    WidgetDesc &withMargin(float l, float t, float r, float b) {
        marginL = l;
        marginT = t;
        marginR = r;
        marginB = b;
        return *this;
    }
    WidgetDesc &withPadding(float l, float t, float r, float b) {
        paddingL = l;
        paddingT = t;
        paddingR = r;
        paddingB = b;
        return *this;
    }
    WidgetDesc &withMinSize(float w, float h) {
        minSizeX = w;
        minSizeY = h;
        return *this;
    }
    WidgetDesc &withMaxSize(float w, float h) {
        maxSizeX = w;
        maxSizeY = h;
        return *this;
    }
    WidgetDesc &withPercent(float w, float h) {
        percentW = w;
        percentH = h;
        return *this;
    }
    WidgetDesc &withStyleClass(std::string v) {
        styleClass = std::move(v);
        return *this;
    }
    WidgetDesc &withAspectRatio(float ratio) {
        aspectRatio = ratio;
        return *this;
    }
    WidgetDesc &withAbsolute(float ax, float ay, float x = 0.f, float y = 0.f) {
        absolute = true;
        anchorX = ax;
        anchorY = ay;
        posX = x;
        posY = y;
        return *this;
    }
    WidgetDesc &withTint(float r, float g, float b, float a = 1.f) {
        tintR = r;
        tintG = g;
        tintB = b;
        tintA = a;
        return *this;
    }
    WidgetDesc &withUv(float u0, float v0, float u1, float v1) {
        uv0x = u0;
        uv0y = v0;
        uv1x = u1;
        uv1y = v1;
        return *this;
    }
    WidgetDesc &withNinePatch(float l, float t, float r, float b) {
        borderL = l;
        borderT = t;
        borderR = r;
        borderB = b;
        return *this;
    }
    WidgetDesc &withCornerRadius(float radius) {
        cornerRadius = radius;
        return *this;
    }
    WidgetDesc &withWrap(float width) {
        wrapWidth = width;
        return *this;
    }
    WidgetDesc &withItemHeight(float height) {
        itemHeight = height;
        return *this;
    }
    WidgetDesc &withGap(float g) {
        gap = g;
        return *this;
    }
    WidgetDesc &withGaps(float columns, float rows) {
        columnGap = columns;
        rowGap = rows;
        return *this;
    }
    WidgetDesc &withFlexWrap(FlexWrap wrap) {
        flexWrap = wrap;
        return *this;
    }
    WidgetDesc &withOverflow(OverflowMode mode) {
        overflow = mode;
        return *this;
    }
    WidgetDesc &withGridColumnSpan(int span) {
        gridColumnSpan = span;
        return *this;
    }
    WidgetDesc &withFlexDirection(FlexDirection d) {
        flexDirection = d;
        return *this;
    }
    WidgetDesc &withAlign(FlexAlign a) {
        alignItems = a;
        return *this;
    }
    WidgetDesc &withJustify(FlexJustify j) {
        justifyContent = j;
        return *this;
    }
    WidgetDesc &withFlexGrow(float g) {
        flexGrow = g;
        return *this;
    }
    WidgetDesc &withFlexShrink(float shrink) {
        flexShrink = shrink;
        return *this;
    }
    WidgetDesc &withFlexBasis(float basis) {
        flexBasis = basis;
        return *this;
    }
    WidgetDesc &withAlignSelf(FlexAlign align) {
        alignSelf = int(align);
        return *this;
    }
    WidgetDesc &withClick(std::function<void()> fn) {
        onClick = std::move(fn);
        return *this;
    }
    WidgetDesc &withToggle(std::function<void(bool)> fn) {
        onToggle = std::move(fn);
        return *this;
    }
    WidgetDesc &withValueFn(std::function<void(float)> fn) {
        onValue = std::move(fn);
        return *this;
    }
    WidgetDesc &withTextChange(std::function<void(const std::string &)> fn) {
        onTextChange = std::move(fn);
        return *this;
    }
    WidgetDesc &child(WidgetDesc c) {
        children.push_back(std::move(c));
        return *this;
    }
 
    const std::string &reconcileKey() const { return key.empty() ? id : key; }
};
 
EVENGINE_API_WORLD WidgetDesc window(std::string title, std::vector<WidgetDesc> children = {}, std::string id = "root");
EVENGINE_API_WORLD WidgetDesc text(std::string content, std::string id = "");
EVENGINE_API_WORLD WidgetDesc button(std::string label, std::string id = "", std::function<void()> onClick = {});
EVENGINE_API_WORLD WidgetDesc icon(Icon value, std::string id = "");
EVENGINE_API_WORLD WidgetDesc iconButton(Icon value, std::string label = "", std::string id = "",
                                         std::function<void()> onClick = {});
EVENGINE_API_WORLD WidgetDesc group(std::vector<WidgetDesc> children = {}, std::string id = "");
EVENGINE_API_WORLD WidgetDesc sameLine(std::string id = "");
EVENGINE_API_WORLD WidgetDesc separator(std::string id = "");
EVENGINE_API_WORLD WidgetDesc checkbox(std::string label, bool checked = false, std::string id = "",
                                       std::function<void(bool)> onToggle = {});
EVENGINE_API_WORLD WidgetDesc slider(std::string label, float value, float minV, float maxV, std::string id = "",
                                     std::function<void(float)> onValue = {});
EVENGINE_API_WORLD WidgetDesc progress(float fraction, std::string id = "", std::string overlay = "");
EVENGINE_API_WORLD WidgetDesc combo(std::string label, std::vector<std::string> options, int selected,
                                    std::string id = "", std::function<void(float)> onValue = {});
EVENGINE_API_WORLD WidgetDesc image(std::string id = "", float width = 0.f, float height = 0.f,
                                    std::function<void()> onClick = {});
WidgetDesc ninePatchPanel(std::vector<WidgetDesc> children = {}, std::string id = "",
                          uint64_t textureId = 0);
EVENGINE_API_WORLD WidgetDesc imageButton(std::string id, float width, float height,
                                          std::function<void()> onClick = {});
EVENGINE_API_WORLD WidgetDesc viewport(std::string id = "", float width = 0.f, float height = 0.f);
EVENGINE_API_WORLD WidgetDesc inputText(std::string label, std::string value, std::string id = "",
                                        std::function<void(const std::string &)> onChange = {});
EVENGINE_API_WORLD WidgetDesc searchField(std::string hint, std::string value = {}, std::string id = "",
                                          std::function<void(const std::string &)> onChange = {});
EVENGINE_API_WORLD WidgetDesc toggleSwitch(std::string label, bool checked = false, std::string id = "",
                                           std::function<void(bool)> onToggle = {});
EVENGINE_API_WORLD WidgetDesc badge(std::string label, std::string id = "");
EVENGINE_API_WORLD WidgetDesc colorPalette(std::string label, float r, float g, float b, float a = 1.f,
                                           std::string id = "", std::function<void(float)> onValue = {});
EVENGINE_API_WORLD WidgetDesc card(std::vector<WidgetDesc> children = {}, std::string id = "");
EVENGINE_API_WORLD WidgetDesc sectionHeader(std::string label, std::string id = "");
EVENGINE_API_WORLD WidgetDesc menuBar(std::vector<WidgetDesc> children = {}, std::string id = "");
EVENGINE_API_WORLD WidgetDesc menu(std::string label, std::vector<WidgetDesc> children = {}, std::string id = "");
EVENGINE_API_WORLD WidgetDesc menuItem(std::string label, std::string shortcut = {}, std::string id = "",
                                       std::function<void()> onClick = {}, bool selected = false);
EVENGINE_API_WORLD WidgetDesc toolbar(std::vector<WidgetDesc> children = {}, std::string id = "");
EVENGINE_API_WORLD WidgetDesc toolbox(std::vector<WidgetDesc> children = {}, std::string id = "", float cellSize = 0.f,
                                      int columns = 0);
EVENGINE_API_WORLD WidgetDesc sidebar(std::vector<WidgetDesc> children = {}, std::string id = "", float width = 0.f);
EVENGINE_API_WORLD WidgetDesc statusBar(std::vector<WidgetDesc> children = {}, std::string id = "");
EVENGINE_API_WORLD WidgetDesc splitPane(FlexDirection direction, WidgetDesc first, WidgetDesc second,
                                        float ratio = 0.25f, std::string id = "",
                                        std::function<void(float)> onResize = {});
EVENGINE_API_WORLD WidgetDesc collapsingHeader(std::string label, std::vector<WidgetDesc> children = {},
                                               std::string id = "", bool defaultOpen = true);
EVENGINE_API_WORLD WidgetDesc child(std::string id, std::vector<WidgetDesc> children = {}, float width = 0.f,
                                    float height = 120.f);
EVENGINE_API_WORLD WidgetDesc scrollList(std::string id, std::vector<WidgetDesc> children = {}, float height = 0.f,
                                         float itemHeight = 0.f);
EVENGINE_API_WORLD WidgetDesc virtualList(std::string listId, const std::vector<std::string> &items,
                                          float height = 200.f, float itemHeight = 0.f);
 
EVENGINE_API_WORLD WidgetDesc flex(FlexDirection direction, std::vector<WidgetDesc> children = {}, std::string id = "");
EVENGINE_API_WORLD WidgetDesc row(std::vector<WidgetDesc> children = {}, std::string id = "");
EVENGINE_API_WORLD WidgetDesc column(std::vector<WidgetDesc> children = {}, std::string id = "");
EVENGINE_API_WORLD WidgetDesc grid(int columns, std::vector<WidgetDesc> children = {}, std::string id = "");
EVENGINE_API_WORLD WidgetDesc spacer(std::string id = "", float grow = 1.f);
 
EVENGINE_API_WORLD WidgetDesc when(bool cond, WidgetDesc child);
WidgetDesc whenElse(bool cond, WidgetDesc ifTrue, WidgetDesc ifFalse);
 
WidgetDesc list(std::string listId, const std::vector<std::string> &items,
                const std::function<WidgetDesc(const std::string &, int)> &itemFn);
 
EVENGINE_API_WORLD WidgetDesc listButtons(std::string listId, const std::vector<std::string> &items);
 
EVENGINE_API_WORLD void applyTree(UIHost *host, WidgetDesc root);
 
bool applyTreeReconcile(UIHost *host, WidgetDesc root);
 
}  // namespace eve::ui