tdf#130857 qt weld: Implement QtInstanceWidget::strip_mnemonic
[LibreOffice.git] / udkapi / com / sun / star / uno / XInterface.idl
blobb34df5f346ae422adb88f95966ce72023cb78d11
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 * This file incorporates work covered by the following license notice:
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
21 module com { module sun { module star { module uno {
23 /** base interface of all UNO interfaces
25 <p> It provides lifetime control by reference counting and the
26 possibility of querying for other
27 interfaces of the same logical object.
30 <p>
31 "Logical Object" in this case means that the
32 interfaces actually can be supported by internal (e.g. aggregated) physical objects.</p>
34 <p> Deriving from this interface is mandatory for all UNO interfaces.
35 <p> Each language binding (Java, C++, StarBasic, Python, ... ) may
36 provide a different mapping of this interface, please look into the language
37 dependent documentation.
39 <p> The UNO object does not export the state of the reference count (acquire() and
40 release() do not have return values). In general, also the UNO object itself
41 should not make any assumption on the concrete value of the reference count
42 (except on the transition from one to zero ).
45 published interface XInterface
47 /** queries for a new interface to an existing UNO object.
48 <p>
49 The queryInterface() method is the entry point to obtain other interfaces which
50 are exported by the object. The caller asks the implementation of the object,
51 if it supports the interface specified by the type argument. The call may either
52 return with an interface reference of the requested type or with a void any.
54 <p>
55 There are certain specifications, a queryInterface() implementation must not violate.
56 <p>
57 1) If queryInterface on a specific object has once returned a valid interface reference
58 for a given type, it must return a valid reference for any successive queryInterface
59 calls on this object for the same type.
60 <p>
61 2) If queryInterface on a specific object has once returned a null reference
62 for a given type, it must always return a null reference for the same type.
63 <p>
64 3) If queryInterface on a reference A returns reference B, queryInterface on
65 B for Type A must return interface reference A or calls made on the returned
66 reference must be equivalent to calls made on reference A.
67 <p>
68 4) If queryInterface on a reference A returns reference B, queryInterface on
69 A and B for XInterface must return the same interface reference (object identity).
71 <p> The reason for the strong specification is, that a Uno Runtime Environment (URE)
72 may choose to cache queryInterface() calls.
73 <p> As mentioned above, certain language bindings may map this function differently also
74 with different specifications, please visit the language dependent specification for it.
75 The current C++ binding sticks to the specification state
76 <p>
77 The rules mentioned above are basically identical to the rules of QueryInterface in MS COM.
79 @param aType a UNO interface type, for which an object reference shall be obtained.
80 @return an interface reference in case the requested interface is supported by the object,
81 a void any otherwise.
83 any queryInterface( [in] type aType );
85 /** increases the reference counter by one.
87 <p>When you have called acquire() on the
88 UNO object, it is often said, that you have a reference or a hard reference
89 to the object.
91 <p>
92 It is only allowed to invoke a method on a UNO object, when you keep
93 a hard reference to it.
95 <p> Every call to acquire must be followed by a corresponding call to release
96 some time later, which may eventually lead to the destruction of the object.
98 void acquire();
100 /** decreases the reference counter by one.
101 <p>When the reference counter reaches 0, the object gets deleted.</p>
102 <p>Calling release() on the object is often called releasing
103 or clearing the reference to an object.
105 void release();
110 }; }; }; };
112 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */