Back to index

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

Interface implemented by objects capable of fixing up strings into URIs. More...

import "nsIURIFixup.idl";

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

List of all members.

Public Member Functions

nsIURI createExposableURI (in nsIURI aURI)
 Converts an internal URI (e.g.
nsIURI createFixupURI (in AUTF8String aURIText, in unsigned long aFixupFlags)
 Converts the specified string into a URI, first attempting to correct any errors in the syntax or other vagaries.

Public Attributes

const unsigned long FIXUP_FLAG_NONE = 0
 No fixup flags.
const unsigned long FIXUP_FLAG_ALLOW_KEYWORD_LOOKUP = 1
 Allow the fixup to use a keyword lookup service to complete the URI.
const unsigned long FIXUP_FLAGS_MAKE_ALTERNATE_URI = 2
 Tell the fixup to make an alternate URI from the input URI, for example to turn foo into www.foo.com.

Detailed Description

Interface implemented by objects capable of fixing up strings into URIs.

Definition at line 48 of file nsIURIFixup.idl.


Member Function Documentation

Converts an internal URI (e.g.

a wyciwyg URI) into one which we can expose to the user, for example on the URL bar.

Parameters:
aURIThe URI to be converted
Returns:
nsIURI The converted, exposable URI
Exceptions:
NS_ERROR_MALFORMED_URIwhen the exposable portion of aURI is malformed
NS_ERROR_UNKNOWN_PROTOCOLwhen we can't get a protocol handler service for the URI scheme.
nsIURI nsIURIFixup::createFixupURI ( in AUTF8String  aURIText,
in unsigned long  aFixupFlags 
)

Converts the specified string into a URI, first attempting to correct any errors in the syntax or other vagaries.

Returns a wellformed URI or nsnull if it can't.

Parameters:
aURITextCandidate URI.
aFixupFlagsFlags that govern ways the URI may be fixed up.

Member Data Documentation

Allow the fixup to use a keyword lookup service to complete the URI.

The fixup object implementer should honour this flag and only perform any lengthy keyword (or search) operation if it is set.

Definition at line 58 of file nsIURIFixup.idl.

No fixup flags.

Definition at line 51 of file nsIURIFixup.idl.

Tell the fixup to make an alternate URI from the input URI, for example to turn foo into www.foo.com.

Definition at line 64 of file nsIURIFixup.idl.


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