yaze::editor::PanelDescriptor Struct Reference

Metadata for an editor panel (formerly PanelInfo) More...

#include <panel_manager.h>

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.

Public Attributes
std::string	card_id
std::string	display_name
std::string	window_title
std::string	icon
std::string	category
PanelCategory	panel_category = PanelCategory::EditorBound
PanelContextScope	context_scope = PanelContextScope::kNone
PanelScope	scope = PanelScope::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 an editor panel (formerly PanelInfo)

Definition at line 49 of file panel_manager.h.

Member Enumeration Documentation

ShortcutScope

enum class yaze::editor::PanelDescriptor::ShortcutScope

strong

Enumerator
kGlobal
kEditor
kPanel

Definition at line 63 of file panel_manager.h.

Member Function Documentation

GetWindowTitle()

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

inline

Get the effective window title for DockBuilder.

Returns

window_title if set, otherwise generates from icon + display_name

Definition at line 83 of file panel_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::PanelDescriptor::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 97 of file panel_manager.h.

References card_id, display_name, and icon.

Referenced by yaze::editor::PanelManager::GetPanelWindowName().

Member Data Documentation

card_id

std::string yaze::editor::PanelDescriptor::card_id

Definition at line 50 of file panel_manager.h.

Referenced by yaze::editor::anonymous_namespace{panel_manager.cc}::BuildDescriptorFromPanel(), GetImGuiWindowName(), yaze::editor::EditorManager::RegisterEmulatorPanels(), anonymous_namespace{main.cc}::RegisterLabPanels(), yaze::editor::PanelManager::RegisterPanel(), yaze::editor::PanelManager::RegisterPanel(), and yaze::editor::PanelHost::ToDescriptor().

display_name

std::string yaze::editor::PanelDescriptor::display_name

Definition at line 51 of file panel_manager.h.

Referenced by yaze::editor::anonymous_namespace{panel_manager.cc}::BuildDescriptorFromPanel(), yaze::editor::PanelManager::DrawAllVisiblePanels(), yaze::editor::ActivityBar::DrawPanelBrowser(), GetImGuiWindowName(), GetWindowTitle(), yaze::editor::PanelManager::RegisterEditorPanel(), yaze::editor::EditorManager::RegisterEmulatorPanels(), anonymous_namespace{main.cc}::RegisterLabPanels(), yaze::editor::PanelManager::RegisterPanel(), and yaze::editor::PanelHost::ToDescriptor().

window_title

std::string yaze::editor::PanelDescriptor::window_title

Definition at line 52 of file panel_manager.h.

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

icon

std::string yaze::editor::PanelDescriptor::icon

Definition at line 53 of file panel_manager.h.

Referenced by yaze::editor::anonymous_namespace{panel_manager.cc}::BuildDescriptorFromPanel(), yaze::editor::PanelManager::DrawAllVisiblePanels(), GetImGuiWindowName(), GetWindowTitle(), yaze::editor::EditorManager::RegisterEmulatorPanels(), anonymous_namespace{main.cc}::RegisterLabPanels(), yaze::editor::PanelManager::RegisterPanel(), and yaze::editor::PanelHost::ToDescriptor().

category

std::string yaze::editor::PanelDescriptor::category

Definition at line 54 of file panel_manager.h.

Referenced by yaze::editor::anonymous_namespace{panel_manager.cc}::BuildDescriptorFromPanel(), yaze::editor::PanelManager::DrawAllVisiblePanels(), yaze::editor::EditorManager::RegisterEmulatorPanels(), anonymous_namespace{main.cc}::RegisterLabPanels(), yaze::editor::PanelManager::RegisterPanel(), and yaze::editor::PanelHost::ToDescriptor().

panel_category

PanelCategory yaze::editor::PanelDescriptor::panel_category = PanelCategory::EditorBound

Definition at line 57 of file panel_manager.h.

Referenced by yaze::editor::anonymous_namespace{panel_manager.cc}::BuildDescriptorFromPanel(), yaze::editor::PanelManager::DrawAllVisiblePanels(), yaze::editor::EditorManager::RegisterEmulatorPanels(), and yaze::editor::PanelHost::ToDescriptor().

context_scope

PanelContextScope yaze::editor::PanelDescriptor::context_scope = PanelContextScope::kNone

Definition at line 60 of file panel_manager.h.

Referenced by yaze::editor::PanelManager::ApplyContextPolicy(), yaze::editor::anonymous_namespace{panel_manager.cc}::BuildDescriptorFromPanel(), yaze::editor::EditorManager::RegisterEmulatorPanels(), and yaze::editor::PanelHost::ToDescriptor().

scope

PanelScope yaze::editor::PanelDescriptor::scope = PanelScope::kSession

Definition at line 62 of file panel_manager.h.

Referenced by yaze::editor::anonymous_namespace{panel_manager.cc}::BuildDescriptorFromPanel(), yaze::editor::EditorManager::RegisterEmulatorPanels(), yaze::editor::PanelManager::RegisterPanel(), and yaze::editor::PanelHost::ToDescriptor().

shortcut_hint

std::string yaze::editor::PanelDescriptor::shortcut_hint

Definition at line 68 of file panel_manager.h.

Referenced by yaze::editor::anonymous_namespace{panel_manager.cc}::BuildDescriptorFromPanel(), yaze::editor::EditorManager::RegisterEmulatorPanels(), anonymous_namespace{main.cc}::RegisterLabPanels(), yaze::editor::PanelManager::RegisterPanel(), and yaze::editor::PanelHost::ToDescriptor().

shortcut_scope

ShortcutScope yaze::editor::PanelDescriptor::shortcut_scope = ShortcutScope::kPanel

Definition at line 69 of file panel_manager.h.

visibility_flag

bool* yaze::editor::PanelDescriptor::visibility_flag

Definition at line 70 of file panel_manager.h.

Referenced by yaze::editor::PanelManager::ApplyContextPolicy(), yaze::editor::anonymous_namespace{panel_manager.cc}::BuildDescriptorFromPanel(), yaze::editor::PanelManager::DrawAllVisiblePanels(), yaze::editor::ActivityBar::DrawPanelBrowser(), yaze::editor::ActivityBar::DrawSidePanel(), yaze::editor::EditorManager::RegisterEmulatorPanels(), anonymous_namespace{main.cc}::RegisterLabPanels(), yaze::editor::PanelManager::RegisterPanel(), yaze::editor::PanelManager::RegisterPanel(), and yaze::editor::PanelHost::ToDescriptor().

on_show

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

Definition at line 71 of file panel_manager.h.

Referenced by yaze::editor::EditorManager::RegisterEmulatorPanels(), yaze::editor::PanelManager::RegisterPanel(), and yaze::editor::PanelHost::ToDescriptor().

on_hide

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

Definition at line 72 of file panel_manager.h.

Referenced by yaze::editor::EditorManager::RegisterEmulatorPanels(), yaze::editor::PanelManager::RegisterPanel(), and yaze::editor::PanelHost::ToDescriptor().

priority

int yaze::editor::PanelDescriptor::priority

Definition at line 73 of file panel_manager.h.

Referenced by yaze::editor::anonymous_namespace{panel_manager.cc}::BuildDescriptorFromPanel(), yaze::editor::EditorManager::RegisterEmulatorPanels(), anonymous_namespace{main.cc}::RegisterLabPanels(), yaze::editor::PanelManager::RegisterPanel(), and yaze::editor::PanelHost::ToDescriptor().

enabled_condition

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

Definition at line 76 of file panel_manager.h.

disabled_tooltip

std::string yaze::editor::PanelDescriptor::disabled_tooltip

Definition at line 77 of file panel_manager.h.

Referenced by anonymous_namespace{main.cc}::RegisterLabPanels().

---

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

• src/app/editor/system/panel_manager.h