OmegaEngine API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Events | List of all members
OmegaGUI.Render.Button Class Reference

Button control More...

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

Public Member Functions

 Button (Dialog parent)
 Create new button instance More...
 
override void OnHotKey ()
 The hotkey for this button was pressed More...
 
override bool HandleKeyboard (WindowMessage msg, IntPtr wParam, IntPtr lParam)
 Will handle the keyboard strokes More...
 
override bool HandleMouse (WindowMessage msg, Point pt, IntPtr wParam, IntPtr lParam)
 Handle mouse messages from the buttons More...
 
override void Render (Device device, float elapsedTime)
 Render the button 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 bool ContainsPoint (Point pt)
 Does the control contain this point 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 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 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...
 
virtual void UpdateRectangles ()
 Updates the rectangles More...
 

Protected Attributes

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>()
 

Events

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

Additional Inherited Members

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

Detailed Description

Button control

Constructor & Destructor Documentation

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

Create new button instance

Member Function Documentation

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

Will handle the keyboard strokes

Reimplemented from OmegaGUI.Render.Control.

Reimplemented in OmegaGUI.Render.DropdownList, OmegaGUI.Render.CheckBox, and OmegaGUI.Render.RadioButton.

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

Handle mouse messages from the buttons

Reimplemented from OmegaGUI.Render.Control.

Reimplemented in OmegaGUI.Render.DropdownList, OmegaGUI.Render.CheckBox, and OmegaGUI.Render.RadioButton.

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

The hotkey for this button was pressed

Reimplemented from OmegaGUI.Render.Control.

Reimplemented in OmegaGUI.Render.DropdownList, OmegaGUI.Render.CheckBox, and OmegaGUI.Render.RadioButton.

void OmegaGUI.Render.Button.RaiseClickEvent ( Button  sender,
bool  wasTriggeredByUser 
)
inlineprotected

Create new button instance

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

Render the button

Implements OmegaGUI.Render.Control.

Reimplemented in OmegaGUI.Render.DropdownList, and OmegaGUI.Render.CheckBox.

Member Data Documentation

override bool OmegaGUI.Render.Button.CanHaveFocus => IsVisible && IsEnabled

Can the button have focus


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