Back to index

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

The nsIWebNavigationInfo interface exposes a way to get information on the capabilities of Gecko webnavigation objects. More...

import "nsIWebNavigationInfo.idl";

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

List of all members.

Public Member Functions

unsigned long isTypeSupported (in ACString aType, in nsIWebNavigation aWebNav)
 Query whether aType is supported.

Public Attributes

const unsigned long UNSUPPORTED = 0
 Returned by isTypeSupported to indicate lack of support for a type.
const unsigned long IMAGE = 1
 Returned by isTypeSupported to indicate that a type is supported as an image.
const unsigned long PLUGIN = 2
 Returned by isTypeSupported to indicate that a type is supported via an NPAPI ("Netscape 4 API") plug-in.
const unsigned long OTHER = 1 << 15
 Returned by isTypeSupported to indicate that a type is supported via some other means.

Detailed Description

The nsIWebNavigationInfo interface exposes a way to get information on the capabilities of Gecko webnavigation objects.

UNDER_REVIEW

Definition at line 49 of file nsIWebNavigationInfo.idl.


Member Function Documentation

unsigned long nsIWebNavigationInfo::isTypeSupported ( in ACString  aType,
in nsIWebNavigation  aWebNav 
)

Query whether aType is supported.

Parameters:
aTypethe MIME type in question.
aWebNavthe nsIWebNavigation object for which the request is being made. This is allowed to be null. If it is non-null, the return value of this method may depend on the exact state of aWebNav and the values set through nsIWebBrowserSetup; otherwise the method will assume that the caller is interested in information about nsIWebNavigation objects in their default state.
Returns:
an enum value indicating whether and how aType is supported.
Note:
This method may rescan plugins to ensure that they're properly registered for the types they support.

Member Data Documentation

Returned by isTypeSupported to indicate that a type is supported as an image.

Definition at line 63 of file nsIWebNavigationInfo.idl.

Returned by isTypeSupported to indicate that a type is supported via some other means.

Note:
Other return types may be added here in the future as they become relevant.

Definition at line 81 of file nsIWebNavigationInfo.idl.

Returned by isTypeSupported to indicate that a type is supported via an NPAPI ("Netscape 4 API") plug-in.

This is not the value returned for "XPCOM plug-ins".

Definition at line 70 of file nsIWebNavigationInfo.idl.

Returned by isTypeSupported to indicate lack of support for a type.

Note:
this is guaranteed not to change, so that boolean tests can be done on the return value if isTypeSupported to detect whether a type is supported at all.

Definition at line 57 of file nsIWebNavigationInfo.idl.


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