summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/uno/XWeak.idl
blob: b240eb038159a3e9b47723b93f91b314778853dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_uno_XWeak_idl__ 
#define __com_sun_star_uno_XWeak_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_uno_XAdapter_idl__ 
#include <com/sun/star/uno/XAdapter.idl> 
#endif 
 
 
//============================================================================= 
 
 module com {  module sun {  module star {  module uno {  
 
//============================================================================= 
 
// DocMerge from xml: interface com::sun::star::uno::XWeak
/** the server-side interface to a weak object.
    
    
    
    <p>This interface is proxy to the adapted object. 
    In order to make it possible to have weak references to objects, 
    the <type>XAdapter</type> interface must be implemented to provide
    a weak adapter for the clients.
    
    <h4>Concept of weak referencing:</h4>
    
    </p>
    <p>This module specifies the interfaces for implementing and using
    weak references.</p>
    <p>
    
    </p>
    <p>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.
    
    </p>
    <p>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:
    
    <dl>
    <dt>
    <type>XWeak</type> 
    </dt>
    <dd>is the server-side interface of the referred object. This
    referred object must support the <type>XAdapter</type> interface.
    
    </dd>
    <dt>
    <type>XReference</type> 
    </dt>
    <dd>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.
    
    </dd>
    </dl>
    </p>
 */
published interface XWeak: com::sun::star::uno::XInterface
{ 
    //------------------------------------------------------------------------- 
     
    // DocMerge from xml: method com::sun::star::uno::XWeak::queryAdapter
    /** queries the weak adapter.
        
        
        
        <p>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.
        
        </p>
     */
    com::sun::star::uno::XAdapter queryAdapter(); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
/*============================================================================= 
 
=============================================================================*/ 
#endif