gecko-dev/modules/plugin/base/public/nsIPluginManagerMac.idl

110 lines
4.3 KiB
Plaintext

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: NPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Netscape Public License
* Version 1.1 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/NPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the NPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the NPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
////////////////////////////////////////////////////////////////////////////////
/**
* <B>INTERFACE TO NETSCAPE COMMUNICATOR PLUGINS (NEW C++ API).</B>
*
* <P>This supersedes the old plugin API (npapi.h, npupp.h), and
* eliminates the need for glue files: npunix.c, npwin.cpp and npmac.cpp that
* get linked with the plugin. You will however need to link with the "backward
* adapter" (badapter.cpp) in order to allow your plugin to run in pre-5.0
* browsers.
*
* <P>See nsPlugin.idl for an overview of how this interface fits with the
* overall plugin architecture.
*/
////////////////////////////////////////////////////////////////////////////////
#include "nsIPluginManager2.idl"
/**
* nsIPluginManagerMac: New top-level window handling calls for Mac.
*/
[uuid(f2c0a3fc-2df8-11d4-8cf4-0060b0fc14a3)]
interface nsIPluginManagerMac : nsIPluginManager2
{
/**
* Registers a top-level window with the browser. Events received by that
* window will be dispatched to the event handler specified.
*
* @param handler - the event handler for the window
* @param window - the platform window reference
*/
void registerWindow(in nsIEventHandler handler,
in nsPluginPlatformWindowRef window);
/**
* Unregisters a top-level window with the browser. The handler and window pair
* should be the same as that specified to RegisterWindow.
*
* @param handler - the event handler for the window
* @param window - the platform window reference
*/
void unregisterWindow(in nsIEventHandler handler,
in nsPluginPlatformWindowRef window);
/**
* Allocates a new menu ID (for the Mac).
*
* @param handler - the event handler for the window
* @param isSubmenu - whether this is a sub-menu ID or not
* @result - the resulting menu ID
*/
short allocateMenuID(in nsIEventHandler handler,
in boolean isSubmenu);
/**
* Deallocates a menu ID (for the Mac).
*
* @param handler - the event handler for the window
* @param menuID - the menu ID
*/
void deallocateMenuID(in nsIEventHandler handler,
in short menuID);
/**
* Indicates whether this event handler has allocated the given menu ID.
*
* @param handler - the event handler for the window
* @param menuID - the menu ID
* @result - returns PR_TRUE if the menu ID is allocated
*/
boolean hasAllocatedMenuID(in nsIEventHandler handler,
in short menuID);
};