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

EditorPanel wrapper for the music song browser. More...

#include <music_song_browser_panel.h>

Inheritance diagram for yaze::editor::MusicSongBrowserPanel:
Collaboration diagram for yaze::editor::MusicSongBrowserPanel:

Public Member Functions

 MusicSongBrowserPanel (zelda3::music::MusicBank *music_bank, int *current_song_index, music::SongBrowserView *song_browser_view)
 
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.
 
void SetOnSongSelected (std::function< void(int)> callback)
 
void SetOnOpenTracker (std::function< void(int)> callback)
 
void SetOnOpenPianoRoll (std::function< void(int)> callback)
 
void SetOnExportAsm (std::function< void(int)> callback)
 
void SetOnImportAsm (std::function< void(int)> callback)
 
void SetOnEdit (std::function< void()> callback)
 
- 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.
 

Private Attributes

zelda3::music::MusicBankmusic_bank_ = nullptr
 
int * current_song_index_ = nullptr
 
music::SongBrowserViewsong_browser_view_ = nullptr
 

Detailed Description

EditorPanel wrapper for the music song browser.

Delegates to SongBrowserView for the actual UI drawing.

Definition at line 21 of file music_song_browser_panel.h.

Constructor & Destructor Documentation

◆ MusicSongBrowserPanel()

yaze::editor::MusicSongBrowserPanel::MusicSongBrowserPanel ( zelda3::music::MusicBank * music_bank,
int * current_song_index,
music::SongBrowserView * song_browser_view )
inline

Definition at line 23 of file music_song_browser_panel.h.

Member Function Documentation

◆ GetId()

std::string yaze::editor::MusicSongBrowserPanel::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 34 of file music_song_browser_panel.h.

◆ GetDisplayName()

std::string yaze::editor::MusicSongBrowserPanel::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 35 of file music_song_browser_panel.h.

◆ GetIcon()

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

Material Design icon for this panel.

Returns
Icon constant (e.g., ICON_MD_LIST)

Implements yaze::editor::EditorPanel.

Definition at line 36 of file music_song_browser_panel.h.

References ICON_MD_LIBRARY_MUSIC.

◆ GetEditorCategory()

std::string yaze::editor::MusicSongBrowserPanel::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 37 of file music_song_browser_panel.h.

◆ GetPriority()

int yaze::editor::MusicSongBrowserPanel::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 38 of file music_song_browser_panel.h.

◆ Draw()

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

Draw the panel content.

Parameters
p_openPointer 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 44 of file music_song_browser_panel.h.

References current_song_index_, yaze::editor::music::SongBrowserView::Draw(), yaze::editor::music::SongBrowserView::GetSelectedSongIndex(), music_bank_, yaze::editor::music::SongBrowserView::SetSelectedSongIndex(), and song_browser_view_.

Here is the call graph for this function:

◆ SetOnSongSelected()

void yaze::editor::MusicSongBrowserPanel::SetOnSongSelected ( std::function< void(int)> callback)
inline

Definition at line 63 of file music_song_browser_panel.h.

References yaze::editor::music::SongBrowserView::SetOnSongSelected(), and song_browser_view_.

Here is the call graph for this function:

◆ SetOnOpenTracker()

void yaze::editor::MusicSongBrowserPanel::SetOnOpenTracker ( std::function< void(int)> callback)
inline

Definition at line 67 of file music_song_browser_panel.h.

References yaze::editor::music::SongBrowserView::SetOnOpenTracker(), and song_browser_view_.

Here is the call graph for this function:

◆ SetOnOpenPianoRoll()

void yaze::editor::MusicSongBrowserPanel::SetOnOpenPianoRoll ( std::function< void(int)> callback)
inline

Definition at line 71 of file music_song_browser_panel.h.

References yaze::editor::music::SongBrowserView::SetOnOpenPianoRoll(), and song_browser_view_.

Here is the call graph for this function:

◆ SetOnExportAsm()

void yaze::editor::MusicSongBrowserPanel::SetOnExportAsm ( std::function< void(int)> callback)
inline

Definition at line 75 of file music_song_browser_panel.h.

References yaze::editor::music::SongBrowserView::SetOnExportAsm(), and song_browser_view_.

Here is the call graph for this function:

◆ SetOnImportAsm()

void yaze::editor::MusicSongBrowserPanel::SetOnImportAsm ( std::function< void(int)> callback)
inline

Definition at line 79 of file music_song_browser_panel.h.

References yaze::editor::music::SongBrowserView::SetOnImportAsm(), and song_browser_view_.

Here is the call graph for this function:

◆ SetOnEdit()

void yaze::editor::MusicSongBrowserPanel::SetOnEdit ( std::function< void()> callback)
inline

Definition at line 83 of file music_song_browser_panel.h.

References yaze::editor::music::SongBrowserView::SetOnEdit(), and song_browser_view_.

Here is the call graph for this function:

Member Data Documentation

◆ music_bank_

zelda3::music::MusicBank* yaze::editor::MusicSongBrowserPanel::music_bank_ = nullptr
private

Definition at line 88 of file music_song_browser_panel.h.

Referenced by Draw().

◆ current_song_index_

int* yaze::editor::MusicSongBrowserPanel::current_song_index_ = nullptr
private

Definition at line 89 of file music_song_browser_panel.h.

Referenced by Draw().

◆ song_browser_view_

music::SongBrowserView* yaze::editor::MusicSongBrowserPanel::song_browser_view_ = nullptr
private

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