Difference between revisions of "LGUI2:checkbox"

From Lavish Software Wiki
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
A [[LavishGUI 2]] checkbox element is a standard [[LGUI2:Content Container|Content Container]] element, which implements 2- or 3-state checkbox behavior, supporting "checked" "unchecked" and "indeterminate" values.  
 
A [[LavishGUI 2]] checkbox element is a standard [[LGUI2:Content Container|Content Container]] element, which implements 2- or 3-state checkbox behavior, supporting "checked" "unchecked" and "indeterminate" values.  
  
−
== Defining a button element ==
+
== Defining a checkbox element ==
 
A checkbox element is a [[LGUI2:Content Container|Content Container]], with added events and styles relating to checkbox behavior.
 
A checkbox element is a [[LGUI2:Content Container|Content Container]], with added events and styles relating to checkbox behavior.
  
Line 8: Line 8:
 
|-
 
|-
 
! useIndeterminate
 
! useIndeterminate
−
| A boolean (true/false) value specifying whether to use the Indeterminate state, making the checkbox a 3-state checkbox instead of 2-state
+
| A boolean (true/false) value specifying whether to use the Indeterminate state, making the checkbox a 3-state checkbox instead of 2-state. Default is '''false''' if not specified
 +
|-
 +
! checked
 +
| A string value specifying the checked state ("checked"/"unchecked"/"indeterminate") or ("true"/"false"/"maybe"). Default is '''unchecked''' if not specified
 +
|-
 +
! checkedBinding
 +
| A [[LGUI2:Data Binding|Data Binding]] definition to use for '''checked''' (typically bound to a bool value)
 
|}
 
|}
  
Line 48: Line 54:
  
 
== Examples ==
 
== 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: <tt>MyController:HandleButton1</tt>
 
−
: See [[LGUI2:LS1:lgui2eventargs|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"]
 
−
    }
 
−
  }
 
−
}
 
  
 
{{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 13:16, 6 May 2022

A LavishGUI 2 checkbox element is a standard Content Container element, which implements 2- or 3-state checkbox behavior, supporting "checked" "unchecked" and "indeterminate" values.

Defining a checkbox element

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

checkbox properties
useIndeterminate A boolean (true/false) value specifying whether to use the Indeterminate state, making the checkbox a 3-state checkbox instead of 2-state. Default is false if not specified
checked A string value specifying the checked state ("checked"/"unchecked"/"indeterminate") or ("true"/"false"/"maybe"). Default is unchecked if not specified
checkedBinding A Data Binding definition to use for checked (typically bound to a bool value)


Events

checkbox events
Define these Event Handlers within an "eventHandlers" Object
onUnchecked The box is now unchecked (☐)
onIndeterminate The box is now indeterminate (▣)
onChecked The box is now checked (☑)
onCheckedChanged The Checked state has been changed

Styles

checkbox styles
Define these Styles within a "styles" Object
onUnchecked The box is now unchecked (☐)
onIndeterminate The box is now indeterminate (▣)
onChecked The box is now checked (☑)

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:checkbox&oldid=8506"