Difference between revisions of "LavishGUI:lguicheckbox (Data Type)"

From Lavish Software Wiki
Jump to navigation Jump to search
Line 5: Line 5:
 
* [[DataType:bool|bool]] '''Down''' :  TRUE if the checkbox is pressed
 
* [[DataType:bool|bool]] '''Down''' :  TRUE if the checkbox is pressed
 
* [[DataType:bool|bool]] '''Checked''' :  TRUE if button is checked
 
* [[DataType:bool|bool]] '''Checked''' :  TRUE if button is checked
* [[ISSession:lguifont (Data Type)|lguifont]] '''Font''' : font object the checkbox is using
+
* [[LavishGUI:lguifont (Data Type)|lguifont]] '''Font''' : font object the checkbox is using
 
== Methods ==
 
== Methods ==
 
*'''SetText['''text''']''' : sets the text on the checkbox
 
*'''SetText['''text''']''' : sets the text on the checkbox
Line 13: Line 13:
  
 
== Inherits ==
 
== Inherits ==
[[ISSession:lguielement (Data Type)|isuielement]]
+
[[LavishGUI:lguielement (Data Type)|isuielement]]
  
 
== Returns ==
 
== Returns ==

Revision as of 04:44, 11 October 2005

Description

This data type provides and controls data for ISUI checkboxes.

Members

  • string Text : checkbox text
  • bool Down : TRUE if the checkbox is pressed
  • bool Checked : TRUE if button is checked
  • lguifont Font : font object the checkbox is using

Methods

  • SetText[text] : sets the text on the checkbox
  • SetChecked : sets the checkbox to checked status
  • UnsetChecked : sets the checkbox to unchecked status
  • ToggleChecked : toggles the checkbox status

Inherits

isuielement

Returns

Same as lguielement.Name

Examples

Retrieve text on a checkbox

  • echo Text on Checkbox: ${UIElement[test].FindChild[checkboxtest].Text}
Output
Text on Checkbox: I am a test Checkbox

Display if a checkbox is pressed

  • echo Checkbox Pressed? ${UIElement[test].FindChild[checkboxtest].Down}
Output
Checkbox Pressed? FALSE

Display a checkbox's checked status

  • echo Checkbox Checked? ${UIElement[test].FindChild[checkboxtest].Checked}
Output
Checkbox Checked? FALSE

Display a checkbox's font

  • echo Checkbox font: ${UIElement[test].FindChild[checkboxtest].Font}
Output
Checkbox font: terminal

Set text on a checkbox

  • UIElement[test].FindChild[checkboxtest]:SetText[Checkbox Text V2.0]
  • echo Text on checkbox: ${UIElement[test].FindChild[checkboxtest].Text}
Output
Text on checkbox: Checkbox Text V2.0

Toggle a checkbox's checked status

  • UIElement[test].FindChild[checkboxtest]:ToggleChecked
  • echo Checkbox Checked? ${UIElement[test].FindChild[checkboxtest].Checked}
Output
Checkbox Checked? TRUE

Uncheck a checkbox

  • UIElement[test].FindChild[checkboxtest]:UnsetChecked
  • echo Checkbox Checked? ${UIElement[test].FindChild[checkboxtest].Checked}
Output
Checkbox Checked? FALSE

See Also