nsIWeakReference.idl
上传用户:goldcmy89
上传日期:2017-12-03
资源大小:2246k
文件大小:4k
源码类别:
PlugIns编程
开发平台:
Visual C++
- /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
- *
- * ***** 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 the Mozilla browser.
- *
- * The Initial Developer of the Original Code is
- * Netscape Communications, Inc.
- * Portions created by the Initial Developer are Copyright (C) 1999
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s):
- * Pierre Phaneuf <pp@ludusdesign.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"
- /**
- * An instance of |nsIWeakReference| is a proxy object that cooperates with
- * its referent to give clients a non-owning, non-dangling reference. Clients
- * own the proxy, and should generally manage it with an |nsCOMPtr| (see the
- * type |nsWeakPtr| for a |typedef| name that stands out) as they would any
- * other XPCOM object. The |QueryReferent| member function provides a
- * (hopefully short-lived) owning reference on demand, through which clients
- * can get useful access to the referent, while it still exists.
- *
- * @status FROZEN
- * @version 1.0
- * @see nsISupportsWeakReference
- * @see nsWeakReference
- * @see nsWeakPtr
- */
- [scriptable, uuid(9188bc85-f92e-11d2-81ef-0060083a0bcf)]
- interface nsIWeakReference : nsISupports
- {
- /**
- * |QueryReferent| queries the referent, if it exists, and like |QueryInterface|, produces
- * an owning reference to the desired interface. It is designed to look and act exactly
- * like (a proxied) |QueryInterface|. Don't hold on to the produced interface permanently;
- * that would defeat the purpose of using a non-owning |nsIWeakReference| in the first place.
- */
- void QueryReferent( in nsIIDRef uuid, [iid_is(uuid), retval] out nsQIResult result );
- };
- /**
- * |nsISupportsWeakReference| is a factory interface which produces appropriate
- * instances of |nsIWeakReference|. Weak references in this scheme can only be
- * produced for objects that implement this interface.
- *
- * @status FROZEN
- * @version 1.0
- * @see nsIWeakReference
- * @see nsSupportsWeakReference
- */
- [scriptable, uuid(9188bc86-f92e-11d2-81ef-0060083a0bcf)]
- interface nsISupportsWeakReference : nsISupports
- {
- /**
- * |GetWeakReference| produces an appropriate instance of |nsIWeakReference|.
- * As with all good XPCOM `getters', you own the resulting interface and should
- * manage it with an |nsCOMPtr|.
- *
- * @see nsIWeakReference
- * @see nsWeakPtr
- * @see nsCOMPtr
- */
- nsIWeakReference GetWeakReference();
- };
- %{C++
- #ifdef MOZILLA_INTERNAL_API
- #include "nsIWeakReferenceUtils.h"
- #endif
- %}