Difference between revisions of "LGUI2:LS1:lgui2layer"

From Lavish Software Wiki
Jump to navigation Jump to search
(Created page with "{{ObjectType-Vitals|lgui2layer|LavishGUI 2|none|same as Name|none|no|void *}} A lgui2layer object provides access to a LavishGUI 2 LGUI2:Layer == Members == * Obj...")
 
Line 5: Line 5:
 
== Members ==
 
== Members ==
 
* [[ObjectType:string|string]] '''Name''': Name of the layer, such as "base" (the default layer)
 
* [[ObjectType:string|string]] '''Name''': Name of the layer, such as "base" (the default layer)
 +
* [[LGUI2:LS1:lgui2screen|lgui2screen]] '''Screen''': The root element for the layer
 
* [[ObjectType:float|float]] '''X''': The X coordinate of the top left corner of this layer
 
* [[ObjectType:float|float]] '''X''': The X coordinate of the top left corner of this layer
 
* [[ObjectType:float|float]] '''Y''': The Y coordinate of the top left corner of this layer
 
* [[ObjectType:float|float]] '''Y''': The Y coordinate of the top left corner of this layer
Line 14: Line 15:
 
* [[LGUI2:LS1:lgui2element|lgui2element]] '''FocusElement''':  Retrieves the element with keyboard focus, if any
 
* [[LGUI2:LS1:lgui2element|lgui2element]] '''FocusElement''':  Retrieves the element with keyboard focus, if any
 
* [[LGUI2:LS1:lgui2element|lgui2element]] '''MouseCaptureElement''': Retrieves the element with Mouse Capture, if any
 
* [[LGUI2:LS1:lgui2element|lgui2element]] '''MouseCaptureElement''': Retrieves the element with Mouse Capture, if any
 +
* [[LGUI2:LS1:lgui2element|lgui2element]] '''LoadFile['''filename''']''': Loads an [[LGUI2:Element|Element]] file into the layer, returning an [[LGUI2:LS1:lgui2element|lgui2element]]-derived object type depending on the LavishGUI 2 element type. A JSON Object is expected in the file.
 +
* [[ObjectType:uint|uint]] '''LoadArrayFile['''filename''']''': Loads a JSON Array file containing [[LGUI2:Element|Elements]] into the layer, returning the number of elements loaded.
 +
* [[LGUI2:LS1:lgui2element|lgui2element]] '''LoadJSON['''json''']''': Loads an Element, as defined by a json object, into the layer
 +
  
 
== Methods ==
 
== Methods ==
−
* none
+
* '''LoadBindingsFile['''filename''']''': Loads an [[LGUI2:Input Bindings|Input Bindings]] file into the layer. A JSON Array is expected in the file.
 +
* '''LoadArrayFile['''filename''']''': Loads a JSON Array file containing [[LGUI2:Element|Elements]] into the layer.
 +
* '''LoadFile['''filename''']''': Loads an [[LGUI2:Element|Element]] file into the layer. A JSON Object is expected in the file.
 +
* '''LoadSkinFile['''filename''']''': Loads a [[LGUI2:Skin|Skin]] file into the layer. A JSON Object is expected in the file.
 +
* '''AddBinding['''json''']''': Adds an [[LGUI2:Input Binding|Input Binding]] to the layer
 +
* '''RemoveBinding['''name''']''': Removes an [[LGUI2:Input Binding|Input Binding]] from the layer by name
  
 
== Examples ==
 
== Examples ==

Revision as of 17:47, 14 November 2018

Object Type Vitals
lgui2layer
Defined By LavishGUI 2
Inherits none
Reduces To same as Name
Variable Object Type none
Uses Sub-Types no
C/C++ Type void *

A lgui2layer object provides access to a LavishGUI 2 Layer

Members

  • string Name: Name of the layer, such as "base" (the default layer)
  • lgui2screen Screen: The root element for the layer
  • float X: The X coordinate of the top left corner of this layer
  • float Y: The Y coordinate of the top left corner of this layer
  • float Width: The Width of this layer
  • float Height: The Height of this layer
  • float CursorX: The X coordinate of the current mouse cursor position
  • float CursorY: The Y coordinate of the current mouse cursor position
  • lgui2element ElementFromPoint[X,Y]: Retrieves a UI element, given an (X,Y) pair
  • lgui2element FocusElement: Retrieves the element with keyboard focus, if any
  • lgui2element MouseCaptureElement: Retrieves the element with Mouse Capture, if any
  • lgui2element LoadFile[filename]: Loads an Element file into the layer, returning an lgui2element-derived object type depending on the LavishGUI 2 element type. A JSON Object is expected in the file.
  • uint LoadArrayFile[filename]: Loads a JSON Array file containing Elements into the layer, returning the number of elements loaded.
  • lgui2element LoadJSON[json]: Loads an Element, as defined by a json object, into the layer


Methods

  • LoadBindingsFile[filename]: Loads an Input Bindings file into the layer. A JSON Array is expected in the file.
  • LoadArrayFile[filename]: Loads a JSON Array file containing Elements into the layer.
  • LoadFile[filename]: Loads an Element file into the layer. A JSON Object is expected in the file.
  • LoadSkinFile[filename]: Loads a Skin file into the layer. A JSON Object is expected in the file.
  • AddBinding[json]: Adds an Input Binding to the layer
  • RemoveBinding[name]: Removes an Input Binding from the layer by name

Examples

LavishGUI 2 Element Types

LavishGUI 2 LavishScript Object Types

Core API (see Using LavishGUI 2 from LavishScript)
lgui2 - lgui2animateargs - lgui2animationtype - lgui2elementref - lgui2eventargs - lgui2eventhandler - lgui2elementtype - lgui2itemviewgeneratorargs - lgui2inputbinding - lgui2layer - lgui2skin - lgui2trigger
Enums
elgui2animationframestate - elgui2dpad - elgui2edge - elgui2fontflags - elgui2horizontalalignment - elgui2imageorientation - elgui2progresstext - elgui2scrollbar - elgui2sizetocontent - elgui2verticalignment - elgui2visibility
Element Components
lgui2animation - lgui2brush - lgui2fontstyle - lgui2margins - lgui2item - lgui2property - lgui2radialitem - lgui2radialgaugeneedle
Element Base Types
lgui2element - lgui2bordered - lgui2contentbase - lgui2headeredcontentbase - lgui2itemlist
Elements
Retrieved from "https://www.lavishsoft.com/wiki/index.php?title=LGUI2:LS1:lgui2layer&oldid=8112"