private.sysMsgBoxFrame - WIN

Class sysMsgBoxFrame
Inherits from applicationFrame.

The sysMsgBoxFrame class provides a message box application. It is dressed with a title bar and close button. The message is wrapped as needed and the message box frame sized appropriately, blocking all other user interaction until the message box is dismissed. The class is defined privately in the win API. To display a system message box call desktopWindow:msgbox. Use parentFrame:msgbox for an application message box.

Properties

sysMsgBox__active_frame
parentFrame
Stores the active frame when called.

Methods

See also API Reference, WIN.

private.sysMsgBoxFrame:constructor

frame sysMsgBoxFrame:constructor (dir)

 Constructs and returns the instantiated system message box frame window.

Parameters
dir
string
Desktop directory under /win/devices.

Returns
frame
sysMsgBoxFrame
The instantiated frame window.

Remarks


top


private.sysMsgBoxFrame:do_msgbox

sysMsgBoxFrame:do_msgbox (title, message, bgcolor, active_frame)

Configures and displays the message box.

Parameters
title string
Title bar text.
message string Message to display.
bgcolor number
Background color of the message box, if nil the theme's popup_back color is used.
active_frame parentFrame
The currently active frame when called.

Returns
none



Remarks


top


private.sysMsgBoxFrame:draw

sysMsgBoxFrame:draw (gdi, bounds)

Erases the title bar and draws the window frame.

Parameters
gdi
GDI
GDI object to use for drawing.
bounds
rect
Invalidated area of the window.

Returns
none



Remarks
See window:draw.


top


private.sysMsgBoxFrame:on_frame_activate

sysMsgBoxFrame:on_frame_activate (active)

Disables the task bar and currently active frame when activated. Restores them when deactivated.

Parameters
active
boolean
True if made active, false if inactive.

Returns
none



Remarks
See parentFrame:on_frame_activate.


top


private.sysMsgBoxFrame:on_quit

result sysMsgBoxFrame:on_quit ()

Hides the message box and ensures the message box frame cannot be quit.

Parameters
none



Returns
result
boolean
Always true.

Remarks
See applicationFrame:on_quit.


top


private.sysMsgBoxFrame:on_resize

result sysMsgBoxFrame:on_resize ()

Reconfigures the message box frame.

Parameters
none



Returns
result
boolean
Always true.

Remarks
See applicationFrame:on_resize.


top


private.sysMsgBoxFrame:set_bg_color

sysMsgBoxFrame:set_bg_color (color)

Sets the background color of the message box and message windows.

Parameters
color
number
Color to set.

Returns
none



Remarks
See window:set_bg_color.


top


See also API Reference, WIN.