tmozIDialog Interface Reference

Dialog class. More...

List of all members.

Public Member Functions
void	addParameter (in nsISupports param)
	Add parameter to the dialog.
void	doModal ()
	Open as modal dialog.
void	create (in boolean show)
	Open dialog.
void	close ()
	Close dialog.
Public Attributes
attribute AString	dialogUrl
	Dialog URL.
attribute boolean	canResize
	Set if dialog can be resized.
readonly attribute boolean	opened
	Flag if dialog opened.

---

Detailed Description

Dialog class.

Class represents XUL based dialog. Dialog is initialy empty and have to be initialized. Dialog can be activated using doModal() or create() method.

• 1. Set dialog template url (dialogUrl)
• 2. Add parameters for the dialog (addParameter)
• 3. Open dialog (call doModal() or create() )

This class can be created using tmozIDialogFactory.

---

Member Function Documentation

void addParameter

(

in nsISupports

param

)

Add parameter to the dialog.

Add one or more parameteres to the dialog. Method can be called several times to add more parameters. These parameters can be used in the method onLoad.

Parameters:

param

Parameter

void close

(

)

Close dialog.

Function will close opened dialog. This can be used only for dialogs opened by create() function.

void create

(

in boolean

show

)

Open dialog.

Create and display non-modal dialog.

Parameters:

show

Display flag true dialog is visible false dialog is hidden

void doModal

(

)

Open as modal dialog.

Starts modal dialog. If caller is interested about return value special object have to be set as parameter for the dialog.

---

Member Data Documentation

attribute boolean canResize

Set if dialog can be resized.

Flag is dialog can be resize. Set this attribute before dialog is created.

• true if dialog can be resized
• false if dialog cannot be resized (fixed border)

attribute AString dialogUrl

Dialog URL.

Dialog URL have to be set before activation. Example: 'chrome://tahiti/content/aboutDialog.xul'

readonly attribute boolean opened

Flag if dialog opened.

Flag is true if dialog is opened. Flag is false if dialog is closed.