Back to index

lightning-sunbird  0.9+nobinonly
nsIUrlWidget.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; 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  *   Bill Law    <law@netscape.com>
00024  *   Jesse Burris    <jburris@mmxi.com>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either of the GNU General Public License Version 2 or later (the "GPL"),
00028  * or 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 //filename: nsIUrlWidget.idl
00041 
00042 #include "nsISupports.idl"
00043 
00044 interface nsIDOMWindowInternal;
00045 
00046 
00047 /* nsIUrlWidget
00048  *
00049  * This interface describes the service that you can use to
00050  * have the currently displayed url appear in a hidden editbox control.
00051  * It is created, and called, in navigator.js.
00052  */
00053 [scriptable, uuid(1802ee81-34a1-11d4-82ee-0050da2da771)]
00054 interface nsIUrlWidget : nsISupports {
00055 
00056        /*------------------ SetURLToHiddenControl ---------------------
00057        | Set the currently displayed url to a hidden edit control.           |
00058        | Created the edit control, if not already created.                          |
00059        --------------------------------------------------------------*/
00060     void SetURLToHiddenControl( in string aURL, in nsIDOMWindowInternal parent );
00061 };
00062 
00063 //Used in navigator.js to instantiate and call this class.
00064 %{C++
00065 #define NS_IURLWIDGET_CONTRACTID    "@mozilla.org/urlwidget;1"
00066 #define NS_IURLWIDGET_CLASSNAME "nsUrlWidget"
00067 %}