INTEGRATION: CWS fwkbugfix02 (1.1.2); FILE ADDED

2004/04/14 11:21:52 mav 1.1.2.1: #i22465# state change events

1 files changed, 136 insertions, 0 deletions

diff --git a/offapi/com/sun/star/embed/XStateChangeListener.idl b/offapi/com/sun/star/embed/XStateChangeListener.idl
new file mode 100644
index 000000000000..392d2ec95289
--- /dev/null
+++ b/offapi/com/sun/star/embed/XStateChangeListener.idl
@@ -0,0 +1,136 @@
+/*************************************************************************
+ *
+ *  $RCSfile: XStateChangeListener.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: hr $ $Date: 2004-05-10 18:07:29 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library 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 for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_embed_XStateChangeListener_idl__
+#define __com_sun_star_embed_XStateChangeListener_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_embed_WrongStateException_idl__
+#include <com/sun/star/embed/WrongStateException.idl>
+#endif
+
+//============================================================================
+
+module com {  module sun {  module star {  module embed {
+
+//============================================================================
+
+/** makes it possible to receive events when an embedded object changes it's
+    state.
+ */
+interface XStateChangeListener: com::sun::star::lang::XEventListener
+{
+    //------------------------------------------------------------------------
+    /** is called just before the object changes state.
+
+        <p>
+        Actually the listener can try to complain about state changing, but
+        it is up to object to decide whether the state change can be
+        prevented. Anyway the possibility to complain must be used very
+        carefully.
+        </p>
+
+        @param aEvent
+            specifies the object that is going to change own state
+
+        @param nOldState
+            specifies the old state of the object
+
+        @param nNewState
+            specifies the new state of the object
+
+        @throws ::com::sun::star::embed::WrongStateException
+            the state change is unexpected by listener
+     */
+    void changingState( [in] com::sun::star::lang::EventObject aEvent,
+                        [in] long nOldState,
+                        [in] long nNewState )
+        raises( ::com::sun::star::embed::WrongStateException );
+
+    //------------------------------------------------------------------------
+    /** is called after the object has changed state.
+
+        @param aEvent
+            specifies the object that has changed own state
+
+        @param nOldState
+            specifies the old state of the object
+
+        @param nNewState
+            specifies the new state of the object
+     */
+    void stateChanged( [in] com::sun::star::lang::EventObject aEvent,
+                        [in] long nOldState,
+                        [in] long nNewState );
+};
+
+//============================================================================
+
+}; }; }; };
+
+#endif
+