TriEngine  v0.0.16
General-purpose engine in C#/OpenGL
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events
TriDevs.TriEngine.UI.IControl Interface Reference

A UI control that can be drawn on screen and interacted with. More...

Inheritance diagram for TriDevs.TriEngine.UI.IControl:
[legend]
Collaboration diagram for TriDevs.TriEngine.UI.IControl:
[legend]

Public Member Functions

void Enable ()
 Enables the control. More...
 
void Disable ()
 Disables the control. More...
 
void Show ()
 Shows the control. More...
 
void Hide ()
 Hides the control. More...
 
- Public Member Functions inherited from TriDevs.TriEngine.Interfaces.IUpdatable
void Update ()
 Updates the object. More...
 
- Public Member Functions inherited from TriDevs.TriEngine.Interfaces.IDrawable
void Draw ()
 Draw the object to screen. More...
 

Properties

bool Enabled [get, set]
 Gets or sets a value indicating whether this control can be interacted with. More...
 
bool Visible [get, set]
 Gets or sets a value indicating whether this control should be drawn to the screen. More...
 
Color Color [get, set]
 The color of this control. More...
 
Point< int > Position [get, set]
 The position of this control, in pixel coordinates. More...
 
Point< int > Size [get, set]
 Gets or sets the size of this control, in pixels. More...
 
Rectangle Rectangle [get, set]
 Gets the rectangular area on the screen that this control is occupying. More...
 
string Text [get, set]
 Gets or sets the text associated with this control. More...
 

Events

ControlClickedEventHandler Clicked
 Raised when this control is clicked on by the user. More...
 

Detailed Description

A UI control that can be drawn on screen and interacted with.

Member Function Documentation

void TriDevs.TriEngine.UI.IControl.Disable ( )

Disables the control.

Implemented in TriDevs.TriEngine.UI.Control.

void TriDevs.TriEngine.UI.IControl.Enable ( )

Enables the control.

Implemented in TriDevs.TriEngine.UI.Control.

Here is the caller graph for this function:

void TriDevs.TriEngine.UI.IControl.Hide ( )

Hides the control.

Implemented in TriDevs.TriEngine.UI.Control.

Here is the caller graph for this function:

void TriDevs.TriEngine.UI.IControl.Show ( )

Shows the control.

Implemented in TriDevs.TriEngine.UI.Control.

Here is the caller graph for this function:

Property Documentation

Color TriDevs.TriEngine.UI.IControl.Color
getset

The color of this control.

bool TriDevs.TriEngine.UI.IControl.Enabled
getset

Gets or sets a value indicating whether this control can be interacted with.

Point<int> TriDevs.TriEngine.UI.IControl.Position
getset

The position of this control, in pixel coordinates.

Rectangle TriDevs.TriEngine.UI.IControl.Rectangle
getset

Gets the rectangular area on the screen that this control is occupying.

Point<int> TriDevs.TriEngine.UI.IControl.Size
getset

Gets or sets the size of this control, in pixels.

string TriDevs.TriEngine.UI.IControl.Text
getset

Gets or sets the text associated with this control.

bool TriDevs.TriEngine.UI.IControl.Visible
getset

Gets or sets a value indicating whether this control should be drawn to the screen.

Event Documentation

ControlClickedEventHandler TriDevs.TriEngine.UI.IControl.Clicked

Raised when this control is clicked on by the user.


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