restartBox.js File Reference

A reusable restart box. More...

Go to the source code of this file.

Functions
Components utils	import ("resource://app/jsmodules/StringUtils.jsm")
function	sbRestartBox (title, message)
	Display a restart message box with a title and message. More...
function	sbRestartBox_strings (titlestring, msgstring, defaulttitle, defaultmsg)
	Display a restart message box using strings from the songbird.properties locale file. More...

Variables
const	SB_RESTARTBOX_RESTARTLATER = 0
const	SB_RESTARTBOX_RESTARTNOW = 1
const	SB_RESTARTBOX_RESTARTEOP = 2

Detailed Description

A reusable restart box.

Definition in file restartBox.js.

Function Documentation

Components utils import

(

"resource://app/jsmodules/StringUtils.jsm"

)

function sbRestartBox	(		title,
			message
	)

Display a restart message box with a title and message.

Parameters

title	The title of the restart message box.
message	The message for the restart message box.

Returns

Success code: -1, 0, 1, or 2.

Return values

-1	Error.
0	Restart later.
1	Restart now.
2	Restart at end of playback.

Definition at line 52 of file restartBox.js.

Here is the call graph for this function:

Here is the caller graph for this function:

function sbRestartBox_strings	(		titlestring,
			msgstring,
			defaulttitle,
			defaultmsg
	)

Display a restart message box using strings from the songbird.properties locale file.

Parameters

titlestring	The title string key.
msgstring	The message string key.
defaulttitle	The default title.
defaultmsg	The default message.

Returns

Success code: -1, 0, 1, or 2.

Return values

-1	Error.
0	Restart later.
1	Restart now.
2	Restart at end of playback.

Definition at line 102 of file restartBox.js.

Here is the call graph for this function:

Variable Documentation

const SB_RESTARTBOX_RESTARTEOP = 2

Definition at line 40 of file restartBox.js.

const SB_RESTARTBOX_RESTARTLATER = 0

Definition at line 38 of file restartBox.js.

const SB_RESTARTBOX_RESTARTNOW = 1

Definition at line 39 of file restartBox.js.