Dialog Class Reference

Modal Dialog. More...

Inheritance diagram for Dialog:
ContainerWidget Widget MessageDialog

List of all members.

Public Member Functions

 Dialog ()
 Constructor.
 Dialog (Effect showEffect, Effect hideEffect)
 Constructor.
void Show ()
 Displays the dialog box.
void Show (Effect effect)
 Displays the dialog box.
void Hide ()
 Hides the dialog box.
void Hide (Effect effect)
 Hides the dialog box.

Protected Member Functions

override void DisposeSelf ()
 Frees used resources.
internal override void Render ()
 Renders a scene graph.

Properties

override float Width [get, set]
 Obtains and sets the width.
override float Height [get, set]
 Obtains and sets the height.
Effect ShowEffect [get, set]
 Obtains and sets the effect when displaying a dialog.
Effect HideEffect [get, set]
 Obtains and sets the effect when hiding a dialog.
DialogBackgroundStyle BackgroundStyle [get, set]
 Obtains and sets the background type of the dialog.
ImageAsset CustomBackgroundImage [get, set]
 Obtains and sets the background image of the dialog.
NinePatchMargin CustomBackgroundNinePatchMargin [get, set]
 Obtains and sets 9PatchMargin of the background image of the dialog.
UIColor CustomBackgroundColor [get, set]
 Obtains and sets the background color of the dialog.
UIColor BackgroundFilterColor [get, set]
 Obtains and sets the color that multiplies in the background image.
bool HideOnTouchOutside [get, set]
 Whether to close a dialog when the outside of the dialog is touched.
Widget DefaultFocusWidget [get, set]
 Widget in focus first.
DialogResult Result [get, set]
 Obtains and sets the dialog result.

Events

EventHandler Showing
 Event issued when a dialog is displayed.
EventHandler Shown
 Event issued when a dialog is displayed.
EventHandler< DialogEventArgsHiding
 Event issued when a dialog disappears.
EventHandler< DialogEventArgsHidden
 Event issued when a dialog has disappeared.

Detailed Description

Modal Dialog.

Any part can be listed.


Member Function Documentation

void Hide ( Effect  effect)

Hides the dialog box.

Parameters:
effectEffect when the dialog is displayed
void Show ( Effect  effect)

Displays the dialog box.

Parameters:
effectEffect when the dialog is displayed

Property Documentation

UIColor CustomBackgroundColor [get, set]

Obtains and sets the background color of the dialog.

This is enabled only when BackgroundStyle is Custom.

ImageAsset CustomBackgroundImage [get, set]

Obtains and sets the background image of the dialog.

This is enabled only when BackgroundStyle is Custom. When null is set, the background image is not displayed.

NinePatchMargin CustomBackgroundNinePatchMargin [get, set]

Obtains and sets 9PatchMargin of the background image of the dialog.

This is enabled only when BackgroundStyle is Custom and CustomBackgroundImage is set.

Widget DefaultFocusWidget [get, set]

Widget in focus first.

When there is null, the default widget is used.

Effect HideEffect [get, set]

Obtains and sets the effect when hiding a dialog.

When there is null, the effect is not used.

Effect ShowEffect [get, set]

Obtains and sets the effect when displaying a dialog.

When there is null, the effect is not used.


Event Documentation

EventHandler<DialogEventArgs> Hidden

Event issued when a dialog has disappeared.

This is issued at the time an Effect is terminated when a HideEffect is set.

EventHandler<DialogEventArgs> Hiding

Event issued when a dialog disappears.

This is issued before an Effect is started when a HideEffect is set.

EventHandler Showing

Event issued when a dialog is displayed.

This is issued before an Effect is started when a ShowEffect is set.

EventHandler Shown

Event issued when a dialog is displayed.

This is issued at the time an Effect is terminated when a ShowEffect is set.