yaze::editor::WindowDescriptor Struct Reference

Metadata for a dockable editor window (formerly PanelInfo) More...

#include <workspace_window_manager.h>

Collaboration diagram for yaze::editor::WindowDescriptor:

Public Types
enum class	ShortcutScope { kGlobal , kEditor , kPanel }

Public Member Functions
std::string	GetWindowTitle () const
	Get the effective window title for DockBuilder.
std::string	GetImGuiWindowName () const
	Build the exact ImGui window name used by PanelWindow::Begin.
bool	IsAdmitted () const
bool	IsListedInWindowBrowser () const

Public Attributes
std::string	card_id
std::string	display_name
std::string	window_title
std::string	icon
std::string	category
std::string	workflow_group
std::string	workflow_label
std::string	workflow_description
int	workflow_priority = 50
WindowLifecycle	window_lifecycle = WindowLifecycle::EditorBound
WindowContextScope	context_scope = WindowContextScope::kNone
WindowPresentationPolicy	presentation
WindowScope	scope = WindowScope::kSession
std::string	shortcut_hint
ShortcutScope	shortcut_scope = ShortcutScope::kPanel
bool *	visibility_flag
std::function< void()>	on_show
std::function< void()>	on_hide
int	priority
std::function< bool()>	enabled_condition
std::string	disabled_tooltip

Detailed Description

Metadata for a dockable editor window (formerly PanelInfo)

Definition at line 50 of file workspace_window_manager.h.

Member Enumeration Documentation

ShortcutScope

enum class yaze::editor::WindowDescriptor::ShortcutScope

strong

Enumerator
kGlobal
kEditor
kPanel

Definition at line 74 of file workspace_window_manager.h.

Member Function Documentation

GetWindowTitle()

std::string yaze::editor::WindowDescriptor::GetWindowTitle ( ) const

inline

Get the effective window title for DockBuilder.

Returns

window_title if set, otherwise generates from icon + display_name

Definition at line 95 of file workspace_window_manager.h.

References display_name, icon, and window_title.

Referenced by yaze::editor::layout_designer::anonymous_namespace{layout_designer_window.cc}::ApplyLayoutToDockspace().

GetImGuiWindowName()

std::string yaze::editor::WindowDescriptor::GetImGuiWindowName ( ) const

inline

Build the exact ImGui window name used by PanelWindow::Begin.

Uses the display label plus a stable ID suffix to keep DockBuilder and runtime window identity aligned.

Definition at line 109 of file workspace_window_manager.h.

References card_id, display_name, and icon.

Referenced by yaze::editor::WorkspaceWindowManager::GetWindowNameImpl().

IsAdmitted()

bool yaze::editor::WindowDescriptor::IsAdmitted ( ) const

inline

Definition at line 118 of file workspace_window_manager.h.

References yaze::editor::WindowPresentationPolicy::IsAdmitted(), and presentation.

Referenced by IsListedInWindowBrowser().

Here is the call graph for this function:

IsListedInWindowBrowser()

bool yaze::editor::WindowDescriptor::IsListedInWindowBrowser ( ) const

inline

Definition at line 119 of file workspace_window_manager.h.

References IsAdmitted(), yaze::editor::WindowPresentationPolicy::list_in_window_browser, and presentation.

Referenced by yaze::editor::MenuOrchestrator::AddPanelsMenuItems().

Here is the call graph for this function:

Member Data Documentation

card_id

std::string yaze::editor::WindowDescriptor::card_id

Definition at line 51 of file workspace_window_manager.h.

Referenced by yaze::editor::anonymous_namespace{workspace_window_manager_state.cc}::BuildDescriptorFromPanel(), yaze::editor::anonymous_namespace{workspace_window_manager.cc}::BuildDescriptorFromPanel(), GetImGuiWindowName(), yaze::editor::WorkspaceWindowManager::GetWindowsInCategoryImpl(), yaze::editor::WorkspaceWindowManager::GetWindowsSortedByMRUImpl(), yaze::editor::anonymous_namespace{window_browser.cc}::MatchesWindowSearch(), yaze::editor::anonymous_namespace{window_sidebar.cc}::MatchesWindowSearch(), yaze::editor::EditorManager::RegisterEmulatorPanels(), anonymous_namespace{main.cc}::RegisterLabPanels(), yaze::editor::WorkspaceWindowManager::RegisterPanel(), yaze::editor::WorkspaceWindowManager::RegisterPanel(), yaze::editor::WindowSidebar::SidebarSectionFor(), and yaze::editor::WindowHost::ToDescriptor().

display_name

std::string yaze::editor::WindowDescriptor::display_name

Definition at line 52 of file workspace_window_manager.h.

Referenced by yaze::editor::anonymous_namespace{workspace_window_manager_state.cc}::BuildDescriptorFromPanel(), yaze::editor::anonymous_namespace{workspace_window_manager.cc}::BuildDescriptorFromPanel(), yaze::editor::WindowSidebar::Draw(), yaze::editor::WorkspaceWindowManager::DrawAllVisiblePanels(), GetImGuiWindowName(), GetWindowTitle(), yaze::editor::anonymous_namespace{window_browser.cc}::MatchesWindowSearch(), yaze::editor::anonymous_namespace{window_sidebar.cc}::MatchesWindowSearch(), yaze::editor::EditorManager::RegisterEmulatorPanels(), anonymous_namespace{main.cc}::RegisterLabPanels(), yaze::editor::WorkspaceWindowManager::RegisterPanel(), yaze::editor::WorkspaceWindowManager::RegisterWindowContent(), and yaze::editor::WindowHost::ToDescriptor().

window_title

std::string yaze::editor::WindowDescriptor::window_title

Definition at line 54 of file workspace_window_manager.h.

Referenced by yaze::editor::anonymous_namespace{workspace_window_manager_state.cc}::BuildDescriptorFromPanel(), yaze::editor::anonymous_namespace{workspace_window_manager.cc}::BuildDescriptorFromPanel(), GetWindowTitle(), yaze::editor::EditorManager::RegisterEmulatorPanels(), anonymous_namespace{main.cc}::RegisterLabPanels(), and yaze::editor::WindowHost::ToDescriptor().

icon

std::string yaze::editor::WindowDescriptor::icon

Definition at line 55 of file workspace_window_manager.h.

Referenced by yaze::editor::anonymous_namespace{workspace_window_manager_state.cc}::BuildDescriptorFromPanel(), yaze::editor::anonymous_namespace{workspace_window_manager.cc}::BuildDescriptorFromPanel(), yaze::editor::WorkspaceWindowManager::DrawAllVisiblePanels(), GetImGuiWindowName(), GetWindowTitle(), yaze::editor::EditorManager::RegisterEmulatorPanels(), anonymous_namespace{main.cc}::RegisterLabPanels(), yaze::editor::WorkspaceWindowManager::RegisterPanel(), and yaze::editor::WindowHost::ToDescriptor().

category

std::string yaze::editor::WindowDescriptor::category

Definition at line 56 of file workspace_window_manager.h.

Referenced by yaze::editor::AuditPanelAdmission(), yaze::editor::anonymous_namespace{workspace_window_manager_state.cc}::BuildDescriptorFromPanel(), yaze::editor::anonymous_namespace{workspace_window_manager.cc}::BuildDescriptorFromPanel(), yaze::editor::WorkspaceWindowManager::DrawAllVisiblePanels(), yaze::editor::EditorManager::RegisterEmulatorPanels(), anonymous_namespace{main.cc}::RegisterLabPanels(), yaze::editor::WorkspaceWindowManager::RegisterPanel(), and yaze::editor::WindowHost::ToDescriptor().

workflow_group

std::string yaze::editor::WindowDescriptor::workflow_group

Definition at line 57 of file workspace_window_manager.h.

Referenced by yaze::editor::anonymous_namespace{workspace_window_manager_state.cc}::BuildDescriptorFromPanel(), yaze::editor::anonymous_namespace{workspace_window_manager.cc}::BuildDescriptorFromPanel(), and yaze::editor::WindowSidebar::SidebarSectionFor().

workflow_label

std::string yaze::editor::WindowDescriptor::workflow_label

Definition at line 58 of file workspace_window_manager.h.

Referenced by yaze::editor::anonymous_namespace{workspace_window_manager_state.cc}::BuildDescriptorFromPanel(), and yaze::editor::anonymous_namespace{workspace_window_manager.cc}::BuildDescriptorFromPanel().

workflow_description

std::string yaze::editor::WindowDescriptor::workflow_description

Definition at line 59 of file workspace_window_manager.h.

Referenced by yaze::editor::anonymous_namespace{workspace_window_manager_state.cc}::BuildDescriptorFromPanel(), and yaze::editor::anonymous_namespace{workspace_window_manager.cc}::BuildDescriptorFromPanel().

workflow_priority

int yaze::editor::WindowDescriptor::workflow_priority = 50

Definition at line 60 of file workspace_window_manager.h.

Referenced by yaze::editor::anonymous_namespace{workspace_window_manager_state.cc}::BuildDescriptorFromPanel(), and yaze::editor::anonymous_namespace{workspace_window_manager.cc}::BuildDescriptorFromPanel().

window_lifecycle

WindowLifecycle yaze::editor::WindowDescriptor::window_lifecycle = WindowLifecycle::EditorBound

Definition at line 63 of file workspace_window_manager.h.

Referenced by yaze::editor::anonymous_namespace{workspace_window_manager_state.cc}::BuildDescriptorFromPanel(), yaze::editor::anonymous_namespace{workspace_window_manager.cc}::BuildDescriptorFromPanel(), yaze::editor::EditorManager::RegisterEmulatorPanels(), and yaze::editor::WindowHost::ToDescriptor().

context_scope

WindowContextScope yaze::editor::WindowDescriptor::context_scope = WindowContextScope::kNone

Definition at line 66 of file workspace_window_manager.h.

Referenced by yaze::editor::anonymous_namespace{workspace_window_manager_state.cc}::BuildDescriptorFromPanel(), yaze::editor::anonymous_namespace{workspace_window_manager.cc}::BuildDescriptorFromPanel(), yaze::editor::EditorManager::RegisterEmulatorPanels(), and yaze::editor::WindowHost::ToDescriptor().

presentation

WindowPresentationPolicy yaze::editor::WindowDescriptor::presentation

Definition at line 71 of file workspace_window_manager.h.

Referenced by yaze::editor::AuditPanelAdmission(), yaze::editor::anonymous_namespace{workspace_window_manager_state.cc}::BuildDescriptorFromPanel(), yaze::editor::anonymous_namespace{workspace_window_manager.cc}::BuildDescriptorFromPanel(), IsAdmitted(), IsListedInWindowBrowser(), yaze::editor::EditorManager::RegisterEmulatorPanels(), and yaze::editor::WindowHost::ToDescriptor().

scope

WindowScope yaze::editor::WindowDescriptor::scope = WindowScope::kSession

Definition at line 73 of file workspace_window_manager.h.

Referenced by yaze::editor::anonymous_namespace{workspace_window_manager_state.cc}::BuildDescriptorFromPanel(), yaze::editor::anonymous_namespace{workspace_window_manager.cc}::BuildDescriptorFromPanel(), yaze::editor::EditorManager::RegisterEmulatorPanels(), yaze::editor::WorkspaceWindowManager::RegisterPanel(), and yaze::editor::WindowHost::ToDescriptor().

shortcut_hint

std::string yaze::editor::WindowDescriptor::shortcut_hint

Definition at line 79 of file workspace_window_manager.h.

Referenced by yaze::editor::anonymous_namespace{workspace_window_manager_state.cc}::BuildDescriptorFromPanel(), yaze::editor::anonymous_namespace{workspace_window_manager.cc}::BuildDescriptorFromPanel(), yaze::editor::anonymous_namespace{window_browser.cc}::MatchesWindowSearch(), yaze::editor::anonymous_namespace{window_sidebar.cc}::MatchesWindowSearch(), yaze::editor::EditorManager::RegisterEmulatorPanels(), anonymous_namespace{main.cc}::RegisterLabPanels(), yaze::editor::WorkspaceWindowManager::RegisterPanel(), and yaze::editor::WindowHost::ToDescriptor().

shortcut_scope

ShortcutScope yaze::editor::WindowDescriptor::shortcut_scope = ShortcutScope::kPanel

Definition at line 80 of file workspace_window_manager.h.

visibility_flag

bool* yaze::editor::WindowDescriptor::visibility_flag

Definition at line 81 of file workspace_window_manager.h.

Referenced by yaze::editor::anonymous_namespace{workspace_window_manager_state.cc}::BuildDescriptorFromPanel(), yaze::editor::anonymous_namespace{workspace_window_manager.cc}::BuildDescriptorFromPanel(), yaze::editor::CollectDefaultVisibleWindowIds(), yaze::editor::WindowBrowser::Draw(), yaze::editor::WindowSidebar::Draw(), yaze::editor::WorkspaceWindowManager::DrawAllVisiblePanels(), yaze::editor::UICoordinator::DrawPanelFinder(), yaze::editor::EditorManager::RegisterEmulatorPanels(), anonymous_namespace{main.cc}::RegisterLabPanels(), yaze::editor::WorkspaceWindowManager::RegisterPanel(), yaze::editor::WorkspaceWindowManager::RegisterPanel(), and yaze::editor::WindowHost::ToDescriptor().

on_show

std::function<void()> yaze::editor::WindowDescriptor::on_show

Definition at line 82 of file workspace_window_manager.h.

Referenced by yaze::editor::EditorManager::RegisterEmulatorPanels(), yaze::editor::WorkspaceWindowManager::RegisterPanel(), and yaze::editor::WindowHost::ToDescriptor().

on_hide

std::function<void()> yaze::editor::WindowDescriptor::on_hide

Definition at line 83 of file workspace_window_manager.h.

Referenced by yaze::editor::EditorManager::RegisterEmulatorPanels(), yaze::editor::WorkspaceWindowManager::RegisterPanel(), and yaze::editor::WindowHost::ToDescriptor().

priority

int yaze::editor::WindowDescriptor::priority

Definition at line 84 of file workspace_window_manager.h.

Referenced by yaze::editor::anonymous_namespace{workspace_window_manager_state.cc}::BuildDescriptorFromPanel(), yaze::editor::anonymous_namespace{workspace_window_manager.cc}::BuildDescriptorFromPanel(), yaze::editor::WorkspaceWindowManager::GetWindowsSortedByMRUImpl(), yaze::editor::EditorManager::RegisterEmulatorPanels(), anonymous_namespace{main.cc}::RegisterLabPanels(), yaze::editor::WorkspaceWindowManager::RegisterPanel(), and yaze::editor::WindowHost::ToDescriptor().

enabled_condition

std::function<bool()> yaze::editor::WindowDescriptor::enabled_condition

Definition at line 88 of file workspace_window_manager.h.

Referenced by yaze::editor::anonymous_namespace{workspace_window_manager_state.cc}::BuildDescriptorFromPanel(), and yaze::editor::anonymous_namespace{workspace_window_manager.cc}::BuildDescriptorFromPanel().

disabled_tooltip

std::string yaze::editor::WindowDescriptor::disabled_tooltip

Definition at line 89 of file workspace_window_manager.h.

Referenced by yaze::editor::anonymous_namespace{workspace_window_manager_state.cc}::BuildDescriptorFromPanel(), yaze::editor::anonymous_namespace{workspace_window_manager.cc}::BuildDescriptorFromPanel(), and anonymous_namespace{main.cc}::RegisterLabPanels().

---

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

• src/app/editor/system/workspace/workspace_window_manager.h