OmegaGUI.DialogRenderer Class Reference

Displays a Dialog using Render.Dialog. More...

Inheritance diagram for OmegaGUI.DialogRenderer:

Public Member Functions
override string	ToString ()
	DialogRenderer (GuiManager manager, string filename, Point location=new Point(), Lua lua=null)
	Creates a new dialog renderer from an XML file More...
	DialogRenderer (GuiManager manager, Dialog dialog, Point location=new Point(), Lua lua=null)
	Creates a new dialog renderer for a Model.Dialog More...
void	Show ()
	Show the dialog More...
void	ShowModal ()
	Show the dialog with exclusive mouse handling More...
void	Update ()
	Update the dialog output More...
void	Close ()
	Closes the dialog More...
void	ImportLua (string filename)
	Imports an external Lua script into the GUI's Lua instance More...
Control	GetControl (string name)
	Gets the first Model.Control in this DialogRenderer with the specified name More...
void	SetLocation (int x, int y)
	Changes the dialog's on-screen position. More...
void	MsgBox (string text)
void	MsgBox (string text, Action< Render.MsgBoxResult > callback)
void	MsgBox (string text, Render.MsgBoxType type, Action< Render.MsgBoxResult > callback)
void	Dispose ()
	Removes the Engine hooks and queues the LuaInterface.Lua interpreter for disposal More...

Properties
bool	Disposed [get]
	Has this dialog been disposed? More...
string	Name [get, set]
	Text value to make it easier to identify a particular dialog More...
Dialog	DialogModel [get]
	The dialog to be displayed More...
Render.Dialog	DialogRender [get]
	The rendering system used to display DialogModel More...

Detailed Description

Displays a Dialog using Render.Dialog.

Constructor & Destructor Documentation

DialogRenderer() [1/2]

OmegaGUI.DialogRenderer.DialogRenderer ( GuiManager  manager, string  filename, Point  location = new Point(), Lua  lua = null  )

inline

Creates a new dialog renderer from an XML file

Parameters

manager	The GuiManager used to interface with the Engine
filename	The filename of the XML file to load
location	The location of the dialog on the screen
lua	The scripting engine to execute event handlers.

DialogRenderer() [2/2]

OmegaGUI.DialogRenderer.DialogRenderer ( GuiManager  manager, Dialog  dialog, Point  location = new Point(), Lua  lua = null  )

inline

Creates a new dialog renderer for a Model.Dialog

Parameters

manager	The GuiManager used to interface with the Engine
dialog	The dialog to be displayed
location	The location of the dialog on the screen
lua	The scripting engine to execute event handlers.

Member Function Documentation

Close()

void OmegaGUI.DialogRenderer.Close ( )

inline

Closes the dialog

Dispose()

void OmegaGUI.DialogRenderer.Dispose ( )

inline

Removes the Engine hooks and queues the LuaInterface.Lua interpreter for disposal

GetControl()

Control OmegaGUI.DialogRenderer.GetControl ( string  name )

inline

Gets the first Model.Control in this DialogRenderer with the specified name

Exceptions

ArgumentNullException	name is null.
KeyNotFoundException	An element with the specified key does not exist in the dictionary.

ImportLua()

void OmegaGUI.DialogRenderer.ImportLua ( string  filename )

inline

Imports an external Lua script into the GUI's Lua instance

Parameters

filename

The Lua file to import

SetLocation()

void OmegaGUI.DialogRenderer.SetLocation ( int  x, int  y  )

inline

Changes the dialog's on-screen position.

Show()

void OmegaGUI.DialogRenderer.Show ( )

inline

Show the dialog

ShowModal()

void OmegaGUI.DialogRenderer.ShowModal ( )

inline

Show the dialog with exclusive mouse handling

Update()

void OmegaGUI.DialogRenderer.Update ( )

inline

Update the dialog output

Property Documentation

DialogModel

Dialog OmegaGUI.DialogRenderer.DialogModel

get

The dialog to be displayed

DialogRender

Render.Dialog OmegaGUI.DialogRenderer.DialogRender

get

The rendering system used to display DialogModel

Disposed

bool OmegaGUI.DialogRenderer.Disposed

get

Has this dialog been disposed?

Name

string OmegaGUI.DialogRenderer.Name

getset

Text value to make it easier to identify a particular dialog

---

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

• OmegaGUI/DialogRenderer.cs