Abstract base class for all control models More...

Inheritance diagram for OmegaGUI.Render.Control:

Public Member Functions
override string	ToString ()

virtual void	OnInitialize ()
	Initialize the control More...

abstract void	Render (Device device, float elapsedTime)
	Render the control More...

virtual bool	MsgProc (IntPtr hWnd, WindowMessage msg, IntPtr wParam, IntPtr lParam)
	Message Handler More...

virtual bool	HandleKeyboard (WindowMessage msg, IntPtr wParam, IntPtr lParam)
	Handle the keyboard data More...

virtual bool	HandleMouse (WindowMessage msg, Point pt, IntPtr wParam, IntPtr lParam)
	Handle the mouse data 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	OnHotKey ()
	Called when the control's hotkey is hit 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
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
	Control (Dialog parent)
	Create a new instance of a control More...

virtual void	UpdateRectangles ()
	Updates the rectangles More...

Protected Attributes
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< Element >	elementList = new List<Element>()

Properties
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	MouseEnter

Detailed Description

Abstract base class for all control models

Constructor & Destructor Documentation

◆ Control()

OmegaGUI.Render.Control.Control ( Dialog parent )

inlineprotected

Create a new instance of a control

Member Function Documentation

◆ ContainsPoint()

virtual bool OmegaGUI.Render.Control.ContainsPoint ( Point pt )

inlinevirtual

Does the control contain this point

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

◆ HandleKeyboard()

virtual bool OmegaGUI.Render.Control.HandleKeyboard	(	WindowMessage	msg,
		IntPtr	wParam,
		IntPtr	lParam
	)

inlinevirtual

Handle the keyboard data

Reimplemented in OmegaGUI.Render.TextBox, OmegaGUI.Render.Slider, OmegaGUI.Render.DropdownList, OmegaGUI.Render.CheckBox, OmegaGUI.Render.ListBox, OmegaGUI.Render.RadioButton, and OmegaGUI.Render.Button.

◆ HandleMouse()

virtual bool OmegaGUI.Render.Control.HandleMouse	(	WindowMessage	msg,
		Point	pt,
		IntPtr	wParam,
		IntPtr	lParam
	)

inlinevirtual

Handle the mouse data

Reimplemented in OmegaGUI.Render.TextBox, OmegaGUI.Render.DropdownList, OmegaGUI.Render.ListBox, OmegaGUI.Render.ScrollBar, OmegaGUI.Render.CheckBox, OmegaGUI.Render.Slider, OmegaGUI.Render.RadioButton, and OmegaGUI.Render.Button.

◆ MsgProc()

virtual bool OmegaGUI.Render.Control.MsgProc	(	IntPtr	hWnd,
		WindowMessage	msg,
		IntPtr	wParam,
		IntPtr	lParam
	)

inlinevirtual

Message Handler

Reimplemented in OmegaGUI.Render.TextBox.

◆ OnFocusIn()

virtual void OmegaGUI.Render.Control.OnFocusIn ( )

inlinevirtual

Called when control gets focus

Reimplemented in OmegaGUI.Render.TextBox.

◆ OnFocusOut()

virtual void OmegaGUI.Render.Control.OnFocusOut ( )

inlinevirtual

Called when control loses focus

Reimplemented in OmegaGUI.Render.DropdownList.

◆ OnHotKey()

virtual void OmegaGUI.Render.Control.OnHotKey ( )

inlinevirtual

Called when the control's hotkey is hit

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

◆ OnInitialize()

virtual void OmegaGUI.Render.Control.OnInitialize ( )

inlinevirtual

Initialize the control

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

◆ OnMouseEnter()

virtual void OmegaGUI.Render.Control.OnMouseEnter ( )

inlinevirtual

Called when mouse goes over the control

◆ OnMouseExit()

virtual void OmegaGUI.Render.Control.OnMouseExit ( )

inlinevirtual

Called when mouse leaves the control

◆ Refresh()

virtual void OmegaGUI.Render.Control.Refresh ( )

inlinevirtual

Refreshes the control

◆ Render()

abstract void OmegaGUI.Render.Control.Render	(	Device	device,
		float	elapsedTime
	)

pure virtual

Render the control

Implemented in OmegaGUI.Render.TextBox, OmegaGUI.Render.ListBox, OmegaGUI.Render.DropdownList, OmegaGUI.Render.Slider, OmegaGUI.Render.ScrollBar, OmegaGUI.Render.Button, OmegaGUI.Render.CheckBox, OmegaGUI.Render.Label, OmegaGUI.Render.GroupBox, and OmegaGUI.Render.PictureBox.

◆ SetLocation()

virtual void OmegaGUI.Render.Control.SetLocation	(	int	x,
		int	y
	)

inlinevirtual

Called to set control's location

◆ SetSize()

virtual void OmegaGUI.Render.Control.SetSize	(	int	w,
		int	h
	)

inlinevirtual

Called to set control's size

◆ UpdateRectangles()

virtual void OmegaGUI.Render.Control.UpdateRectangles ( )

inlineprotectedvirtual

Updates the rectangles

Reimplemented in OmegaGUI.Render.TextBox, OmegaGUI.Render.Slider, OmegaGUI.Render.CheckBox, OmegaGUI.Render.ListBox, OmegaGUI.Render.DropdownList, and OmegaGUI.Render.ScrollBar.

Member Data Documentation

◆ CanHaveFocus

virtual bool OmegaGUI.Render.Control.CanHaveFocus => false

Can the control have focus

◆ ControlType

virtual ControlType OmegaGUI.Render.Control.ControlType => ctrlType

Type of the control

◆ Parent

Dialog OmegaGUI.Render.Control.Parent => parentDialog

The parent dialog of this control

Property Documentation

◆ Hotkey

virtual Keys OmegaGUI.Render.Control.Hotkey

getset

The controls hotkey

◆ ID

virtual int OmegaGUI.Render.Control.ID

getset

Unique ID of the control

◆ IsEnabled

virtual bool OmegaGUI.Render.Control.IsEnabled

getset

Is the control enabled

◆ IsVisible

virtual bool OmegaGUI.Render.Control.IsVisible

getset

Is the control visible

◆ this[uint elementIndex]

Element OmegaGUI.Render.Control.this[uint elementIndex]

getset

Index for the elements this control has access to

◆ UserData

object OmegaGUI.Render.Control.UserData

getset

User specified data

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

OmegaGUI/Render/Control.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Events

Detailed Description

Constructor & Destructor Documentation

◆ Control()

Member Function Documentation

◆ ContainsPoint()

◆ HandleKeyboard()

◆ HandleMouse()

◆ MsgProc()

◆ OnFocusIn()

◆ OnFocusOut()

◆ OnHotKey()

◆ OnInitialize()

◆ OnMouseEnter()

◆ OnMouseExit()

◆ Refresh()

◆ Render()

◆ SetLocation()

◆ SetSize()

◆ UpdateRectangles()

Member Data Documentation

◆ CanHaveFocus

◆ ControlType

◆ Parent

Property Documentation

◆ Hotkey

◆ ID

◆ IsEnabled

◆ IsVisible

◆ this[uint elementIndex]

◆ UserData