AlphaFramework API  1.0.3
Public Member Functions | Protected Member Functions | List of all members
AlphaFramework.Editor.AsyncWaitDialog Class Reference

Displays a "Loading..." dialog box in a separate GUI thread for cases where the main message pump is blocked. More...

Inheritance diagram for AlphaFramework.Editor.AsyncWaitDialog:

Public Member Functions

 AsyncWaitDialog ([NotNull, Localizable(true)] string title, [CanBeNull] Icon icon=null)
 Creates a new asynchrnous waiting dialog. More...
 
void Start ()
 Starts a new message pump with this dialog in a new thread. More...
 
void Stop ()
 Closes the dialog and stops the separate message pump. More...
 

Protected Member Functions

override void Dispose (bool disposing)
 Clean up any resources being used. More...
 

Detailed Description

Displays a "Loading..." dialog box in a separate GUI thread for cases where the main message pump is blocked.

Constructor & Destructor Documentation

◆ AsyncWaitDialog()

AlphaFramework.Editor.AsyncWaitDialog.AsyncWaitDialog ( [NotNull, Localizable(true)] string  title,
[CanBeNull] Icon  icon = null 
)
inline

Creates a new asynchrnous waiting dialog.

Parameters
titleThe title of th dialog to display.
iconThe icon for the dialog to display in the task bar; can be null.

Member Function Documentation

◆ Dispose()

override void AlphaFramework.Editor.AsyncWaitDialog.Dispose ( bool  disposing)
inlineprotected

Clean up any resources being used.

Parameters
disposingtrue if managed resources should be disposed; otherwise, false.

◆ Start()

void AlphaFramework.Editor.AsyncWaitDialog.Start ( )
inline

Starts a new message pump with this dialog in a new thread.

◆ Stop()

void AlphaFramework.Editor.AsyncWaitDialog.Stop ( )
inline

Closes the dialog and stops the separate message pump.


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