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

Validated data-only portable manifest with preserved purchaser extension sections. More...

Public Member Functions

GWG.WindowFramework.Theming.Json.JsonObject GetExtensionData ()
 Returns a copy of extension data; callers cannot mutate the retained manifest.
GWG.WindowFramework.Theming.Json.JsonObject GetExtensions ()
 Returns independently owned extension data without an external JSON package.
string ToJson ()
 Serializes the retained validated data, preserving unknown extension sections.

Static Public Member Functions

static bool TryParse (string json, out PlayerThemeManifest manifest, out string error)
 Parses and validates a bounded manifest without touching disk assets.

Static Public Attributes

const int MaximumBytes = 262144
 Maximum UTF-8 manifest size.

Properties

string Description [get, private set]
 Gets bounded description.
string FontId [get, private set]
 Optional shipped font identifier; resolved only against configured prepared themes.
string Id [get, private set]
 Gets validated stable player ID.
IReadOnlyDictionary< string, string > ImagePaths [get]
 Gets validated relative image references keyed by canonical token.
IReadOnlyList< string > Issues [get]
 Gets recoverable field errors; omitted overrides inherit the configured default.
string Name [get, private set]
 Gets bounded plain-text display name.
bool UsesFolderName [get, private set]
 Whether display name follows the folder rather than legacy manifest metadata.
PlayerThemeValues Values = new PlayerThemeValues() [get]
 Gets resolved explicit colour/number overrides; omitted keys remain absent.

Static Private Member Functions

static string QuoteInput (string text)
 Quotes only bounded player-supplied text; path/control redaction still applies.
static string Text (GWG.WindowFramework.Theming.Json.JsonNode token, string key, int maximum, bool required)

Private Attributes

readonly Dictionary< string, string > _imagePaths = new Dictionary<string, string>(StringComparer.Ordinal)
readonly List< string > _issues = new List<string>()
GWG.WindowFramework.Theming.Json.JsonObject _source

Detailed Description

Validated data-only portable manifest with preserved purchaser extension sections.

No polymorphic deserialization, reflection, code or URLs are executed. Extension sections are preserved as bounded JSON but are not applied without compiled handlers. Image paths here are only relative-path syntax checked; filesystem containment and link checks are still required by the importer before opening any file.

Member Function Documentation

◆ GetExtensionData()

GWG.WindowFramework.Theming.Json.JsonObject GWG.WindowFramework.Theming.PlayerThemeManifest.GetExtensionData ( )
inline

Returns a copy of extension data; callers cannot mutate the retained manifest.

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

◆ GetExtensions()

GWG.WindowFramework.Theming.Json.JsonObject GWG.WindowFramework.Theming.PlayerThemeManifest.GetExtensions ( )
inline

Returns independently owned extension data without an external JSON package.

Returns
A framework-owned object tree; mutations do not change the retained manifest.

Explicitly typed callers must use GWG.WindowFramework.Theming.Json.JsonObject. The return type changes to remove the external serializer requirement; var callers and the method name remain usable. Existing saved JSON and compiled string-based extension contracts are unchanged.

Here is the call graph for this function:

◆ QuoteInput()

string GWG.WindowFramework.Theming.PlayerThemeManifest.QuoteInput ( string text)
inlinestaticprivate

Quotes only bounded player-supplied text; path/control redaction still applies.

Do not pass runtime exceptions or internal paths. This is a search hint, not executable markup.

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

◆ Text()

string GWG.WindowFramework.Theming.PlayerThemeManifest.Text ( GWG.WindowFramework.Theming.Json.JsonNode token,
string key,
int maximum,
bool required )
inlinestaticprivate
Here is the caller graph for this function:

◆ ToJson()

string GWG.WindowFramework.Theming.PlayerThemeManifest.ToJson ( )
inline

Serializes the retained validated data, preserving unknown extension sections.

Returns
Standard JSON without comments.
Here is the call graph for this function:

◆ TryParse()

bool GWG.WindowFramework.Theming.PlayerThemeManifest.TryParse ( string json,
out PlayerThemeManifest manifest,
out string error )
inlinestatic

Parses and validates a bounded manifest without touching disk assets.

Parameters
jsonUTF-8-compatible JSON text.
manifestValidated result or null.
errorBounded validation message identifying the failing key.
Returns
True when structural schema is safe, including omitted invalid supported field overrides recorded in Issues. Inspect Issues separately; unknown framework keys/groups or unsafe paths reject the manifest. This operation does not decode images or apply a theme.
Here is the call graph for this function:
Here is the caller graph for this function:

Field Documentation

◆ _imagePaths

readonly Dictionary<string, string> GWG.WindowFramework.Theming.PlayerThemeManifest._imagePaths = new Dictionary<string, string>(StringComparer.Ordinal)
private

◆ _issues

readonly List<string> GWG.WindowFramework.Theming.PlayerThemeManifest._issues = new List<string>()
private

◆ _source

GWG.WindowFramework.Theming.Json.JsonObject GWG.WindowFramework.Theming.PlayerThemeManifest._source
private

◆ MaximumBytes

const int GWG.WindowFramework.Theming.PlayerThemeManifest.MaximumBytes = 262144
static

Maximum UTF-8 manifest size.

Property Documentation

◆ Description

string GWG.WindowFramework.Theming.PlayerThemeManifest.Description
getprivate set

Gets bounded description.

◆ FontId

string GWG.WindowFramework.Theming.PlayerThemeManifest.FontId
getprivate set

Optional shipped font identifier; resolved only against configured prepared themes.

◆ Id

string GWG.WindowFramework.Theming.PlayerThemeManifest.Id
getprivate set

Gets validated stable player ID.

◆ ImagePaths

IReadOnlyDictionary<string, string> GWG.WindowFramework.Theming.PlayerThemeManifest.ImagePaths
get

Gets validated relative image references keyed by canonical token.

◆ Issues

IReadOnlyList<string> GWG.WindowFramework.Theming.PlayerThemeManifest.Issues
get

Gets recoverable field errors; omitted overrides inherit the configured default.

◆ Name

string GWG.WindowFramework.Theming.PlayerThemeManifest.Name
getprivate set

Gets bounded plain-text display name.

◆ UsesFolderName

bool GWG.WindowFramework.Theming.PlayerThemeManifest.UsesFolderName
getprivate set

Whether display name follows the folder rather than legacy manifest metadata.

◆ Values

PlayerThemeValues GWG.WindowFramework.Theming.PlayerThemeManifest.Values = new PlayerThemeValues()
get

Gets resolved explicit colour/number overrides; omitted keys remain absent.