Difference between revisions of "LGUI2:LS1:lgui2element"

From Lavish Software Wiki
Jump to: navigation, search
Line 5: Line 5:
 
* [[ObjectType:unistring|unistring]] '''Name''': The specified Name (if any) of this element
 
* [[ObjectType:unistring|unistring]] '''Name''': The specified Name (if any) of this element
 
* [[ObjectType:jsonobject|jsonobject]] '''Metadata''': The JSON object containing any Metadata associated with this element
 
* [[ObjectType:jsonobject|jsonobject]] '''Metadata''': The JSON object containing any Metadata associated with this element
* ... '''Locate['''elementName''','''elementType''','''flags''']''':  
+
* [[LGUI2:LS1:lgui2element|lgui2element]] '''Locate['''elementName''','''elementType''','''flags''']''':  
 
* [[LGUI2:LS1:lgui2elementtype|lgui2elementtype]] '''ElementType''': The type of Element (e.g. "window")
 
* [[LGUI2:LS1:lgui2elementtype|lgui2elementtype]] '''ElementType''': The type of Element (e.g. "window")
 
* [[ObjectType:float|float]] '''X''': X offset for this element
 
* [[ObjectType:float|float]] '''X''': X offset for this element
Line 19: Line 19:
 
* [[ObjectType:bool|bool]] '''AcceptsKeyboardFocus''': TRUE if the element accepts keyboard focus, allowing non-mouse input events to route to this element
 
* [[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
 
* [[LGUI2:LS1:lgui2layer|lgui2layer]] '''Layer''': [[LGUI2:Layer|Layer]] containing the element
 +
* [[LGUI2:LS1:lgui2element|lgui2element]] '''ContextMenu''': The [[LGUI2:contextmenu|contextmenu]] (if any) for this element
 +
* [[LGUI2:LS1:elgui2horizontalalignment|elgui2horizontalalignment]] '''HorizontalAlignment''':
 +
* [[LGUI2:LS1:elgui2verticalalignment|elgui2verticalalignment]] '''VerticalAlignment''':
  
 
== Methods ==
 
== Methods ==
Line 30: Line 33:
 
* '''SetPadding['''#''','''#''']''': Sets Left/Right and Top/Bottom padding values to these #'s (in that order)
 
* '''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)
 
* '''SetPadding['''#''','''#''','''#''','''#''']''': Sets Left, Top, Right, Bottom padding values to these #'s (in that order)
 +
* '''SetHorizontalAlignment['''[[LGUI2:LS1:elgui2horizontalalignment|elgui2horizontalalignment]]''']''':
 +
* '''SetVerticalAlignment['''[[LGUI2:LS1:elgui2verticalalignment|elgui2verticalalignment]]''']''':
  
  
 
{{LGUI2:ObjectType}}
 
{{LGUI2:ObjectType}}

Revision as of 16:44, 13 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
  • lgui2element 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
  • lgui2element ContextMenu: The contextmenu (if any) for this element
  • elgui2horizontalalignment HorizontalAlignment:
  • elgui2verticalalignment VerticalAlignment:

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)
  • SetHorizontalAlignment[elgui2horizontalalignment]:
  • SetVerticalAlignment[elgui2verticalalignment]:


LavishGUI 2 Element Types

LavishGUI 2 LavishScript Object Types

Core API (see Using LavishGUI 2 from LavishScript)
lgui2 - lgui2animateargs - lgui2animationtype - lgui2eventargs - lgui2eventhandler - lgui2elementtype - lgui2itemviewgeneratorargs - lgui2inputbinding - lgui2layer - lgui2skin
Enums
elgui2animationframestate - elgui2dpad - elgui2edge - elgui2fontflags - elgui2horizontalalignment - elgui2imageorientation - elgui2progresstext - elgui2scrollbar - elgui2sizetocontent - elgui2verticalignment
Element Components
lgui2animation - lgui2brush - lgui2fontstyle - lgui2margins - lgui2item - lgui2radialitem
Element Base Types
lgui2element - lgui2bordered - lgui2contentbase - lgui2headeredcontentbase - lgui2itemlist
Elements