privateBrowsing

The privateBrowsing class simplifies the access to the Private Browsing mode.

Method overview

privateBrowsing(in MozMillController controller);
start(in boolean useShortcut);
stop(in boolean useShortcut);
waitForTransistionComplete(in boolean state);

Attributs

Attribute Type Description
enabled
boolean
This attribute uses the nsIPrivateBrowsingService interface to switch or get the current Private Browsing state.
handler
func_ptr
The callback handler for the confirmation dialog if showPrompt is true.
showPrompt
boolean
Enable or disable the confirmation prompt when entering the Private Browsing mode.

Methods

privateBrowsing()

The constructor of the class.

privateBrowsing(
  in MozMillController controller
);
Parameters
controller
Mozmill controller of the browser window to operate on.

start()

Turns on private browsing mode.

start(
  in boolean useShortcut
);
Parameters
useShortcut
If set to true the keyboard shortcut is used. Otherwise a mouse click is synthesized.

stop()

Turns off the private browsing mode.

stop(
  in boolean useShortcut
);
Parameters
useShortcut
If set to true the keyboard shortcut is used. Otherwise a mouse click is synthesized.

waitForTransistionComplete()

Wait until the transition in or out of the Private Browsing mode has been completed.

waitForTransistionComplete(
  in boolean state
);
Parameters
state
Target state to wait for.

Document Tags and Contributors

 Contributors to this page: Sheppy, Whimboo
 Last updated by: Sheppy,