summaryrefslogtreecommitdiffstats
path: root/udkapi/com/sun/star/lang/XComponent.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--udkapi/com/sun/star/lang/XComponent.idl117
1 files changed, 117 insertions, 0 deletions
diff --git a/udkapi/com/sun/star/lang/XComponent.idl b/udkapi/com/sun/star/lang/XComponent.idl
new file mode 100644
index 000000000..b0390d3a8
--- /dev/null
+++ b/udkapi/com/sun/star/lang/XComponent.idl
@@ -0,0 +1,117 @@
+/* -*- 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_lang_XComponent_idl__
+#define __com_sun_star_lang_XComponent_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+
+module com { module sun { module star { module lang {
+
+ published interface XEventListener;
+
+/** allows to explicitly free resources and break cyclic references.
+
+ <p>Actually the real lifetime of a UNO object is controlled by
+ references kept on interfaces of this object. But there are two
+ distinct meanings in keeping a reference to an interface:
+ 1st to own the object and 2nd to know the object.
+
+ <p>You are only allowed to keep references of interfaces
+ to UNO objects if you are by definition the owner of that object or
+ your reference is very temporary or you have registered an
+ EventListener at that object and release the reference when
+ "disposing" is called.</p>
+ */
+published interface XComponent: com::sun::star::uno::XInterface
+{
+ /** The owner of an object calls this method to explicitly free all
+ resources kept by this object and thus break cyclic references.
+
+ <p>Only the owner of this object is allowed to call this method.
+ The object should release all resources and references in the
+ easiest possible manner ( for instance no serialization should
+ take place anymore ).
+ </p>
+ <p>
+ The object must notify all registered listeners using the method
+ XEventListener::disposing(). All notified objects
+ should release there references to this object without
+ calling XComponent::removeEventListener()
+ (the disposed object will release the listeners eitherway).
+ </p>
+
+ <p>After this method has been called, the object should behave as passive
+ as possible, thus it should ignore all calls
+ in case it can comply with its specification (for instance addEventListener()).
+ Often the object can't fulfill its specification anymore,
+ in this case it must throw the DisposedException
+ (which is derived from com::sun::star::uno::RuntimeException)
+ when it gets called.</p>
+
+ <p>For some objects no real owner can be identified, thus it can be
+ disposed from multiple reference holders. In this case
+ the object should be able to cope with multiple dispose()-calls (which
+ are inevitable in a multithreaded environment).
+ */
+ void dispose();
+
+ /** adds an event listener to the object.
+
+ <p>The broadcaster fires the disposing method of this listener
+ if the XComponent::dispose() method is called.</p>
+
+ <p>It is suggested to allow multiple registration of the same listener,
+ thus for each time a listener is added, it has to be removed.</p>
+
+ <p>If this XComponent is already disposed when
+ XComponent::addEventListener() is called, the call will not fail
+ with a DisposedException, but the caller will be notified via the
+ XEventListener::disposing()
+ callback. This callback can occur synchronously within the
+ addEventListener() call.</p>
+
+ @see XComponent::removeEventListener
+ */
+ void addEventListener( [in] XEventListener xListener );
+
+ /** removes an event listener from the listener list.
+
+ <p>It is a "noop" if the specified listener is not registered.</p>
+
+ <p>It is suggested to allow multiple registration of the same listener,
+ thus for each time a listener is added, it has to be removed.
+
+ <p>If this XComponent is already disposed when
+ XComponent::removeEventListener() is called, the call will not
+ fail with a DisposedException,
+ but will rather be ignored silently.</p>
+
+ @see XComponent::addEventListener
+ */
+ void removeEventListener( [in] XEventListener aListener );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */