summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/frame/XTerminateListener.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/frame/XTerminateListener.idl')
-rw-r--r--offapi/com/sun/star/frame/XTerminateListener.idl92
1 files changed, 92 insertions, 0 deletions
diff --git a/offapi/com/sun/star/frame/XTerminateListener.idl b/offapi/com/sun/star/frame/XTerminateListener.idl
new file mode 100644
index 000000000000..f141af78ef10
--- /dev/null
+++ b/offapi/com/sun/star/frame/XTerminateListener.idl
@@ -0,0 +1,92 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: XTerminateListener.idl,v $
+ * $Revision: 1.9 $
+ *
+ * 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_frame_XTerminateListener_idl__
+#define __com_sun_star_frame_XTerminateListener_idl__
+
+#ifndef __com_sun_star_lang_XEventListener_idl__
+#include <com/sun/star/lang/XEventListener.idl>
+#endif
+
+#ifndef __com_sun_star_lang_EventObject_idl__
+#include <com/sun/star/lang/EventObject.idl>
+#endif
+
+#ifndef __com_sun_star_frame_TerminationVetoException_idl__
+#include <com/sun/star/frame/TerminationVetoException.idl>
+#endif
+
+
+//=============================================================================
+
+ module com { module sun { module star { module frame {
+
+//=============================================================================
+/** has to be provided if an object wants to receive an event
+ when the master environment (e.g., desktop) is terminated.
+
+ @see XDesktop::terminate()
+ @see XDesktop::addTerminateListener()
+ @see XDesktop::removeTerminateListener()
+ */
+published interface XTerminateListener: com::sun::star::lang::XEventListener
+{
+ //-------------------------------------------------------------------------
+ /** is called when the master environment (e.g., desktop) is about to terminate.
+
+ <p>
+ Termination can be intercepted by throwing <type>TerminationVetoException</type>.
+ Interceptor will be the new owner of desktop and should call <member>XDesktop::terminate()</member>
+ after finishing his own operations.
+ </p>
+
+ @param Event
+ describe the source of the event (e.g., the desktop)
+
+ @throws TerminationVetoException
+ listener can disagree with this query by throwing this veto exception
+ */
+ void queryTermination( [in] com::sun::star::lang::EventObject Event )
+ raises( TerminationVetoException );
+
+ //-------------------------------------------------------------------------
+ /** is called when the master environment is finally terminated.
+ Not veto will be accepted then.
+
+ @param Event
+ describe the source of the event (e.g., the desktop)
+ */
+ void notifyTermination( [in] com::sun::star::lang::EventObject Event );
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif