sbIWindowWatcher.idl

Go to the documentation of this file.

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 :miv */
/*
//
// BEGIN SONGBIRD GPL
//
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2008 POTI, Inc.
// http://songbirdnest.com
//
// This file may be licensed under the terms of of the
// GNU General Public License Version 2 (the "GPL").
//
// Software distributed under the License is distributed
// on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
// express or implied. See the GPL for the specific language
// governing rights and limitations.
//
// You should have received a copy of the GPL along with this
// program. If not, go to http://www.gnu.org/licenses/gpl.html
// or write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// END SONGBIRD GPL
//
*/

#include "nsISupports.idl"

interface nsIDOMWindow;

interface sbICallWithWindowCallback;

[scriptable, uuid(93cf33df-770f-49ec-afb7-20db242dd366)]
interface sbIWindowWatcher : nsISupports
{
  readonly attribute boolean isShuttingDown;


  /*XXXeps add cancel. */

  void callWithWindow(in AString                   aWindowType,
                      in sbICallWithWindowCallback aCallback,
                      [optional] in boolean        aWait);


  nsIDOMWindow getWindow(in AString aWindowType);


  void waitForWindow(in AString aWindowType);
};


[scriptable, function, uuid(4052eb5e-fe52-4e31-abca-1263c2cfd009)]
interface sbICallWithWindowCallback : nsISupports
{
  void handleWindowCallback(in nsIDOMWindow aWindow);
};


//
// C++ defs.
//

%{C++
#define SB_WINDOWWATCHER_CONTRACTID \
          "@songbirdnest.com/Songbird/window-watcher;1"
%}C++