yaze::editor::WindowPresentationPolicy Struct Reference

#include <editor_panel.h>

Public Member Functions
bool	IsAdmitted () const
WindowPresentationPolicy	WithHost (std::string host_name) const
	Returns a copy that names the hosting surface.

Static Public Member Functions
static WindowPresentationPolicy	CoreWorkspace ()
static WindowPresentationPolicy	EmbeddedTool (std::string capability=std::string())
static WindowPresentationPolicy	OptionalPopOut ()
static WindowPresentationPolicy	Diagnostic ()

Public Attributes
WindowPresentationRole	role = WindowPresentationRole::kOptionalPopOut
WindowDefaultHost	default_host = WindowDefaultHost::kWorkspace
bool	list_in_window_browser = true
bool	allow_popout = true
std::string	required_capability
std::function< bool()>	capability_condition
bool	declared = false
std::string	host

Detailed Description

Definition at line 102 of file editor_panel.h.

Member Function Documentation

IsAdmitted()

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

inline

Definition at line 122 of file editor_panel.h.

References capability_condition.

Referenced by yaze::editor::WindowDescriptor::IsAdmitted().

WithHost()

WindowPresentationPolicy yaze::editor::WindowPresentationPolicy::WithHost ( std::string host_name ) const

inline

Returns a copy that names the hosting surface.

Definition at line 127 of file editor_panel.h.

References host.

Referenced by yaze::editor::AgentMesenDebugPanel::GetPresentationPolicy(), yaze::editor::OracleStateLibraryEditorPanel::GetPresentationPolicy(), yaze::editor::FeatureFlagEditorEditorPanel::GetPresentationPolicy(), yaze::editor::ManifestEditorPanel::GetPresentationPolicy(), yaze::editor::SramViewerEditorPanel::GetPresentationPolicy(), yaze::editor::MesenScreenshotEditorPanel::GetPresentationPolicy(), yaze::editor::GraphicsPrototypeViewerPanel::GetPresentationPolicy(), yaze::editor::MenuTilemapPanel::GetPresentationPolicy(), yaze::editor::NamingScreenPanel::GetPresentationPolicy(), yaze::editor::OracleMenuInspectorPanel::GetPresentationPolicy(), yaze::editor::OracleValidationPanel::GetPresentationPolicy(), yaze::editor::DungeonEditorV2::Load(), yaze::editor::EditorManager::RegisterEmulatorPanels(), and yaze::editor::anonymous_namespace{dungeon_editor_v2.cc}::WorkbenchTool().

CoreWorkspace()

static WindowPresentationPolicy yaze::editor::WindowPresentationPolicy::CoreWorkspace ( )

inlinestatic

Definition at line 133 of file editor_panel.h.

References yaze::editor::kCoreWorkspace, and role.

Referenced by yaze::editor::AgentChatPanel::GetPresentationPolicy(), yaze::editor::AssemblyCodeEditorPanel::GetPresentationPolicy(), yaze::editor::GraphicsPixelEditorPanel::GetPresentationPolicy(), yaze::editor::MessageEditorPanel::GetPresentationPolicy(), yaze::editor::MusicPianoRollPanel::GetPresentationPolicy(), yaze::editor::PaletteControlPanel::GetPresentationPolicy(), yaze::editor::VanillaSpriteEditorPanel::GetPresentationPolicy(), yaze::editor::DungeonEditorV2::Initialize(), yaze::editor::PaletteEditor::Initialize(), yaze::editor::EditorManager::RegisterEditors(), and yaze::editor::EditorManager::RegisterEmulatorPanels().

EmbeddedTool()

static WindowPresentationPolicy yaze::editor::WindowPresentationPolicy::EmbeddedTool ( std::string capability = std::string() )

inlinestatic

Definition at line 137 of file editor_panel.h.

References yaze::editor::kEmbedded, yaze::editor::kEmbeddedTool, and role.

Referenced by yaze::editor::MenuTilemapPanel::GetPresentationPolicy(), and yaze::editor::anonymous_namespace{dungeon_editor_v2.cc}::WorkbenchTool().

OptionalPopOut()

static WindowPresentationPolicy yaze::editor::WindowPresentationPolicy::OptionalPopOut ( )

inlinestatic

Definition at line 149 of file editor_panel.h.

References yaze::editor::kOptionalPopOut, and role.

Referenced by yaze::editor::OracleRamPanel::GetPresentationPolicy(), yaze::editor::AgentConfigurationPanel::GetPresentationPolicy(), yaze::editor::AgentStatusPanel::GetPresentationPolicy(), yaze::editor::AgentPromptEditorPanel::GetPresentationPolicy(), yaze::editor::AgentBotProfilesPanel::GetPresentationPolicy(), yaze::editor::AgentBuilderPanel::GetPresentationPolicy(), yaze::editor::AgentKnowledgeBasePanel::GetPresentationPolicy(), yaze::editor::AssemblyFileBrowserPanel::GetPresentationPolicy(), yaze::editor::AssemblySymbolsPanel::GetPresentationPolicy(), yaze::editor::AssemblyBuildOutputPanel::GetPresentationPolicy(), yaze::editor::AssemblyDisassemblyPanel::GetPresentationPolicy(), yaze::editor::AssemblyToolbarPanel::GetPresentationPolicy(), yaze::editor::CutsceneCameraPanel::GetPresentationPolicy(), yaze::editor::GraphicsSheetBrowserPanel::GetPresentationPolicy(), yaze::editor::GraphicsPaletteControlsPanel::GetPresentationPolicy(), yaze::editor::GraphicsLinkSpritePanel::GetPresentationPolicy(), yaze::editor::GraphicsPolyhedralPanel::GetPresentationPolicy(), yaze::editor::GraphicsGfxGroupPanel::GetPresentationPolicy(), yaze::editor::GraphicsPalettesetPanel::GetPresentationPolicy(), yaze::editor::GraphicsUsagePreviewPanel::GetPresentationPolicy(), yaze::editor::DungeonMapsPanel::GetPresentationPolicy(), yaze::editor::InventoryMenuPanel::GetPresentationPolicy(), yaze::editor::OverworldMapScreenPanel::GetPresentationPolicy(), yaze::editor::TitleScreenPanel::GetPresentationPolicy(), yaze::editor::workflow::ProjectWorkflowOutputPanel::GetPresentationPolicy(), yaze::editor::layout_designer::LayoutDesignerPanel::GetPresentationPolicy(), yaze::editor::MessageListPanel::GetPresentationPolicy(), yaze::editor::FontAtlasPanel::GetPresentationPolicy(), yaze::editor::DictionaryPanel::GetPresentationPolicy(), yaze::editor::MusicAssemblyPanel::GetPresentationPolicy(), yaze::editor::MusicInstrumentEditorPanel::GetPresentationPolicy(), yaze::editor::MusicPlaybackControlPanel::GetPresentationPolicy(), yaze::editor::MusicSampleEditorPanel::GetPresentationPolicy(), yaze::editor::MusicSongBrowserPanel::GetPresentationPolicy(), yaze::editor::AnnotationOverlayPanel::GetPresentationPolicy(), yaze::editor::ProgressionDashboardPanel::GetPresentationPolicy(), yaze::editor::StoryEventGraphPanel::GetPresentationPolicy(), yaze::editor::QuickAccessPalettePanel::GetPresentationPolicy(), yaze::editor::CustomPalettePanel::GetPresentationPolicy(), yaze::editor::PaletteGroupPanel::GetPresentationPolicy(), yaze::editor::AboutPanel::GetPresentationPolicy(), yaze::editor::SpriteCatalogPanel::GetPresentationPolicy(), yaze::editor::CustomSpriteEditorPanel::GetPresentationPolicy(), yaze::editor::ResourceWindowContent::GetPresentationPolicy(), yaze::editor::DungeonEditorV2::Initialize(), yaze::editor::PaletteEditor::Initialize(), yaze::editor::DungeonEditorV2::OnRoomSelected(), yaze::editor::MusicEditor::OpenSong(), yaze::editor::MusicEditor::OpenSongPianoRoll(), yaze::editor::DungeonEditorV2::ProcessPendingSwap(), yaze::editor::EditorManager::RegisterEmulatorPanels(), and yaze::editor::WorkspaceWindowManager::RegisterWindowContent().

Diagnostic()

static WindowPresentationPolicy yaze::editor::WindowPresentationPolicy::Diagnostic ( )

inlinestatic

Definition at line 153 of file editor_panel.h.

References yaze::editor::kDiagnostic, yaze::editor::kEmbedded, and role.

Referenced by yaze::editor::AgentMesenDebugPanel::GetPresentationPolicy(), yaze::editor::OracleStateLibraryEditorPanel::GetPresentationPolicy(), yaze::editor::FeatureFlagEditorEditorPanel::GetPresentationPolicy(), yaze::editor::ManifestEditorPanel::GetPresentationPolicy(), yaze::editor::SramViewerEditorPanel::GetPresentationPolicy(), yaze::editor::MesenScreenshotEditorPanel::GetPresentationPolicy(), yaze::editor::GraphicsPrototypeViewerPanel::GetPresentationPolicy(), yaze::editor::NamingScreenPanel::GetPresentationPolicy(), yaze::editor::OracleMenuInspectorPanel::GetPresentationPolicy(), yaze::editor::OracleValidationPanel::GetPresentationPolicy(), yaze::editor::DungeonEditorV2::Load(), and yaze::editor::EditorManager::RegisterEmulatorPanels().

Member Data Documentation

role

WindowPresentationRole yaze::editor::WindowPresentationPolicy::role = WindowPresentationRole::kOptionalPopOut

Definition at line 103 of file editor_panel.h.

Referenced by yaze::editor::AuditPanelAdmission(), CoreWorkspace(), Diagnostic(), EmbeddedTool(), and OptionalPopOut().

default_host

WindowDefaultHost yaze::editor::WindowPresentationPolicy::default_host = WindowDefaultHost::kWorkspace

Definition at line 104 of file editor_panel.h.

list_in_window_browser

bool yaze::editor::WindowPresentationPolicy::list_in_window_browser = true

Definition at line 105 of file editor_panel.h.

Referenced by yaze::editor::WindowDescriptor::IsListedInWindowBrowser().

allow_popout

bool yaze::editor::WindowPresentationPolicy::allow_popout = true

Definition at line 106 of file editor_panel.h.

required_capability

std::string yaze::editor::WindowPresentationPolicy::required_capability

Definition at line 107 of file editor_panel.h.

capability_condition

std::function<bool()> yaze::editor::WindowPresentationPolicy::capability_condition

Definition at line 108 of file editor_panel.h.

Referenced by IsAdmitted().

declared

bool yaze::editor::WindowPresentationPolicy::declared = false

True only when a panel author chose a role on purpose. The named factory functions below set it; a default-constructed policy keeps the historical listed pop-out behavior but is reported by the panel admission audit (see panel_admission.h), which fails the unit tests.

Definition at line 114 of file editor_panel.h.

Referenced by yaze::editor::AuditPanelAdmission(), and yaze::editor::WorkspaceWindowManager::RegisterWindowContent().

host

std::string yaze::editor::WindowPresentationPolicy::host

The surface that hosts this content or triggers it, in a few words (for example "Dungeon Workbench inspector" or "Command palette"). Required for kEmbeddedTool and kDiagnostic so every demoted window names where users find it instead.

Definition at line 120 of file editor_panel.h.

Referenced by yaze::editor::AuditPanelAdmission(), and WithHost().

---

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

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