ActionCatalog.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Valentin Eloy
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
#include <array>
#include <optional>
 
#include "HMI/Editor/EditorTool.h"
#include "HMI/Editor/PixelTool.h"
#include "HMI/Input/EditorKeyBindings.h"
#include "HMI/Interface/IconGeometry.h"

 
namespace hmi {

enum class EditorActionGroup { None, LevelTools, PixelTools, PixelCommands };

enum class ActionSurface {
    ToolBarAndMenu,  
    MenuOnly,        
};

struct EditorActionSpec {
    IconId id;
    const char* labelKey;
    const char* shortcut;
    bool checkable;
    EditorActionGroup group;
    ActionSurface surface;
};

constexpr int EDITOR_ACTION_CATALOG_COUNT = 30;

[[nodiscard]] const std::array<EditorActionSpec, EDITOR_ACTION_CATALOG_COUNT>&
editorActionCatalog();

[[nodiscard]] const EditorActionSpec& editorActionSpec(IconId id);

constexpr int TOOLBAR_COMMAND_BUDGET = 5;

[[nodiscard]] std::optional<EditorTool> editorActionTool(IconId id);

[[nodiscard]] IconId editorActionForTool(EditorTool tool);

[[nodiscard]] std::optional<PixelTool> editorActionPixelTool(IconId id);

[[nodiscard]] IconId editorActionForPixelTool(PixelTool tool);

struct KeyBindingIconEntry {
    EditorAction action;
    IconId id;
};

constexpr int KEY_BINDING_ICON_COUNT = 9;

[[nodiscard]] const std::array<KeyBindingIconEntry, KEY_BINDING_ICON_COUNT>&
keyBindingIconCatalog();

[[nodiscard]] IconId iconForKeyBindingAction(EditorAction action);

[[nodiscard]] std::optional<EditorAction> keyBindingActionForIcon(IconId id);
 
}  // namespace hmi