Difference between revisions of "LGUI2:button"

From Lavish Software Wiki
Jump to navigation Jump to search
 
Line 1: Line 1:
 
A [[LavishGUI 2]] button element is a standard [[LGUI2:Content Container|Content Container]] element, which can be "Pressed" in various ways (such as a mouse click), usually to activate some behavior.
 
A [[LavishGUI 2]] button element is a standard [[LGUI2:Content Container|Content Container]] element, which can be "Pressed" in various ways (such as a mouse click), usually to activate some behavior.
 +
  
 
== Defining a button element ==
 
== Defining a button element ==
 
A button element is a [[LGUI2:Content Container|Content Container]], with added events and styles relating to button behavior.
 
A button element is a [[LGUI2:Content Container|Content Container]], with added events and styles relating to button behavior.
 +
  
 
=== Events ===
 
=== Events ===
Line 19: Line 21:
 
| The Pressed state has been changed
 
| The Pressed state has been changed
 
|}
 
|}
 +
  
 
=== Styles ===
 
=== Styles ===
Line 32: Line 35:
 
| The button is now released
 
| The button is now released
 
|}
 
|}
 +
  
 
== Examples ==
 
== Examples ==
Line 53: Line 57:
 
   }
 
   }
 
  }
 
  }
 +
  
 
{{LGUI2:Element}}
 
{{LGUI2:Element}}
 
[[Category:LavishGUI 2 Bordered Elements]]
 
[[Category:LavishGUI 2 Bordered Elements]]
 
[[Category:LavishGUI 2 Content Container Elements]]
 
[[Category:LavishGUI 2 Content Container Elements]]

Latest revision as of 02:46, 17 November 2018

A LavishGUI 2 button element is a standard Content Container element, which can be "Pressed" in various ways (such as a mouse click), usually to activate some behavior.


Defining a button element

A button element is a Content Container, with added events and styles relating to button behavior.


Events

button events
Define these Event Handlers within an "eventHandlers" Object
onPress The button is now pressed
onRelease The button is now released
onPressedChanged The Pressed state has been changed


Styles

button styles
Define these Styles within a "styles" Object
onPress The button is now pressed
onRelease The button is now released


Examples

A button element, with a 1 pixel thick white border around a black background containing a textblock.
When clicked, this button will execute the LavishScript code: MyController:HandleButton1
See lgui2eventargs for an example controller with onMouseButtonMove
{
  "type": "button",
  "name": "button1",
  "content": "My border has some text!",
  "borderBrush": {
    "color": [ 1.0, 1.0, 1.0 ]
  },
  "backgroundBrush": {
    "color": [ 0, 0, 0 ]
  },
  "borderThickness": 1
  "eventHandlers": {
    "onRelease": ["method","MyController","HandleButton1"]
    }
  }
}


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