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::WindowHost Class Reference

Thin host API over WorkspaceWindowManager for declarative window workflows. More...

#include <panel_host.h>

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

Public Member Functions

 WindowHost (WorkspaceWindowManager *window_manager=nullptr)
 
void SetWindowManager (WorkspaceWindowManager *window_manager)
 
WorkspaceWindowManager * window_manager () const
 
bool RegisterPanel (size_t session_id, const WindowDefinition &definition)
 
bool RegisterPanel (const WindowDefinition &definition)
 
bool RegisterPanels (size_t session_id, const std::vector< WindowDefinition > &definitions)
 
bool RegisterPanels (const std::vector< WindowDefinition > &definitions)
 
bool RegisterWindow (size_t session_id, const WindowDefinition &definition)
 
bool RegisterWindow (const WindowDefinition &definition)
 
bool RegisterWindows (size_t session_id, const std::vector< WindowDefinition > &definitions)
 
bool RegisterWindows (const std::vector< WindowDefinition > &definitions)
 
void RegisterPanelAlias (const std::string &legacy_id, const std::string &canonical_id)
 
void RegisterWindowAlias (const std::string &legacy_id, const std::string &canonical_id)
 
bool OpenWindow (size_t session_id, const std::string &window_id)
 
bool CloseWindow (size_t session_id, const std::string &window_id)
 
bool ToggleWindow (size_t session_id, const std::string &window_id)
 
bool IsWindowOpen (size_t session_id, const std::string &window_id) const
 
bool OpenAndFocusWindow (size_t session_id, const std::string &window_id) const
 
std::string ResolveWindowId (const std::string &window_id) const
 
std::string GetWorkspaceWindowName (size_t session_id, const std::string &window_id) const
 

Static Private Member Functions

static WindowDescriptor ToDescriptor (const WindowDefinition &definition)
 

Private Attributes

WorkspaceWindowManager * window_manager_ = nullptr
 

Detailed Description

Thin host API over WorkspaceWindowManager for declarative window workflows.

Definition at line 43 of file panel_host.h.

Constructor & Destructor Documentation

◆ WindowHost()

yaze::editor::WindowHost::WindowHost ( WorkspaceWindowManager * window_manager = nullptr)
inlineexplicit

Definition at line 45 of file panel_host.h.

Member Function Documentation

◆ SetWindowManager()

void yaze::editor::WindowHost::SetWindowManager ( WorkspaceWindowManager * window_manager)
inline

Definition at line 48 of file panel_host.h.

References window_manager(), and window_manager_.

Here is the call graph for this function:

◆ window_manager()

WorkspaceWindowManager * yaze::editor::WindowHost::window_manager ( ) const
inline

Definition at line 51 of file panel_host.h.

References window_manager_.

Referenced by SetWindowManager().

◆ RegisterPanel() [1/2]

bool yaze::editor::WindowHost::RegisterPanel ( size_t session_id,
const WindowDefinition & definition )

Definition at line 27 of file panel_host.cc.

References yaze::editor::WindowDefinition::id, yaze::editor::WindowDefinition::legacy_ids, yaze::editor::WorkspaceWindowManager::OpenWindow(), RegisterPanelAlias(), yaze::editor::WorkspaceWindowManager::RegisterWindow(), ToDescriptor(), yaze::editor::WindowDefinition::visible_by_default, and window_manager_.

Referenced by RegisterPanel(), RegisterPanels(), RegisterWindow(), and RegisterWindow().

Here is the call graph for this function:

◆ RegisterPanel() [2/2]

bool yaze::editor::WindowHost::RegisterPanel ( const WindowDefinition & definition)

Definition at line 45 of file panel_host.cc.

References yaze::editor::WorkspaceWindowManager::GetActiveSessionId(), RegisterPanel(), and window_manager_.

Here is the call graph for this function:

◆ RegisterPanels() [1/2]

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

Definition at line 52 of file panel_host.cc.

References RegisterPanel(), and window_manager_.

Referenced by RegisterPanels(), RegisterWindows(), and RegisterWindows().

Here is the call graph for this function:

◆ RegisterPanels() [2/2]

bool yaze::editor::WindowHost::RegisterPanels ( const std::vector< WindowDefinition > & definitions)

Definition at line 65 of file panel_host.cc.

References yaze::editor::WorkspaceWindowManager::GetActiveSessionId(), RegisterPanels(), and window_manager_.

Here is the call graph for this function:

◆ RegisterWindow() [1/2]

bool yaze::editor::WindowHost::RegisterWindow ( size_t session_id,
const WindowDefinition & definition )
inline

Definition at line 59 of file panel_host.h.

References RegisterPanel().

Here is the call graph for this function:

◆ RegisterWindow() [2/2]

bool yaze::editor::WindowHost::RegisterWindow ( const WindowDefinition & definition)
inline

Definition at line 62 of file panel_host.h.

References RegisterPanel().

Here is the call graph for this function:

◆ RegisterWindows() [1/2]

bool yaze::editor::WindowHost::RegisterWindows ( size_t session_id,
const std::vector< WindowDefinition > & definitions )
inline

Definition at line 65 of file panel_host.h.

References RegisterPanels().

Here is the call graph for this function:

◆ RegisterWindows() [2/2]

bool yaze::editor::WindowHost::RegisterWindows ( const std::vector< WindowDefinition > & definitions)
inline

Definition at line 69 of file panel_host.h.

References RegisterPanels().

Here is the call graph for this function:

◆ RegisterPanelAlias()

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

Definition at line 73 of file panel_host.cc.

References yaze::editor::WorkspaceWindowManager::RegisterPanelAlias(), and window_manager_.

Referenced by RegisterPanel(), and RegisterWindowAlias().

Here is the call graph for this function:

◆ RegisterWindowAlias()

void yaze::editor::WindowHost::RegisterWindowAlias ( const std::string & legacy_id,
const std::string & canonical_id )
inline

Definition at line 75 of file panel_host.h.

References RegisterPanelAlias().

Here is the call graph for this function:

◆ OpenWindow()

bool yaze::editor::WindowHost::OpenWindow ( size_t session_id,
const std::string & window_id )

Definition at line 81 of file panel_host.cc.

References yaze::editor::WorkspaceWindowManager::OpenWindow(), and window_manager_.

Here is the call graph for this function:

◆ CloseWindow()

bool yaze::editor::WindowHost::CloseWindow ( size_t session_id,
const std::string & window_id )

Definition at line 85 of file panel_host.cc.

References yaze::editor::WorkspaceWindowManager::CloseWindow(), and window_manager_.

Here is the call graph for this function:

◆ ToggleWindow()

bool yaze::editor::WindowHost::ToggleWindow ( size_t session_id,
const std::string & window_id )

Definition at line 89 of file panel_host.cc.

References yaze::editor::WorkspaceWindowManager::ToggleWindow(), and window_manager_.

Here is the call graph for this function:

◆ IsWindowOpen()

bool yaze::editor::WindowHost::IsWindowOpen ( size_t session_id,
const std::string & window_id ) const

Definition at line 93 of file panel_host.cc.

References yaze::editor::WorkspaceWindowManager::IsWindowOpen(), and window_manager_.

Here is the call graph for this function:

◆ OpenAndFocusWindow()

bool yaze::editor::WindowHost::OpenAndFocusWindow ( size_t session_id,
const std::string & window_id ) const

Definition at line 98 of file panel_host.cc.

References yaze::editor::WorkspaceWindowManager::GetWorkspaceWindowName(), yaze::editor::WorkspaceWindowManager::OpenWindow(), and window_manager_.

Here is the call graph for this function:

◆ ResolveWindowId()

std::string yaze::editor::WindowHost::ResolveWindowId ( const std::string & window_id) const

Definition at line 118 of file panel_host.cc.

References yaze::editor::WorkspaceWindowManager::ResolveWindowAlias(), and window_manager_.

Here is the call graph for this function:

◆ GetWorkspaceWindowName()

std::string yaze::editor::WindowHost::GetWorkspaceWindowName ( size_t session_id,
const std::string & window_id ) const

Definition at line 123 of file panel_host.cc.

References yaze::editor::WorkspaceWindowManager::GetWorkspaceWindowName(), and window_manager_.

Here is the call graph for this function:

◆ ToDescriptor()

WindowDescriptor yaze::editor::WindowHost::ToDescriptor ( const WindowDefinition & definition)
staticprivate

Definition at line 9 of file panel_host.cc.

References yaze::editor::WindowDescriptor::card_id, yaze::editor::WindowDefinition::category, yaze::editor::WindowDescriptor::category, yaze::editor::WindowDefinition::context_scope, yaze::editor::WindowDescriptor::context_scope, yaze::editor::WindowDefinition::display_name, yaze::editor::WindowDescriptor::display_name, yaze::editor::WindowDefinition::icon, yaze::editor::WindowDescriptor::icon, yaze::editor::WindowDefinition::id, yaze::editor::WindowDefinition::on_hide, yaze::editor::WindowDescriptor::on_hide, yaze::editor::WindowDefinition::on_show, yaze::editor::WindowDescriptor::on_show, yaze::editor::WindowDefinition::priority, yaze::editor::WindowDescriptor::priority, yaze::editor::WindowDefinition::scope, yaze::editor::WindowDescriptor::scope, yaze::editor::WindowDefinition::shortcut_hint, yaze::editor::WindowDescriptor::shortcut_hint, yaze::editor::WindowDefinition::visibility_flag, yaze::editor::WindowDescriptor::visibility_flag, yaze::editor::WindowDefinition::window_lifecycle, yaze::editor::WindowDescriptor::window_lifecycle, yaze::editor::WindowDefinition::window_title, and yaze::editor::WindowDescriptor::window_title.

Referenced by RegisterPanel().

Member Data Documentation

◆ window_manager_

WorkspaceWindowManager* yaze::editor::WindowHost::window_manager_ = nullptr
private

Definition at line 95 of file panel_host.h.

Referenced by CloseWindow(), GetWorkspaceWindowName(), IsWindowOpen(), OpenAndFocusWindow(), OpenWindow(), RegisterPanel(), RegisterPanel(), RegisterPanelAlias(), RegisterPanels(), RegisterPanels(), ResolveWindowId(), SetWindowManager(), ToggleWindow(), and window_manager().

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