yaze 0.3.2
Link to the Past ROM Editor
 
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
yaze::gui::CanvasMenuItem Struct Reference

Declarative menu item definition. More...

#include <canvas_menu.h>

Public Member Functions

 CanvasMenuItem ()=default
 
 CanvasMenuItem (const std::string &lbl, std::function< void()> cb)
 
 CanvasMenuItem (const std::string &lbl, const std::string &ico, std::function< void()> cb)
 
 CanvasMenuItem (const std::string &lbl, const std::string &ico, std::function< void()> cb, const std::string &sc)
 

Static Public Member Functions

static CanvasMenuItem Destructive (const std::string &lbl, const std::string &ico, std::function< void()> cb, bool confirm=true, const std::string &sc="")
 
static CanvasMenuItem Disabled (const std::string &lbl)
 
static CanvasMenuItem Conditional (const std::string &lbl, std::function< void()> cb, std::function< bool()> condition)
 
static CanvasMenuItem WithPopup (const std::string &lbl, const std::string &popup_id, std::function< void()> render_callback)
 

Public Attributes

std::string label
 
std::string icon
 
std::string shortcut
 
std::string tooltip
 
std::function< void()> callback
 
std::optional< CanvasPopupDefinition > popup
 
std::function< bool()> enabled_condition
 
std::function< bool()> visible_condition
 
std::function< bool()> checked_condition
 
std::vector< CanvasMenuItem > subitems
 
ImVec4 color = ImVec4(1, 1, 1, 1)
 
bool separator_after = false
 
bool destructive = false
 
bool requires_confirmation = false
 

Detailed Description

Declarative menu item definition.

Pure data structure representing a menu item with optional popup linkage. Can be composed into hierarchical menus via subitems.

Definition at line 64 of file canvas_menu.h.

Constructor & Destructor Documentation

◆ CanvasMenuItem() [1/4]

yaze::gui::CanvasMenuItem::CanvasMenuItem ( )
default

◆ CanvasMenuItem() [2/4]

yaze::gui::CanvasMenuItem::CanvasMenuItem ( const std::string & lbl,
std::function< void()> cb )
inline

Definition at line 121 of file canvas_menu.h.

◆ CanvasMenuItem() [3/4]

yaze::gui::CanvasMenuItem::CanvasMenuItem ( const std::string & lbl,
const std::string & ico,
std::function< void()> cb )
inline

Definition at line 125 of file canvas_menu.h.

◆ CanvasMenuItem() [4/4]

yaze::gui::CanvasMenuItem::CanvasMenuItem ( const std::string & lbl,
const std::string & ico,
std::function< void()> cb,
const std::string & sc )
inline

Definition at line 130 of file canvas_menu.h.

Member Function Documentation

◆ Destructive()

static CanvasMenuItem yaze::gui::CanvasMenuItem::Destructive ( const std::string & lbl,
const std::string & ico,
std::function< void()> cb,
bool confirm = true,
const std::string & sc = "" )
inlinestatic

Definition at line 136 of file canvas_menu.h.

References destructive, and requires_confirmation.

Referenced by yaze::editor::DungeonCanvasViewer::BuildRoomContextMenu(), yaze::editor::DungeonCanvasViewer::BuildSelectionContextMenuItems(), yaze::editor::music::SongBrowserView::Draw(), yaze::editor::Tile16Editor::DrawBrushAndTilePaletteControls(), yaze::editor::anonymous_namespace{palette_editor.cc}::DrawCustomColorContextMenu(), yaze::gui::PaletteEditorWidget::DrawPaletteGrid(), yaze::editor::WelcomeScreen::DrawProjectPanel(), and yaze::editor::OracleStateLibraryPanel::DrawStateList().

◆ Disabled()

static CanvasMenuItem yaze::gui::CanvasMenuItem::Disabled ( const std::string & lbl)
inlinestatic

Definition at line 148 of file canvas_menu.h.

References enabled_condition, and label.

Referenced by yaze::editor::WelcomeScreen::DrawProjectPanel(), and yaze::editor::MapPropertiesSystem::SetupCanvasContextMenu().

◆ Conditional()

static CanvasMenuItem yaze::gui::CanvasMenuItem::Conditional ( const std::string & lbl,
std::function< void()> cb,
std::function< bool()> condition )
inlinestatic

Definition at line 158 of file canvas_menu.h.

References callback, enabled_condition, and label.

Referenced by yaze::editor::RoomMatrixContent::Draw(), and yaze::editor::MapPropertiesSystem::SetupCanvasContextMenu().

◆ WithPopup()

static CanvasMenuItem yaze::gui::CanvasMenuItem::WithPopup ( const std::string & lbl,
const std::string & popup_id,
std::function< void()> render_callback )
inlinestatic

Definition at line 169 of file canvas_menu.h.

References label, and popup.

Member Data Documentation

◆ label

std::string yaze::gui::CanvasMenuItem::label

Definition at line 66 of file canvas_menu.h.

Referenced by yaze::editor::DungeonCanvasViewer::AddLoadedRoomContextMenuItems(), yaze::editor::DungeonCanvasViewer::BuildCopyExportContextMenu(), yaze::editor::DungeonCanvasViewer::BuildDebugContextMenu(), yaze::editor::DungeonCanvasViewer::BuildInsertContextMenu(), yaze::editor::DungeonCanvasViewer::BuildLayerVisibilityContextMenu(), yaze::editor::DungeonCanvasViewer::BuildOpenContextMenu(), yaze::editor::DungeonCanvasViewer::BuildOverlayContextMenu(), yaze::editor::DungeonCanvasViewer::BuildReportContextMenu(), yaze::editor::DungeonCanvasViewer::BuildRoomContextMenu(), yaze::editor::DungeonCanvasViewer::BuildSelectionContextMenuItems(), Conditional(), Disabled(), yaze::editor::OverworldCanvasRenderer::DrawTile16Selector(), yaze::gui::RenderMenuItem(), yaze::editor::MapPropertiesSystem::SetupCanvasContextMenu(), and WithPopup().

◆ icon

std::string yaze::gui::CanvasMenuItem::icon

Definition at line 69 of file canvas_menu.h.

Referenced by yaze::editor::DungeonCanvasViewer::AddLoadedRoomContextMenuItems(), yaze::editor::DungeonCanvasViewer::BuildCopyExportContextMenu(), yaze::editor::DungeonCanvasViewer::BuildDebugContextMenu(), yaze::editor::DungeonCanvasViewer::BuildInsertContextMenu(), yaze::editor::DungeonCanvasViewer::BuildLayerVisibilityContextMenu(), yaze::editor::DungeonCanvasViewer::BuildOpenContextMenu(), yaze::editor::DungeonCanvasViewer::BuildOverlayContextMenu(), yaze::editor::DungeonCanvasViewer::BuildReportContextMenu(), yaze::editor::DungeonCanvasViewer::BuildRoomContextMenu(), yaze::editor::DungeonCanvasViewer::BuildSelectionContextMenuItems(), yaze::editor::OverworldCanvasRenderer::DrawTile16Selector(), yaze::gui::RenderMenuItem(), and yaze::editor::MapPropertiesSystem::SetupCanvasContextMenu().

◆ shortcut

std::string yaze::gui::CanvasMenuItem::shortcut

Definition at line 72 of file canvas_menu.h.

Referenced by yaze::editor::DungeonCanvasViewer::BuildSelectionContextMenuItems(), yaze::editor::OverworldCanvasRenderer::DrawTile16Selector(), yaze::gui::RenderMenuItem(), and yaze::editor::MapPropertiesSystem::SetupCanvasContextMenu().

◆ tooltip

std::string yaze::gui::CanvasMenuItem::tooltip

Definition at line 76 of file canvas_menu.h.

Referenced by yaze::gui::RenderMenuItem(), and yaze::editor::MapPropertiesSystem::SetupCanvasContextMenu().

◆ callback

std::function<void()> yaze::gui::CanvasMenuItem::callback

Definition at line 79 of file canvas_menu.h.

Referenced by Conditional(), yaze::editor::OverworldCanvasRenderer::DrawTile16Selector(), and yaze::gui::RenderMenuItem().

◆ popup

std::optional<CanvasPopupDefinition> yaze::gui::CanvasMenuItem::popup

Definition at line 82 of file canvas_menu.h.

Referenced by yaze::gui::RenderMenuItem(), and WithPopup().

◆ enabled_condition

std::function<bool()> yaze::gui::CanvasMenuItem::enabled_condition
Initial value:
= []() {
return true;
}

Definition at line 85 of file canvas_menu.h.

Referenced by yaze::editor::DungeonCanvasViewer::BuildDebugContextMenu(), yaze::editor::DungeonCanvasViewer::BuildInsertContextMenu(), yaze::editor::DungeonCanvasViewer::BuildLayerVisibilityContextMenu(), yaze::editor::DungeonCanvasViewer::BuildOverlayContextMenu(), yaze::editor::DungeonCanvasViewer::BuildSelectionContextMenuItems(), Conditional(), yaze::gui::TileSelectorWidget::CopyTileIdMenuItem(), Disabled(), yaze::editor::OverworldCanvasRenderer::DrawTile16Selector(), yaze::gui::RenderMenuItem(), and yaze::editor::MapPropertiesSystem::SetupCanvasContextMenu().

◆ visible_condition

std::function<bool()> yaze::gui::CanvasMenuItem::visible_condition
Initial value:
= []() {
return true;
}

Definition at line 90 of file canvas_menu.h.

Referenced by yaze::gui::RenderMenuItem(), and yaze::editor::MapPropertiesSystem::SetupCanvasContextMenu().

◆ checked_condition

std::function<bool()> yaze::gui::CanvasMenuItem::checked_condition

Definition at line 95 of file canvas_menu.h.

Referenced by yaze::editor::DungeonCanvasViewer::BuildLayerVisibilityContextMenu(), yaze::editor::DungeonCanvasViewer::BuildOverlayContextMenu(), yaze::gui::RenderMenuItem(), and yaze::editor::MapPropertiesSystem::SetupCanvasContextMenu().

◆ subitems

std::vector<CanvasMenuItem> yaze::gui::CanvasMenuItem::subitems

Definition at line 98 of file canvas_menu.h.

Referenced by yaze::editor::DungeonCanvasViewer::AddLoadedRoomContextMenuItems(), yaze::editor::DungeonCanvasViewer::BuildCopyExportContextMenu(), yaze::editor::DungeonCanvasViewer::BuildDebugContextMenu(), yaze::editor::DungeonCanvasViewer::BuildInsertContextMenu(), yaze::editor::DungeonCanvasViewer::BuildLayerVisibilityContextMenu(), yaze::editor::DungeonCanvasViewer::BuildOpenContextMenu(), yaze::editor::DungeonCanvasViewer::BuildOverlayContextMenu(), yaze::editor::DungeonCanvasViewer::BuildReportContextMenu(), yaze::editor::DungeonCanvasViewer::BuildRoomContextMenu(), yaze::editor::DungeonCanvasViewer::BuildSelectionContextMenuItems(), yaze::gui::RenderMenuItem(), and yaze::editor::MapPropertiesSystem::SetupCanvasContextMenu().

◆ color

ImVec4 yaze::gui::CanvasMenuItem::color = ImVec4(1, 1, 1, 1)

Definition at line 101 of file canvas_menu.h.

Referenced by yaze::gui::RenderMenuItem().

◆ separator_after

bool yaze::gui::CanvasMenuItem::separator_after = false

Definition at line 104 of file canvas_menu.h.

Referenced by yaze::editor::DungeonCanvasViewer::BuildSelectionContextMenuItems(), yaze::gui::RenderMenuItem(), and yaze::editor::MapPropertiesSystem::SetupCanvasContextMenu().

◆ destructive

bool yaze::gui::CanvasMenuItem::destructive = false

Definition at line 108 of file canvas_menu.h.

Referenced by Destructive(), yaze::editor::SessionCoordinator::DrawSessionContextMenu(), and yaze::gui::RenderMenuItem().

◆ requires_confirmation

bool yaze::gui::CanvasMenuItem::requires_confirmation = false

Definition at line 115 of file canvas_menu.h.

Referenced by Destructive(), yaze::editor::SessionCoordinator::DrawSessionContextMenu(), and yaze::gui::RenderMenuItem().

The documentation for this struct was generated from the following file: