OmegaEngine API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Protected Attributes | Package Functions | Properties | List of all members
OmegaGUI.Model.CheckBox Class Reference

CheckBox control More...

Inheritance diagram for OmegaGUI.Model.CheckBox:
OmegaGUI.Model.ButtonBase OmegaGUI.Model.Label OmegaGUI.Model.Control OmegaGUI.Model.RadioButton

Protected Attributes

bool IsChecked
 
- Protected Attributes inherited from OmegaGUI.Model.Label
string ControlText = ""
 
- Protected Attributes inherited from OmegaGUI.Model.Control
Render.Control DXControl
 The OmegaGUI.Render control used for actual rendering More...
 
Point EffectiveLocation
 The actual location of the control on the dialog factoring in AlignHorizontal and AlignVertical More...
 
Size EffectiveSize
 The actual size of the control on the dialog factoring in scaling due to Dialog.Scale More...
 
bool IsEnabled = true
 
bool IsVisible = true
 

Package Functions

override void Generate ()
 Generates a control model from this control view More...
 
- Package Functions inherited from OmegaGUI.Model.Label
override void Generate ()
 Generates a control model from this control view More...
 
- Package Functions inherited from OmegaGUI.Model.Control
void UpdateLayout ()
 Updates the control's location and size More...
 

Properties

override string Text [get, set]
 The text displayed on the control More...
 
virtual bool Checked [get, set]
 Is this control currently checked? More...
 
string OnChanged [get, set]
 A Lua script to execute when the control's value has changed More...
 
- Properties inherited from OmegaGUI.Model.ButtonBase
Keys Hotkey [get, set]
 A hotkey that can substitute a mouse click - no auto-update More...
 
string OnClick [get, set]
 A Lua script to execute when the control is clicked More...
 
- Properties inherited from OmegaGUI.Model.Label
virtual string Text [get, set]
 The text displayed on the control More...
 
TextAlign TextAlign [get, set]
 How the text is to be aligned - only effective for Label More...
 
- Properties inherited from OmegaGUI.Model.Control
string Name [get, set]
 Unique name for identifying this control More...
 
bool Default [get, set]
 Is this the default control on the dialog? - no auto-update More...
 
bool Enabled [get, set]
 Is this control currently active? More...
 
bool Visible [get, set]
 Is this control currently visible? More...
 
Point Location [get, set]
 The location of the control on the dialog More...
 
Size Size [get, set]
 The size of the control on the dialog More...
 
HorizontalMode AlignHorizontal [get, set]
 How to handle the X values of Location and Size More...
 
VerticalMode AlignVertical [get, set]
 How to handle the Y values of Location and Size More...
 
string OnMouseEnter [get, set]
 A Lua script to execute when the mouse enters the area of the control More...
 
string OnMouseExit [get, set]
 A Lua script to execute when the mouse leaves the area of the control More...
 

Additional Inherited Members

- Public Member Functions inherited from OmegaGUI.Model.Control
override string ToString ()
 
Control Clone ()
 Creates a shallow copy of this control. You need to call Generate on it before it can be used for rendering. More...
 
- Public Attributes inherited from OmegaGUI.Model.Control
Rectangle DrawBox => new Rectangle(EffectiveLocation, EffectiveSize)
 The effective area on the window were this control is rendered More...
 
Render.Control ControlModel => DXControl
 
- Protected Member Functions inherited from OmegaGUI.Model.Control
void NeedsUpdate ()
 
void SetupMouseEvents ()
 
- Package Attributes inherited from OmegaGUI.Model.Control
Dialog Parent
 The dialog containing this control More...
 

Detailed Description

CheckBox control

Member Function Documentation

override void OmegaGUI.Model.CheckBox.Generate ( )
inlinepackagevirtual

Generates a control model from this control view

Implements OmegaGUI.Model.Control.

Reimplemented in OmegaGUI.Model.RadioButton.

Property Documentation

virtual bool OmegaGUI.Model.CheckBox.Checked
getset

Is this control currently checked?

string OmegaGUI.Model.CheckBox.OnChanged
getset

A Lua script to execute when the control's value has changed

override string OmegaGUI.Model.CheckBox.Text
getset

The text displayed on the control


The documentation for this class was generated from the following file: