Window Framework for UI Toolkit v2.0.x
GWG.WindowFramework Namespace Reference

Core WindowFramework controls, controller and configuration/data APIs. Contains WindowFrame, cards/modal presentation, tooltip/context-menu controls, theme data, persistence records and supporting utilities. Managed runtime windows use the UIDocument linked to the configured WindowFrameController. Application content, input arbitration and business data remain consumer-owned. See wfw_installation and wfw_window_lifetime. More...

Namespaces

namespace  Demo
 Demonstration windows, page data, tutorial launchers and appearance extensions. Examples illustrate integration and retain documented sample limitations. They are not production inventory, gameplay hotbar, authentication or input-management systems. See wfw_demo_integration and wfw_demo_bootstrap.
namespace  Editor
 Editor-only theme authoring, inspectors, debugging and preparation tooling. Includes Theme Manager/Studio, source inspection/preservation, file transactions and preparation lifecycle. Editor selection is distinct from runtime configured selection; UnityEditor-dependent tools are not player controls. See wfw_theme_manager and wfw_source_authoring_api.
namespace  Experimental
 Unsupported interaction experiments retained as source examples. Not recommended for production. Click logging, random recoloring and experimental icon reparenting are not validated application actions or inventory-transfer implementations. See wfw_utilities_experimental for known limitations.
namespace  FormElements
 Reusable UI Toolkit settings controls. Contains TooltipSettingsFormElement, ContextMenuSettingsFormElement, ThemeSelectorFormElement and WindowBehaviorSettingsFormElement. UXML registration supports design-time authoring; runtime usage still requires configured controller/theme data and styling. Controls edit preferences/selection, not authored stylesheet palettes. See wfw_settings_forms.
namespace  Manipulators
 Window and content interaction manipulators. Provides dragging, directional resizing, configurable click activation, tooltip and context-menu activation. Each manipulator has specific target, permission and lifecycle requirements; they are not interchangeable on arbitrary visual elements. See wfw_resize_geometry, wfw_tooltips and wfw_context_menus.
namespace  Telemetry
 Optional structured framework diagnostics and interaction observation. Emits diagnostic Unity logs with channel filtering and method-specific compilation guards. It is not a remote analytics/backend service or a universal zero-overhead guarantee. See wfw_diagnostics.
namespace  Tests
namespace  Theming
 Prepared and portable player-theme data, validation and appearance application. Contains configured snapshots, catalog/runtime selection, bounded folder import/export, validation reports, reversible bindings and compiled extension contracts. Player data does not execute loose USS, UXML or code. Borrowed project resources and decoded folder-owned images have distinct lifetimes. See wfw_prepared_theme_workflow, wfw_portable_import_export and wfw_portable_bindings.
namespace  VisualScripting
 Optional preview Visual Scripting units, events and bridge component. Compiled through the dedicated package-constrained assembly when the supported Visual Scripting package is available. Units operate existing configured windows and shipped selection; request outputs do not certify asynchronous completion or business operations. See visual_scripting.

Data Structures

class  CardElement
 A content-sized presentation card with a fixed header/footer and a scrolling body. More...
class  ContextMenuConfig
 Configuration class for a runtime context menu. More...
class  ContextMenuItem
 Used to define the items that will be displayed in the context menu. More...
class  Extensions
 Visual-tree ancestor lookup and sample placeholder construction utilities. More...
class  TooltipStrings
 TooltipStrings is a static class that provides a collection of constant strings. These strings are used as a tooltip for various UI fields and elements within the window framework editor UI. The tooltips provide a shared location for descriptive information to guide users in understanding the purpose of specific fields or actions without having to clutter the code with reused text. More...
class  WindowFrame
 Represents a customizable window frame for UI elements in Unity. Provides functionality for resizing, moving, locking, and saving window state. Includes support for themes, tooltips, and context menus. More...
class  WindowFrameContextMenu
 A sophisticated context menu implementation for the Window Framework that provides dynamic menu creation with fade animations and intelligent positioning. More...
class  WindowFrameController
 The WindowFrameController is the central management component for the Window Framework system. It serves as a singleton that manages window frames, themes, tooltips, context menus, and persistent data. More...
class  WindowFrameData
 Represents the serializable data structure for storing and loading window frame configuration and state information. This class contains all the essential properties needed to persist window settings between application sessions. More...
class  WindowFrameDataEntry
 Represents a KeyValue-value pair entry for window frame data storage, designed for serialization compatibility. More...
class  WindowFrameModalHost
 Owns modal presentation exclusively within one controller's windowing document.
class  WindowFramePositionDrawer
 Editor UI Toolkit nine-position grid for serialized WindowFramePosition values. More...
class  WindowFrameSettingsView
 Represents the settings view for the Window Framework. Provides UI controls for adjusting framework settings such as context menu and tooltip behavior, as well as theme management. This view is designed to be used at runtime and can be extended to suit specific project requirements. More...
class  WindowFrameTheme
 Represents an individual theme definition within the Window Framework. Encapsulates theme metadata, styling stylesheets, and visual preview iconography. More...
class  WindowFrameThemeData
 Represents a theme data asset for configuring and managing window frame themes in the Window Framework system. This class is a ScriptableObject that provides functionality for managing themes, tracking the active theme, and applying changes to the window frame styles. More...
class  WindowFrameThemeList
 Serializable container encapsulating a list of WindowFrameTheme definitions. More...
class  WindowFrameTooltip
 Represents a tooltip element that displays contextual information for UI elements. The tooltip can be styled dynamically based on the current theme and supports fade-in and fade-out animations. More...
class  WindowFrameworkConstants
 Package-level paths, package names, and scripting define symbol constants. Runtime PlayerPrefs keys and framework baseline defaults reside directly on WindowFrameThemeData. More...
class  WindowFrameworkData
 Represents the configuration and runtime data for the Window Framework system, enabling management of UI-related settings such as tooltips, context menus, and theme preferences. More...
class  WindowModal
 Fullscreen blocking surface presenting an ordered queue of content-sized cards. More...
class  WindowTabEntry
 Represents an individual tab entry within a nested tabbed WindowFrame container. More...

Enumerations

enum  GlobalsLoadOrder { First , Last }
 Specifies the load Order for the global stylesheet within the Window Framework. It determines whether the global stylesheet is applied before or after theme-specific stylesheets. More...
enum  ThemeApplyMethods { WindowsFramesOnly , ParentPanel , AllPanels }
 Specifies the method used to apply themes within the window framework system. Determines the level or scope of the theme application, allowing themes to be applied selectively to window frames, parent panels, or all available panels. More...
enum  TooltipFadeType { FadeOut , FadeIn , FadeInAndOut , None }
 Defines the fade animation behavior for tooltips. More...
enum  WindowDockState {
  Floating , LeftHalf , RightHalf , TopHalf ,
  BottomHalf , Maximized
}
 Enumeration defining screen dock states for a window frame (split-screen and maximized pinning). More...
enum  WindowFramePosition {
  TopLeft , Top , TopRight , Left ,
  Center , Right , BottomLeft , Bottom ,
  BottomRight
}
 Enumeration defining predefined positioning options for window frames within the screen space. More...

Detailed Description

Core WindowFramework controls, controller and configuration/data APIs. Contains WindowFrame, cards/modal presentation, tooltip/context-menu controls, theme data, persistence records and supporting utilities. Managed runtime windows use the UIDocument linked to the configured WindowFrameController. Application content, input arbitration and business data remain consumer-owned. See wfw_installation and wfw_window_lifetime.

< Primary Namespace for the Window Framework Asset

Enumeration Type Documentation

◆ GlobalsLoadOrder

Specifies the load Order for the global stylesheet within the Window Framework. It determines whether the global stylesheet is applied before or after theme-specific stylesheets.

This enumeration controls the CSS cascade Order, which affects how styles are applied and resolved:

  • First: Global styles are applied first, then theme styles (theme styles take precedence)
  • Last: Theme styles are applied first, then global styles (global styles take precedence)
// Set global styles to load last (highest specificity)
windowFrameController.GlobalsLoadOrder = GlobalsLoadOrder.Last;
GlobalsLoadOrder
Specifies the load Order for the global stylesheet within the Window Framework. It determines whether...
Definition WindowFrameController.cs:28
Enumerator
First 

Global stylesheet loads first in the cascade Order. Theme stylesheets will override global styles where there are conflicts.

Last 

Global stylesheet loads last in the cascade Order. Global styles will override theme stylesheets where there are conflicts.

◆ ThemeApplyMethods

Specifies the method used to apply themes within the window framework system. Determines the level or scope of the theme application, allowing themes to be applied selectively to window frames, parent panels, or all available panels.

This enumeration provides flexibility in theme application, allowing developers to control exactly which UI elements receive theme styling. The different application methods enable fine-grained control over the visual consistency and performance of theme changes.

Performance Considerations:
Different application methods have varying performance implications:

  • WindowsFramesOnly - Most efficient, affects only window frames
  • ParentPanel - Moderate performance impact, affects the main UI document panel
  • AllPanels - Highest performance cost, affects all panels in the scene
// Apply theme only to window frames for best performance
themeData.ThemeApplyMethod = ThemeApplyMethods.WindowsFramesOnly;
// Apply theme to parent panel for broader styling
themeData.ThemeApplyMethod = ThemeApplyMethods.ParentPanel;
// Apply theme to all panels for complete visual consistency
themeData.ThemeApplyMethod = ThemeApplyMethods.AllPanels;
// Dynamic selection based on performance requirements
if (QualitySettings.GetQualityLevel() >= 3)
{
themeData.ThemeApplyMethod = ThemeApplyMethods.AllPanels;
}
else
{
themeData.ThemeApplyMethod = ThemeApplyMethods.WindowsFramesOnly;
}
ThemeApplyMethods
Specifies the method used to apply themes within the window framework system. Determines the level or...
Definition WindowFrameThemeData.cs:67
  • WindowsFramesOnly - Applies the theme to all window frames in the scene.
  • ParentPanel - Applies the theme to the panel of the Ui Document used by the framework.
  • AllPanels - Applies the theme to all UI panels in the scene.
Enumerator
WindowsFramesOnly 

Applies the theme to all window frames in the scene.

ParentPanel 

Apples the theme to the panel used by the UI document assigned to the Window Frame Controller

AllPanels 

Applies the theme to all panel in the scene

◆ TooltipFadeType

Defines the fade animation behavior for tooltips.

This enumeration controls how tooltips appear and disappear, allowing for different visual effects based on user preferences and UI design requirements. The fade behavior affects both the appearance timing and visual smoothness of tooltip transitions.

// Configure tooltip fade behavior
WindowFrameController.Instance.TooltipFadeType = TooltipFadeType.FadeInAndOut;
// Different fade types provide different user experiences:
// FadeOut: Instant appearance, smooth disappearance
// FadeIn: Smooth appearance, instant disappearance
// FadeInAndOut: Smooth both directions
// None: Instant appearance and disappearance
TooltipFadeType
Defines the fade animation behavior for tooltips.
Definition WindowFrameTooltip.cs:30
Enumerator
FadeOut 

Tooltip appears instantly and fades out when hidden. Provides immediate information display with graceful dismissal.

FadeIn 

Tooltip fades in when shown and disappears instantly when hidden. Provides smooth appearance with immediate dismissal.

FadeInAndOut 

Tooltip fades in when shown and fades out when hidden. Provides the smoothest visual experience with gradual transitions.

None 

Tooltip appears and disappears instantly without any fade animation. Provides immediate feedback with no transition delays.

◆ WindowDockState

Enumeration defining screen dock states for a window frame (split-screen and maximized pinning).

Enumerator
Floating 

Window is free-floating and not docked to any screen edge.

LeftHalf 

Window is docked to the left half of the screen.

RightHalf 

Window is docked to the right half of the screen.

TopHalf 

Window is docked to the top half of the screen.

BottomHalf 

Window is docked to the bottom half of the screen.

Maximized 

Window is maximized to fill the entire screen.

◆ WindowFramePosition

Enumeration defining predefined positioning options for window frames within the screen space.

This enumeration provides standardized window positioning options that cover common placement scenarios. Positions are calculated relative to screen dimensions and window size for consistent behavior.

// Position window in center of screen
myWindow.StartPosition = WindowFramePosition.Center;
// Position in top-right corner
myWindow.StartPosition = WindowFramePosition.TopRight;
WindowFramePosition
Enumeration defining predefined positioning options for window frames within the screen space.
Definition WindowFrame.cs:32
Enumerator
TopLeft 

Specifies that the window frame should be positioned at the top-left corner of the screen.

The TopLeft position places the window's top-left corner flush with the top and left edges of the screen. This is typically used to align a window in the uppermost corner of the display space.

Top 

Specifies that the window frame should be positioned at the top center of the screen.

The Top position places the window's top edge centrally aligned with the horizontal middle of the screen. This is often used to position a window prominently along the upper section of the display space.

TopRight 

Specifies that the window frame should be positioned at the top-right corner of the screen.

The TopRight position aligns the window's top-right corner with the top and right edges of the display screen. This is commonly used to position a window in the uppermost corner on the right side of the screen.

Left 

Specifies that the window frame should be positioned along the left edge of the screen.

The Left position aligns the window's vertical center with the screen's vertical midpoint, placing it flush against the left edge of the screen. This is typically used to anchor windows for workflows that prioritize left-aligned layouts.

Center 

Specifies that the window frame should be positioned at the center of the screen.

The Center position places the window's frame equidistant from all edges of the screen, aligning its center point with the screen's center point. This is often used to make the window prominent and centrally located.

Right 

Specifies that the window frame should be positioned at the right side of the screen.

The Right position ensures the window is aligned flush with the right edge of the screen, maintaining vertical positioning based on the window's height. This setting is commonly used to anchor a window along the right-hand side of the display space.

BottomLeft 

Specifies that the window frame should be positioned at the bottom-left corner of the screen.

The BottomLeft position places the window's bottom-left corner flush with the bottom and left edges of the screen. This is typically used to align a window in the lower-left corner of the display space.

Bottom 

Specifies that the window frame should be positioned at the bottom-center of the screen.

The Bottom position aligns the window's bottom edge with the bottom-center of the display space. This is often used to position a window symmetrically along the lower boundary of the screen.

BottomRight 

Specifies that the window frame should be positioned at the bottom-right corner of the screen.

The BottomRight position aligns the window's bottom-right corner flush with the bottom and right edges of the screen. It is commonly used to place a window in the lowermost corner of the display area.