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

Abstract base class for all control views More...

Inheritance diagram for OmegaGUI.Model.Control:
OmegaGUI.Model.GroupBox OmegaGUI.Model.Label OmegaGUI.Model.ListBox OmegaGUI.Model.PictureBox OmegaGUI.Model.Slider OmegaGUI.Model.ButtonBase OmegaGUI.Model.TextBox OmegaGUI.Model.ScrollBar OmegaGUI.Model.Button OmegaGUI.Model.CheckBox OmegaGUI.Model.DropdownList OmegaGUI.Model.RadioButton

Public Member Functions

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

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

void NeedsUpdate ()
 
void SetupMouseEvents ()
 

Protected Attributes

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

abstract void Generate ()
 Generates a control model from this control view More...
 
void UpdateLayout ()
 Updates the control's location and size More...
 

Package Attributes

Dialog Parent
 The dialog containing this control More...
 

Properties

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...
 

Detailed Description

Abstract base class for all control views

Member Function Documentation

Control OmegaGUI.Model.Control.Clone ( )
inline

Creates a shallow copy of this control. You need to call Generate on it before it can be used for rendering.

Returns
The cloned control
abstract void OmegaGUI.Model.Control.Generate ( )
packagepure virtual
void OmegaGUI.Model.Control.UpdateLayout ( )
inlinepackage

Updates the control's location and size

Member Data Documentation

Rectangle OmegaGUI.Model.Control.DrawBox => new Rectangle(EffectiveLocation, EffectiveSize)

The effective area on the window were this control is rendered

Render.Control OmegaGUI.Model.Control.DXControl
protected

The OmegaGUI.Render control used for actual rendering

Point OmegaGUI.Model.Control.EffectiveLocation
protected

The actual location of the control on the dialog factoring in AlignHorizontal and AlignVertical

Size OmegaGUI.Model.Control.EffectiveSize
protected

The actual size of the control on the dialog factoring in scaling due to Dialog.Scale

Dialog OmegaGUI.Model.Control.Parent
package

The dialog containing this control

Property Documentation

HorizontalMode OmegaGUI.Model.Control.AlignHorizontal
getset

How to handle the X values of Location and Size

VerticalMode OmegaGUI.Model.Control.AlignVertical
getset

How to handle the Y values of Location and Size

bool OmegaGUI.Model.Control.Default
getset

Is this the default control on the dialog? - no auto-update

bool OmegaGUI.Model.Control.Enabled
getset

Is this control currently active?

Point OmegaGUI.Model.Control.Location
getset

The location of the control on the dialog

string OmegaGUI.Model.Control.Name
getset

Unique name for identifying this control

string OmegaGUI.Model.Control.OnMouseEnter
getset

A Lua script to execute when the mouse enters the area of the control

string OmegaGUI.Model.Control.OnMouseExit
getset

A Lua script to execute when the mouse leaves the area of the control

Size OmegaGUI.Model.Control.Size
getset

The size of the control on the dialog

bool OmegaGUI.Model.Control.Visible
getset

Is this control currently visible?


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