Detailed Description

Provides API for handling layout features. Contains meta-data and runtime data about workspace layout and its dependencies.

See also: AWorkspaceGUIElement

Public Member Functions
	WorkspaceLayout (string key)
	Creating new meta data for the workspace entry. More...

	WorkspaceLayout (string key, Rect rect)
	Creating new meta data for the workspace entry. More...

bool	IsBonded (AWorkspaceGUIElement element)
	Checks is the element bonded to the workspace. More...

void	BondElement (AWorkspaceGUIElement element)
	Bond element to the layout. More...

void	ReleaseElement (AWorkspaceGUIElement element)
	Releasing to bond between element and layout. More...

Static Public Member Functions
static WorkspaceLayout	DefineFullscreenWorkspace (string key)
	Creating full screen workspace entry that can be applied to the windows in future. More...

static WorkspaceLayout	DefineWorkspace (string key, Rect screenRect)
	Creating workspace entry that can be applied to the windows in future. More...

static bool	FindWorkspace (string key, out WorkspaceLayout metadata)
	Looking for workspace data by the key. More...

static string	GetWorkspaceKey (AWorkspaceGUIElement element)
	Looking for workspace with bond to element. More...

static WorkspaceLayout	BondElementToWorkspace (string workspaceKey, AWorkspaceGUIElement element)
	Bonds element to the workspace layout. More...

static void	ReleaseWorkspaceBond (AWorkspaceGUIElement element)
	Looking for element's bond and releases it if exist. More...

Package Functions
void	OnNewLayoutCreated ()
	Informs subscribers about new layout creation.

Properties
AWorkspaceGUIElement	this[int index] `[get]`
	Returns bonded root element by index. More...

int	Count `[get]`
	Count of bonded elements.

string	Key `[get]`
	Key of the workspace.

Rect	ScreenSpaceRect `[get, set]`
	Workspace rect related to the screen space coordinates. More...

IReadOnlyCollection< AWorkspaceGUIElement >	BondedElements `[get]`
	Collection of elements bonded to the layout.

Events
Action< WorkspaceLayout, AWorkspaceGUIElement >	ElementBondAttached
	Occurs when BondElement(AWorkspaceGUIElement) or BondElementToWorkspace(string, AWorkspaceGUIElement) has been successfully called.

Action< WorkspaceLayout, AWorkspaceGUIElement >	ElementBondDetached
	Occurs when ReleaseElement(AWorkspaceGUIElement) or ReleaseWorkspaceBond(AWorkspaceGUIElement) has been successfully called.

static Action< WorkspaceLayout >	LayoutUpdated
	Occurs when a workspace is created or has an updated rect settings.

static Action< WorkspaceLayout >	LayoutCreated
	Occurs when new layout created.

static Action< WorkspaceLayout >	CollectionChanged
	Occurs when during any element related actions of WorkspaceLayout.

Constructor & Destructor Documentation

◆ WorkspaceLayout() [1/2]

Doloro.UIEngine2.WorkspaceLayout.WorkspaceLayout ( string key )

Creating new meta data for the workspace entry.

Parameters

key

Workspace rect has Full screen size until redefinition.

◆ WorkspaceLayout() [2/2]

Doloro.UIEngine2.WorkspaceLayout.WorkspaceLayout	(	string	key,
		Rect	rect
	)

Creating new meta data for the workspace entry.

Parameters

key	Key related to the workspace.
rect	Screen space rect defined to the

Member Function Documentation

◆ BondElement()

void Doloro.UIEngine2.WorkspaceLayout.BondElement ( AWorkspaceGUIElement element )

Bond element to the layout.

Parameters

element Target element.

◆ BondElementToWorkspace()

static WorkspaceLayout Doloro.UIEngine2.WorkspaceLayout.BondElementToWorkspace	(	string	workspaceKey,
		AWorkspaceGUIElement	element
	)

static

Bonds element to the workspace layout.

Parameters

workspaceKey	Key of the registered workspace.
element	Bonding element.

Returns: Reference to the layout.

Creates new full screen workspace in case if not found be the key.

Exceptions

ArgumentException	`workspaceKey` is null or whitespace.
ArgumentNullException	`element` is null.

◆ DefineFullscreenWorkspace()

static WorkspaceLayout Doloro.UIEngine2.WorkspaceLayout.DefineFullscreenWorkspace ( string key )

static

Creating full screen workspace entry that can be applied to the windows in future.

Parameters

key	Workspace key in register.

Returns: Meta data of created workspace.

◆ DefineWorkspace()

static WorkspaceLayout Doloro.UIEngine2.WorkspaceLayout.DefineWorkspace	(	string	key,
		Rect	screenRect
	)

static

Creating workspace entry that can be applied to the windows in future.

Parameters

key	The unique key of the workspace. Ignores case.
screenRect	Rect that will define the workspace position at the screen.

Returns: Meta data of created workspace.

Exceptions

ArgumentException key is null or whitespace.

In case if entry with the same key already exist then updates the rect and inform bond windows about.

◆ FindWorkspace()

static bool Doloro.UIEngine2.WorkspaceLayout.FindWorkspace	(	string	key,
		out WorkspaceLayout	metadata
	)

static

Looking for workspace data by the key.

Parameters

key	Workspace key.
metadata	Workspace data if registered.

Returns: Search result.

◆ GetWorkspaceKey()

static string Doloro.UIEngine2.WorkspaceLayout.GetWorkspaceKey ( AWorkspaceGUIElement element )

static

Looking for workspace with bond to element.

Parameters

element

Returns: Key of the workspace that contains the window instance. Empty string if bond not found.

Exceptions

ArgumentNullException window is null.

◆ IsBonded()

bool Doloro.UIEngine2.WorkspaceLayout.IsBonded ( AWorkspaceGUIElement element )

Checks is the element bonded to the workspace.

Parameters

element Element to check.

Returns: true in case if was bond with the BondElement(AWorkspaceGUIElement) or BondElementToWorkspace(string, AWorkspaceGUIElement) handler to current workspace instance.

◆ ReleaseElement()

void Doloro.UIEngine2.WorkspaceLayout.ReleaseElement ( AWorkspaceGUIElement element )

Releasing to bond between element and layout.

Parameters

element Target element.

Exceptions

ArgumentNullException	`element` is null.
KeyNotFoundException	Element has no bond with the workspace.

◆ ReleaseWorkspaceBond()

static void Doloro.UIEngine2.WorkspaceLayout.ReleaseWorkspaceBond ( AWorkspaceGUIElement element )

static

Looking for element's bond and releases it if exist.

Parameters

element Target element.

Exceptions

ArgumentNullException element is null.

Property Documentation

◆ ScreenSpaceRect

Rect Doloro.UIEngine2.WorkspaceLayout.ScreenSpaceRect

getset

Workspace rect related to the screen space coordinates.

Full screen by default. Full screen in case if any width or height is lesser then 0.

◆ this[int index]

AWorkspaceGUIElement Doloro.UIEngine2.WorkspaceLayout.this[int index]

get

Returns bonded root element by index.

Parameters

index Index of element in layout catalog.

Returns: REference to element.

The documentation for this class was generated from the following files:

D:/Work/GitHub/DGDK22/Assets/Tauri Interactive/Doloro-GDK/Doloro-UI-2/Runtime/Core/Workspaces/WorkspaceLayoutInstance.cs
D:/Work/GitHub/DGDK22/Assets/Tauri Interactive/Doloro-GDK/Doloro-UI-2/Runtime/Core/Workspaces/WorkspaceLayoutStatic.cs

Detailed Description

Public Member Functions

Static Public Member Functions

Package Functions

Properties

Events

Constructor & Destructor Documentation

◆ WorkspaceLayout() [1/2]

◆ WorkspaceLayout() [2/2]

Member Function Documentation

◆ BondElement()

◆ BondElementToWorkspace()

◆ DefineFullscreenWorkspace()

◆ DefineWorkspace()

◆ FindWorkspace()

◆ GetWorkspaceKey()

◆ IsBonded()

◆ ReleaseElement()

◆ ReleaseWorkspaceBond()

Property Documentation

◆ ScreenSpaceRect

◆ this[int index]