|
Window Framework for UI Toolkit v2.0.x
|
Application-owned registry of compiled portable theme extension handlers. More...
Data Structures | |
| class | Lease |
Public Member Functions | |
| void | Register (IPlayerThemeExtension handler) |
| Registers a compiled handler with a unique bounded dotted namespace. | |
| bool | TryApply (VisualElement scope, PlayerThemeManifest manifest, out IDisposable lease, out string error) |
| Prevalidates all sections, applies in stable order and rolls back leases on failure. | |
| bool | TryApplyWithAssets (VisualElement scope, PlayerThemeFolder folder, out IDisposable lease, out string error) |
| Applies compiled extensions with validated folder resources, without overloading the data-only manifest API. | |
| bool | TrySnapshot (VisualElement scope, PlayerThemeManifest original, Func< string, string, UnityEngine.Texture2D, string > writeImage, out string extensionsJson, out string error) |
| Snapshots extension data and declared raster assets through a framework staging writer. | |
| bool | TrySnapshot (VisualElement scope, PlayerThemeManifest original, out string extensionsJson, out string error) |
| Exports registered effective values while retaining every unknown namespace. | |
| bool | Validate (PlayerThemeManifest manifest, out string error) |
| Validates all registered sections without applying any changes. | |
Private Member Functions | |
| bool | TryApplyCore (VisualElement scope, PlayerThemeManifest manifest, PlayerThemeFolder folder, out IDisposable lease, out string error) |
| bool | TrySections (PlayerThemeManifest manifest, out GWG.WindowFramework.Theming.Json.JsonObject sections, out string error) |
| bool | TrySnapshotCore (VisualElement scope, PlayerThemeManifest original, Func< string, string, UnityEngine.Texture2D, string > writeImage, out string extensionsJson, out string error) |
Static Private Member Functions | |
| static string | Diagnostic (Exception exception) |
Private Attributes | |
| readonly SortedDictionary< string, IPlayerThemeExtension > | _handlers = new SortedDictionary<string, IPlayerThemeExtension>(StringComparer.Ordinal) |
Application-owned registry of compiled portable theme extension handlers.
Never resolves type names from player data. Unknown namespaces are ignored for application and retained during export. Register before importing/applying themes; keep this registry alive as long as its leases. Data-only handlers remain unchanged. Optional IPlayerThemeAssetExtension handlers declare logical raster keys; load with registry-aware folder discovery and apply using the folder overload. Never open unvalidated paths in a handler.
|
inlinestaticprivate |

|
inline |
Registers a compiled handler with a unique bounded dotted namespace.
| ArgumentException | Namespace is invalid or already registered. |
| ArgumentNullException | Handler is null. |
|
inline |
Prevalidates all sections, applies in stable order and rolls back leases on failure.
| scope | Explicit purchaser UI subtree. |
| manifest | Validated manifest. |
| lease | Non-null reversible aggregate lease on success. |
| error | Bounded failure diagnostic. |
Handlers throwing during Apply must undo their own partial mutations. Previously completed handlers are released in reverse order; release failures are reported.

|
inlineprivate |


|
inline |
Applies compiled extensions with validated folder resources, without overloading the data-only manifest API.
| scope | Explicit purchaser subtree. |
| folder | Live validated resource owner. |
| lease | Reversible borrowed-resource UI lease; release before folder disposal. |
| error | Bounded failure. |
Use for image-capable handlers. A distinct name keeps existing TryApply(scope, null, ...) calls unambiguous.

|
inlineprivate |


|
inline |
Snapshots extension data and declared raster assets through a framework staging writer.
| scope | Purchaser subtree. |
| original | Source metadata or null. |
| writeImage | Synchronous namespace/key/texture writer returning relative paths. |
| extensionsJson | Merged bounded JSON. |
| error | Failure diagnostic. |
Intended for transactional exporters, not arbitrary player-controlled writers. Unknown sections remain data only.

|
inline |
Exports registered effective values while retaining every unknown namespace.
| scope | Purchaser scope whose effective defaults are exported. |
| original | Source manifest, or null for a built-in theme. |
| extensionsJson | Merged standard object JSON on success. |
| error | Validation failure. |
Unregistered sections are preserved semantically, not byte-for-byte formatting. Nothing returned here is applied automatically or executed.


|
inlineprivate |


|
inline |
Validates all registered sections without applying any changes.
| manifest | Already structurally validated framework manifest. |
| error | Bounded failure diagnostic. |

|
private |