/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

/**
 * This is the interface to the Popup Window Manager: an object which
 * maintains popup window permissions by website.
 */

#include "nsISupports.idl"

interface nsIURI;

[scriptable, uuid(3210a6aa-b464-4f57-9335-b22815567cf1)]
interface nsIPopupWindowManager : nsISupports {

  /**
   * These values are returned by the testPermission method
   */
  const PRUint32 ALLOW_POPUP = 1;
  const PRUint32 DENY_POPUP = 2;
  const PRUint32 ALLOW_POPUP_WITH_PREJUDICE = 3;

  /**
   * Test whether a website has permission to show a popup window.
   * @param   uri is the URI to be tested
   * @return  one of the enumerated permission actions defined above
   */
  PRUint32 testPermission(in nsIURI uri);
};

%{ C++
#define NS_POPUPWINDOWMANAGER_CONTRACTID "@mozilla.org/PopupWindowManager;1"
%}