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.

Public Attributes
std::string	card_id
std::string	display_name
std::string	window_title
std::string	icon
std::string	category
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 44 of file panel_manager.h.

Member Enumeration Documentation

ShortcutScope

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

strong

Enumerator
kGlobal
kEditor
kPanel

Definition at line 50 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 70 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(), yaze::editor::LayoutManager::BuildLayoutFromPreset(), yaze::editor::LayoutManager::GetWindowTitle(), yaze::editor::LayoutOrchestrator::GetWindowTitle(), and yaze::editor::PanelManager::ValidatePanel().

Member Data Documentation

card_id

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

Definition at line 45 of file panel_manager.h.

Referenced by yaze::editor::PanelManager::RegisterEditorPanel(), yaze::editor::PanelManager::RegisterPanel(), and yaze::editor::PanelManager::RegisterPanel().

display_name

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

Definition at line 46 of file panel_manager.h.

Referenced by yaze::editor::ActivityBar::DrawPanelBrowser(), GetWindowTitle(), yaze::editor::PanelManager::RegisterEditorPanel(), and yaze::editor::PanelManager::RegisterPanel().

window_title

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

Definition at line 47 of file panel_manager.h.

Referenced by GetWindowTitle(), and yaze::editor::PanelManager::RegisterEditorPanel().

icon

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

Definition at line 48 of file panel_manager.h.

Referenced by GetWindowTitle(), yaze::editor::PanelManager::RegisterEditorPanel(), and yaze::editor::PanelManager::RegisterPanel().

category

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

Definition at line 49 of file panel_manager.h.

Referenced by yaze::editor::PanelManager::RegisterEditorPanel(), and yaze::editor::PanelManager::RegisterPanel().

shortcut_hint

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

Definition at line 55 of file panel_manager.h.

Referenced by yaze::editor::PanelManager::RegisterEditorPanel(), and yaze::editor::PanelManager::RegisterPanel().

shortcut_scope

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

Definition at line 56 of file panel_manager.h.

visibility_flag

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

Definition at line 57 of file panel_manager.h.

Referenced by yaze::editor::ActivityBar::DrawSidePanel(), yaze::editor::PanelManager::RegisterEditorPanel(), yaze::editor::PanelManager::RegisterPanel(), and yaze::editor::PanelManager::RegisterPanel().

on_show

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

Definition at line 58 of file panel_manager.h.

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

on_hide

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

Definition at line 59 of file panel_manager.h.

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

priority

int yaze::editor::PanelDescriptor::priority

Definition at line 60 of file panel_manager.h.

Referenced by yaze::editor::PanelManager::RegisterEditorPanel(), and yaze::editor::PanelManager::RegisterPanel().

enabled_condition

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

Definition at line 63 of file panel_manager.h.

disabled_tooltip

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

Definition at line 64 of file panel_manager.h.

---

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

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