nsIURIFixup

IID:2EFD4A40-A5E1-11d4-9589-0020183BF181
Inherits From:nsISupports

Interface implemented by objects capable of fixing up strings into URIs

This interface is implemented by the following components:


Constants

PRUint32 FIXUP_FLAG_NONE = 0
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.
PRUint32 FIXUP_FLAG_ALLOW_KEYWORD_LOOKUP = 1
Tell the fixup to make an alternate URI from the input URI, for example to turn foo into www.foo.com.
PRUint32 FIXUP_FLAGS_MAKE_ALTERNATE_URI = 2

Methods

nsIURI createExposableURI ( nsIURI URI ) nsIURI createFixupURI ( AUTF8String URIText , PRUint32 fixupFlags )

nsIURI createExposableURI ( nsIURI URI )

Converts an internal URI (e.g. a wyciwyg URI) into one which we can expose to the user, for example on the URL bar.

Arguments:
URI: The URI to be converted
Returns:
nsIURI The converted, exposable URI

nsIURI createFixupURI ( AUTF8String URIText , PRUint32 fixupFlags )

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.

Arguments:
URIText: Candidate URI.
fixupFlags: Flags that govern ways the URI may be fixed up.

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com