From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- udkapi/com/sun/star/uno/XWeak.idl | 102 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 102 insertions(+) create mode 100644 udkapi/com/sun/star/uno/XWeak.idl (limited to 'udkapi/com/sun/star/uno/XWeak.idl') diff --git a/udkapi/com/sun/star/uno/XWeak.idl b/udkapi/com/sun/star/uno/XWeak.idl new file mode 100644 index 000000000..16e7428f5 --- /dev/null +++ b/udkapi/com/sun/star/uno/XWeak.idl @@ -0,0 +1,102 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * 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 file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_uno_XWeak_idl__ +#define __com_sun_star_uno_XWeak_idl__ + +#include + +#include + + + + module com { module sun { module star { module uno { + +/** the server-side interface to a weak object. + + + +

This interface is proxy to the adapted object. + In order to make it possible to have weak references to objects, + the XAdapter interface must be implemented to provide + a weak adapter for the clients. + +

Concept of weak referencing:

+ +

+

This module specifies the interfaces for implementing and using + weak references.

+

+ +

+

The sense of weak references is to hold a reference to an object + without affecting the lifetime of the object. That means that a weak + reference may become invalid, at any time, if the referenced object dies. + +

+

The following interfaces describe one way to handle weak references + by providing a weak adapter. The weak object has to provide this + adapter if anyone wants to hold a weak reference. To separate their + lifetimes, the adapter and the original object must not share the same + reference counter. The weak reference is in fact only a hard reference + to the adapter, which knows - but does not hold - the original object. + That means that the implementation and synchronization of weak + referencing is the responsibility of the object. The following + interfaces are involved in the concept of weak referencing: + +

+
+ XWeak +
+
is the server-side interface of the referred object. This + referred object must support the XAdapter interface. + +
+
+ XReference +
+
is a client-side interface which must be implemented by + the holder of any weak reference. It is used for notification + when the adapted object dies. + +
+
+

+ */ +published interface XWeak: com::sun::star::uno::XInterface +{ + /** queries the weak adapter. + + + +

It is important that the adapter must know, but not hold + the adapted object. If the adapted object dies, all references + to the adapter have to be notified to release the adapter. + +

+ */ + com::sun::star::uno::XAdapter queryAdapter(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3