OmegaEngine API  1.0.3
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | Events | List of all members
OmegaGUI.Render.CheckBox Class Reference

CheckBox control More...

Inheritance diagram for OmegaGUI.Render.CheckBox:
OmegaGUI.Render.Button OmegaGUI.Render.Label OmegaGUI.Render.Control OmegaGUI.Render.RadioButton

Public Member Functions

 CheckBox (Dialog parent)
 Create new checkbox instance More...
 
override void OnHotKey ()
 Override hotkey to fire event More...
 
override bool ContainsPoint (Point pt)
 Does the control contain the point? More...
 
override void Render (Device device, float elapsedTime)
 Render the checkbox control More...
 
override bool HandleKeyboard (WindowMessage msg, IntPtr wParam, IntPtr lParam)
 Handle the keyboard for the checkbox More...
 
override bool HandleMouse (WindowMessage msg, Point pt, IntPtr wParam, IntPtr lParam)
 Handle mouse messages from the checkbox More...
 
- Public Member Functions inherited from OmegaGUI.Render.Button
 Button (Dialog parent)
 Create new button instance More...
 
- Public Member Functions inherited from OmegaGUI.Render.Label
 Label (Dialog parent)
 Create a new instance of a static text control More...
 
override void Render (Device device, float elapsedTime)
 Render this control More...
 
string GetTextCopy ()
 Return a copy of the string More...
 
void SetText (string newText)
 Sets the updated text for this control More...
 
- Public Member Functions inherited from OmegaGUI.Render.Control
override string ToString ()
 
virtual void OnInitialize ()
 Initialize the control More...
 
virtual bool MsgProc (IntPtr hWnd, WindowMessage msg, IntPtr wParam, IntPtr lParam)
 Message Handler More...
 
virtual void OnFocusIn ()
 Called when control gets focus More...
 
virtual void OnFocusOut ()
 Called when control loses focus More...
 
virtual void OnMouseEnter ()
 Called when mouse goes over the control More...
 
virtual void OnMouseExit ()
 Called when mouse leaves the control More...
 
virtual void SetLocation (int x, int y)
 Called to set control's location More...
 
virtual void SetSize (int w, int h)
 Called to set control's size More...
 
virtual void Refresh ()
 Refreshes the control More...
 

Public Attributes

const int BoxLayer = 0
 
const int CheckLayer = 1
 
- Public Attributes inherited from OmegaGUI.Render.Button
const int ButtonLayer = 0
 
const int FillLayer = 1
 
override bool CanHaveFocus => IsVisible && IsEnabled
 Can the button have focus More...
 
- Public Attributes inherited from OmegaGUI.Render.Control
uint index
 
bool IsDefault
 
Dialog Parent => parentDialog
 The parent dialog of this control More...
 
virtual bool CanHaveFocus => false
 Can the control have focus More...
 
virtual ControlType ControlType => ctrlType
 Type of the control More...
 

Protected Member Functions

void RaiseChangedEvent (CheckBox sender, bool wasTriggeredByUser)
 Create new button instance More...
 
virtual void SetCheckedInternal (bool ischecked, bool fromInput)
 Sets the checked state and fires the event if necessary More...
 
override void UpdateRectangles ()
 Update the rectangles More...
 
- Protected Member Functions inherited from OmegaGUI.Render.Button
void RaiseClickEvent (Button sender, bool wasTriggeredByUser)
 Create new button instance More...
 
- Protected Member Functions inherited from OmegaGUI.Render.Control
 Control (Dialog parent)
 Create a new instance of a control More...
 

Protected Attributes

Rectangle buttonRect
 
Rectangle textRect
 
bool isBoxChecked
 
- Protected Attributes inherited from OmegaGUI.Render.Button
bool isPressed
 
- Protected Attributes inherited from OmegaGUI.Render.Label
string textData
 
- Protected Attributes inherited from OmegaGUI.Render.Control
Dialog parentDialog
 
object localUserData
 
bool visible = true
 
bool isMouseOver
 
bool hasFocus
 
int controlId
 
ControlType ctrlType
 
Keys ctrlHotKey
 
bool enabled = true
 
Rectangle boundingBox
 
int controlX
 
List< ElementelementList = new List<Element>()
 

Properties

virtual bool IsChecked [get, set]
 Checked property More...
 
- Properties inherited from OmegaGUI.Render.Label
TextAlign TextAlign [get, set]
 
- Properties inherited from OmegaGUI.Render.Control
object UserData [get, set]
 User specified data More...
 
virtual bool IsEnabled [get, set]
 Is the control enabled More...
 
virtual bool IsVisible [get, set]
 Is the control visible More...
 
virtual int ID [get, set]
 Unique ID of the control More...
 
virtual Keys Hotkey [get, set]
 The controls hotkey More...
 
Element this[uint elementIndex] [get, set]
 Index for the elements this control has access to More...
 

Events

EventHandler Changed
 
- Events inherited from OmegaGUI.Render.Button
EventHandler Click
 
- Events inherited from OmegaGUI.Render.Control
EventHandler MouseEnter
 

Detailed Description

CheckBox control

Constructor & Destructor Documentation

◆ CheckBox()

OmegaGUI.Render.CheckBox.CheckBox ( Dialog  parent)
inline

Create new checkbox instance

Member Function Documentation

◆ ContainsPoint()

override bool OmegaGUI.Render.CheckBox.ContainsPoint ( Point  pt)
inlinevirtual

Does the control contain the point?

Reimplemented from OmegaGUI.Render.Control.

◆ HandleKeyboard()

override bool OmegaGUI.Render.CheckBox.HandleKeyboard ( WindowMessage  msg,
IntPtr  wParam,
IntPtr  lParam 
)
inlinevirtual

Handle the keyboard for the checkbox

Reimplemented from OmegaGUI.Render.Button.

Reimplemented in OmegaGUI.Render.RadioButton.

◆ HandleMouse()

override bool OmegaGUI.Render.CheckBox.HandleMouse ( WindowMessage  msg,
Point  pt,
IntPtr  wParam,
IntPtr  lParam 
)
inlinevirtual

Handle mouse messages from the checkbox

Reimplemented from OmegaGUI.Render.Button.

Reimplemented in OmegaGUI.Render.RadioButton.

◆ OnHotKey()

override void OmegaGUI.Render.CheckBox.OnHotKey ( )
inlinevirtual

Override hotkey to fire event

Reimplemented from OmegaGUI.Render.Button.

Reimplemented in OmegaGUI.Render.RadioButton.

◆ RaiseChangedEvent()

void OmegaGUI.Render.CheckBox.RaiseChangedEvent ( CheckBox  sender,
bool  wasTriggeredByUser 
)
inlineprotected

Create new button instance

◆ Render()

override void OmegaGUI.Render.CheckBox.Render ( Device  device,
float  elapsedTime 
)
inlinevirtual

Render the checkbox control

Reimplemented from OmegaGUI.Render.Button.

◆ SetCheckedInternal()

virtual void OmegaGUI.Render.CheckBox.SetCheckedInternal ( bool  ischecked,
bool  fromInput 
)
inlineprotectedvirtual

Sets the checked state and fires the event if necessary

◆ UpdateRectangles()

override void OmegaGUI.Render.CheckBox.UpdateRectangles ( )
inlineprotectedvirtual

Update the rectangles

Reimplemented from OmegaGUI.Render.Control.

Property Documentation

◆ IsChecked

virtual bool OmegaGUI.Render.CheckBox.IsChecked
getset

Checked property


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