Doloro GDK 22 .1.0 Beta
by Tauri Interactive
|
Provides API for handling layout features. Contains meta-data and runtime data about workspace layout and its dependencies.
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. | |
Doloro.UIEngine2.WorkspaceLayout.WorkspaceLayout | ( | string | key | ) |
Creating new meta data for the workspace entry.
key |
Workspace rect has Full screen size until redefinition.
Doloro.UIEngine2.WorkspaceLayout.WorkspaceLayout | ( | string | key, |
Rect | rect | ||
) |
Creating new meta data for the workspace entry.
key | Key related to the workspace. |
rect | Screen space rect defined to the |
void Doloro.UIEngine2.WorkspaceLayout.BondElement | ( | AWorkspaceGUIElement | element | ) |
Bond element to the layout.
element | Target element. |
|
static |
Bonds element to the workspace layout.
workspaceKey | Key of the registered workspace. |
element | Bonding element. |
Creates new full screen workspace in case if not found be the key.
ArgumentException | workspaceKey is null or whitespace. |
ArgumentNullException | element is null. |
|
static |
Creating full screen workspace entry that can be applied to the windows in future.
key | Workspace key in register. |
|
static |
Creating workspace entry that can be applied to the windows in future.
key | The unique key of the workspace. Ignores case. |
screenRect | Rect that will define the workspace position at the screen. |
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.
|
static |
Looking for workspace data by the key.
key | Workspace key. |
metadata | Workspace data if registered. |
|
static |
Looking for workspace with bond to element.
element |
ArgumentNullException | window is null. |
bool Doloro.UIEngine2.WorkspaceLayout.IsBonded | ( | AWorkspaceGUIElement | element | ) |
Checks is the element bonded to the workspace.
element | Element to check. |
true
in case if was bond with the BondElement(AWorkspaceGUIElement) or BondElementToWorkspace(string, AWorkspaceGUIElement) handler to current workspace instance.void Doloro.UIEngine2.WorkspaceLayout.ReleaseElement | ( | AWorkspaceGUIElement | element | ) |
Releasing to bond between element and layout.
element | Target element. |
ArgumentNullException | element is null. |
KeyNotFoundException | Element has no bond with the workspace. |
|
static |
Looking for element's bond and releases it if exist.
element | Target element. |
ArgumentNullException | element is null. |
|
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.
|
get |
Returns bonded root element by index.
index | Index of element in layout catalog. |