|
Window Framework for UI Toolkit v2.0.x
|
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... | |
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
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:
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:
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.
Enumeration defining screen dock states for a window frame (split-screen and maximized pinning).
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.