/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla 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/MPL/
 *
 * 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):
 *   Doug Turner <dougt@netscape.com> (Original Author)
 *   Dan Mosedale <dmose@netscape.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either of 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 MPL, 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 MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
interface nsIEventQueue;

/**
 * See http://www.mozilla.org/projects/xpcom/Proxies.html
 */

[scriptable, uuid(eea90d43-b059-11d2-915e-c12b696c9333)]
interface nsIProxyObjectManager : nsISupports 
{
    /**
     * Constants for proxyType
     */
    /**
     * Synchronous: Block until result available, like function call.
     */
    const long INVOKE_SYNC   = 0x0001; 
    /**
     * Asynchronous: Return without waiting for result.
     * (Warning: do not pass &pointers into stack when using this flag.)
     */
    const long INVOKE_ASYNC  = 0x0002; 

    /**
     * Always create proxy even if for same thread as current thread.
     */
    const long FORCE_PROXY_CREATION = 0x0004;


    void getProxyForObject(in nsIEventQueue destQueue, 
                           in nsIIDRef iid, 
                           in nsISupports object, 
                           in PRInt32 proxyType,
                           [iid_is(iid),retval] out nsQIResult result);
    
    void getProxy(in nsIEventQueue destQueue, 
                  in nsIIDRef cid, 
                  in nsISupports aOuter,
                  in nsIIDRef iid,
                  in PRInt32 proxyType,
                  [iid_is(iid),retval] out nsQIResult result);
                                        
};


%{C++
#include "nsProxyEvent.h"

#define NS_XPCOMPROXY_CONTRACTID "@mozilla.org/xpcomproxy;1"
#define NS_XPCOMPROXY_CLASSNAME "XPCom Proxy"

#define NS_PROXYEVENT_MANAGER_CID                \
{ 0xeea90d41, 									 \
  0xb059, 										 \
  0x11d2,						                 \
 {0x91, 0x5e, 0xc1, 0x2b, 0x69, 0x6c, 0x93, 0x33}\
} 

/**
 * Helper function for code that already has a link-time dependency on
 * libxpcom and needs to get proxies in a bunch of different places.
 * This way, the caller isn't forced to get the proxy object manager
 * themselves every single time, thus making the calling code more
 * readable.
 */
extern NS_COM nsresult
NS_GetProxyForObject(nsIEventQueue *destQueue, 
                     REFNSIID aIID, 
                     nsISupports* aObj, 
                     PRInt32 proxyType, 
                     void** aProxyObject);
%}
