Back to index

lightning-sunbird  0.9+nobinonly
nsIURI.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Gagan Saksena <gagan@netscape.com> (original author)
00024  *   Darin Fisher <darin@netscape.com>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either the GNU General Public License Version 2 or later (the "GPL"), or
00028  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #include "nsISupports.idl"
00041 
00072 %{C++
00073 #undef GetPort  // XXX Windows!
00074 #undef SetPort  // XXX Windows!
00075 %}
00076 
00093 [scriptable, uuid(07a22cc0-0ce5-11d3-9331-00104ba0fd40)]
00094 interface nsIURI : nsISupports
00095 {
00096     /************************************************************************
00097      * The URI is broken down into the following principal components:
00098      */
00099 
00106     attribute AUTF8String spec;
00107 
00114     readonly attribute AUTF8String prePath;
00115 
00120     attribute ACString scheme;
00121 
00127     attribute AUTF8String userPass;
00128 
00135     attribute AUTF8String username;
00136     attribute AUTF8String password;
00137 
00143     attribute AUTF8String hostPort;
00144 
00152     attribute AUTF8String host;
00153 
00158     attribute long port;
00159 
00166     attribute AUTF8String path;
00167 
00168 
00169     /************************************************************************
00170      * An URI supports the following methods:
00171      */
00172 
00178     boolean equals(in nsIURI other);
00179 
00185     boolean schemeIs(in string scheme);
00186 
00193     nsIURI clone();
00194 
00201     AUTF8String resolve(in AUTF8String relativePath);
00202 
00203 
00204     /************************************************************************
00205      * Additional attributes:
00206      */
00207 
00213     readonly attribute ACString asciiSpec;
00214 
00220     readonly attribute ACString asciiHost;
00221 
00231     readonly attribute ACString originCharset;
00232 };