Component:DesktopDisplayLayout: Difference between revisions

From Resonite Wiki
Automated: update Fields
userspace
 
Line 1: Line 1:
{{Infobox Component
{{Infobox Component
|Image=DesktopDisplayLayoutComponent.png
|Image=DesktopDisplayLayoutComponent.png
|Name=Desktop Display Layout
|Name=DesktopDisplayLayout
}}
}}
The '''DesktopDisplayLayout''' component displays a list of display selection buttons for a user's monitor settup. Used in the dash and only works in the dash world.
 
The '''DesktopDisplayLayout''' component displays a list of display selection buttons for a user's monitor settup. It is used in the [[dash menu]] and only works in [[userspace]].


== Fields ==
== Fields ==
Line 13: Line 14:


== DisplayItemHandler ==
== DisplayItemHandler ==
A Sync delegate of type [[Type:Delegate|Delegate]]<[[Type:Display|Display]] display, [[Type:Slot|Slot]] itemRoot>
A Sync delegate of type [[Type:Delegate|Delegate]]<[[Type:Display|Display]] display, [[Type:Slot|Slot]] itemRoot>


== Examples ==
== Examples ==
Used in the dash desktop tab.
Used in the dash desktop tab.



Latest revision as of 18:41, 14 April 2025

Component image 
DesktopDisplayLayout component as seen in the Scene Inspector


The DesktopDisplayLayout component displays a list of display selection buttons for a user's monitor settup. It is used in the dash menu and only works in userspace.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
User direct UserRef The user to get displays for.
DisplayTemplate Slot the template to use when generating display selection buttons.
ItemGenerated delegate of identity DesktopDisplayLayout.DisplayItemHandler usually the OnDisplayItemGenerated() sync delegate from DesktopControlDialog.

DisplayItemHandler

A Sync delegate of type Delegate<Display display, Slot itemRoot>

Examples

Used in the dash desktop tab.

See Also