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

List box control More...

Inheritance diagram for OmegaGUI.Model.ListBox:
OmegaGUI.Model.Control

Package Functions

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

ListBoxStyle Style [get, set]
 The style of the list box More...
 
MonitoredCollection< string > Items [get]
 A list of strings selectable in the control More...
 
string SelectedItem [get, set]
 The currently selected item in the control More...
 
string OnSelection [get, set]
 A Lua script to execute when the user selects an entry More...
 
string OnDoubleClick [get, set]
 A Lua script to execute when the user double-clicks onto an entry 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 ()
 
- 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 Attributes inherited from OmegaGUI.Model.Control
Dialog Parent
 The dialog containing this control More...
 

Detailed Description

List box control

Member Function Documentation

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

Generates a control model from this control view

Implements OmegaGUI.Model.Control.

Property Documentation

MonitoredCollection<string> OmegaGUI.Model.ListBox.Items
get

A list of strings selectable in the control

string OmegaGUI.Model.ListBox.OnDoubleClick
getset

A Lua script to execute when the user double-clicks onto an entry

string OmegaGUI.Model.ListBox.OnSelection
getset

A Lua script to execute when the user selects an entry

string OmegaGUI.Model.ListBox.SelectedItem
getset

The currently selected item in the control

ListBoxStyle OmegaGUI.Model.ListBox.Style
getset

The style of the list box


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