yaze 0.3.2
Link to the Past ROM Editor
 
Loading...
Searching...
No Matches
Public Member Functions | Static Private Member Functions | Private Attributes | List of all members
yaze::editor::PanelHost Class Reference

Thin host API over PanelManager for declarative panel workflows. More...

#include <panel_host.h>

Collaboration diagram for yaze::editor::PanelHost:
Collaboration graph
[legend]

Public Member Functions

 PanelHost (PanelManager *panel_manager=nullptr)
 
void SetPanelManager (PanelManager *panel_manager)
 
PanelManager * panel_manager () const
 
bool RegisterPanel (size_t session_id, const PanelDefinition &definition)
 
bool RegisterPanel (const PanelDefinition &definition)
 
bool RegisterPanels (size_t session_id, const std::vector< PanelDefinition > &definitions)
 
bool RegisterPanels (const std::vector< PanelDefinition > &definitions)
 
void RegisterPanelAlias (const std::string &legacy_id, const std::string &canonical_id)
 
bool ShowPanel (size_t session_id, const std::string &panel_id)
 
bool HidePanel (size_t session_id, const std::string &panel_id)
 
bool TogglePanel (size_t session_id, const std::string &panel_id)
 
bool IsPanelVisible (size_t session_id, const std::string &panel_id) const
 
bool OpenAndFocus (size_t session_id, const std::string &panel_id) const
 
std::string ResolvePanelId (const std::string &panel_id) const
 
std::string GetPanelWindowName (size_t session_id, const std::string &panel_id) const
 

Static Private Member Functions

static PanelDescriptor ToDescriptor (const PanelDefinition &definition)
 

Private Attributes

PanelManager * panel_manager_ = nullptr
 

Detailed Description

Thin host API over PanelManager for declarative panel workflows.

Definition at line 43 of file panel_host.h.

Constructor & Destructor Documentation

◆ PanelHost()

yaze::editor::PanelHost::PanelHost ( PanelManager * panel_manager = nullptr)
inlineexplicit

Definition at line 45 of file panel_host.h.

Member Function Documentation

◆ SetPanelManager()

void yaze::editor::PanelHost::SetPanelManager ( PanelManager * panel_manager)
inline

Definition at line 48 of file panel_host.h.

References panel_manager(), and panel_manager_.

Here is the call graph for this function:

◆ panel_manager()

PanelManager * yaze::editor::PanelHost::panel_manager ( ) const
inline

Definition at line 51 of file panel_host.h.

References panel_manager_.

Referenced by SetPanelManager().

◆ RegisterPanel() [1/2]

bool yaze::editor::PanelHost::RegisterPanel ( size_t session_id,
const PanelDefinition & definition )

Definition at line 27 of file panel_host.cc.

References yaze::editor::PanelDefinition::id, yaze::editor::PanelDefinition::legacy_ids, panel_manager_, yaze::editor::PanelManager::RegisterPanel(), RegisterPanelAlias(), yaze::editor::PanelManager::ShowPanel(), ToDescriptor(), and yaze::editor::PanelDefinition::visible_by_default.

Referenced by RegisterPanel(), and RegisterPanels().

Here is the call graph for this function:

◆ RegisterPanel() [2/2]

bool yaze::editor::PanelHost::RegisterPanel ( const PanelDefinition & definition)

Definition at line 45 of file panel_host.cc.

References yaze::editor::PanelManager::GetActiveSessionId(), panel_manager_, and RegisterPanel().

Here is the call graph for this function:

◆ RegisterPanels() [1/2]

bool yaze::editor::PanelHost::RegisterPanels ( size_t session_id,
const std::vector< PanelDefinition > & definitions )

Definition at line 52 of file panel_host.cc.

References panel_manager_, and RegisterPanel().

Referenced by RegisterPanels().

Here is the call graph for this function:

◆ RegisterPanels() [2/2]

bool yaze::editor::PanelHost::RegisterPanels ( const std::vector< PanelDefinition > & definitions)

Definition at line 65 of file panel_host.cc.

References yaze::editor::PanelManager::GetActiveSessionId(), panel_manager_, and RegisterPanels().

Here is the call graph for this function:

◆ RegisterPanelAlias()

void yaze::editor::PanelHost::RegisterPanelAlias ( const std::string & legacy_id,
const std::string & canonical_id )

Definition at line 73 of file panel_host.cc.

References panel_manager_, and yaze::editor::PanelManager::RegisterPanelAlias().

Referenced by RegisterPanel().

Here is the call graph for this function:

◆ ShowPanel()

bool yaze::editor::PanelHost::ShowPanel ( size_t session_id,
const std::string & panel_id )

Definition at line 81 of file panel_host.cc.

References panel_manager_, and yaze::editor::PanelManager::ShowPanel().

Here is the call graph for this function:

◆ HidePanel()

bool yaze::editor::PanelHost::HidePanel ( size_t session_id,
const std::string & panel_id )

Definition at line 85 of file panel_host.cc.

References yaze::editor::PanelManager::HidePanel(), and panel_manager_.

Here is the call graph for this function:

◆ TogglePanel()

bool yaze::editor::PanelHost::TogglePanel ( size_t session_id,
const std::string & panel_id )

Definition at line 89 of file panel_host.cc.

References panel_manager_, and yaze::editor::PanelManager::TogglePanel().

Here is the call graph for this function:

◆ IsPanelVisible()

bool yaze::editor::PanelHost::IsPanelVisible ( size_t session_id,
const std::string & panel_id ) const

Definition at line 93 of file panel_host.cc.

References yaze::editor::PanelManager::IsPanelVisible(), and panel_manager_.

Here is the call graph for this function:

◆ OpenAndFocus()

bool yaze::editor::PanelHost::OpenAndFocus ( size_t session_id,
const std::string & panel_id ) const

Definition at line 98 of file panel_host.cc.

References yaze::editor::PanelManager::GetPanelWindowName(), panel_manager_, and yaze::editor::PanelManager::ShowPanel().

Here is the call graph for this function:

◆ ResolvePanelId()

std::string yaze::editor::PanelHost::ResolvePanelId ( const std::string & panel_id) const

Definition at line 118 of file panel_host.cc.

References panel_manager_, and yaze::editor::PanelManager::ResolvePanelAlias().

Here is the call graph for this function:

◆ GetPanelWindowName()

std::string yaze::editor::PanelHost::GetPanelWindowName ( size_t session_id,
const std::string & panel_id ) const

Definition at line 123 of file panel_host.cc.

References yaze::editor::PanelManager::GetPanelWindowName(), and panel_manager_.

Here is the call graph for this function:

◆ ToDescriptor()

PanelDescriptor yaze::editor::PanelHost::ToDescriptor ( const PanelDefinition & definition)
staticprivate

Definition at line 9 of file panel_host.cc.

References yaze::editor::PanelDescriptor::card_id, yaze::editor::PanelDefinition::category, yaze::editor::PanelDescriptor::category, yaze::editor::PanelDefinition::context_scope, yaze::editor::PanelDescriptor::context_scope, yaze::editor::PanelDefinition::display_name, yaze::editor::PanelDescriptor::display_name, yaze::editor::PanelDefinition::icon, yaze::editor::PanelDescriptor::icon, yaze::editor::PanelDefinition::id, yaze::editor::PanelDefinition::on_hide, yaze::editor::PanelDescriptor::on_hide, yaze::editor::PanelDefinition::on_show, yaze::editor::PanelDescriptor::on_show, yaze::editor::PanelDefinition::panel_category, yaze::editor::PanelDescriptor::panel_category, yaze::editor::PanelDefinition::priority, yaze::editor::PanelDescriptor::priority, yaze::editor::PanelDefinition::scope, yaze::editor::PanelDescriptor::scope, yaze::editor::PanelDefinition::shortcut_hint, yaze::editor::PanelDescriptor::shortcut_hint, yaze::editor::PanelDefinition::visibility_flag, yaze::editor::PanelDescriptor::visibility_flag, yaze::editor::PanelDefinition::window_title, and yaze::editor::PanelDescriptor::window_title.

Referenced by RegisterPanel().

Member Data Documentation

◆ panel_manager_

PanelManager* yaze::editor::PanelHost::panel_manager_ = nullptr
private

Definition at line 76 of file panel_host.h.

Referenced by GetPanelWindowName(), HidePanel(), IsPanelVisible(), OpenAndFocus(), panel_manager(), RegisterPanel(), RegisterPanel(), RegisterPanelAlias(), RegisterPanels(), RegisterPanels(), ResolvePanelId(), SetPanelManager(), ShowPanel(), and TogglePanel().

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