Back to index

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

nsIStandardURL defines the interface to an URL with the standard file path format common to protocols like http, ftp, and file. More...

import "nsIStandardURL.idl";

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

List of all members.

Public Member Functions

void init (in unsigned long aUrlType, in long aDefaultPort, in AUTF8String aSpec, in string aOriginCharset, in nsIURI aBaseURI)
 Initialize a standard URL.

Public Attributes

const unsigned long URLTYPE_STANDARD = 1
 blah:foo/bar => blah://foo/bar blah:/foo/bar => blah:///foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah:///foo/bar
const unsigned long URLTYPE_AUTHORITY = 2
 blah:foo/bar => blah://foo/bar blah:/foo/bar => blah://foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah://foo/bar
const unsigned long URLTYPE_NO_AUTHORITY = 3
 blah:foo/bar => blah:///foo/bar blah:/foo/bar => blah:///foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah:///foo/bar
attribute boolean mutable
 Control whether or not this URL can be modified.

Detailed Description

nsIStandardURL defines the interface to an URL with the standard file path format common to protocols like http, ftp, and file.

It supports initialization from a relative path and provides some customization on how URLs are normalized.

UNDER_REVIEW

Definition at line 53 of file nsIStandardURL.idl.


Member Function Documentation

void nsIStandardURL::init ( in unsigned long  aUrlType,
in long  aDefaultPort,
in AUTF8String  aSpec,
in string  aOriginCharset,
in nsIURI  aBaseURI 
)

Initialize a standard URL.

Parameters:
aUrlType- one of the URLTYPE_ flags listed above.
aDefaultPort- if the port parsed from the URL string matches this port, then the port will be removed from the canonical form of the URL.
aSpec- URL string.
aOriginCharset- the charset from which this URI string originated. this corresponds to the charset that should be used when communicating this URI to an origin server, for example. if null, then provide aBaseURI implements this interface, the origin charset of aBaseURI will be assumed, otherwise defaulting to UTF-8 (i.e., no charset transformation from aSpec).
aBaseURI- if null, aSpec must specify an absolute URI. otherwise, aSpec will be resolved relative to aBaseURI.

Member Data Documentation

Control whether or not this URL can be modified.

Protocol handlers can set this flag before handing out an URL to ensure that it is not inadvertently modified.

Definition at line 110 of file nsIStandardURL.idl.

blah:foo/bar => blah://foo/bar blah:/foo/bar => blah://foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah://foo/bar

Definition at line 69 of file nsIStandardURL.idl.

blah:foo/bar => blah:///foo/bar blah:/foo/bar => blah:///foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah:///foo/bar

Definition at line 77 of file nsIStandardURL.idl.

blah:foo/bar => blah://foo/bar blah:/foo/bar => blah:///foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah:///foo/bar

Definition at line 61 of file nsIStandardURL.idl.


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