tmozIUserSettings Interface Reference

User settings. More...

List of all members.

Public Member Functions
tmozIUserSettingsPage	getPage (in long index)
	Return page.
void	registerPage (in tmozIUserSettingsPage page)
	Register page to the setting dialog.
void	registerDialogConfirmation (in AString description, in AString optionName, in long type)
	Register simple option.
Public Attributes
const long	CONFIRM_TYPE_CHECKBOX = 0
	Type of confirmation.
const long	CONFIRM_TYPE_THREESTATE = 1
	Type of confirmation.
readonly attribute long	pageCount
	Page count.

---

Detailed Description

User settings.

Interface allows to register custom pages for user settings dialog. This dialog allows to set various configuration options.

---

Member Function Documentation

tmozIUserSettingsPage getPage

(

in long

index

)

Return page.

Return page with given index

Parameters:

index

Page index

Returns:

Return page. Throw exception if page does not exists.

void registerDialogConfirmation	(	in AString	description,
		in AString	optionName,
		in long	type
	)

Register simple option.

This method allows to register simple option to the dialog. These options do not require separate sheet.

Parameters:

	description	User visible description
	optionName	Name of the configuration where settings will be saved
	type	Type of the option 0 - simple checkbox 1 - three state option (0 - no, 1 - yes, 2 - ask)

void registerPage

(

in tmozIUserSettingsPage

page

)

Register page to the setting dialog.

Parameters:

page

Interface for page.

---

Member Data Documentation

const long CONFIRM_TYPE_CHECKBOX = 0

Type of confirmation.

Item will be displayed at checkbox

const long CONFIRM_TYPE_THREESTATE = 1

Type of confirmation.

Item will be displayed as dropdown box - Ask/No/Yes

readonly attribute long pageCount

Page count.

Number of registered pages.