Difference between revisions of "LGUI2:LS1:lgui2element"

From Lavish Software Wiki
Jump to navigation Jump to search
Line 15: Line 15:
 
* [[ObjectType:float|float]] '''ActualWidth''': Actual width of this element (does not include Margins)
 
* [[ObjectType:float|float]] '''ActualWidth''': Actual width of this element (does not include Margins)
 
* [[ObjectType:float|float]] '''ActualHeight''': Actual height of this element (does not include Margins)
 
* [[ObjectType:float|float]] '''ActualHeight''': Actual height of this element (does not include Margins)
 +
* [[LGUI2:LS1:lgui2margins|lgui2margins]] '''Margins''': Margins surrounding this element (outside its bounds)
 +
* [[LGUI2:LS1:lgui2margins|lgui2margins]] '''Padding''': Padding surrounding this element's contents (inside its bounds, and border if applicable)
 +
* [[ObjectType:bool|bool]] '''AcceptsKeyboardFocus''': TRUE if the element accepts keyboard focus, allowing non-mouse input events to route to this element
 +
* [[LGUI2:LS1:lgui2layer|lgui2layer]] '''Layer''': [[LGUI2:Layer|Layer]] containing the element
  
 
== Methods ==
 
== Methods ==
Line 20: Line 24:
 
* '''ClearChildren''': Detaches all children from this element
 
* '''ClearChildren''': Detaches all children from this element
 
* '''Detach''': Detaches this element from its parent (typically for "unloading")
 
* '''Detach''': Detaches this element from its parent (typically for "unloading")
 
+
* '''SetMargins['''#''']''': Sets all of this element's margin values to this #
 +
* '''SetMargins['''#''','''#''']''': Sets Left/Right and Top/Bottom margin values to these #'s (in that order)
 +
* '''SetMargins['''#''','''#''','''#''','''#''']''': Sets Left, Top, Right, Bottom margin values to these #'s (in that order)
 +
* '''SetPadding['''#''']''': Sets all of this element's padding values to this #
 +
* '''SetPadding['''#''','''#''']''': Sets Left/Right and Top/Bottom padding values to these #'s (in that order)
 +
* '''SetPadding['''#''','''#''','''#''','''#''']''': Sets Left, Top, Right, Bottom padding values to these #'s (in that order)
  
 
[[Category:LavishGUI 2]]
 
[[Category:LavishGUI 2]]
 
[[Category:LavishGUI 2 LavishScript API]]
 
[[Category:LavishGUI 2 LavishScript API]]

Revision as of 05:09, 3 July 2018

Object Type Vitals
lgui2element
Defined By LavishGUI 2
Inherits none
Reduces To lgui2element
Variable Object Type none
Uses Sub-Types no
C/C++ Type ILGUI2Element *

lgui2element provides LavishScript access to Elements

Members

  • unistring Name: The specified Name (if any) of this element
  • jsonobject Metadata: The JSON object containing any Metadata associated with this element
  • ... Locate[elementName,elementType,flags]:
  • lgui2elementtype ElementType: The type of Element (e.g. "window")
  • float X: X offset for this element
  • float Y: Y offset for this element
  • float Width: Width for this element (does not include Margins)
  • float Height: Height for this element (does not include Margins)
  • float ActualX: Actual X position for this element
  • float ActualY: Actual Y position for this element
  • float ActualWidth: Actual width of this element (does not include Margins)
  • float ActualHeight: Actual height of this element (does not include Margins)
  • lgui2margins Margins: Margins surrounding this element (outside its bounds)
  • lgui2margins Padding: Padding surrounding this element's contents (inside its bounds, and border if applicable)
  • bool AcceptsKeyboardFocus: TRUE if the element accepts keyboard focus, allowing non-mouse input events to route to this element
  • lgui2layer Layer: Layer containing the element

Methods

  • SetName[value]: Assigns a new value to the Name
  • ClearChildren: Detaches all children from this element
  • Detach: Detaches this element from its parent (typically for "unloading")
  • SetMargins[#]: Sets all of this element's margin values to this #
  • SetMargins[#,#]: Sets Left/Right and Top/Bottom margin values to these #'s (in that order)
  • SetMargins[#,#,#,#]: Sets Left, Top, Right, Bottom margin values to these #'s (in that order)
  • SetPadding[#]: Sets all of this element's padding values to this #
  • SetPadding[#,#]: Sets Left/Right and Top/Bottom padding values to these #'s (in that order)
  • SetPadding[#,#,#,#]: Sets Left, Top, Right, Bottom padding values to these #'s (in that order)