yaze::editor::MusicHelpPanel Class Reference

EditorPanel providing help documentation for the Music Editor. More...

#include <music_help_panel.h>

Inheritance diagram for yaze::editor::MusicHelpPanel:

Collaboration diagram for yaze::editor::MusicHelpPanel:

Public Member Functions
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.
void	Draw (bool *p_open) override
	Draw the panel content.
Public Member Functions inherited from yaze::editor::EditorPanel
virtual	~EditorPanel ()=default
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 PanelCategory	GetPanelCategory () const
	Get the lifecycle category for this panel.
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 float	GetPreferredWidth () const
	Get preferred width for this panel (optional)
virtual bool	IsVisibleByDefault () const
	Whether this panel should be visible by default.
virtual std::string	GetParentPanelId () const
	Get parent panel ID for cascade behavior.
virtual bool	CascadeCloseChildren () const
	Whether closing this panel should close child panels.

Detailed Description

EditorPanel providing help documentation for the Music Editor.

Definition at line 17 of file music_help_panel.h.

Member Function Documentation

GetId()

std::string yaze::editor::MusicHelpPanel::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::EditorPanel.

Definition at line 23 of file music_help_panel.h.

GetDisplayName()

std::string yaze::editor::MusicHelpPanel::GetDisplayName ( ) const

inlineoverridevirtual

Human-readable name shown in menus and title bars.

Returns

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

Implements yaze::editor::EditorPanel.

Definition at line 24 of file music_help_panel.h.

GetIcon()

std::string yaze::editor::MusicHelpPanel::GetIcon ( ) const

inlineoverridevirtual

Material Design icon for this panel.

Returns

Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::EditorPanel.

Definition at line 25 of file music_help_panel.h.

References ICON_MD_HELP.

GetEditorCategory()

std::string yaze::editor::MusicHelpPanel::GetEditorCategory ( ) const

inlineoverridevirtual

Editor category this panel belongs to.

Returns

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

Implements yaze::editor::EditorPanel.

Definition at line 26 of file music_help_panel.h.

GetPriority()

int yaze::editor::MusicHelpPanel::GetPriority ( ) const

inlineoverridevirtual

Get display priority for menu ordering.

Returns

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

Reimplemented from yaze::editor::EditorPanel.

Definition at line 27 of file music_help_panel.h.

Draw()

void yaze::editor::MusicHelpPanel::Draw ( bool * p_open )

inlineoverridevirtual

Draw the panel content.

Parameters

p_open

Pointer to visibility flag (nullptr if not closable)

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

Implements yaze::editor::EditorPanel.

Definition at line 33 of file music_help_panel.h.

---

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

• src/app/editor/music/panels/music_help_panel.h