Abstract base class for all control views More...
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 |
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
◆ 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
Member Data Documentation
◆ DrawBox
| Rectangle OmegaGUI.Model.Control.DrawBox => new Rectangle(EffectiveLocation, EffectiveSize) |
The effective area on the window were this control is rendered
◆ DXControl
|
protected |
The OmegaGUI.Render control used for actual rendering
◆ EffectiveLocation
|
protected |
The actual location of the control on the dialog factoring in AlignHorizontal and AlignVertical
◆ EffectiveSize
|
protected |
The actual size of the control on the dialog factoring in scaling due to Dialog.Scale
Property Documentation
◆ AlignHorizontal
|
getset |
How to handle the X values of Location and Size
◆ AlignVertical
|
getset |
How to handle the Y values of Location and Size
◆ Default
|
getset |
Is this the default control on the dialog? - no auto-update
◆ Enabled
|
getset |
Is this control currently active?
◆ Location
|
getset |
The location of the control on the dialog
◆ Name
|
getset |
Unique name for identifying this control
◆ OnMouseEnter
|
getset |
A Lua script to execute when the mouse enters the area of the control
◆ OnMouseExit
|
getset |
A Lua script to execute when the mouse leaves the area of the control
◆ Size
|
getset |
The size of the control on the dialog
◆ Visible
|
getset |
Is this control currently visible?
The documentation for this class was generated from the following file:
- OmegaGUI/Model/Control.cs
