summaryrefslogtreecommitdiffstats
path: root/udkapi/com/sun/star/uno/XAggregation.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--udkapi/com/sun/star/uno/XAggregation.idl111
1 files changed, 111 insertions, 0 deletions
diff --git a/udkapi/com/sun/star/uno/XAggregation.idl b/udkapi/com/sun/star/uno/XAggregation.idl
new file mode 100644
index 000000000..2bd5b6f25
--- /dev/null
+++ b/udkapi/com/sun/star/uno/XAggregation.idl
@@ -0,0 +1,111 @@
+/* -*- 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_XAggregation_idl__
+#define __com_sun_star_uno_XAggregation_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+
+module com { module sun { module star { module uno {
+
+/** Objects which implement this interface can become aggregates of
+ a delegator.
+
+ <p>That means if an object "A" aggregates "B", "A" can provide all
+ or some of the interfaces of "B". Whenever the method
+ XInterface::queryInterface()
+ is called on either of the objects, the call will be forwarded
+ to object "A". Object "A" now can determine whether to use the
+ interfaces of "A" or "B" or neither. Actually, any number of
+ aggregates can be used, even nested ones (aggregated objects which are
+ delegators by themselves).
+
+ <p>The following rules are to be observed:
+ <ol>
+ <li>All calls to XInterface::acquire()
+ which are made before the delegator was set (using the method
+ XAggregation::setDelegator()) must not be taken back
+ (using the method XInterface::release())
+ before the delegation is removed by calling
+ <code>xAggregation-&gt;setDelegator(NULL)</code>.
+
+ <li>The constructor of a delegator has to increment its
+ own reference count by calling its method
+ XInterface::acquire()
+ before it sets itself to any aggregate using the method
+ XAggregation::setDelegator(). After that
+ call it has to reset its own reference count without the
+ destructor getting called.
+
+ <li>The destructor of a delegator has to reset the delegator in
+ its aggregated objects by calling their method
+ XAggregation::setDelegator() with
+ NULL before it releases its reference to
+ its aggregated objects.
+ </ol>
+
+ @deprecated
+ Aggregation will no longer be supported as a high-level concept of UNO.
+ You may still have the option to implement a UNO object consisting of
+ several single objects in your specific programming language, though this
+ depends on your programming language.
+*/
+published interface XAggregation: com::sun::star::uno::XInterface
+{
+ /** sets the object to which all calls to the method
+ XInterface::queryInterface()
+ have to be forwarded.
+
+ @param pDelegator
+ specifies the object which handles the calls to
+ XInterface::queryInterface().
+ If <var>pDelegator</var> is NULL, the delegator is
+ removed and thus the object becomes its own delegator and has
+ to handle calls to the method
+ XInterface::queryInterface()
+ itself.
+
+ @see XAggregation::queryAggregation
+ */
+ void setDelegator( [in] com::sun::star::uno::XInterface pDelegator );
+
+ /** is similar to XInterface::queryInterface(),
+ but it is to be processed directly without being forwarded to the
+ delegator.
+
+ <p>This method is only called from within an implementation of
+ XInterface::queryInterface()
+ or XAggregation::queryAggregation(). This method
+ is to be called by the delegator if it does not implement the
+ interface itself. An object which got aggregated cannot depend
+ on getting its own interface when it calls the method
+ XInterface::queryInterface().
+
+ @see XAggregation::setDelegator
+ */
+ any queryAggregation( [in] type aType );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */