Songbird / Development / Songbird Add-Ons API Documentation

components/moz/windowwatcher/public/sbIWindowWatcher.idl

00001 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* vim: set sw=2 :miv */
00003 /*
00004 //
00005 // BEGIN SONGBIRD GPL
00006 //
00007 // This file is part of the Songbird web player.
00008 //
00009 // Copyright(c) 2005-2008 POTI, Inc.
00010 // http://songbirdnest.com
00011 //
00012 // This file may be licensed under the terms of of the
00013 // GNU General Public License Version 2 (the "GPL").
00014 //
00015 // Software distributed under the License is distributed
00016 // on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
00017 // express or implied. See the GPL for the specific language
00018 // governing rights and limitations.
00019 //
00020 // You should have received a copy of the GPL along with this
00021 // program. If not, go to http://www.gnu.org/licenses/gpl.html
00022 // or write to the Free Software Foundation, Inc.,
00023 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00024 //
00025 // END SONGBIRD GPL
00026 //
00027 */
00028 
00029 #include "nsISupports.idl"
00030 
00031 interface nsIDOMWindow;
00032 
00049 interface sbICallWithWindowCallback;
00050 
00051 [scriptable, uuid(93cf33df-770f-49ec-afb7-20db242dd366)]
00052 interface sbIWindowWatcher : nsISupports
00053 {
00059   readonly attribute boolean isShuttingDown;
00060 
00061 
00073   /*XXXeps add cancel. */
00074 
00075   void callWithWindow(in AString                   aWindowType,
00076                       in sbICallWithWindowCallback aCallback,
00077                       [optional] in boolean        aWait);
00078 
00079 
00092   nsIDOMWindow getWindow(in AString aWindowType);
00093 
00094 
00106   void waitForWindow(in AString aWindowType);
00107 };
00108 
00109 
00117 [scriptable, function, uuid(4052eb5e-fe52-4e31-abca-1263c2cfd009)]
00118 interface sbICallWithWindowCallback : nsISupports
00119 {
00126   void handleWindowCallback(in nsIDOMWindow aWindow);
00127 };
00128 
00129 
00130 //
00131 // C++ defs.
00132 //
00133 
00134 %{C++
00135 #define SB_WINDOWWATCHER_CONTRACTID \
00136           "@songbirdnest.com/Songbird/window-watcher;1"
00137 %}C++
00138 

Generated on Tue Mar 10 14:28:55 2009 for Songbird by  doxygen 1.5.2