Window Framework v1.2.4
Window Framework for Unity UI Toolkit
Loading...
Searching...
No Matches
GWG.WindowFramework.Demo.UXMLBasedDemoWindow Class Reference
Inheritance diagram for GWG.WindowFramework.Demo.UXMLBasedDemoWindow:

Public Member Functions

 UXMLBasedDemoWindow ()
 Represents a custom help window derived from the WindowFrame class. Used to create and display a specialized UXML-based help interface.
Public Member Functions inherited from GWG.WindowFramework.WindowFrame
 WindowFrame ()
 Represents a custom UI element serving as a container for window-based content, including a header, content, and footer, providing event handling and theme adaptability for Unity's UI Toolkit.
void CloseWindow (bool forceAll=false)
 Closes the window if allowed.
void Hide ()
 Hides the window while keeping it in memory.
void SetOpeningPosition ()
 Sets the opening position of the window based on the selected position. Options include: TopLeft, Top, TopRight, Left, Center, Right, BottomLeft, Bottom, BottomRight.
void Show ()
 Shows the window by setting its display style to flex and opacity to 1.0f.

Properties

DemoPageData DemoPageData [get, set]
int SelectedPage [get, set]
Properties inherited from GWG.WindowFramework.WindowFrame
bool Active [get, set]
 Gets or sets whether the window is active.
bool AllowClose = true [get, set]
 Gets or sets whether the window can be closed.
bool AllowFullscreen = true [get, set]
 Determines whether the window frame can toggle to fullscreen mode.
bool AllowLock [get, set]
 Gets or sets whether the window can be locked.
bool AllowMove = true [get, set]
 Gets or sets whether the window can be moved.
bool AllowMultipleInstances = true [get, set]
 Gets or sets whether multiple instances of this window are allowed.
bool AllowResize [get, set]
 Gets or sets whether the window can be resized.
VisualElement Content [get, set]
 Gets or sets the content area of the window.
override VisualElement contentContainer [get]
 Overrides the contentContainer to return the window's content area instead of the root.
ContextMenuConfig ContextMenuConfig [get, set]
 Gets or sets the context menu configuration for this window.
float DefaultHeight = 300 [get, set]
 Gets or sets the default height of the window.
float DefaultWidth = 300 [get, set]
 Gets or sets the default width of the window.
VisualElement FooterToolbar [get, set]
 Gets or sets the toolbar in the footer area of the window.
bool Fullscreen [get, set]
 Gets or sets whether the window is in fullscreen mode.
bool Locked [get, set]
 Gets or sets whether the window is locked.
bool LockedFullscreen [get, set]
 Determines whether the fullscreen mode of the window is locked, preventing the user from toggling fullscreen on or off.
bool LockedToStartPosition [get, set]
 Gets or sets whether the window is locked to its start position.
float MinHeight [get, set]
 Gets or sets the minimum height of the window.
float MinWidth [get, set]
 Gets or sets the minimum width of the window.
string OptionsMenuTooltip [get, set]
 Gets or sets the tooltip for the options menu button.
string ParentObjectId [get, set]
 Gets or sets the ID of the parent object associated with the window.
string ResizeAreaTooltip [get, set]
 Gets or sets the tooltip for the resize area.
bool ShowFooter [get, set]
 Gets or sets whether the footer is visible.
bool ShowHeader [get, set]
 Gets or sets whether the header is visible.
WindowFramePosition StartPosition [get, set]
 Gets or sets the position of the window frame.
List< StyleSheet > StyleSheet [get, set]
 Gets or sets the stylesheet applied to the window.
string Title [get, set]
 Gets or sets the title of the window.
string WindowId [get, set]
 Gets or sets the unique ID of the window.
bool WindowMemoryEnabled = false [get, set]
 Gets or sets whether the window memory is enabled.

Private Member Functions

VisualElement CreateHelpLine (string label, string link)
VisualElement CreateHelpUI ()
void CreateMenu ()
void FindContextDemos ()
void Initialize ()
void LoadPage (int index)

Private Attributes

DemoPageData _demoPageData
ListView _menu
TwoPaneSplitView _menuSplitView
ScrollView _rightContent
bool pickaxeEquiped = false

Additional Inherited Members

Events inherited from GWG.WindowFramework.WindowFrame
static Action< WindowFrameOnWindowFrameAdded
 Event triggered when a new WindowFrame is added to the panel.
static Action< WindowFrameOnWindowFrameRemoved
 Event triggered when a WindowFrame is removed from the panel.

Constructor & Destructor Documentation

◆ UXMLBasedDemoWindow()

GWG.WindowFramework.Demo.UXMLBasedDemoWindow.UXMLBasedDemoWindow ( )

Member Function Documentation

◆ CreateHelpLine()

VisualElement GWG.WindowFramework.Demo.UXMLBasedDemoWindow.CreateHelpLine ( string label,
string link )
private

◆ CreateHelpUI()

VisualElement GWG.WindowFramework.Demo.UXMLBasedDemoWindow.CreateHelpUI ( )
private

◆ CreateMenu()

void GWG.WindowFramework.Demo.UXMLBasedDemoWindow.CreateMenu ( )
private

◆ FindContextDemos()

void GWG.WindowFramework.Demo.UXMLBasedDemoWindow.FindContextDemos ( )
private

◆ Initialize()

void GWG.WindowFramework.Demo.UXMLBasedDemoWindow.Initialize ( )
private

◆ LoadPage()

void GWG.WindowFramework.Demo.UXMLBasedDemoWindow.LoadPage ( int index)
private

Member Data Documentation

◆ _demoPageData

DemoPageData GWG.WindowFramework.Demo.UXMLBasedDemoWindow._demoPageData
private

◆ _menu

ListView GWG.WindowFramework.Demo.UXMLBasedDemoWindow._menu
private

◆ _menuSplitView

TwoPaneSplitView GWG.WindowFramework.Demo.UXMLBasedDemoWindow._menuSplitView
private

◆ _rightContent

ScrollView GWG.WindowFramework.Demo.UXMLBasedDemoWindow._rightContent
private

◆ pickaxeEquiped

bool GWG.WindowFramework.Demo.UXMLBasedDemoWindow.pickaxeEquiped = false
private

Property Documentation

◆ DemoPageData

DemoPageData GWG.WindowFramework.Demo.UXMLBasedDemoWindow.DemoPageData
getset

◆ SelectedPage

int GWG.WindowFramework.Demo.UXMLBasedDemoWindow.SelectedPage
getset