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

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...

Static Public Attributes

const string ApplyMethodTooltip
 Legacy apply-scope help text; actual composition/hosting contracts are in the manual.
const string DataFileNameFieldTooltip
 Framework persistence filename field help.
const string DefaultButtonTooltip = "Set as the Default Theme"
 Configured default-designation button help.
const string DefaultStylesheetFieldTooltip
 Explicit fallback stylesheet field help, not hidden palette selection.
const string GlobalLoadOrderFieldTooltip
 Global sheet ordering field help; shared collection sheets compose separately.
const string GlobalStylesheetFieldTooltip
 Optional global stylesheet field help.
const string MemoryEnabledFieldTooltip
 Memory field help; concrete type and stable IDs remain required for records.
const string RemoveThemeButtonTooltip = "Remove Theme from the system"
 Collection entry removal help; does not itself authorize asset-file deletion.
const string SaveThemeButtonTooltip = "Save Theme to the system"
 Source save button help; persistence follows the authoring transaction.
const string SetActiveThemeButtonTooltip = "Set as the Active Theme"
 Shipped active selection button help.
const string StyleSheetFieldTooltip
 Theme stylesheet picker help; modern settings TSS still requires collection composition.
const string TelemetryEnabledFieldTooltip
 Telemetry toggle help; not an external analytics service.
const string ThemeDataFieldTooltip
 Configured theme-data picker help.
const string TooltipsEnabledFieldTooltip = "Enables/Disables tooltips for window elements."
 Tooltip enablement field caption help.
const string UIDocumentFieldTooltip
 Document-field help; omitted reference requires an existing same-object UIDocument.

Detailed Description

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.

Field Documentation

◆ ApplyMethodTooltip

const string GWG.WindowFramework.TooltipStrings.ApplyMethodTooltip
static
Initial value:
= "The method to use to apply the theme to the window framework.\n\n" +
"<b>Window Frames Only</b> - Applies theme only to items contained in or derived from the WindowFrame class\n\n" +
"<b>Parent panel</b> - Applies theme to the entire panel that the WindowFrameController is attached to. This action replaces all stylesheets on the panel with the theme stylesheets and effects ALL elements that are children of the panel.\n\n" +
"<b>All Panels</b> - The system will attempt to find all active panels in the scene and apply the theme stylesheets to them. ALso, When using multiple layers or panels make sure you the sort Order corect and that you set the primary visual element in the layer to <b>Position Ignore</b> or it will block mouse clicks."

Legacy apply-scope help text; actual composition/hosting contracts are in the manual.

◆ DataFileNameFieldTooltip

const string GWG.WindowFramework.TooltipStrings.DataFileNameFieldTooltip
static
Initial value:
= "The name of the file to save and load window data to and from.\n" +
"It is saved into the Persistant Storage Directory defined in the project"

Framework persistence filename field help.

◆ DefaultButtonTooltip

const string GWG.WindowFramework.TooltipStrings.DefaultButtonTooltip = "Set as the Default Theme"
static

Configured default-designation button help.

◆ DefaultStylesheetFieldTooltip

const string GWG.WindowFramework.TooltipStrings.DefaultStylesheetFieldTooltip
static
Initial value:
= "Default <b>TSS</b> or <b>USS</b> Stylesheet to use if Themes are not enabled or no theme is set.\n" +
"This will return the defined Theme default if Themes are enabled"

Explicit fallback stylesheet field help, not hidden palette selection.

◆ GlobalLoadOrderFieldTooltip

const string GWG.WindowFramework.TooltipStrings.GlobalLoadOrderFieldTooltip
static
Initial value:
= "The load Order of the <b>Global StyleSheet</b>.\n" +
"This will be used to determine the Order in which the global stylesheet is loaded.\n\n" +
"<b>First</b> - Loads the globals stylesheet (if defined) then the theme stylesheet\n\n" +
"<b>Last</b> - Loads the theme stylesheets then the global stylesheet (if defined)"

Global sheet ordering field help; shared collection sheets compose separately.

◆ GlobalStylesheetFieldTooltip

const string GWG.WindowFramework.TooltipStrings.GlobalStylesheetFieldTooltip
static
Initial value:
= "Global <b>TSS</b> or <b>USS</b> Stylesheet to apply for all themes.\n" +
"Using a <b>TSS (Unity Theme)</b> allows for multiple stylesheets to be applied at once.\n\n" +
"Using a <b>USS (StyleSheet)</b> allows for only the single stylesheet to be applied.\n\n" +
"This will be added to all windows even when only unsing the default"

Optional global stylesheet field help.

◆ MemoryEnabledFieldTooltip

const string GWG.WindowFramework.TooltipStrings.MemoryEnabledFieldTooltip
static
Initial value:
= "Enables memory saving for window data.\n" +
"This will save the window data to the device's persistent storage."

Memory field help; concrete type and stable IDs remain required for records.

◆ RemoveThemeButtonTooltip

const string GWG.WindowFramework.TooltipStrings.RemoveThemeButtonTooltip = "Remove Theme from the system"
static

Collection entry removal help; does not itself authorize asset-file deletion.

◆ SaveThemeButtonTooltip

const string GWG.WindowFramework.TooltipStrings.SaveThemeButtonTooltip = "Save Theme to the system"
static

Source save button help; persistence follows the authoring transaction.

◆ SetActiveThemeButtonTooltip

const string GWG.WindowFramework.TooltipStrings.SetActiveThemeButtonTooltip = "Set as the Active Theme"
static

Shipped active selection button help.

◆ StyleSheetFieldTooltip

const string GWG.WindowFramework.TooltipStrings.StyleSheetFieldTooltip
static
Initial value:
= "The <b>TSS</b> StyleSheet to use for this theme.\n\n" +
"Using a <b>TSS (Unity Theme)</b> allows for multiple stylesheets to be applied at once.\n\n" +
"This has no effect on the Global StyleSheet since it is applied if it exists regardless theme."

Theme stylesheet picker help; modern settings TSS still requires collection composition.

◆ TelemetryEnabledFieldTooltip

const string GWG.WindowFramework.TooltipStrings.TelemetryEnabledFieldTooltip
static
Initial value:
= "Enables high-density machine-readable debug telemetry logging.\n" +
"Outputs structured JSON logs for pointer events, window boundary tracking, resize calculations, tooltips, and context menus."

Telemetry toggle help; not an external analytics service.

◆ ThemeDataFieldTooltip

const string GWG.WindowFramework.TooltipStrings.ThemeDataFieldTooltip
static
Initial value:
= "The theme data to use for the window framework.\n" +
"This will be used to set the current theme and stylesheets."

Configured theme-data picker help.

◆ TooltipsEnabledFieldTooltip

const string GWG.WindowFramework.TooltipStrings.TooltipsEnabledFieldTooltip = "Enables/Disables tooltips for window elements."
static

Tooltip enablement field caption help.

◆ UIDocumentFieldTooltip

const string GWG.WindowFramework.TooltipStrings.UIDocumentFieldTooltip
static
Initial value:
= "<b>OPTIONAL</b> - The UI Document to use for the window framework.\n\n" +
"This is optional as the Framework will find the attached document.\n\n" +
"IF however you are getting strange null ref errors then assigning this may help"

Document-field help; omitted reference requires an existing same-object UIDocument.