Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIWebBrowserFocus Interface Reference

nsIWebBrowserFocus Interface that embedders use for controlling and interacting with the browser focus management. More...

import "nsIWebBrowserFocus.idl";

Inheritance diagram for nsIWebBrowserFocus:
Inheritance graph
[legend]
Collaboration diagram for nsIWebBrowserFocus:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void activate ()
 MANDATORY activate() is a mandatory call that must be made to the browser when the embedding application's window is activated and the browser area was the last thing in focus.
void deactivate ()
 MANDATORY deactivate() is a mandatory call that must be made to the browser when the embedding application's window is deactivated and the browser area was the last thing in focus.
void setFocusAtFirstElement ()
 Give the first element focus within mozilla (i.e.
void setFocusAtLastElement ()
 Give the last element focus within mozilla (i.e.

Public Attributes

attribute nsIDOMWindow focusedWindow
 The currently focused nsDOMWindow when the browser is active, or the last focused nsDOMWindow when the browser is inactive.
attribute nsIDOMElement focusedElement
 The currently focused nsDOMElement when the browser is active, or the last focused nsDOMElement when the browser is inactive.

Detailed Description

nsIWebBrowserFocus Interface that embedders use for controlling and interacting with the browser focus management.

The embedded browser can be focused by clicking in it or tabbing into it. If the browser is currently focused and the embedding application's top level window is disabled, deactivate() must be called, and activate() called again when the top level window is reactivated for the browser's focus memory to work correctly.

FROZEN

Definition at line 59 of file nsIWebBrowserFocus.idl.


Member Function Documentation

MANDATORY activate() is a mandatory call that must be made to the browser when the embedding application's window is activated and the browser area was the last thing in focus.

This method can also be called if the embedding application wishes to give the browser area focus, without affecting the currently focused element within the browser.

Note:
If you fail to make this call, mozilla focus memory will not work correctly.

MANDATORY deactivate() is a mandatory call that must be made to the browser when the embedding application's window is deactivated and the browser area was the last thing in focus.

On non-windows platforms, deactivate() should also be called when focus moves from the browser to the embedding chrome.

Note:
If you fail to make this call, mozilla focus memory will not work correctly.

Give the first element focus within mozilla (i.e.

TAB was pressed and focus should enter mozilla)

Give the last element focus within mozilla (i.e.

SHIFT-TAB was pressed and focus should enter mozilla)


Member Data Documentation

The currently focused nsDOMElement when the browser is active, or the last focused nsDOMElement when the browser is inactive.

Definition at line 111 of file nsIWebBrowserFocus.idl.

The currently focused nsDOMWindow when the browser is active, or the last focused nsDOMWindow when the browser is inactive.

Definition at line 105 of file nsIWebBrowserFocus.idl.


The documentation for this interface was generated from the following file: