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.

Static Public Attributes
const string	ApplyMethodTooltip
const string	DataFileNameFieldTooltip
const string	DefaultButtonTooltip = "Set as the Default Theme"
const string	DefaultStylesheetFieldTooltip
const string	GlobalLoadOrderFieldTooltip
const string	GlobalStylesheetFieldTooltip
const string	MemoryEnabledFieldTooltip
const string	RemoveThemeButtonTooltip = "Remove Theme from the system"
const string	SaveThemeButtonTooltip = "Save Theme to the system"
const string	SetActiveThemeButtonTooltip = "Set as the Active Theme"
const string	StyleSheetFieldTooltip
const string	ThemeDataFieldTooltip
const string	TooltipsEnabledFieldTooltip = "Enables/Disables tooltips for window elements."
const string	UIDocumentFieldTooltip

Member Data 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."

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"

DefaultButtonTooltip

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

static

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"

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)"

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"

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

RemoveThemeButtonTooltip

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

static

SaveThemeButtonTooltip

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

static

SetActiveThemeButtonTooltip

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

static

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

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

TooltipsEnabledFieldTooltip

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

static

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"