Window Framework for UI Toolkit v2.0.x
GWG.WindowFramework.Theming.PreparedThemeSnapshot Class Referencesealed

Build-prepared supported values embedded in the existing theme configuration. More...

Data Structures

class  Entry
 One serialized derived catalog value; validation is deferred to TryGetValues. More...

Public Member Functions

 PreparedThemeSnapshot (ThemeStyleSheet source, string fingerprint, List< Entry > entries, string report)
 Creates preparation output without modifying source stylesheets.
void SetCopyLimitations (string report)
 Records a bounded plain-text preparation scope disclosure, without modifying source.
void SetDeveloperDefinitions (IEnumerable< DeveloperThemeDefinition > definitions)
 Retains validated detached definitions from the configured stylesheet graph.
void SetPreparedFont (string id, Font font)
 Records a font resolved from the authoritative source during editor preparation.
bool TryGetValues (ThemeStyleSheet source, out PlayerThemeValues values, out string error)
 Validates and materializes a complete supported snapshotfor the matching source.

Properties

string CopyLimitations [get]
 Gets the source features not serialized by portable Copy; does not imply visual parity.
IReadOnlyList< DeveloperThemeDefinition > DeveloperDefinitions [get]
 Derived developer metadata and consumers, not another authored settings asset.
string Fingerprint [get]
 Gets dependency fingerprint recorded during editor preparation.
Font Font [get]
 Gets the borrowed configured font reference; null denotes inherited panel font.
string FontId [get]
 Gets the build-prepared shipped font identifier; absent on older snapshots.
string Report [get]
 Gets bounded preparation failure explanation, empty on success.

Static Private Member Functions

static void ValidateDeveloperDefinitions (List< DeveloperThemeDefinition > definitions)

Private Attributes

string _copyLimitations
List< DeveloperThemeDefinition > _developerDefinitions = new List<DeveloperThemeDefinition>()
List< Entry > _entries = new List<Entry>()
string _fingerprint
Font _font
string _fontId
string _report
ThemeStyleSheet _source

Detailed Description

Build-prepared supported values embedded in the existing theme configuration.

Not an independently shipped asset or a second palette authority. Editor preparation derives these entries from referenced stylesheet inputs. References retain Unity GUID relocation semantics. Runtime does not parse USS, access AssetDatabase or own referenced textures.

Constructor & Destructor Documentation

◆ PreparedThemeSnapshot()

GWG.WindowFramework.Theming.PreparedThemeSnapshot.PreparedThemeSnapshot ( ThemeStyleSheet source,
string fingerprint,
List< Entry > entries,
string report )
inline

Creates preparation output without modifying source stylesheets.

Parameters
sourceAuthoritative referenced stylesheet.
fingerprintEditor dependency fingerprint.
entriesDerived values; no fallback palette.
reportPreparation issues that must block complete copy.
Here is the call graph for this function:
Here is the caller graph for this function:

Member Function Documentation

◆ SetCopyLimitations()

void GWG.WindowFramework.Theming.PreparedThemeSnapshot.SetCopyLimitations ( string report)
inline

Records a bounded plain-text preparation scope disclosure, without modifying source.

Parameters
reportUnsupported selector/layout/import scope explanation.

◆ SetDeveloperDefinitions()

void GWG.WindowFramework.Theming.PreparedThemeSnapshot.SetDeveloperDefinitions ( IEnumerable< DeveloperThemeDefinition > definitions)
inline

Retains validated detached definitions from the configured stylesheet graph.

Optional labels/descriptions are retained for deferred editor work, never added to player JSON. Callers must not mutate these records; all authored defaults remain in source USS.

Here is the call graph for this function:

◆ SetPreparedFont()

void GWG.WindowFramework.Theming.PreparedThemeSnapshot.SetPreparedFont ( string id,
Font font )
inline

Records a font resolved from the authoritative source during editor preparation.

Parameters
idStable asset-derived identifier, or panel-default for inherited fonts.
fontTrusted build-referenced font; never a player file.

◆ TryGetValues()

bool GWG.WindowFramework.Theming.PreparedThemeSnapshot.TryGetValues ( ThemeStyleSheet source,
out PlayerThemeValues values,
out string error )
inline

Validates and materializes a complete supported snapshotfor the matching source.

Parameters
sourceCurrent theme stylesheet reference.
valuesComplete detached value model on success; null on failure.
errorActionable preparation/schema failure.
Returns
True only for a matching, issue-free, complete catalog.

Editor/build tooling must refresh fingerprints when dependencies change. Runtime cannot compute a source fingerprint. This validates stored types, ranges and source identity.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ValidateDeveloperDefinitions()

void GWG.WindowFramework.Theming.PreparedThemeSnapshot.ValidateDeveloperDefinitions ( List< DeveloperThemeDefinition > definitions)
inlinestaticprivate
Here is the caller graph for this function:

Field Documentation

◆ _copyLimitations

string GWG.WindowFramework.Theming.PreparedThemeSnapshot._copyLimitations
private

◆ _developerDefinitions

List<DeveloperThemeDefinition> GWG.WindowFramework.Theming.PreparedThemeSnapshot._developerDefinitions = new List<DeveloperThemeDefinition>()
private

◆ _entries

List<Entry> GWG.WindowFramework.Theming.PreparedThemeSnapshot._entries = new List<Entry>()
private

◆ _fingerprint

string GWG.WindowFramework.Theming.PreparedThemeSnapshot._fingerprint
private

◆ _font

Font GWG.WindowFramework.Theming.PreparedThemeSnapshot._font
private

◆ _fontId

string GWG.WindowFramework.Theming.PreparedThemeSnapshot._fontId
private

◆ _report

string GWG.WindowFramework.Theming.PreparedThemeSnapshot._report
private

◆ _source

ThemeStyleSheet GWG.WindowFramework.Theming.PreparedThemeSnapshot._source
private

Property Documentation

◆ CopyLimitations

string GWG.WindowFramework.Theming.PreparedThemeSnapshot.CopyLimitations
get

Gets the source features not serialized by portable Copy; does not imply visual parity.

◆ DeveloperDefinitions

IReadOnlyList<DeveloperThemeDefinition> GWG.WindowFramework.Theming.PreparedThemeSnapshot.DeveloperDefinitions
get

Derived developer metadata and consumers, not another authored settings asset.

◆ Fingerprint

string GWG.WindowFramework.Theming.PreparedThemeSnapshot.Fingerprint
get

Gets dependency fingerprint recorded during editor preparation.

◆ Font

Font GWG.WindowFramework.Theming.PreparedThemeSnapshot.Font
get

Gets the borrowed configured font reference; null denotes inherited panel font.

◆ FontId

string GWG.WindowFramework.Theming.PreparedThemeSnapshot.FontId
get

Gets the build-prepared shipped font identifier; absent on older snapshots.

◆ Report

string GWG.WindowFramework.Theming.PreparedThemeSnapshot.Report
get

Gets bounded preparation failure explanation, empty on success.