OmegaEngine API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Properties | List of all members
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, set]
 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

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
managerThe GuiManager used to interface with the Engine
filenameThe filename of the XML file to load
locationThe location of the dialog on the screen
luaThe scripting engine to execute event handlers.
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
managerThe GuiManager used to interface with the Engine
dialogThe dialog to be displayed
locationThe location of the dialog on the screen
luaThe scripting engine to execute event handlers.

Member Function Documentation

void OmegaGUI.DialogRenderer.Close ( )
inline

Closes the dialog

void OmegaGUI.DialogRenderer.Dispose ( )
inline

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

Control OmegaGUI.DialogRenderer.GetControl ( string  name)
inline

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

Exceptions
ArgumentNullExceptionname is null.
KeyNotFoundExceptionAn element with the specified key does not exist in the dictionary.
void OmegaGUI.DialogRenderer.ImportLua ( string  filename)
inline

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

Parameters
filenameThe Lua file to import
void OmegaGUI.DialogRenderer.SetLocation ( int  x,
int  y 
)
inline

Changes the dialog's on-screen position.

void OmegaGUI.DialogRenderer.Show ( )
inline

Show the dialog

void OmegaGUI.DialogRenderer.ShowModal ( )
inline

Show the dialog with exclusive mouse handling

void OmegaGUI.DialogRenderer.Update ( )
inline

Update the dialog output

Property Documentation

Dialog OmegaGUI.DialogRenderer.DialogModel
get

The dialog to be displayed

Render.Dialog OmegaGUI.DialogRenderer.DialogRender
get

The rendering system used to display DialogModel

bool OmegaGUI.DialogRenderer.Disposed
getset

Has this dialog been disposed?

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: