An XML-serializable dialog view More...

Inheritance diagram for OmegaGUI.Model.Dialog:

Public Member Functions
override string	ToString ()

ICollection< Control >	PickControls (Rectangle area)
	Finds Controls within a certain area More...

void	MsgBox (string text, MsgBoxType type, Action< MsgBoxResult > callback)

Dialog	Clone ()
	Creates a deep copy of this dialog. You need to call GenerateRender on it before it can be used for rendering. More...

Public Member Functions inherited from NanoByte.Common.ICloneable< Dialog >
Dialog	Clone ()

Static Public Member Functions
static Dialog	FromContent (string id)
	Loads a dialog from an XML file via the ContentManager. More...

Public Attributes
XColor	ColorBackground
	Used for XML serialization. More...

bool	TextureFileValid => !string.IsNullOrEmpty(_textureFile) && ContentManager.FileExists("GUI/Textures", _textureFile)

float	EffectiveScale => _scale * _autoScale
	The effective scale resulting from the user-defined and automatic scaling to fullscreen More...

Collection< ButtonStyle >	ButtonStyles => _buttonStyles
	A list of all custom button styles available in the dialog More...

BindingList< Control >	Controls => _controls
	A list of all controls on the dialog More...

Properties
static CultureInfo	ResourceCulture `[get, set]`
	The culture used for loading the assembly resources More...

bool	NeedsUpdate `[get, set]`
	A flag to determine whether the model counterpart to this dialog vuew needs to be recreated to reflect changes made to properties More...

string	CaptionText `[get, set]`
	The caption text displayed at the top of this dialog More...

int	CaptionHeight `[get, set]`
	The height of caption displayed at the top of this dialog More...

bool	Animate = true `[get, set]`
	Shall this dialog use animations? More...

Color	BackgroundColor `[get, set]`
	The dialog's background color More...

Color	CaptionColor `[get, set]`
	The dialog's caption bar color More...

Color	TextColor `[get, set]`
	The color of text on the dialog - no auto-update More...

string	OnShow `[get, set]`
	A script to be run when the dialog is first shown More...

string	OnUpdate `[get, set]`
	A script to be run after the dialog was first shown and whenever it needs to update its output More...

string	TextureFile `[get, set]`
	The file containing the texture for controls on this dialog - no auto-update More...

string	FontName `[get, set]`
	The name of font for text on controls - no auto-update More...

uint	FontSize `[get, set]`
	The font size More...

Size	Size `[get, set]`
	The initial size of the dialog, used for auto-scaling fullscreen dialogs - no auto-update More...

Point	Shift `[get, set]`
	A set of coordinates by which all control positions are shifted More...

float	Scale `[get, set]`
	A factor by which all sizes are multiplied, is ignored in fullscreen mode More...

bool	Fullscreen `[get, set]`
	Shall this dialog be auto-scaled to fill the complete screen? - no auto-update More...

bool	Visible = true `[get, set]`
	Is this dialog currently visible? More...

Control	this[string name] `[get]`
	Gets the first Control in this Dialog with the specified name More...

Events
ScriptExecution	ScriptFired
	Occurs whenever one of the controls fires a script More...

Detailed Description

An XML-serializable dialog view

Member Function Documentation

◆ Clone()

Dialog OmegaGUI.Model.Dialog.Clone ( )

inline

Creates a deep copy of this dialog. You need to call GenerateRender on it before it can be used for rendering.

Returns: The cloned dialog.

◆ FromContent()

static Dialog OmegaGUI.Model.Dialog.FromContent ( string id )

inlinestatic

Loads a dialog from an XML file via the ContentManager.

Parameters

id	The ID of the file to load from

Returns: The loaded dialog

◆ PickControls()

ICollection<Control> OmegaGUI.Model.Dialog.PickControls ( Rectangle area )

inline

Finds Controls within a certain area

Parameters

area	The coordinate area to look in

Returns: A list of all Controls with the area .

Member Data Documentation

◆ ButtonStyles

Collection<ButtonStyle> OmegaGUI.Model.Dialog.ButtonStyles => _buttonStyles

A list of all custom button styles available in the dialog

◆ ColorBackground

XColor OmegaGUI.Model.Dialog.ColorBackground

Used for XML serialization.

◆ Controls

BindingList<Control> OmegaGUI.Model.Dialog.Controls => _controls

A list of all controls on the dialog

◆ EffectiveScale

float OmegaGUI.Model.Dialog.EffectiveScale => _scale * _autoScale

The effective scale resulting from the user-defined and automatic scaling to fullscreen

Property Documentation

◆ Animate

bool OmegaGUI.Model.Dialog.Animate = true

getset

Shall this dialog use animations?

◆ BackgroundColor

Color OmegaGUI.Model.Dialog.BackgroundColor

getset

The dialog's background color

◆ CaptionColor

Color OmegaGUI.Model.Dialog.CaptionColor

getset

The dialog's caption bar color

◆ CaptionHeight

int OmegaGUI.Model.Dialog.CaptionHeight

getset

The height of caption displayed at the top of this dialog

◆ CaptionText

string OmegaGUI.Model.Dialog.CaptionText

getset

The caption text displayed at the top of this dialog

◆ FontName

string OmegaGUI.Model.Dialog.FontName

getset

The name of font for text on controls - no auto-update

◆ FontSize

uint OmegaGUI.Model.Dialog.FontSize

getset

The font size

◆ Fullscreen

bool OmegaGUI.Model.Dialog.Fullscreen

getset

Shall this dialog be auto-scaled to fill the complete screen? - no auto-update

◆ NeedsUpdate

bool OmegaGUI.Model.Dialog.NeedsUpdate

getset

A flag to determine whether the model counterpart to this dialog vuew needs to be recreated to reflect changes made to properties

◆ OnShow

string OmegaGUI.Model.Dialog.OnShow

getset

A script to be run when the dialog is first shown

◆ OnUpdate

string OmegaGUI.Model.Dialog.OnUpdate

getset

A script to be run after the dialog was first shown and whenever it needs to update its output

◆ ResourceCulture

CultureInfo OmegaGUI.Model.Dialog.ResourceCulture

staticgetset

The culture used for loading the assembly resources

◆ Scale

float OmegaGUI.Model.Dialog.Scale

getset

A factor by which all sizes are multiplied, is ignored in fullscreen mode

◆ Shift

Point OmegaGUI.Model.Dialog.Shift

getset

A set of coordinates by which all control positions are shifted

◆ Size

Size OmegaGUI.Model.Dialog.Size

getset

The initial size of the dialog, used for auto-scaling fullscreen dialogs - no auto-update

◆ TextColor

Color OmegaGUI.Model.Dialog.TextColor

getset

The color of text on the dialog - no auto-update

◆ TextureFile

string OmegaGUI.Model.Dialog.TextureFile

getset

The file containing the texture for controls on this dialog - no auto-update

◆ this[string name]

Control OmegaGUI.Model.Dialog.this[string name]

get

Gets the first Control in this Dialog with the specified name

Exceptions

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

◆ Visible

bool OmegaGUI.Model.Dialog.Visible = true

getset

Is this dialog currently visible?

Event Documentation

◆ ScriptFired

ScriptExecution OmegaGUI.Model.Dialog.ScriptFired

Occurs whenever one of the controls fires a script

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

OmegaGUI/Model/Dialog.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Properties

Events

Detailed Description

Member Function Documentation

◆ Clone()

◆ FromContent()

◆ PickControls()

Member Data Documentation

◆ ButtonStyles

◆ ColorBackground

◆ Controls

◆ EffectiveScale

Property Documentation

◆ Animate

◆ BackgroundColor

◆ CaptionColor

◆ CaptionHeight

◆ CaptionText

◆ FontName

◆ FontSize

◆ Fullscreen

◆ NeedsUpdate

◆ OnShow

◆ OnUpdate

◆ ResourceCulture

◆ Scale

◆ Shift

◆ Size

◆ TextColor

◆ TextureFile

◆ this[string name]

◆ Visible

Event Documentation

◆ ScriptFired