gecko-dev/xpcom/base/nsIWeakReference.idl

68 строки
2.3 KiB
Plaintext
Исходник Обычный вид История

1999-08-22 00:06:52 +04:00
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
2012-05-21 15:12:37 +04:00
* 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/. */
1999-08-03 07:41:27 +04:00
#include "nsISupports.idl"
1999-08-22 00:06:52 +04:00
/**
* 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.
*
* @version 1.0
1999-08-22 00:06:52 +04:00
* @see nsISupportsWeakReference
* @see nsWeakReference
* @see nsWeakPtr
*/
1999-08-03 07:41:27 +04:00
[scriptable, uuid(9188bc85-f92e-11d2-81ef-0060083a0bcf)]
interface nsIWeakReference : nsISupports
1999-08-22 00:06:52 +04:00
{
/**
* |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 );
};
1999-08-03 07:41:27 +04:00
1999-08-22 00:06:52 +04:00
/**
* |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.
*
* @version 1.0
1999-08-22 00:06:52 +04:00
* @see nsIWeakReference
* @see nsSupportsWeakReference
*/
1999-08-03 07:41:27 +04:00
[scriptable, uuid(9188bc86-f92e-11d2-81ef-0060083a0bcf)]
interface nsISupportsWeakReference : nsISupports
1999-08-22 00:06:52 +04:00
{
/**
* |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();
};
1999-08-03 07:41:27 +04:00
%{C++
#ifdef MOZILLA_INTERNAL_API
#include "nsIWeakReferenceUtils.h"
#endif
1999-08-03 07:41:27 +04:00
%}