Back to index

lightning-sunbird  0.9+nobinonly
nsISidebar.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is mozilla.org Code.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 1998
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 /*
00040 
00041   The Sidebar API for 3rd parties
00042 
00043 */
00044 
00045 #include "nsISupports.idl"
00046 
00047 [scriptable, uuid(577cb745-8caf-11d3-aaef-00805f8a4905)]
00048 interface nsISidebar : nsISupports
00049 {
00050     void addPanel(in wstring aTitle, in string aContentURL,
00051                   in string aCustomizeURL);
00052     void addPersistentPanel(in wstring aTitle, in string aContentURL,
00053                             in string aCustomizeURL);
00054     void addSearchEngine(in string engineURL, in string iconURL,
00055                          in wstring suggestedTitle, in wstring suggestedCategory);
00056 };
00057 
00058 [scriptable, uuid(2efb7dc9-e7b3-44b7-8557-60b1485cfd6e)]
00059 interface nsISidebar_MOZILLA_1_8_BRANCH : nsISidebar
00060 {
00061     void addMicrosummaryGenerator(in string generatorURL);
00062 };
00063 
00064 [scriptable, uuid(4350fb73-9305-41df-a669-11d26222d420)]
00065 interface nsISidebarExternal : nsISupports
00066 {
00067     void AddSearchProvider(in string aDescriptionURL);
00068     unsigned long IsSearchProviderInstalled(in string aSearchURL);
00069 };
00070 
00071 %{ C++
00072 // {22117140-9c6e-11d3-aaf1-00805f8a4905} 
00073 #define NS_SIDEBAR_CID \
00074 { 0x22117140, 0x9c6e, 0x11d3, { 0xaa, 0xf1, 0x00, 0x80, 0x5f, 0x8a, 0x49, 0x05 } }
00075 
00076 #define NS_SIDEBAR_CONTRACTID "@mozilla.org/sidebar;1"
00077 %}
00078 
00079 /*
00080  var isidebar = Components.interfaces.nsISidebar;
00081  var csidebar = Components.classes['@mozilla.org/sidebar;1'];
00082  var sidebar = csidebar.createInstance(isidebar);
00083 */