yaze 0.3.2
Link to the Past ROM Editor
 
Loading...
Searching...
No Matches
yaze::editor::AssemblyToolbarPanel Class Reference

Toolbar panel with quick actions. More...

#include <assembly_editor_views.h>

Inheritance diagram for yaze::editor::AssemblyToolbarPanel:
Collaboration diagram for yaze::editor::AssemblyToolbarPanel:

Public Types

using DrawCallback = std::function<void()>
 

Public Member Functions

 AssemblyToolbarPanel (DrawCallback draw_callback)
 
std::string GetId () const override
 Unique identifier for this panel.
 
std::string GetDisplayName () const override
 Human-readable name shown in menus and title bars.
 
std::string GetIcon () const override
 Material Design icon for this panel.
 
std::string GetEditorCategory () const override
 Editor category this panel belongs to.
 
int GetPriority () const override
 Get display priority for menu ordering.
 
bool IsVisibleByDefault () const override
 Whether this panel should be visible by default.
 
void Draw (bool *p_open) override
 Draw the panel content.
 
- Public Member Functions inherited from yaze::editor::WindowContent
virtual ~WindowContent ()=default
 
virtual void OnFirstDraw ()
 Called once before the first Draw() in a session.
 
virtual bool RequiresLazyInit () const
 Whether this panel uses lazy initialization.
 
void InvalidateLazyInit ()
 Reset lazy init state so OnFirstDraw() runs again.
 
virtual void OnOpen ()
 Called when panel becomes visible.
 
virtual void OnClose ()
 Called when panel is hidden.
 
virtual void OnFocus ()
 Called when panel receives focus.
 
virtual WindowLifecycle GetWindowLifecycle () const
 Get the lifecycle category for this window.
 
virtual WindowContextScope GetContextScope () const
 Optional context binding for this window (room/selection/etc)
 
virtual WindowScope GetScope () const
 Get the registration scope for this window.
 
virtual bool IsEnabled () const
 Check if this panel is currently enabled.
 
virtual std::string GetDisabledTooltip () const
 Get tooltip text when panel is disabled.
 
virtual std::string GetShortcutHint () const
 Get keyboard shortcut hint for display.
 
virtual std::string GetWorkflowGroup () const
 Optional workflow group for hack-centric actions.
 
virtual std::string GetWorkflowLabel () const
 Optional workflow label for menus/command palette.
 
virtual std::string GetWorkflowDescription () const
 Optional workflow description for menus/command palette.
 
virtual int GetWorkflowPriority () const
 Optional workflow ordering priority (lower sorts first).
 
virtual float GetPreferredWidth () const
 Get preferred width for this panel (optional)
 
virtual bool PreferAutoHideTabBar () const
 Whether the dock node hosting this panel should auto-hide its tab bar.
 
virtual std::string GetParentPanelId () const
 Get parent panel ID for cascade behavior.
 
virtual bool CascadeCloseChildren () const
 Whether closing this panel should close child panels.
 
void DrawWithLazyInit (bool *p_open)
 Execute lazy initialization if needed, then call Draw()
 

Private Attributes

DrawCallback draw_callback_
 

Additional Inherited Members

- Protected Member Functions inherited from yaze::editor::WindowContent
void InvalidateCache ()
 Invalidate all cached computations.
 
template<typename T >
T & GetCached (const std::string &key, std::function< T()> compute)
 Get or compute a cached value.
 
bool IsCacheValid () const
 Check if cache has been invalidated.
 
void ClearCache ()
 Clear all cached values (more aggressive than InvalidateCache)
 

Detailed Description

Toolbar panel with quick actions.

Definition at line 157 of file assembly_editor_views.h.

Member Typedef Documentation

◆ DrawCallback

using yaze::editor::AssemblyToolbarPanel::DrawCallback = std::function<void()>

Definition at line 159 of file assembly_editor_views.h.

Constructor & Destructor Documentation

◆ AssemblyToolbarPanel()

yaze::editor::AssemblyToolbarPanel::AssemblyToolbarPanel ( DrawCallback draw_callback)
inlineexplicit

Definition at line 161 of file assembly_editor_views.h.

Member Function Documentation

◆ GetId()

std::string yaze::editor::AssemblyToolbarPanel::GetId ( ) const
inlineoverridevirtual

Unique identifier for this panel.

Returns
Panel ID in format "{category}.{name}" (e.g., "dungeon.room_selector")

IDs should be:

  • Lowercase with underscores
  • Prefixed with editor category
  • Unique across all panels

Implements yaze::editor::WindowContent.

Definition at line 164 of file assembly_editor_views.h.

◆ GetDisplayName()

std::string yaze::editor::AssemblyToolbarPanel::GetDisplayName ( ) const
inlineoverridevirtual

Human-readable name shown in menus and title bars.

Returns
Display name (e.g., "Room Selector")

Implements yaze::editor::WindowContent.

Definition at line 165 of file assembly_editor_views.h.

◆ GetIcon()

std::string yaze::editor::AssemblyToolbarPanel::GetIcon ( ) const
inlineoverridevirtual

Material Design icon for this panel.

Returns
Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::WindowContent.

Definition at line 166 of file assembly_editor_views.h.

References ICON_MD_CONSTRUCTION.

◆ GetEditorCategory()

std::string yaze::editor::AssemblyToolbarPanel::GetEditorCategory ( ) const
inlineoverridevirtual

Editor category this panel belongs to.

Returns
Category name matching EditorType (e.g., "Dungeon", "Overworld")

Implements yaze::editor::WindowContent.

Definition at line 167 of file assembly_editor_views.h.

◆ GetPriority()

int yaze::editor::AssemblyToolbarPanel::GetPriority ( ) const
inlineoverridevirtual

Get display priority for menu ordering.

Returns
Priority value (lower = higher in list, default 50)

Reimplemented from yaze::editor::WindowContent.

Definition at line 168 of file assembly_editor_views.h.

◆ IsVisibleByDefault()

bool yaze::editor::AssemblyToolbarPanel::IsVisibleByDefault ( ) const
inlineoverridevirtual

Whether this panel should be visible by default.

Returns
true if panel should be visible when editor first opens

Override this to set panels as visible by default. Most panels default to hidden to reduce UI clutter.

Reimplemented from yaze::editor::WindowContent.

Definition at line 169 of file assembly_editor_views.h.

◆ Draw()

void yaze::editor::AssemblyToolbarPanel::Draw ( bool * p_open)
inlineoverridevirtual

Draw the panel content.

Parameters
p_openPointer to visibility flag (nullptr if not closable)

Called by WorkspaceWindowManager when the panel is visible. Do NOT call ImGui::Begin/End - the PanelWindow wrapper handles that. Just draw your content directly.

Implements yaze::editor::WindowContent.

Definition at line 171 of file assembly_editor_views.h.

References draw_callback_.

Member Data Documentation

◆ draw_callback_

DrawCallback yaze::editor::AssemblyToolbarPanel::draw_callback_
private

Definition at line 178 of file assembly_editor_views.h.

Referenced by Draw().


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